Sign inSign up

earce9000/document-manager

By earce9000

•Updated 1 day ago

Self-hosted document manager: versions, tags, full-text/semantic search, Miro export, AI agent API.

Image
Content management system
0

7.5K

earce9000/document-manager repository overview

Document Manager

⁠Document Manager

Self-hosted document management service for single-file documents (HTML / MHTML / Markdown / PDF / images / CSV / TSV / text / log / JSON / draw.io / Excel / Word / PowerPoint). Versioning, tagging, projects with annotated contents lists, sandboxed hosting of web-page mockups, full-text and semantic search, export to Miro boards, and a token-authenticated REST API designed for AI agents. Documentation below is in Japanese; see the GitHub repository⁠ for details.

⁠どんなシステムか

社内の資料を1か所に集めて、探して、そのままブラウザで読むためのドキュメント管理サービスです。 Node.js (Express) 製で、このイメージを起動するだけで動きます。

扱うのは「1ファイルで完結する文書」です。設定ファイル(YAML・XML・TOML・INI)、字幕・文字起こし(SRT・VTT)、 テキストで書く図(Mermaid・PlantUML・Graphviz)、手順のスクリプト(.sh・.ps1)もそのまま置けて、中身は全文検索の 対象になります。Mermaid(.mmd)はテキストのままではなく図として描画します(公式のライブラリを同梱しているため、 外部へは出ません)。主なものは HTML / MHTML / Markdown / PDF / 画像(SVG・PNG・JPEG) / CSV・TSV / テキスト・ログ / JSON / draw.io / Excel・Word・PowerPoint に対応していて、どれも ダウンロードせずにブラウザ上でそのまま閲覧できます。Markdown や MHTML はサーバー側で見やすい形に 変換し、PDF はブラウザ標準のビューアで開きます。Markdown の表は途中で折り返さずに表示し、 手順書に貼られたコマンドはボタン1つでコピーできます。draw.io は公式ビューアを同梱しており、図をそのまま 描画します(画像を別途用意する必要はありません)。Excel・Word・PowerPoint は内容の概要 (シートの表・見出しと段落・スライドごとの本文と発表者ノート)を表示し、中身の文字は全文検索の 対象になります(この概要表示では書式・図・グラフは再現しません)。

レイアウトも見たい場合は、変換サービス(別イメージ earce9000/document-manager-converter)を 併せて起動すると、PDFでも開けるようになります。ただし LibreOffice による変換のため忠実な再現では ありません(フォントの字幅の違いで行の折り返しやページ数がずれることがあります)。変換サービスは任意で、無くても文書の登録・検索・概要表示には影響しません。

HTML や Markdown の資料をメールなどで人に渡すための 「PDFでダウンロード」 もあります。 PDF変換サービス(別イメージ earce9000/document-manager-pdf-converter)を併せて起動すると、 HTML・Markdown・MHTML・draw.io の文書を、プレビューの見た目のままPDFにして保存できます。 A4 には区切らないので表や図が途中で切れず、横に長い表はページを右へ広げて入れます。 フォントは BIZ UDゴシックで描くため行の折り返しが少しずれることがあり、外部のサイトに置かれた 画像は入りません(該当するときは保存時に知らせます)。

文書一覧とプレビュー

資料はタグとプロジェクトで整理します。タグは自由入力で、よく使うタグだけを並べた 「タグ体系」の画面から一覧できます。プロジェクトはフォルダ階層を持てるので、案件ごとの資料を まとめるのに向いています。1つの文書を複数のプロジェクトに置くこともできます。

タグ体系

版の管理ができます。修正した資料を「新しい版」としてアップロードすると、古い版は自動的に アーカイブされ、タグとプロジェクトへの登録は新しい版へ引き継がれます。プレビューの上部には 「v1 › v2 › v3」と版の履歴が並び、過去の版もそのまま開けます。別々に登録してしまった資料を、 後から新旧の版として結び直すこともできます。版とは別に、見積書と契約書のような関連文書どうしを 結ぶこともできます。

プロジェクト

