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 版本、下载链接和服务器上的目的地。

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

数据库信息。推荐使用 PostgreSQL。

# 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