WIKIPLUSの設定

ここでは、WIKIPLUSが動作するための必須項目のみをご案内しています。その他の詳細設定については、カスタマイズマニュアルをご覧ください。

設定ファイルの書式について

WIKIPLUSの設定ファイルはYAML形式で記述します。YAMLはインデントにも意味があるフォーマットのため、編集時には書式に十分ご注意ください。

YAMLの詳細はオフィシャルサイトをご覧ください。

その他YAML記述の参考になるサイト例:

設定ファイルのパス

WIKIPLUSの設定ファイルは以下のパスに保存します。

/opt/JPC/wikiplus/conf

また、WIKIPLUSの動作に必要な設定ファイルは以下があります。

ファイル名内容
server-config.ymlWIKIPLUSのサーバが動作するために必要なパラメータを設定するためのファイルです。このファイルは、/opt/JPC/wikiplus/libexec/にある、os.ymlとserver-config.ymlを上書きします。編集は必須です。
影響範囲: サーバ全体
service-config.ymlWIKIPLUSの表記に関する設定や、サービスの設定をするためのファイルです。このファイルは、/opt/JPC/wikiplus/libexec/service-config.ymlを上書きします。編集は必須です。
影響範囲: インスタンス（VirtualHost）全体
default-config.ymlインスタンス（VirtualHost）動作のための初期値を設定するためのファイルです。このファイルは、インスタンスのデプロイごとに/var/www/[FQDN]/config/user-config.ymlとして複製されます。
default-config.ymlを変更しても、すでに作成されたuser-config.ymlは影響を受けません。また、user-config.ymlは、インスタンスごとの設定やプログラムにより変更されていくため、default-config.ymlの内容とは異なる場合があります。設置は必須ですが、編集は必須ではありません。
このファイルは、/opt/JPC/wikiplus/libexec/default-config.ymlを上書きします。
limit-config.ymlインスタンス（VirtualHost）の動作制限の初期値を設定するためのファイルです。このファイルは、インスタンスのデプロイごとに/var/www/[FQDN].ymlとして複製されます。
limit-config.ymlを変更しても、すでに作成された[FQDN].ymlは影響を受けません。インスタンス独自の制限を設定したい場合は、[FQDN].ymlを直接編集してください。設置は必須ですが、編集は必須ではありません。
このファイルは、/opt/JPC/wikiplus/libexec/limit-config.ymlを上書きします。

設定ファイルを準備する

設定ファイルはサンプルとして拡張子「dist」で保存されています。これを拡張子「yml」としてコピーし、編集します。

# cd /opt/JPC/wikiplus/conf
# cp default-config.yml.dist default-config.yml
# cp limit-config.yml.dist limit-config.yml
# cp server-config.yml.dist server-config.yml
# cp service-config.yml.dist service-config.yml

server-config.ymlの編集

  • すべての「!!!!」エントリを変更します。
  • サーバー固有の値は、環境に合わせ記述してください。
大項目中項目小項目説明
SERVEROPENHTTPIPADDR公開用URLが待ち受けるIPアドレスを入力します。
例）IPADDR: 192.0.2.1
SUFFIX公開用URL「http://[システムID].[ドメイン名]/」でアクセスするときのドメイン名を入力します。
例）SUFFIX: wp.example.jp
OPENHTTPSIPADDR公開用SSL URLが待ち受けるIPアドレスを入力します。
例）IPADDR: 192.0.2.1
SUFFIX公開用SSL URL「http://[システムID].[ドメイン名]/」でアクセスするときのドメイン名を入力します。
例）SUFFIX: wp.example.jp
CLOSEHTTPSIPADDR編集用SSL URLが待ち受けるIPアドレスを入力します。
例）IPADDR: 192.0.2.1
PORT編集用SSL URLが待ち受けるポート番号を入力します。省略した場合は、443番になります。
例）PORT: 443
SUFFIX編集用SSL URL「http://[編集用ドメイン]/[システムID]/」でアクセスするときの編集用ドメイン名を入力します。
例）SUFFIX: edit.wp.example.jp
DBMSPostgreSQLのホスト名、またはIPアドレスを入力します。
例）127.0.0.1
DBMSPORTPostgreSQLが待ち受けるポート番号を入力します。
例）5432
DBNAMEWIKIPLUSのデータベース名を入力します。
例）wikiplus
DBUSERWIKIPLUSのデータベースにアクセスできるユーザー名を入力します。
例）wikiplus
DBPASSWDDBUSERで入力したユーザーのパスワードを入力します。
例）wikiplus

server-config.ymlの設定例

SERVER:
 OPENHTTP:
  IPADDR: 192.0.2.1
  SUFFIX: wp.example.jp
 OPENHTTPS:
  IPADDR: 192.0.2.1
  SUFFIX: wp.example.jp
 CLOSEHTTPS:
  IPADDR: 192.0.2.1
  PORT: 443
  SUFFIX: edit.wp.example.jp
 DBMS: 127.0.0.1
 DBMSPORT: 5432
 DBNAME: wikiplus
 DBUSER: wikiplus
 DBPASSWD: wikiplus

service-config.ymlの編集

  • すべての「!!!!」エントリを変更します。
  • サービスの動作モードや、表記に関する設定を行います。
SERVICEBLANDSERVICE_ADMIN_MAILADDRESSサービス管理者のメールアドレスを入力します。
例）admin@example.jp
RESERVEDUSERNAMEシステムIDとして、エンドユーザーが指定できない文字列を配列で指定します。編集用ホスト名・WHM用ホスト名を入力しておく必要があります。
例）www、root、admin、edit、whmなど
FQDNエンドユーザーがサイトプロパティのFQDNに指定できない文字列を配列で指定します。
例）www.example.jp、www.example.co.jpなど

service-config.ymlの設定例

SERVICE:
 BRAND:
  SERVICE_ADMIN_MAILADDRESS: admin@example.jp
 MESSAGE:
  SITEPROP:
 MAIL:
RESERVED:
 USERNAME:
  - www
  - root
  - admin
  - edit
  - whm
 FQDN:
  - www.example.jp
  - www.example.co.jp

引き続き「ミドルウェアの設定」にお進みください。