オリジナルのドキュメント
最終同期リビジョン: 1b5aaf34a
ドキュメントはAGPLv3でライセンスされています。
先に、システム要件を確認してください。
¶ Docker イメージを使う
Wiki.js は Docker イメージ requarks/wiki として Docker Hubに公開されています。
ベータの間、
requarks/wiki:betaのようにbetaタグを指定する必要があります!
¶ 環境変数
以下の環境変数をセットしてください。指定のない限りこれらはすべて必須です。
PostgreSQL, MySQL, MariaDB, MSSQL の場合のみ:
- DB_TYPE : データベースの種類 (
mysql,postgres,mariadb,mssqlorsqlite) - DB_HOST : データベースのホスト名やIP
- DB_PORT : データベースノポート
- DB_USER : データベースに接続するユーザー名
- DB_PASS : データベースに接続するパスワード
- DB_NAME : データベース名
When connecting to a database server with SSL enforced:
- DB_SSL : Set to either
1ortrueto enable. (optional, off if omitted)
データベースのパスワードをかわりにローカルファイルシークレットをつかって提供する場合:
- DB_PASS_FILE: データベースパスワードを含むファイルへのパス (optional, replaces DB_PASS)
SQLite の場合のみ:
- DB_FILEPATH : SQLitファイルへのパス
¶ 例
Wiki.js を実行するコマンドの例です:
docker run -d -p 8080:3000 --name wiki --restart unless-stopped -e "DB_TYPE=mysql" -e "DB_HOST=db" -e "DB_PORT=3306" -e "DB_USER=wikijs" -e "DB_PASS=wikijsrocks" -e "DB_NAME=wiki" requarks/wiki:beta
¶ Alternative: 設定ファイルをマウントする
もし、環境変数を使用したくない場合、かわりに設定ファイルをマウントすることもできます。
サンプル設定ファイルをベースに新しいファイルを作成し、値をセットアップにあうように変更してください。以下のように設定ファイルをコンテナにマウントできます:
docker run -d -p 8080:3000 --name wiki --restart unless-stopped -v YOUR-FILE.yml:/wiki/config.yml requarks/wiki:beta
It's also possible to define an alternate location for the config file to be loaded from. This is useful in scenarios where you want to mount a configuration folder instead. Define the environment variable CONFIG_FILE with the path to the config file.
¶ Docker Compose を使用する
PostgreSQLとともにDocker Compose ファイルを使用する場合のサンプルはこちらです:
version: "3"
services:
db:
image: postgres:9-alpine
environment:
POSTGRES_DB: wiki
POSTGRES_PASSWORD: wikijsrocks
POSTGRES_USER: wikijs
logging:
driver: "none"
volumes:
- db-data:/var/lib/postgresql/data
wiki:
image: requarks/wiki:beta
depends_on:
- db
environment:
DB_TYPE: postgres
DB_HOST: db
DB_PORT: 5432
DB_USER: wikijs
DB_PASS: wikijsrocks
DB_NAME: wiki
ports:
- "3000:3000" # <-- 例えば、ポート80で待機したい場合はこれを "80:3000" に置換してください。
volumes:
db-data:
¶ ARM イメージ
ARM64やARMv7のようなバリアントを使用するには、イメージタグに requarks/wiki:beta-arm を指定します。
このイメージは以下と互換性があります:
- ARM64: Raspberry Pi 4, 3 and later Raspberry Pi 2 (v1.2)
- ARMv7: Early Raspberry Pi 2 (v1.1)
初代のRaspberry Piは サポートされませんl (ARMv6)。
¶ OpenShift
An example OpenShift-compatible Dockerfile is available here.