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 という名前のフィールドを渡す
  • 方法2localstorage$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 は WeCom 環境でのみ有効になります。
  • デフォルト値[]

THEME_LIST

  • :JSON 文字列
  • 説明:ユーザーが選択可能なテーマを設定するために使用します。nameI18nKey はテーマ表示テキストに対応する国際化 key(「国際化コンテンツ管理」ページで管理が必要)、code は最初の手順でアップロードしたテーマ code と 1 対 1 で対応する必要があり、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 を分けて設定でき、WeCom 内のアイコンと名称も設定可能です。
  • 参考値
{
"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 app ボタンを設定するために使用します。
    • URL: 遷移先のリンクを指定します。
    • NAME: 表示するタイトルを表します(国際化 key をサポート)。
    • 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: 埋め込むページのリンク。
  • pathkey: 同一かつ一意であれば問題ありません。
  • label: メニュー名。key として国際化に関連付けることもできます。
  • code: 権限コード。バックエンド側でデータベースの機能権限テーブルに対応する code の権限項目を設定する必要があります。

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 ユーザー Token 暗号化用の公開鍵・秘密鍵ペア(バックエンドが自動生成して使用するため、通常は手動管理不要)。
  • :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 (多言語 Key)

ENABLE_WATERMARK

  • :ブール値
  • 説明:PDF ファイルプレビューの透かし表示を制御します。
  • デフォルト値false

ENABLE_DANGER_HTML_ATTRIBUTES

  • :ブール値 true | false
  • 説明:Markdown が styleclassname 属性をレンダリングできるかどうかを制御します。
  • デフォルト値false
  • 警告この設定は比較的危険です(XSS リスクあり)。ユーザーに有効化確認を取っていない場合は、有効化を推奨しません。

PDF_LOADER_LIB

  • :文字列
  • 説明:ファイル前処理における PDF 基本モード解析用の Python パッケージを制御します。
    • pypdf: デフォルトの PDF 解析パッケージで、解析効果は pdfplumber より良好です。
    • pdfplumber: PDF 内のハイパーリンクを解析する必要がある場合は、このパッケージに変更してください。
  • デフォルト値pypdf
  • 警告この設定は比較的センシティブです。ユーザーに有効化確認を取っていない場合は、有効化を推奨しません。
  • :ブール値 true | false
  • 説明:ファイル前処理における Excel 基本モードで、ハイパーリンク解析を含める必要があるかどうかを制御します。
  • デフォルト値false
  • 警告この設定は比較的センシティブです。ユーザーに有効化確認を取っていない場合は、有効化を推奨しません。