「おしながき」で案件の資料を人に渡せます。 資料を集めても、ファイル名だけでは受け取った側が 全部開くことになります。プロジェクト名をクリックすると、その案件にどんな資料が揃っていて それぞれが何なのかを1枚にした一覧が出ます。資料ごとの説明はその場で書け、フォルダは章の 見出しになります。そのままMarkdownでコピーできるので、引き継ぎ・レビュー依頼・打ち合わせの 資料としてメールや議事録に貼れます。

説明はプロジェクトごとに持つので、同じ資料を案件ごとに書き分けられます。

案件が仕上がったら、南京錠でロックして画面からもAIからも編集できなくできます。

おしながき

人に渡すリンクは、更新しても変わりません。 「常に最新版を指すリンク」を渡しておけば、あとで差し替えても 相手は最新を見られます。版を固定したリンクも1クリックでコピーできます。

削除はありません。 「アーカイブ」は Gmail と同じ論理削除で、実ファイルは残り、いつでも元に戻せます。 誰が何をしたかは操作履歴に残り、他の利用者がアップロードやタグ付けをすると、画面の右下に小さな通知が出ます。

操作履歴

Webページのモックアップを、そのまま動かして確認できます。 LLMなどで作った画面案の一式を ZIPでアップロードすると、別ウィンドウで実際に動く状態で開けます(JavaScriptも動きます)。 React のようにJSが画面を組み立てるものでも構いません。文書とは別のコレクションとして管理し、 版を重ねると古い版は自動でアーカイブされ、版履歴から辿れます。サンプルのExcelやPDFを同梱して ダウンロードさせることもできます。

モックアップ管理

安全のため、モックアップはこのアプリから切り離した状態で配信します。アップロードされたJavaScriptは、 このアプリの文書やAPI、ログイン情報に一切手が届きません。置き場所の外へ書き出そうとするZIPや、 極端に膨らむように細工されたZIPも受け付けません。

なおこの機能は既定では無効です。使う場合は、管理画面(右上の歯車)→「サーバー」タブから 有効にしてください(再起動は要りません)。ファイルの置き場所は問いません(S3・GCSでも使えます)。

検索は、ファイル名・タグ・メモ・本文を対象にした部分一致検索が標準です。日本語でも単語の区切りを 気にせず探せます。スペースで区切ると、すべてを含む資料だけに絞り込めます(全角スペースでも構いません)。 語ごとに当たる場所は違っていてよいので、「請求書 2026年度」のようにファイル名とタグにまたがる指定もできます。 加えて、Weaviate を併せて起動すると意味検索(言い換えや表記ゆれを含めて近い資料を探す)も使えるようになります。

ログインは OpenID Connect です。Entra ID・Cognito・Google・Synology SSO など、標準的なプロバイダなら 設定を差し替えるだけで使えます。利用できるのは許可リストに登録された人だけで、権限は管理者・読み書き・ 閲覧のみの3種類です。

AIエージェントから使えます。 ブラウザを介さずに呼べる API キーを画面から発行でき(有効期限は最長1年)、API の仕様は GET api/openapi.json(機械可読)と GET api/usage.md(説明文)で取得できます。Claude Code・OpenAI Codex・ Google Antigravity 用の Skill も画面からダウンロードでき、「この資料アップして」「前の版を置き換えて」 「〜を探して」と話しかけるだけで操作できるようになります。キーで使える権限は、キーの権限と発行した人の いまの権限の低いほうです(発行した人を閲覧のみに下げれば、キーもすぐ閲覧のみになります)。

上で紹介したモックアップとおしながきも、AIから操作できます。 モックアップはもともとAIが作るものなので、 「この画面案をアップして」と言えば、作ったページ一式をそのまま登録し、開くためのURLを返します (フォルダを渡すだけでよく、ZIPに固める必要はありません)。おしながきも「この案件の資料一覧ちょうだい」で そのまま受け取れます。

