Skip to main content

システム内蔵環境変数設定

本ドキュメントはシステム内蔵の環境変数設定について説明します。対応する設定ページは https://{your-host}/admin/system/environment-variables です。

説明：

  1. your-host は設定対象の環境ドメインです。例えば、Stage環境の場合は staging.example.com となります。
  2. 本ドキュメントで説明しているのは docker の env 環境変数ではなく、システム内蔵の設定項目です。システムを再起動せず、ページをリフレッシュするだけで素早く設定変更を反映できます。
  3. 対応する環境で該当変数が見つからない場合は、新規作成してください。

カスタム env 設定の由来​

プロダクトのフロントエンドに遷移する際、以下の2つの方法で追加の env 設定を指定できます。値はリンク（encodeURIComponent が必要）です。

  • 方法1：アドレスバーのパラメータに sm-env というフィールドを渡す
  • 方法2：localstorage に $serviceme-next-custom-env というフィールドを設定する

プロダクトはこのリンクをリクエストし、その設定をシステム内の env 設定にマージします。例：

https://app.example.com/?sm-env=%2fstatic%2fenv.json

この場合、https://app.example.com/static/env.json から追加設定を取得します。

設定の優先順位：localstorage で指定した追加パラメータ > sm-env で指定した追加パラメータ > システム内設定パラメータ > フロントエンドのデフォルトパラメータ

CUSTOM_CSS​

  • タイプ：文字列配列
  • 説明：配列内の各文字列はcssファイルのリンクです。この配列内の全てのcssファイルはシステム初期化時に読み込まれます。
  • デフォルト値：[]

CUSTOM_CSS_WEIXIN_WORK​

  • タイプ：文字列配列
  • 説明：上記 CUSTOM_CSS と同様ですが、この配列に設定したcssはWeChat Work環境下のみ有効です。
  • デフォルト値：[]

THEME_LIST​

  • タイプ：JSON文字列
  • 説明：ユーザーが選択できるテーマを設定します。nameI18nKey はテーマ表示テキストの国際化キー（「国際化コンテンツ管理」ページで管理）、code はアップロードしたテーマコードと一致させる必要があります。color は選択時にテキスト前に表示されるカラードットです。
  • 参考値：

SERVICEME スタイル：

[
  {"nameI18nKey":"theme.form.color.purple","code":"purple","color":"#722ed1"},
  {"nameI18nKey":"theme.form.color.blue","code":"blue","color":"#1677ff"}
]

OneAI スタイル：

[
  {"nameI18nKey":"swo","code":"swo","color":"#472aff"}
]

BROWSER_TITLE​

  • タイプ：JSON文字列
  • 説明：ブラウザタブに表示されるアイコンと名称を設定します。PCとH5で個別設定可能、WeChat Workのアイコンと名称も設定可能です。
  • 参考値：
{
  "TITLE_DESKTOP": "System Name",
  "TITLE_MOBILE": "System Name",
  "TITLE_WX_WORK": "System Name",
  "ICON_DESKTOP": "./favicon.svg",
  "ICON_MOBILE": "./favicon.svg",
  "ICON_WX_WORK": "./favicon.svg"
}

ENTRY_MAINTENANCE​

  • タイプ：数値
  • 説明：この値が 1 の場合、全ユーザーが「メンテナンス中」ページに強制リダイレクトされます。
  • メンテナンスチャンネル：この制限をバイパスするメンテナンス担当者は、F12の localstorage にてキー $serviceme-next-skip-maintenance、値 true を設定してください。
  • デフォルト値：0

CUSTOM_HOME_AI_APP​

  • タイプ：JSON文字列
  • 説明：ホーム画面下部のAIアプリボタンを設定します。
    • URL: 遷移先リンク
    • NAME: 表示タイトル（国際化キー対応）
    • IMG: 表示画像パス
    • BG_COLOR: 背景色
  • 参考値：
