Create readme-vars.yml

This commit is contained in:
aptalca 2018-12-17 14:57:43 -05:00 committed by Ryan Kuba
parent 0b059f2535
commit cf99cf5f8a

53
readme-vars.yml Normal file
View File

@ -0,0 +1,53 @@
---
# 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.
If you are sharing your Plex server with other users, allow them to request new content using an easy to manage interface!
Manage all your requests for Movies and TV with ease, leave notes for the user and get notification when a user requests something.
Allow your users to post issues against their requests so you know there is a problem with the audio etc.
Even automatically sent 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"}
- { arch: "{{ arch_armhf }}", tag: "arm32v6-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/appdata/config>", desc: "Contains all relevant configuration files." }
param_usage_include_ports: true
param_ports:
- { external_port: "3579", internal_port: "3579", port_desc: "web gui" }
param_usage_include_env: true
param_env_vars:
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
# optional parameters
optional_block_1: false
optional_block_1_items: ""
# 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.
# changelog
changelogs:
- { date: "17.12.18:", 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." }