Skip to main content

必要インフラと環境変数リファレンス

必要インフラと環境変数リファレンス

セルフホスト版 Docmost の インフラ要件 と 主要な環境変数 をまとめたリファレンスです。

必要インフラ

コンポーネント バージョン 必須 用途
PostgreSQL 18 推奨 ✓ メインデータベース
Redis 8 推奨 ✓ セッション・キャッシュ・共同編集
ストレージ local / S3 / Azure ✓ 添付ファイル保存

オプション:

必須環境変数

変数 説明 例
APP_URL 公開 URL（origin のみ） https://docs.example.com
APP_SECRET 暗号化用シークレット openssl rand -hex 32 で生成
DATABASE_URL PostgreSQL 接続文字列 postgresql://user:pass@db:5432/docmost
REDIS_URL Redis 接続文字列 redis://redis:6379

アプリケーション

変数 既定値 説明
PORT 3000 リッスンポート
NODE_ENV development 実行環境
JWT_TOKEN_EXPIRES_IN 90d セッション有効期限
CLOUD false クラウド版フラグ（セルフホストは false）
DISABLE_TELEMETRY false テレメトリ無効化

ストレージ

変数 説明
STORAGE_DRIVER local（既定）/ s3 / azure
FILE_UPLOAD_SIZE_LIMIT アップロード上限（既定 50mb）
FILE_IMPORT_SIZE_LIMIT インポート上限（既定 200mb）
AWS_S3_* S3 関連（アクセスキー・バケット等）
AZURE_STORAGE_* Azure Blob 関連

→ 詳細: 「ストレージ — local / S3 / Azure」（No.10.3）

メール

変数 説明
MAIL_DRIVER log（既定）/ smtp / postmark
MAIL_FROM_ADDRESS 送信元メールアドレス
MAIL_FROM_NAME 送信者名（既定 Docmost）
SMTP_HOST / SMTP_PORT SMTP サーバー
SMTP_USERNAME / SMTP_PASSWORD SMTP 認証
SMTP_SECURE TLS 使用（true / false）
POSTMARK_TOKEN Postmark 利用時

検索

変数 説明
SEARCH_DRIVER database（既定）/ typesense
TYPESENSE_URL Typesense エンドポイント
TYPESENSE_API_KEY API キー

AI（Enterprise ライセンス + 設定）

変数 説明
AI_DRIVER AI プロバイダ
OPENAI_API_KEY / OPENAI_API_URL OpenAI
GEMINI_API_KEY Google Gemini
OLLAMA_API_URL ローカル Ollama

共同編集・その他

変数 説明
COLLAB_URL 共同編集 WebSocket URL（リバースプロキシ時）
COLLAB_DISABLE_REDIS Redis なし共同編集（true）
DRAWIO_URL Draw.io サーバー URL
GOTENBERG_URL PDF レンダリング
IFRAME_EMBED_ALLOWED iframe 埋め込み許可
SAML_DISABLE_REQUESTED_AUTHN_CONTEXT SAML 認証コンテキスト

運用チェックリスト

  1. APP_URL は HTTPS で本番運用を推奨
  2. APP_SECRET は再起動後も変えない（セッションが無効化される）
  3. PostgreSQL と Redis のバックアップを定期取得（No.10.4）
  4. SMTP を設定して招待・通知メールを有効化

関連ナレッジ