readme-vars.yml

---

# project information
project_name: kopia
project_url: "https://kopia.io/"
project_logo: "https://raw.githubusercontent.com/kopia/kopia/master/icons/kopia.svg"
project_blurb: "Kopia is a fast and secure open-source backup/restore tool that allows you to create encrypted snapshots of your data and save the snapshots to remote or cloud storage of your choice, to network-attached storage or server, or locally on your machine."
project_github_repo_url: "https://github.com/imagegenius/docker-{{ project_name }}"

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest" }
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest" }

# development version
development_versions: false

# 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>", desc: "Appdata Path" }
  - { vol_path: "/source", vol_host_path: "</path/to/source>", desc: "Backup Source Path" }
  - { vol_path: "/cache", vol_host_path: "</path/to/uploads>", desc: "Temporary Uploads Path (Cache)" }
opt_param_usage_include_vols: true
opt_param_volumes:
  - { vol_path: "/local", vol_host_path: "</path/to/local>", desc: "Path for local filesystem repositories" }
param_usage_include_ports: true
param_ports:
  - { external_port: "51515", internal_port: "51515", port_desc: "WebUI Port" }
param_usage_include_env: true
param_env_vars:
  - { env_var: "USERNAME", env_value: "kopia", desc: "Specify a username to access the WebUI, this can be removed after first setup" }
  - { env_var: "PASSWORD", env_value: "kopia", desc: "Specify a password to access the WebUI, this can be removed after first setup" }
param_device_map: true
param_devices:
  - { device_path: "/dev/fuse", device_host_path: "/dev/fuse", desc: "Allows fuse mounts to function" }
cap_add_param: true
cap_add_param_vars:
  - { cap_add_var: "SYS_ADMIN" }

param_usage_include_hostname: true
param_hostname: "kopia"
param_hostname_desc: "Set hostname for the container."

# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
  - { env_var: "KOPIA_PERSIST_CREDENTIALS_ON_CONNECT", env_value: "true", desc: "Automatically connect to repository" }
  - { env_var: "CLI_ARGS", env_value: "", desc: "Overwrite CLI arguments" }

# optional parameters
optional_block_1: false
optional_block_1_items: ""

# unraid template
unraid_category: "Backup: Cloud: Network:Other Productivity: Tools:"

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  The WebUI can be found at `http://your-ip:51515`. Login with the username and password specified in the `USERNAME` and `PASSWORD` variables.

  The `htpasswd` file is automatically generated on startup (if it does not exist) with the specified username/password in the variables.

  After this file has been generated, the `USERNAME`/`PASSWORD` variables can be removed, and the `htpasswd` file can be modified with the `htpasswd` command as desired.

  By default, Kopia will be started with the following configuration:

  ```bash
  kopia server start \
    --insecure \
    --disable-csrf-token-checks \
    --address=0.0.0.0:51515 \
    --htpasswd-file /config/htpasswd
  ```
  This can be easily overwritten by specifying startup parameters in the `CLI_ARGS` variable, which will overwrite everything after the `kopia` command, eg:

  `CLI_ARGS=`
  ```bash
  server start \
    --disable-csrf-token-checks \
    --tls-cert-file=/config/keys/fullchain.pem \
    --tls-key-file=/config/keys/privkey.pem \
    --address=0.0.0.0:51515 \
    --server-username=kopia \
    --server-password=kopia
  ```

  **When specifying `CLI_ARGS`, they must be on a single line.**

  If you have entered invalid `CLI_ARGS`, Kopia will not start (see the logs if this happens).

# changelog
changelogs:
  - { date: "24.03.24:", desc: "rebase to alpine edge." }
  - { date: "22.04.23:", desc: "use `htpasswd` file." }
  - { date: "21.04.23:", desc: "Add `CLI_ARGS` variable." }
  - { date: "14.04.23:", desc: "BREAKING: move cache from /tmp to /cache." }
  - { date: "11.04.23:", desc: "fix run script ('kopia server' to 'kopia server start')" }
  - { date: "28.03.23:", desc: "set home in service" }
  - { date: "23.03.23:", desc: "add fuse package" }
  - { date: "21.03.23:", desc: "Add service checks" }
  - { date: "26.01.23:", desc: "Initial release." }