Ansible Wiki.js

Ansibleを使用してWiki.jsをインストールおよび設定します。

要件

Wiki.jsはnodejsとPostgreSQLなどのデータベースを必要とします。MariaDBやSQLiteも使用できますが、Wiki.jsは将来の更新のためにPostgreSQLを推奨しています。 supertarto.nodejsとsupertarto.postgresqlを使用できます。

テストしたプラットフォーム

• Debian 10 (Buster)
• Debian 11 (Bullseye)
• Debian 12 (Bookworm)

ロール変数

強制的にインストール/アップデートします。

wikijs_update: false

Wiki.jsのバージョン、ダウンロードURL、およびサーバー上の保存先。

wikijs_version: "2.5..300"
wikijs_download_url: "https://github.com/Requarks/wiki/releases/download/{{ wikijs_version }}/wiki-js.tar.gz"
wikijs_download_dest: /usr/local/wikijs

サービスを実行するために作成・使用するシステムユーザーとグループ。wikijs_user_additional_groupsは、システムユーザーの追加グループを指定するために使用できます。

wikijs_system_user: wikijs
wikijs_system_group: wikijs
wikijs_user_additional_groups: ""

Wiki.jsインスタンスへの接続に使用するポート。

wikijs_config_port: 3000

データベース情報。Postgresが推奨されています。

# postgres, mysql, mariadb, mssql, sqlite
wikijs_config_db_type: postgres
wikijs_config_db_host: localhost
wikijs_config_db_port: 5432
wikijs_config_db_user: wikijs
wikijs_config_db_pass: wikijsrocks
wikijs_config_db_db: wiki
wikijs_config_db_ssl: false

データベースへのSSL接続の設定。 autoがtrueの場合は無視されます。

wikijs_config_ssl_options:
  auto: true
  # 'auto'がfalseのときに必要なフィールドを使用します。
  # rejectUnauthorized: true
  # ca: path/to/ca.crt
  # cert: path/to/cert.crt
  # key: path/to/key.pem
  # pfx: path/to/cert.pfx
  # passphrase: xyz123

SQLiteを選択した場合のみ使用されます。

wikijs_config_sqlite_storage: path/to/database.sqlite

SSLを使用する必要がある場合のSSL証明書に関する情報。

wikijs_config_ssl_enabled: false
wikijs_config_ssl_port: 3443
# custom, letsencrypt
wikijs_config_ssl_provider: custom

# Customの場合のみ
# pem, pfx
wikijs_config_ssl_format: pem
# pemの場合のみ
wikijs_config_ssl_key: path/to/key.pem
wikijs_config_ssl_cert: path/to/cert.pem
wikijs_config_ssl_pfx: path/to/cert.pfx
wikijs_config_ssl_passphrase: null
wikijs_config_ssl_dhparam: null

# Letsencryptの場合のみ
wikijs_config_ssl_domain: wiki.yourdomain.com
wikijs_config_ssl_subscriberEmail: [email protected]

wikijs_config_bindIP: "0.0.0.0"
wikijs_config_logLevel: info
wikijs_config_offline: false
wikijs_config_ha: false
wikijs_config_dataPath: ./data

例

---
- hosts: all
  roles:
    - role: supertarto.nodejs
    - role: supertarto.postgresql
    - role: supertarto.wikijs

  vars:
    postgresql_databases:
      - name: wiki
    postgresql_users:
      - name: wikijs
        password: wikijsrocks

インストール

ansible-galaxy role install supertarto.wikijs

ライセンス

GPL V3.0