Wikijs

Description / name	Input element
Your domain name

Overview

Wikijs is a modern, lightweight and powerful wiki app built on NodeJS.

Manual

Releases

Community

---

Deployment

sb install sandbox-wikijs

Usage

Visit https://wikijs.iYOUR_DOMAIN_NAMEi.

Basics

Info

📢 No default user is configured until you run through the setup screen, so you should ideally run through setup as soon as the container is deployed to secure the site. It is not behind authelia by default.

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   wikijs_name: "custom_value"
   

   Avoid overriding variables ending in _default

   When overriding variables that end in _default (like wikijs_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

   Instead, use the corresponding _custom variable (like wikijs_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsWebDNSTraefikDockerDocker+Global Override Options

wikijs_name

# Type: string
wikijs_name: wikijs

wikijs_role_postgres_deploy

# Type: bool (true/false)
wikijs_role_postgres_deploy: true

wikijs_role_postgres_name

# Type: string
wikijs_role_postgres_name: "{{ wikijs_name }}-postgres"

wikijs_role_postgres_user

# Type: string
wikijs_role_postgres_user: "{{ postgres_role_docker_env_user }}"

wikijs_role_postgres_password

# Type: string
wikijs_role_postgres_password: "{{ postgres_role_docker_env_password }}"

wikijs_role_postgres_docker_env_db

# Type: string
wikijs_role_postgres_docker_env_db: "{{ wikijs_name }}"

wikijs_role_postgres_docker_image_tag

# Type: string
wikijs_role_postgres_docker_image_tag: "15-alpine"

wikijs_role_postgres_docker_image_repo

# Type: string
wikijs_role_postgres_docker_image_repo: "postgres"

wikijs_role_postgres_docker_healthcheck

# Type: dict
wikijs_role_postgres_docker_healthcheck:
  test: ["CMD-SHELL", "pg_isready -d {{ lookup('role_var', '_postgres_docker_env_db', role='wikijs') }} -U {{ postgres_role_docker_env_user }}"]
  start_period: 20s
  interval: 30s
  retries: 5
  timeout: 5s

wikijs_role_postgres_paths_folder

# Type: string
wikijs_role_postgres_paths_folder: "{{ wikijs_name }}"

wikijs_role_postgres_paths_location

# Type: string
wikijs_role_postgres_paths_location: "{{ server_appdata_path }}/{{ wikijs_role_postgres_paths_folder }}/postgres"

wikijs_role_web_subdomain

# Type: string
wikijs_role_web_subdomain: "{{ wikijs_name }}"

wikijs_role_web_domain

# Type: string
wikijs_role_web_domain: "{{ user.domain }}"

wikijs_role_web_port

# Type: string
wikijs_role_web_port: "3000"

wikijs_role_web_url

# Type: string
wikijs_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='wikijs') + '.' + lookup('role_var', '_web_domain', role='wikijs')
                      if (lookup('role_var', '_web_subdomain', role='wikijs') | length > 0)
                      else lookup('role_var', '_web_domain', role='wikijs')) }}"

wikijs_role_dns_record

# Type: string
wikijs_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='wikijs') }}"

wikijs_role_dns_zone

# Type: string
wikijs_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='wikijs') }}"

wikijs_role_dns_proxy

# Type: bool (true/false)
wikijs_role_dns_proxy: "{{ dns_proxied }}"

wikijs_role_traefik_sso_middleware

# Type: string
wikijs_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

wikijs_role_traefik_middleware_default

# Type: string
wikijs_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

wikijs_role_traefik_middleware_custom

# Type: string
wikijs_role_traefik_middleware_custom: ""

wikijs_role_traefik_certresolver

# Type: string
wikijs_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

wikijs_role_traefik_enabled

# Type: bool (true/false)
wikijs_role_traefik_enabled: true

wikijs_role_traefik_api_enabled

# Type: bool (true/false)
wikijs_role_traefik_api_enabled: true

wikijs_role_traefik_api_endpoint

# Type: string
wikijs_role_traefik_api_endpoint: "PathPrefix(`/graphql`)"

Container

wikijs_role_docker_container

# Type: string
wikijs_role_docker_container: "{{ wikijs_name }}"

Image

wikijs_role_docker_image_pull

# Type: bool (true/false)
wikijs_role_docker_image_pull: true

wikijs_role_docker_image_repo

# Type: string
wikijs_role_docker_image_repo: "ghcr.io/requarks/wiki"

wikijs_role_docker_image_tag

