# sismics/docs architecture

> Architecture diagram of the GitHub repository sismics/docs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sismics/docs
- Repository: https://github.com/sismics/docs

## Overview

Teedy is a document-management system. Its principal workflow is users submitting documents through the web/API or bulk importer, then managing and finding them; the README documents OCR, metadata, permissions, versioning, and workflow capabilities. The sampled files show request setup, authentication, database initialization, email handling, and sharing UI, but not the core document-processing or REST implementation. Those documented subsystems are included at supported enclosing paths; their internal links are not inferred. Evidence is limited to the README and supplied source excerpts/index.

Main entry points: [`docs-core/src/main/java`](https://github.com/sismics/docs/tree/master/docs-core/src/main/java) (Document management), [`docs-web-common/src/main/java/com/sismics/util/filter/RequestContextFilter.java`](https://github.com/sismics/docs/blob/master/docs-web-common/src/main/java/com/sismics/util/filter/RequestContextFilter.java) (Request lifecycle), [`docs-web-common/src/main/java/com/sismics/util/filter/JwtBasedSecurityFilter.java`](https://github.com/sismics/docs/blob/master/docs-web-common/src/main/java/com/sismics/util/filter/JwtBasedSecurityFilter.java) (Authentication), [`docs-web/src/main/webapp/src/app/share`](https://github.com/sismics/docs/tree/master/docs-web/src/main/webapp/src/app/share) (Web interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User entry points"]
  node_web["Web interface"]
  node_bulk["Bulk importer<br/>[main.js]"]
  node_api["REST API"]
end

subgraph group_domain["Document capabilities"]
  node_sharing["Document sharing<br/>[Share.js]"]
  node_documents["Document management"]
  node_search["Search"]
  node_ocr["OCR and extraction"]
  node_workflow["Workflow"]
  node_metadata["Metadata and tags"]
end

subgraph group_security["Request and identity"]
  node_auth["Authentication"]
  node_authorization["Permissions context"]
  node_totp["Two-factor codes"]
end

subgraph group_platform["Core platform"]
  node_request["Request lifecycle"]
  node_thread["Request context"]
  node_persistence["Persistence setup<br/>[EMF.java]"]
  node_schema["Schema upgrades<br/>[DbOpenHelper.java]"]
  node_email["Email handling<br/>[EmailUtil.java]"]
end

node_user(("User"))

node_user -->|"uses"| node_web
node_user -->|"uses"| node_api
node_user -->|"imports through"| node_bulk
node_web -->|"presents sharing"| node_sharing
node_bulk -->|"imports documents"| node_documents
node_api -.->|"manages documents"| node_documents
node_documents -.->|"supports finding"| node_search
node_documents -.->|"supports extraction"| node_ocr
node_documents -.->|"supports workflow"| node_workflow
node_documents -.->|"supports metadata"| node_metadata
node_request -->|"sets context"| node_thread
node_request -->|"creates entity manager"| node_persistence
node_thread -->|"provides request state"| node_request
node_persistence -->|"initializes schema"| node_schema
node_auth -->|"passes identity"| node_authorization
node_auth -.->|"validates token"| node_user
node_email -.->|"emails users"| node_user

click node_web "https://github.com/sismics/docs/tree/master/docs-web/src/main/webapp/src/app/share"
click node_bulk "https://github.com/sismics/docs/blob/master/docs-importer/main.js"
click node_api "https://github.com/sismics/docs/tree/master/docs-web"
click node_sharing "https://github.com/sismics/docs/blob/master/docs-web/src/main/webapp/src/app/share/controller/Share.js"
click node_documents "https://github.com/sismics/docs/tree/master/docs-core/src/main/java"
click node_search "https://github.com/sismics/docs/tree/master/docs-core/src/main/java"
click node_ocr "https://github.com/sismics/docs/tree/master/docs-core/src/main/java"
click node_workflow "https://github.com/sismics/docs/tree/master/docs-core/src/main/java"
click node_metadata "https://github.com/sismics/docs/tree/master/docs-core/src/main/java"
click node_auth "https://github.com/sismics/docs/blob/master/docs-web-common/src/main/java/com/sismics/util/filter/JwtBasedSecurityFilter.java"
click node_authorization "https://github.com/sismics/docs/blob/master/docs-web-common/src/main/java/com/sismics/util/filter/SecurityFilter.java"
click node_request "https://github.com/sismics/docs/blob/master/docs-web-common/src/main/java/com/sismics/util/filter/RequestContextFilter.java"
click node_thread "https://github.com/sismics/docs/blob/master/docs-core/src/main/java/com/sismics/util/context/ThreadLocalContext.java"
click node_persistence "https://github.com/sismics/docs/blob/master/docs-core/src/main/java/com/sismics/util/jpa/EMF.java"
click node_schema "https://github.com/sismics/docs/blob/master/docs-core/src/main/java/com/sismics/util/jpa/DbOpenHelper.java"
click node_email "https://github.com/sismics/docs/blob/master/docs-core/src/main/java/com/sismics/util/EmailUtil.java"
click node_totp "https://github.com/sismics/docs/blob/master/docs-core/src/main/java/com/sismics/util/totp/GoogleAuthenticator.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_web,node_bulk,node_api,node_user toneBlue
class node_sharing,node_documents,node_search,node_ocr,node_workflow,node_metadata toneAmber
class node_auth,node_authorization,node_totp toneMint
class node_request,node_thread,node_persistence,node_schema,node_email toneRose
```

## Components

### User entry points

- [Web interface](https://github.com/sismics/docs/tree/master/docs-web/src/main/webapp/src/app/share): `docs-web/src/main/webapp/src/app/share`
- [Bulk importer](https://github.com/sismics/docs/blob/master/docs-importer/main.js): `docs-importer/main.js`
- [REST API](https://github.com/sismics/docs/tree/master/docs-web): `docs-web`

### Document capabilities

- [Document sharing](https://github.com/sismics/docs/blob/master/docs-web/src/main/webapp/src/app/share/controller/Share.js): `docs-web/src/main/webapp/src/app/share/controller/Share.js`
- [Document management](https://github.com/sismics/docs/tree/master/docs-core/src/main/java): `docs-core/src/main/java`
- [Search](https://github.com/sismics/docs/tree/master/docs-core/src/main/java): `docs-core/src/main/java`
- [OCR and extraction](https://github.com/sismics/docs/tree/master/docs-core/src/main/java): `docs-core/src/main/java`
- [Workflow](https://github.com/sismics/docs/tree/master/docs-core/src/main/java): `docs-core/src/main/java`
- [Metadata and tags](https://github.com/sismics/docs/tree/master/docs-core/src/main/java): `docs-core/src/main/java`

### Request and identity

- [Authentication](https://github.com/sismics/docs/blob/master/docs-web-common/src/main/java/com/sismics/util/filter/JwtBasedSecurityFilter.java): `docs-web-common/src/main/java/com/sismics/util/filter/JwtBasedSecurityFilter.java`
- [Permissions context](https://github.com/sismics/docs/blob/master/docs-web-common/src/main/java/com/sismics/util/filter/SecurityFilter.java): `docs-web-common/src/main/java/com/sismics/util/filter/SecurityFilter.java`
- [Two-factor codes](https://github.com/sismics/docs/blob/master/docs-core/src/main/java/com/sismics/util/totp/GoogleAuthenticator.java): `docs-core/src/main/java/com/sismics/util/totp/GoogleAuthenticator.java`

### Core platform

- [Request lifecycle](https://github.com/sismics/docs/blob/master/docs-web-common/src/main/java/com/sismics/util/filter/RequestContextFilter.java): `docs-web-common/src/main/java/com/sismics/util/filter/RequestContextFilter.java`
- [Request context](https://github.com/sismics/docs/blob/master/docs-core/src/main/java/com/sismics/util/context/ThreadLocalContext.java): `docs-core/src/main/java/com/sismics/util/context/ThreadLocalContext.java`
- [Persistence setup](https://github.com/sismics/docs/blob/master/docs-core/src/main/java/com/sismics/util/jpa/EMF.java): `docs-core/src/main/java/com/sismics/util/jpa/EMF.java`
- [Schema upgrades](https://github.com/sismics/docs/blob/master/docs-core/src/main/java/com/sismics/util/jpa/DbOpenHelper.java): `docs-core/src/main/java/com/sismics/util/jpa/DbOpenHelper.java`
- [Email handling](https://github.com/sismics/docs/blob/master/docs-core/src/main/java/com/sismics/util/EmailUtil.java): `docs-core/src/main/java/com/sismics/util/EmailUtil.java`

### Other components

- **User**

## Connections

- User → Web interface: uses
- User → REST API: uses
- User → Bulk importer: imports through
- Web interface → Document sharing: presents sharing
- Bulk importer → Document management: imports documents
- REST API → Document management: manages documents
- Document management → Search: supports finding
- Document management → OCR and extraction: supports extraction
- Document management → Workflow: supports workflow
- Document management → Metadata and tags: supports metadata
- Request lifecycle → Request context: sets context (evidence: `docs-web-common/src/main/java/com/sismics/util/filter/RequestContextFilter.java`)
- Request lifecycle → Persistence setup: creates entity manager (evidence: `docs-web-common/src/main/java/com/sismics/util/filter/RequestContextFilter.java`)
- Request context → Request lifecycle: provides request state (evidence: `docs-core/src/main/java/com/sismics/util/context/ThreadLocalContext.java`)
- Persistence setup → Schema upgrades: initializes schema (evidence: `docs-core/src/main/java/com/sismics/util/jpa/EMF.java`)
- Authentication → Permissions context: passes identity (evidence: `docs-web-common/src/main/java/com/sismics/util/filter/JwtBasedSecurityFilter.java`)
- Authentication → User: validates token
- Email handling → User: emails users
