readme-vars.yml

---

# project information
project_name: ombi
project_url: "https://ombi.io"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ombi.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) allows you to host your own Plex Request and user management system.\nIf you are sharing your Plex server with other users, allow them to request new content using an easy to manage interface!\nManage all your requests for Movies and TV with ease, leave notes for the user and get notification when a user requests something.\nAllow your users to post issues against their requests so you know there is a problem with the audio etc.\nEven automatically send them weekly newsletters of new content that has been added to your Plex server!"
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"}
# development version
development_versions: true
development_versions_items:
  - {tag: "latest", desc: "Stable Ombi releases"}
  - {tag: "development", desc: "Releases from the `develop` branch of Ombi"}
# 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: "Contains all relevant configuration files."}
param_usage_include_ports: true
param_ports:
  - {external_port: "3579", internal_port: "3579", port_desc: "web gui"}
# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
  - {env_var: "BASE_URL", env_value: "/", desc: "Subfolder can optionally be defined as an env variable for reverse proxies. Keep in mind that once this value is defined, the gui setting for base url no longer works. To use the gui setting, remove this env variable."}
readonly_supported: true
readonly_message: |
  * `BASE_URL` cannot be changed from `/`
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the webui at `<your-ip>:3579`. Follow the setup wizard on initial install.  Then configure the required services.
# init diagram
init_diagram: |
  "ombi: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-crontab-config -> init-config-end
    init-ombi-config -> init-config-end
    init-config -> init-crontab-config
    init-mods-end -> init-custom-files
    base -> init-envfile
    base -> init-migrations
    init-config-end -> init-mods
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    init-config -> init-ombi-config
    init-adduser -> init-os-end
    init-envfile -> init-os-end
    init-custom-files -> init-services
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-ombi
    svc-ombi -> legacy-services
  }
  Base Images: {
    "baseimage-ubuntu:noble"
  }
  "ombi:latest" <- Base Images
# changelog
changelogs:
  - {date: "08.07.24:", desc: "Rebase to Ubuntu Noble."}
  - {date: "01.07.23:", desc: "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"}
  - {date: "11.09.22:", desc: "Migrate to s6v3."}
  - {date: "01.05.22:", desc: "Rebase to Jammy."}
  - {date: "26.04.21:", desc: "Update tarball name, allow for v4 builds in stable."}
  - {date: "18.01.21:", desc: "Update upstream repo. Deprecate `v4-preview` tag, which is merged to `development` tag upstream."}
  - {date: "14.04.20:", desc: "Add Ombi donate links."}
  - {date: "10.05.19:", desc: "Added an optional env variable for base url setting."}
  - {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
  - {date: "22.02.19:", desc: "Clarify info on tags and development builds."}
  - {date: "25.01.19:", desc: "Add info on tags and development builds."}
  - {date: "09.01.19:", desc: "Switch to multi-arch builds and add aarch64 image."}
  - {date: "11.03.18:", desc: "Add HOME env to Dockerfile."}
  - {date: "05.03.18:", desc: "Switch to Ombi v3 stable based on .net core."}
  - {date: "26.01.18:", desc: "Fix continuation lines."}
  - {date: "16.04.17:", desc: "Switch to using inhouse mono baseimage."}
  - {date: "17.02.17:", desc: "Initial Release."}