[
  {
    "URL": "/app-markmap-gen",
    "NAME": "next.home.ai.governance.item1.title",
    "IMG": "./images/home/home-mindmap.png"
  },
  {
    "URL": "/app-ai-abstract",
    "NAME": "next.home.ai.governance.item2.title",
    "IMG": "./images/home/home-summary.png"
  },
  {
    "URL": "/app-ai-translate-v2",
    "NAME": "next.home.ai.governance.item3.title",
    "IMG": "./images/home/home-translate.png",
    "BG_COLOR": "linear-gradient(176deg, rgba(255,255,255,0.4) 0%, #ECFDF3 100%)"
  }
]

SSO_LOGIN_CONFIG​

  • タイプ：JSON文字列
  • 説明：システム内蔵のシングルサインオン機能を設定します。
  • ドキュメント：内部Wikiの [SSOカスタム設定ガイド] を参照してください。

SSO_LOGIN_SECRET​

  • タイプ：JSON文字列
  • 説明：バックエンドのシングルサインオン処理ロジック用（機密設定）。

CUSTOM_LOGIN_URL​

  • タイプ：文字列
  • 説明：未ログイン時にリダイレクトするカスタムページのURL。
  • デフォルト値：/login

DISABLE_LOGIN_WHEN_CUSTOM​

  • タイプ：ブール値
  • 説明：カスタムログインページ使用時、内蔵ログインページを無効化するかどうか。true の場合、/login アクセス時に自動的に CUSTOM_LOGIN_URL へリダイレクトします。
  • デフォルト値：false

BOT_FILE_ACCEPT​

  • タイプ：文字列配列
  • 説明：アシスタントでアップロード可能なファイル拡張子。
  • デフォルト値：[".pdf", ".xlsx", ".xls", ".csv"]

ENABLE_TOUR​

  • タイプ：1 または 0
  • 説明：ユーザーガイドを有効にするかどうか。
  • デフォルト値：0

CHAT_TEXTAREA_MAX_LENGTH​

  • タイプ：数値
  • 説明：アシスタントチャットボックスで入力可能な最大文字数。
  • デフォルト値：8000

DISABLE_VOICE_INPUT​

  • タイプ：ブール値
  • 説明：ホーム画面やチャットボックスの音声入力ボタンの表示制御。
  • デフォルト値：空（デフォルト表示、true で非表示）

KNOWLEDGE_MAX_SYSTEM_UPLOAD_FILE_SIZE​

  • タイプ：数値
  • 説明：システムでアップロード可能なファイルサイズの最大値（単位：G）。
  • デフォルト値：1024

KNOWLEDGE_MAX_CONCURRENT_FILE_UPLOADS​

  • タイプ：数値
  • 説明：システムで同時にアップロード可能なファイル数の最大値。
  • デフォルト値：10

KNOWLEDGE_MAX_CONCURRENT_FILE_DOWNLOADS​

  • タイプ：数値
  • 説明：システムで一度にダウンロード可能なファイル数の最大値。
  • デフォルト値：10

KNOWLEDGE_MAX_QNA_QUESTION_LENGTH​

  • タイプ：数値
  • 説明：QnA - 質問の最大長。
  • デフォルト値：100

KNOWLEDGE_MAX_QNA_ANSWER_LENGTH​

  • タイプ：数値
  • 説明：QnA - 回答の最大長。
  • デフォルト値：2000

KNOWLEDGE_MAX_FILE_STORAGE_QUOTA​

  • タイプ：数値
  • 説明：ファイルストレージの最大クォータ（GB）。
  • デフォルト値：1

KNOWLEDGE_MAX_META_OPTION_SCOUNT​

  • タイプ：数値
  • 説明：メタデータ - オプション - 最大件数。
  • デフォルト値：20

KNOWLEDGE_MAX_META_OPTIONS_VALUE_LENGTH​

  • タイプ：数値
  • 説明：メタデータ - オプション - 内容の最大長。
  • デフォルト値：100