Miro のボードに書き出せます(任意)。 打ち合わせで使う Miro のボードに、資料を並べて出します。書き出すのは 頼まれたときだけで、ボードが知らないうちに変わることはありません。ボードに置いた目印の付箋([DM]名前 と向き)の 横に、書き出すたびに新しいフレームを作って並べます(向きは8方向と十字)。 前に出したフレームには触りません。PDF・画像はそのまま、HTML・Markdown・draw.io は PDF に、Office は体裁つきの PDF にして出し、各資料に「Document Manager で開く」リンクを付けます。AIエージェントに「この資料を Miro に 書き出して」と頼むか、プレビューのアイコンから1件ずつ出します。画面の上の「Miro」で目印を置き、書き出しの履歴を見られます。 資料の代わりに、AIエージェントが箱と線の一覧からフロー図(担当ごとのレーン・分かれ道・ループ)を描いたり、 付箋を島ごとにまとめて並べたり(親和図・ふりかえり)もできます。位置は Document Manager が決めます。

Miro

AIエージェント用Skillの配布

構成は後から変えられます。 既定では1コンテナで完結し、文書のメタデータは SQLite、ファイルは ローカルディスクに保存します。環境変数を変えるだけで、メタデータを PostgreSQL に、ファイルを S3 や GCS に移せるので、AWS(ECS/Fargate)や GCP(Cloud Run / GKE)で複数インスタンス構成にもできます。 モックアップの原本(ZIP)も S3・GCS に置けます。

⁠構成

システム構成

2つの変換サービス(converter / pdf-converter)と Weaviate / 推論サーバーは、どれも任意です。 無くてもアプリは動き、該当する機能だけが使えなくなります。単一コンテナだけで動かすこともできます。

変換サービスは信用できない文書を開くため(LibreOffice / Chromium)、インターネットにも他の サービスにも出られない専用ネットワークに、別々に閉じ込めています(読み取り専用・作業場所はメモリ上の 一時領域・非root・メモリ上限)。細工された文書に任意のURLを叩かせないためです。

⁠管理画面(管理者のみ)

画面右上の歯車から開く別のページです。サーバーにログインせずに状態を確かめられます。

  • 利用者: ログインできる人(許可リスト)と権限。最後の管理者は下げることも外すこともできません。 外した人のセッションと APIキーは止まります
  • セッション: ログイン中のセッションと APIキー(キーごとに最後に使ったクライアントと Skill の版。古い Skill には 印が付きます)。不正アクセスが疑われるときは、セッション・APIキー・モックアップの表示をまとめて切断できます (パスワードが漏れているなら、認証基盤側での変更も必要です)
  • 監査ログ: 全員ぶんの操作(ログイン、文書の書き込み、管理の操作、権限で断った呼び出し)を期間・利用者・操作で探せます
  • サーバー: 版・ビルド時刻・起動時刻(更新したのにビルド時刻が変わらなければ入れ替わっていない)、DB・ファイルの 置き場・IdP・変換サービス・Weaviate への接続の確認、危ない設定を赤く出すセキュリティ設定、部品の版と部品表。 中身は Markdown で書き出せます。API の回数の上限と機能の On/Off もここで変えます
  • データベース: 破損の検知(起動のたびに自動)と、DBと実ファイルの照合。ファイルだけ残っている文書は登録し直せます (ファイルが見つからない文書の記録は消しません)
  • 変換サービス: 2つの変換サービスが動いているか、変換に失敗した文書はあるか(その場で再実行できます)
  • Miro 連携: Miro との連携と、書き出すボードの選択

⁠立ち上げるために必要な作業

⁠1. 事前に用意するもの

