readme-vars.yml

---

# project information
project_name: znc
project_url: "http://wiki.znc.in/ZNC"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/znc-logo.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is an IRC network bouncer or BNC. It can detach the client from the actual IRC server, and also from selected channels. Multiple clients from different locations can connect to a single ZNC account simultaneously and therefore appear under the same nickname on IRC."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_blurb_optional_extras_enabled: false
# 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"}
param_usage_include_ports: true
param_ports:
  - {external_port: "6501", internal_port: "6501", port_desc: "Port ZNC listens on."}
readonly_supported: true
readonly_message: |
  * Not supported when running with SSL (Further debuging into why is appreciated)
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  To log in to the application, browse to `http://<hostip>:6501`.

  * Default User: admin
  * Default Password: admin
  `change password ASAP.`
# init diagram
init_diagram: |
  "znc: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-znc-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-znc-config
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-znc
    svc-znc -> legacy-services
  }
  Base Images: {
    "baseimage-alpine:3.20"
  }
  "znc:latest" <- Base Images
# changelog
changelogs:
  - {date: "10.06.24:", desc: "Migrate default config file to newer format."}
  - {date: "06.06.24:", desc: "Rebase to Alpine 3.20."}
  - {date: "26.03.24:", desc: "Switch back to multi-threaded builds and ignore `-beta` and `-alpha` tags as well as `-rc`."}
  - {date: "22.02.24:", desc: "Update build system for v1.9.0 (use cmake)."}
  - {date: "23.12.23:", desc: "Rebase to Alpine 3.19."}
  - {date: "12.07.23:", desc: "Rebasing 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: "13.02.23:", desc: "Rebase to Alpine 3.17, migrate to s6v3."}
  - {date: "19.01.22:", desc: "Rebasing to alpine 3.15."}
  - {date: "01.06.20:", desc: "Rebasing to alpine 3.12."}
  - {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
  - {date: "02.11.19:", desc: "Add znc-palaver module."}
  - {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
  - {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
  - {date: "22.02.19:", desc: "Rebasing to alpine 3.9."}
  - {date: "31.01.19:", desc: "Add pipeline logic and multi arch."}
  - {date: "30.01.19:", desc: "Add push and clientbuffer modules."}
  - {date: "17.08.18:", desc: "Rebase to alpine 3.8, use buildstage."}
  - {date: "03.01.18:", desc: "Deprecate cpu_core routine lack of scaling."}
  - {date: "07.12.17:", desc: "Rebase alpine linux 3.7."}
  - {date: "25.10.17:", desc: "Remove debug switch from run command."}
  - {date: "26.05.17:", desc: "Rebase alpine linux 3.6."}
  - {date: "06.02.17:", desc: "Rebase alpine linux 3.5."}
  - {date: "19.01.17:", desc: "Add playback module."}
  - {date: "07.01.17:", desc: "Add ca-certificates package, resolve sasl issues."}
  - {date: "07.12.16:", desc: "Use scanelf to determine runtime dependencies. Fix error with continuation."}
  - {date: "14.10.16:", desc: "Add version layer information."}
  - {date: "30.09.16:", desc: "Fix umask."}
  - {date: "11.09.16:", desc: "Add layer badges to README."}
  - {date: "28.08.16:", desc: "Add badges to README."}
  - {date: "20.08.16:", desc: "Rebase to alpine linux, move to main repository."}
  - {date: "11.12.15:", desc: "Initial Release."}