KNOWLEDGE_REPORT_MAX_QUERY_RANGE_DAYS​

  • タイプ：数値
  • 説明：最大エクスポート範囲日数。
  • デフォルト値：7

KNOWLEDGE_DEFAULT_SUMMARY_PROMPT​

  • タイプ：文字列
  • 説明：ナレッジベース要約のデフォルトプロンプト。
  • デフォルト値：### Summarize the following in the original language in no more than 200 words.

MOBILE_ALLOWED_ROUTES​

  • タイプ：文字列配列
  • 説明：モバイルで許可するルートアドレス。マッチングルールは location.pathname の完全一致です。
  • デフォルト値：[]
  • 参考値：["/settings/system/environment"]

CUSTOM_KNOWLEDGE_SETTING_MENU​

  • タイプ：オブジェクト配列
  • 説明：「ナレッジ管理」ページの左サイドバーのメニューを拡張するための設定。
  • 参考値：
[{
  "customUrl": "http://your-domain.com/page",
  "path": "new-page",
  "key": "new-page",
  "label": "カスタムメニュー名",
  "code": "PermissionCode"
}]

フィールド説明：

  • customUrl: 埋め込むページのリンク
  • path と key: 同じかつ一意であること
  • label: メニュー名（国際化キーとしても利用可能）
  • code: 権限コード。バックエンドのDBの権限テーブルに対応するコードの権限項目を設定する必要があります。

CUSTOM_KNOWLEDGE_SETTING_SIDEBAR_MENU​

  • タイプ：オブジェクト配列
  • 説明：Knowledgeページの左サイドバーのメニューを拡張するための設定（設定方法は上記と同じ）。

CUSTOM_AI_STUDIO_SIDEBAR_MENU​

  • タイプ：オブジェクト配列
  • 説明：AI STUDIOの左サイドバーのメニューを拡張するための設定（設定方法は上記と同じ）。

CUSTOM_MONITOR_SETTING_MENU​

  • タイプ：オブジェクト配列
  • 説明：モニタリング管理ページの左サイドバーのメニューを拡張するための設定（設定方法は上記と同じ）。

DEBUG_MODE​

  • タイプ：ブール値
  • 説明：この値が true の場合、システムはデバッグモードを起動できます。注意！不要な場合は必ずオフまたは削除してください！
  • デフォルト値：false
  • 特徴：デバッグモードはページリフレッシュ後自動的にオフになります。再度手動で起動が必要です。
  • タイプ：文字列
  • 説明：システム左上のLOGO画像リンク。

product_name​

  • タイプ：文字列
  • 説明：システム左上中央のプロダクト名画像リンク。

show_product_name​

  • タイプ：ブール値
  • 説明：product_name を表示するかどうか。
  • 参考値：0（非表示）、1（表示）

show_subscription_label​

  • タイプ：ブール値
  • 説明：左上最後のバージョンラベルを表示するかどうか。
  • 参考値：0（非表示）、1（表示）

DEFAULT_MODEL_GROUP​

  • タイプ：文字列
  • 説明：デフォルトモデルグループ。いくつかの内蔵アシスタントのバインド用。
  • 参考値：15e36556-xxxx-xxxx-xxxx-xxxxxxxxxxxx

