readme-vars.yml

---

# project information
project_name: wikijs
project_url: "https://github.com/Requarks/wiki"
project_logo: "https://static.requarks.io/logo/wikijs-full.svg"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) A modern, lightweight and powerful wiki app built on NodeJS."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
# supported architectures
available_architectures:
  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files"}
  - {vol_path: "/data", vol_host_path: "/path/to/data", desc: "Where Wiki.js data is stored."}
param_usage_include_ports: true
param_ports:
  - {external_port: "3000", internal_port: "3000", port_desc: "Port for Wiki.js's web interface."}
# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
  - {env_var: "DB_TYPE", env_value: "sqlite", desc: "Set to sqlite (default) or postgres depending on the database engine you wish to use"}
  - {env_var: "DB_HOST", env_value: "", desc: "DB hostname (postgres only)"}
  - {env_var: "DB_PORT", env_value: "", desc: "DB port (postgres only)"}
  - {env_var: "DB_NAME", env_value: "", desc: "DB name (postgres only)"}
  - {env_var: "DB_USER", env_value: "", desc: "DB username (postgres only)"}
  - {env_var: "DB_PASS", env_value: "", desc: "DB password (postgres only)"}
readonly_supported: true
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Please note that the database configuration environment variables will apply _on first run only_, after which you will need to directly edit /config/config.yml to change your settings.

  For more information please see the [official documentation](https://docs.requarks.io/).
# init diagram
init_diagram: |
  "wikijs:latest": {
    docker-mods
    base {
      fix-attr +\nlegacy cont-init
    }
    docker-mods -> base
    legacy-services
    custom services
    init-services -> legacy-services
    init-services -> custom services
    custom services -> legacy-services
    legacy-services -> ci-service-check
    init-migrations -> init-adduser
    init-os-end -> init-config
    init-config -> init-config-end
    init-wikijs-config -> init-config-end
    init-os-end -> init-crontab-config
    init-mods-end -> init-custom-files
    base -> init-envfile
    base -> init-migrations
    base -> init-mods
    init-config-end -> init-mods
    init-mods -> init-mods-end
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    base -> init-os-end
    init-adduser -> init-os-end
    init-envfile -> init-os-end
    init-migrations -> init-os-end
    init-custom-files -> init-services
    init-mods-end -> init-services
    init-config -> init-wikijs-config
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-wikijs
    svc-wikijs -> legacy-services
  }
  Base Images: {
    "baseimage-alpine:3.20"
  }
  "wikijs:latest" <- Base Images
# changelog
changelogs:
  - {date: "01.06.24:", desc: "Rebase to Alpine 3.20."}
  - {date: "23.12.23:", desc: "Rebase to Alpine 3.19."}
  - {date: "25.08.22:", desc: "Rebase to Alpine 3.18."}
  - {date: "07.07.23:", desc: "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"}
  - {date: "21.03.23:", desc: "Restore git and openssh packages for git storage support."}
  - {date: "21.03.23:", desc: "Create dummy /etc/os-release to fix System Info page."}
  - {date: "10.10.22:", desc: "Rebasing to alpine 3.16, migrate to s6v3."}
  - {date: "23.01.21:", desc: "Rebasing to alpine 3.13."}
  - {date: "01.06.20:", desc: "Rebasing to alpine 3.12."}
  - {date: "28.04.20:", desc: "Added python dependency for some NPM modules as well as git for storage module"}
  - {date: "14.12.19:", desc: "Initial Release."}