# Type: string
wikijs_role_docker_image_tag: "2"

wikijs_role_docker_image

# Type: string
wikijs_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='wikijs') }}:{{ lookup('role_var', '_docker_image_tag', role='wikijs') }}"

Envs

wikijs_role_docker_envs_default

# Type: dict
wikijs_role_docker_envs_default:
  TZ: "{{ tz }}"
  DB_TYPE: "postgres"
  DB_HOST: "{{ lookup('role_var', '_postgres_name', role='wikijs') }}"
  DB_PORT: "5432"
  DB_USER: "{{ lookup('role_var', '_postgres_user', role='wikijs') }}"
  DB_PASS: "{{ lookup('role_var', '_postgres_password', role='wikijs') }}"
  DB_NAME: "{{ lookup('role_var', '_postgres_docker_env_db', role='wikijs') }}"

wikijs_role_docker_envs_custom

# Type: dict
wikijs_role_docker_envs_custom: {}

Hostname

wikijs_role_docker_hostname

# Type: string
wikijs_role_docker_hostname: "{{ wikijs_name }}"

Networks

wikijs_role_docker_networks_alias

# Type: string
wikijs_role_docker_networks_alias: "{{ wikijs_name }}"

wikijs_role_docker_networks_default

# Type: list
wikijs_role_docker_networks_default: []

wikijs_role_docker_networks_custom

# Type: list
wikijs_role_docker_networks_custom: []

Restart Policy

wikijs_role_docker_restart_policy

# Type: string
wikijs_role_docker_restart_policy: unless-stopped

State

wikijs_role_docker_state

# Type: string
wikijs_role_docker_state: started

Dependencies

wikijs_role_depends_on

# Type: string
wikijs_role_depends_on: "{{ lookup('role_var', '_postgres_name', role='wikijs') }}"

wikijs_role_depends_on_delay

# Type: string (quoted number)
wikijs_role_depends_on_delay: "0"

wikijs_role_depends_on_healthchecks

# Type: string ("true"/"false")
wikijs_role_depends_on_healthchecks: "false"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

wikijs_role_docker_blkio_weight

# Type: int
wikijs_role_docker_blkio_weight:

wikijs_role_docker_cpu_period

# Type: int
wikijs_role_docker_cpu_period:

wikijs_role_docker_cpu_quota

# Type: int
wikijs_role_docker_cpu_quota:

wikijs_role_docker_cpu_shares

# Type: int
wikijs_role_docker_cpu_shares:

wikijs_role_docker_cpus

# Type: string
wikijs_role_docker_cpus:

wikijs_role_docker_cpuset_cpus

# Type: string
wikijs_role_docker_cpuset_cpus:

wikijs_role_docker_cpuset_mems

# Type: string
wikijs_role_docker_cpuset_mems:

wikijs_role_docker_kernel_memory

# Type: string
wikijs_role_docker_kernel_memory:

wikijs_role_docker_memory

# Type: string
wikijs_role_docker_memory:

wikijs_role_docker_memory_reservation

# Type: string
wikijs_role_docker_memory_reservation:

wikijs_role_docker_memory_swap

# Type: string
wikijs_role_docker_memory_swap:

wikijs_role_docker_memory_swappiness

# Type: int
wikijs_role_docker_memory_swappiness:

wikijs_role_docker_shm_size

# Type: string
wikijs_role_docker_shm_size:

Security & Devices

wikijs_role_docker_cap_drop

# Type: list
wikijs_role_docker_cap_drop:

wikijs_role_docker_cgroupns_mode

# Type: string
wikijs_role_docker_cgroupns_mode:

wikijs_role_docker_device_cgroup_rules

# Type: list
wikijs_role_docker_device_cgroup_rules:

wikijs_role_docker_device_read_bps

# Type: list
wikijs_role_docker_device_read_bps:

wikijs_role_docker_device_read_iops

# Type: list
wikijs_role_docker_device_read_iops:

wikijs_role_docker_device_requests

# Type: list
wikijs_role_docker_device_requests:

wikijs_role_docker_device_write_bps

# Type: list
wikijs_role_docker_device_write_bps:

wikijs_role_docker_device_write_iops

# Type: list
wikijs_role_docker_device_write_iops:

wikijs_role_docker_devices

# Type: list
wikijs_role_docker_devices:

wikijs_role_docker_devices_default

# Type: string
wikijs_role_docker_devices_default:

wikijs_role_docker_groups

# Type: list
wikijs_role_docker_groups:

wikijs_role_docker_privileged

# Type: bool (true/false)
wikijs_role_docker_privileged:

wikijs_role_docker_security_opts

# Type: list
wikijs_role_docker_security_opts:

wikijs_role_docker_user

# Type: string
wikijs_role_docker_user:

wikijs_role_docker_userns_mode

# Type: string
wikijs_role_docker_userns_mode:

Networking

wikijs_role_docker_dns_opts

# Type: list
wikijs_role_docker_dns_opts:

wikijs_role_docker_dns_search_domains

# Type: list
wikijs_role_docker_dns_search_domains:

wikijs_role_docker_dns_servers

# Type: list
wikijs_role_docker_dns_servers:

wikijs_role_docker_domainname

# Type: string
wikijs_role_docker_domainname:

wikijs_role_docker_exposed_ports

# Type: list
wikijs_role_docker_exposed_ports:

wikijs_role_docker_hosts

# Type: dict
wikijs_role_docker_hosts:

wikijs_role_docker_hosts_use_common

# Type: bool (true/false)
wikijs_role_docker_hosts_use_common:

wikijs_role_docker_ipc_mode

# Type: string
wikijs_role_docker_ipc_mode:

wikijs_role_docker_links

# Type: list
wikijs_role_docker_links:

wikijs_role_docker_network_mode

# Type: string
wikijs_role_docker_network_mode:

wikijs_role_docker_pid_mode

# Type: string
wikijs_role_docker_pid_mode:

wikijs_role_docker_ports

# Type: list
wikijs_role_docker_ports:

wikijs_role_docker_uts

# Type: string
wikijs_role_docker_uts:

Storage

wikijs_role_docker_keep_volumes

# Type: bool (true/false)
wikijs_role_docker_keep_volumes:

wikijs_role_docker_mounts

# Type: list
wikijs_role_docker_mounts:

wikijs_role_docker_storage_opts

# Type: dict
wikijs_role_docker_storage_opts:

wikijs_role_docker_tmpfs

# Type: list
wikijs_role_docker_tmpfs:

wikijs_role_docker_volume_driver

# Type: string
wikijs_role_docker_volume_driver:

wikijs_role_docker_volumes

# Type: list
wikijs_role_docker_volumes:

wikijs_role_docker_volumes_from

# Type: list
wikijs_role_docker_volumes_from:

wikijs_role_docker_volumes_global

# Type: bool (true/false)
wikijs_role_docker_volumes_global:

wikijs_role_docker_working_dir

# Type: string
wikijs_role_docker_working_dir:

Monitoring & Lifecycle

wikijs_role_docker_auto_remove

# Type: bool (true/false)
wikijs_role_docker_auto_remove:

wikijs_role_docker_cleanup

# Type: bool (true/false)
wikijs_role_docker_cleanup:

wikijs_role_docker_force_kill

# Type: string
wikijs_role_docker_force_kill:

wikijs_role_docker_healthcheck

# Type: dict
wikijs_role_docker_healthcheck:

wikijs_role_docker_healthy_wait_timeout

# Type: int
wikijs_role_docker_healthy_wait_timeout:

wikijs_role_docker_init

# Type: bool (true/false)
wikijs_role_docker_init:

wikijs_role_docker_kill_signal

# Type: string
wikijs_role_docker_kill_signal:

wikijs_role_docker_log_driver

# Type: string
wikijs_role_docker_log_driver:

wikijs_role_docker_log_options

# Type: dict
wikijs_role_docker_log_options:

wikijs_role_docker_oom_killer

# Type: bool (true/false)
wikijs_role_docker_oom_killer:

wikijs_role_docker_oom_score_adj

# Type: int
wikijs_role_docker_oom_score_adj:

wikijs_role_docker_output_logs

# Type: bool (true/false)
wikijs_role_docker_output_logs:

wikijs_role_docker_paused

# Type: bool (true/false)
wikijs_role_docker_paused:

wikijs_role_docker_recreate

# Type: bool (true/false)
wikijs_role_docker_recreate:

wikijs_role_docker_restart_retries

# Type: int
wikijs_role_docker_restart_retries:

wikijs_role_docker_stop_timeout

# Type: int
wikijs_role_docker_stop_timeout:

Other Options

wikijs_role_docker_capabilities

# Type: list
wikijs_role_docker_capabilities:

wikijs_role_docker_cgroup_parent

# Type: string
wikijs_role_docker_cgroup_parent:

wikijs_role_docker_commands