default_robot_ids​

  • タイプ：JSON文字列
  • 説明：システム機能で使用するアシスタントID設定。
  • 参考値：{"file_robot":"95db8ee2-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}

EMAIL_CONFIG​

  • タイプ：JSON文字列
  • 説明：システムメール送信設定（SMTP設定）。

FEEDBACK_EMAIL_TEMPLATE​

  • タイプ：文字列
  • 説明：フィードバック（低評価）メールテンプレート設定。

file_type​

  • タイプ：JSON文字列配列
  • 説明：アシスタントでアップロード可能な単一ファイルタイプ。

mindmap_prompt​

  • タイプ：JSON文字列
  • 説明：マインドマップAI要約プロンプト。複数の生成戦略ごとにプロンプトを設定。未設定の場合はシステム内蔵を使用。

summary_prompt​

  • タイプ：JSON文字列
  • 説明：要約プロンプト（未設定の場合はシステム内蔵を使用）。mindmap_prompt と同様の構造。

need_ai_check_function​

  • タイプ：ブール値
  • 説明：コードノードの安全性チェックが必要かどうか。
  • 参考値：0（オフ）、1（オン）

rag_config​

  • タイプ：JSON文字列
  • 説明：RAG検索設定項目。

SKILL_DB_REF_MAX​

  • タイプ：数値
  • 説明：データベーススキル連携テーブルの上限。
  • デフォルト値：10

WS_PRIVATE_KEY / WS_PUBLIC_KEY​

  • タイプ：文字列
  • 説明：Websocketユーザートークン暗号化の公開鍵/秘密鍵ペア（バックエンド自動生成、通常は手動管理不要）。
  • タイプ：JSON文字列
  • 説明：ホーム画面下部メニューの設定。
  • 参考値：
[
  {
    "id": 1,
    "name": "Link Name",
    "url": "https://www.example.com",
    "open_type": "true",
    "icon": "http://your-domain.com/static/icon.svg"
  }
]

USER_AGREEMENT​

  • タイプ：文字列
  • 説明：ユーザー利用規約の設定画面（多言語対応）。

KIND_REMINDER​

  • タイプ：JSON文字列
  • 説明：ご案内（多言語対応）。
  • 参考値：
{
  "ENABLE": false,
  "LOCALE": [
    { "KEY": "ja-JP", "VALUE": "日本語のご案内" },
    { "KEY": "zh-TW", "VALUE": "繁体字ご案内" },
    { "KEY": "zh-CN", "VALUE": "簡体字ご案内" },
    { "KEY": "en-US", "VALUE": "English Reminder" }
  ]
}

ENABLE はご案内の表示有無を制御し、LOCALE の値は国際化管理で同じ値を作成して多言語対応に利用できます。

SHOW_AI_FILE_TRANSLATOR​

  • タイプ：文字列 'true' | 'false'
  • 説明：AI翻訳機能を表示するかどうか。
  • デフォルト値：'true'
  • 参考値：'true' 表示、'false' または未設定の場合は非表示

CHAT_BUBBLE_WATERMARK​

  • タイプ：文字列
  • 説明：返信内容バブル内のウォーターマーク説明。
  • 参考値：chat.bubble.watermark（多言語キー）

ENABLE_WATERMARK​

  • タイプ：ブール値
  • 説明：PDFファイルプレビューのウォーターマーク表示制御。
  • デフォルト値：false

ENABLE_DANGER_HTML_ATTRIBUTES​

  • タイプ：ブール値 true | false
  • 説明：Markdownで style、classname 属性をレンダリング可能にするかどうか。
  • デフォルト値：false
  • 警告：この設定は危険です（XSSリスクあり）。ユーザーの確認なしに有効化しないでください。

PDF_LOADER_LIB​

  • タイプ：文字列
  • 説明：ファイル前処理のPDF基本モード解析用Pythonパッケージを制御します。
    • pypdf: デフォルトのPDF解析パッケージ。pdfplumber より解析精度が高いです。
    • pdfplumber: PDF内のハイパーリンク解析が必要な場合はこちらを指定してください。
  • デフォルト値：pypdf
  • 警告：この設定は機密性が高いため、ユーザーの確認なしに有効化しないでください。
  • タイプ：ブール値 true | false
  • 説明：ファイル前処理のExcel基本モードでハイパーリンク解析を付与するかどうか。
  • デフォルト値：false
  • 警告：この設定は機密性が高いため、ユーザーの確認なしに有効化しないでください。