OpenID Connect の設定を、利用しているプロバイダ側で済ませてください。クライアントIDと クライアントシークレットを発行し、コールバックURL(https://<公開するホスト名>/login)を登録します。

データの置き場所として、ホスト側にディレクトリを1つ用意します。ここに SQLite のデータベースと 文書ファイルが入ります。

セッションの署名鍵を生成しておきます。

openssl rand -hex 32
⁠2. 起動する
docker run -d \
  --name document-manager \
  -p 8080:8080 \
  -v "$(pwd)/data:/data" \
  -e BASE_PATH="/" \
  -e OIDC_ISSUER="https://accounts.example.com" \
  -e OIDC_CLIENT_ID="<クライアントID>" \
  -e OIDC_CLIENT_SECRET="<クライアントシークレット>" \
  -e OIDC_REDIRECT_URI="https://docs.example.com/login" \
  -e ADMIN_EMAIL="[email protected]" \
  -e SESSION_SECRET="<手順1で生成した値>" \
  earce9000/document-manager:latest

http://localhost:8080/ を開くとログイン画面へ転送されます。

SESSION_SECRET を指定しないと、起動のたびに鍵が変わり、再起動のたびに全員がログアウトされます。 必ず固定の値を渡してください。

⁠3. 最初のログイン

許可リストが空の間は誰もログインできません。 そこで ADMIN_EMAIL が働きます。管理者が1人もいない間に 限り、そのアドレスでログインした人が自動的に管理者として登録されます。常設の特別扱いではないため、 管理者を全員削除してしまっても締め出されません。

最初のログイン後、画面右上の歯車(管理画面)の「利用者」タブで、使う人のメールアドレスを許可リストへ追加してください。 権限は、管理者(admin)・読み書き(readwrite)・閲覧のみ(readonly)から選べます。

⁠4. リバースプロキシの後ろに置く場合

公開するパスを BASE_PATH に設定します。ホスト全体をこのサービスに使うなら /、 サブパスで公開するなら /document_management のように指定します。OIDC_REDIRECT_URI も 公開URLに合わせてください。

画面の自動更新に Server-Sent Events を使うので、プロキシの応答の溜め込みは無効にしてください (Apache なら flushpackets=on。nginx 向けにはアプリが X-Accel-Buffering: no を返します)。

⁠5. 意味検索を使う場合

アプリ・Weaviate・埋め込み計算用の推論サーバーの3つを起動します。Weaviate はポートを公開しないでください。 匿名アクセスが有効なため、外部から触れる状態になってしまいます。

services:
  app:
    image: earce9000/document-manager:latest
    restart: always
    ports:
      - "8080:8080"
    volumes:
      - ./data:/data
    environment:
      BASE_PATH: "/"
      OIDC_ISSUER: "https://accounts.example.com"
      OIDC_CLIENT_ID: "<クライアントID>"
      OIDC_CLIENT_SECRET: "<クライアントシークレット>"
      OIDC_REDIRECT_URI: "https://docs.example.com/login"
      ADMIN_EMAIL: "[email protected]"
      SESSION_SECRET: "<openssl rand -hex 32 の値>"
      WEAVIATE_URL: "http://weaviate:8080"
      WEAVIATE_GRPC_PORT: "50051"
    depends_on:
      - weaviate

  weaviate:
    image: docker.io/semitechnologies/weaviate:1.36.24
    restart: always
    environment:
      AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: "true"
      PERSISTENCE_DATA_PATH: /var/lib/weaviate
      ENABLE_MODULES: text2vec-transformers,text2vec-cohere,text2vec-openai,text2vec-aws
      API_BASED_MODULES_DISABLED: "true"   # ENABLE_MODULES 以外を切る(v1.33 から既定で有効)
      DISABLE_TELEMETRY: "true"
      DEFAULT_VECTORIZER_MODULE: text2vec-transformers
      TRANSFORMERS_INFERENCE_API: http://t2v-transformers:8080
      CLUSTER_HOSTNAME: node1
    volumes:
      - weaviate_data:/var/lib/weaviate
    depends_on:
      - t2v-transformers

  t2v-transformers:
    image: docker.io/semitechnologies/transformers-inference:sentence-transformers-paraphrase-multilingual-mpnet-base-v2
    restart: always
    environment:
      ENABLE_CUDA: "0"

volumes:
  weaviate_data:

登録済みの文書は起動後に順に索引付けされます(進み具合は画面の「ベクトル索引」)。推論サーバーは 1.0〜1.4GB ほどのメモリを使います。

podman 用の構成は deploy/compose.yml⁠ にあります。

⁠6. PDFでダウンロードを使う場合

Miro に HTML・Markdown・draw.io を書き出すときも、この変換を使います。 PDF変換サービス(earce9000/document-manager-pdf-converter)を外へ出られないネットワークに起動し、 アプリに HTML_PDF_URL(例: http://pdf-converter:3000)を渡します。ポートは公開しないでください (認証を持ちません)。compose の例・安全面の考え方・更新の仕方は 変換サービスのページ⁠にあります。

⁠7. Miro に書き出す場合

Miro の開発者ハブでアプリを作り(権限は boards:read と boards:write)、クライアントIDとシークレットを MIRO_CLIENT_ID / MIRO_CLIENT_SECRET で渡すか、管理画面の「Miro 連携」に入力します。管理者が1回連携し、 書き出すボードを選べば使えます。サーバーから api.miro.com へ出られる必要があります。 手順は docs/miro.md⁠ にあります。

⁠8. 主な環境変数
変数既定値説明
OIDC_ISSUER(必須)OpenID Connect の issuer URL
OIDC_CLIENT_ID(必須)クライアントID
OIDC_CLIENT_SECRET(空)クライアントシークレット(パブリッククライアントなら不要)
OIDC_REDIRECT_URI(必須)コールバックURL。プロバイダ側にも同じ値を登録する
ADMIN_EMAIL(未設定)管理者が1人もいない間だけ働く、自己修復用のアドレス
SESSION_SECRET(ランダム)セッションの署名鍵。必ず固定値を指定する
SESSION_MAX_AGE_HOURS16ログインセッションの寿命(時間)。ログイン時点からの絶対時間で、操作しても延びない
BASE_PATH/document_management公開時のパスprefix
DATA_DIR/dataSQLite とローカル保存時の文書ファイルの置き場所。モックアップの展開した控えもここ(S3でも。消えても作り直します)
DATABASE_BACKENDsqlitesqlite / postgres(複数インスタンス構成では必須)
DATABASE_URL(未設定)PostgreSQL の接続文字列(標準の PG* 変数でも可)
STORAGE_BACKENDlocallocal / s3 / gcs
HTML_PDF_URL(未設定)PDFでダウンロード(HTML・Markdown・MHTML・draw.io→PDF)の変換サービスのURL。未設定ならこの機能は無効(画面にボタンが出ないだけ)
OFFICE_RENDER_URL(未設定)体裁つき表示(Office→PDF)の変換サービスのURL。未設定ならこの機能は無効(概要表示だけになります)
WEAVIATE_URL(未設定)設定すると意味検索が有効になる
UPLOAD_MAX_BYTES2684354561ファイルのアップロード上限(256MB)。超過時は413
CONTENT_TEXT_MAX_CHARS300000検索用に保存する本文の上限。超過分は検索対象外(ファイル自体は全て保存される)
MOCKUPS_ENABLED(未設定=無効)モックアップ機能の既定値。管理画面からも切り替えられます
MOCKUP_STORAGE_PREFIXmockupsS3/GCS利用時に、モックアップの原本を置くキーの先頭。文書側(既定 documents)とは必ず別にしてください
MIRO_CLIENT_ID / MIRO_CLIENT_SECRET(未設定)Miro のアプリの値。未設定なら管理画面で入力した値を使う
RATE_LIMIT_AUTHENTICATED / RATE_LIMIT_ANONYMOUS10000 / 300api/* の回数の上限(5分あたり。ログインした人は利用者ごと、ほかはIPごと)。管理画面で変えた値が優先
AUTH_DISABLED(未設定)true で認証を無効化(開発用。本番では使わない。画面に「開発モード」と出ます)
RATE_LIMIT_DISABLED(未設定)true でレート制限を無効化(開発・テスト用。本番では使わない)

S3 の認証情報は AWS SDK の標準の取得順(IAMロール優先)、GCS は Application Default Credentials に従います。 全変数の一覧は GitHub の README にあります。

⁠9. データの扱いと更新・切り戻し

/data をマウントしておけば、文書・モックアップと SQLite のデータベースはそこに残ります。

SQLite のスキーマを上げるときは、新しいファイルにデータを移し、古いファイルは残します(古いイメージへ戻せるように)。 更新前に /data/db のバックアップを取ってください。戻すと、更新後に登録した文書は見えません。

PostgreSQL 構成の場合、スキーマの更新は起動時に自動で適用されます。

タグは latest(最新)と、ビルドした日時の YYYYMMDD.HHMM(JST。直近10世代を残す)です。 切り戻しは日時のタグを指定します。amd64 と arm64 に対応しています。

⁠ライセンス

MIT

ソースコードと詳しいドキュメント: https://github.com/EARCE9000/document-manager⁠

Tag summary

Content type

Image

Digest

sha256:8b40bfa90…

Size

116.7 MB

Last updated

1 day ago

docker pull earce9000/document-manager