# Type: list
wikijs_role_docker_commands:

wikijs_role_docker_create_timeout

# Type: int
wikijs_role_docker_create_timeout:

wikijs_role_docker_entrypoint

# Type: string
wikijs_role_docker_entrypoint:

wikijs_role_docker_env_file

# Type: string
wikijs_role_docker_env_file:

wikijs_role_docker_labels

# Type: dict
wikijs_role_docker_labels:

wikijs_role_docker_labels_use_common

# Type: bool (true/false)
wikijs_role_docker_labels_use_common:

wikijs_role_docker_read_only

# Type: bool (true/false)
wikijs_role_docker_read_only:

wikijs_role_docker_runtime

# Type: string
wikijs_role_docker_runtime:

wikijs_role_docker_sysctls

# Type: list
wikijs_role_docker_sysctls:

wikijs_role_docker_ulimits

# Type: list
wikijs_role_docker_ulimits:

wikijs_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
wikijs_role_autoheal_enabled: true

wikijs_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
wikijs_role_depends_on: ""

wikijs_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
wikijs_role_depends_on_delay: "0"

wikijs_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
wikijs_role_depends_on_healthchecks:

wikijs_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
wikijs_role_diun_enabled: true

wikijs_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
wikijs_role_dns_enabled: true

wikijs_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
wikijs_role_docker_controller: true

wikijs_role_docker_image_repo

# Type: string
wikijs_role_docker_image_repo:

wikijs_role_docker_image_tag

# Type: string
wikijs_role_docker_image_tag:

wikijs_role_docker_volumes_download

# Type: bool (true/false)
wikijs_role_docker_volumes_download:

wikijs_role_postgres_docker_env_db

# Type: string
wikijs_role_postgres_docker_env_db:

wikijs_role_postgres_name

# Type: string
wikijs_role_postgres_name:

wikijs_role_postgres_password

# Type: string
wikijs_role_postgres_password:

wikijs_role_postgres_user

# Type: string
wikijs_role_postgres_user:

wikijs_role_themepark_addons

# Type: string
wikijs_role_themepark_addons:

wikijs_role_themepark_app

# Type: string
wikijs_role_themepark_app:

wikijs_role_themepark_theme

# Type: string
wikijs_role_themepark_theme:

wikijs_role_traefik_api_endpoint

# Type: dict/omit
wikijs_role_traefik_api_endpoint:

wikijs_role_traefik_api_middleware

# Type: string
wikijs_role_traefik_api_middleware:

wikijs_role_traefik_api_middleware_http

# Type: string
wikijs_role_traefik_api_middleware_http:

wikijs_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
wikijs_role_traefik_autodetect_enabled: false

wikijs_role_traefik_certresolver

# Type: string
wikijs_role_traefik_certresolver:

wikijs_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
wikijs_role_traefik_crowdsec_enabled: false

wikijs_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
wikijs_role_traefik_error_pages_enabled: false

wikijs_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
wikijs_role_traefik_gzip_enabled: false

wikijs_role_traefik_middleware_http

# Type: string
wikijs_role_traefik_middleware_http:

wikijs_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
wikijs_role_traefik_middleware_http_api_insecure:

wikijs_role_traefik_middleware_http_insecure

# Type: bool (true/false)
wikijs_role_traefik_middleware_http_insecure:

wikijs_role_traefik_priority

# Type: string
wikijs_role_traefik_priority:

wikijs_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
wikijs_role_traefik_robot_enabled: true

wikijs_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
wikijs_role_traefik_tailscale_enabled: false

wikijs_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
wikijs_role_traefik_wildcard_enabled: true

wikijs_role_web_domain

# Type: string
wikijs_role_web_domain:

wikijs_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
wikijs_role_web_fqdn_override:

Example Override

wikijs_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "wikijs2.{{ user.domain }}"
  - "wikijs.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

wikijs_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
wikijs_role_web_host_override:

Example Override

wikijs_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'wikijs2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

wikijs_role_web_http_port

# Type: string (quoted number)
wikijs_role_web_http_port:

wikijs_role_web_http_scheme

# Type: string ("http"/"https")
wikijs_role_web_http_scheme:

wikijs_role_web_http_serverstransport

# Type: dict/omit
wikijs_role_web_http_serverstransport:

wikijs_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
wikijs_role_web_scheme:

wikijs_role_web_serverstransport

# Type: dict/omit
wikijs_role_web_serverstransport:

wikijs_role_web_subdomain

# Type: string
wikijs_role_web_subdomain: