readme-vars.yml

---

# project information
project_name: yaak
project_url: "https://yaak.app/"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/yaak-logo.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is a desktop API client for organizing and executing REST, GraphQL, and gRPC requests. It's built using [Tauri](https://tauri.app/), [Rust](https://www.rust-lang.org/), and [ReactJS](https://react.dev/)."
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-<version tag>"}

# 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: "Where yaak should store its config and data." }
param_usage_include_ports: true
param_ports:
  - { external_port: "3000", internal_port: "3000", port_desc: "Yaak desktop gui." }
  - { external_port: "3001", internal_port: "3001", port_desc: "Yaak desktop gui HTTPS." }
opt_security_opt_param: true
opt_security_opt_param_vars:
  - { run_var: "seccomp=unconfined", compose_var: "seccomp:unconfined", desc: "For Docker Engine only, many modern gui apps need this to function as syscalls are unkown to Docker." }

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  This image sets up the Yaak desktop app and makes its interface available via KasmVNC server in the browser. The interface is available at `http://your-ip:3000` or `https://your-ip:3001`.

kasm_blurb: true
external_http_port: "3000"
external_https_port: "3001"
noto_fonts: "font-noto-cjk"

# changelog
changelogs:
  - { date: "12.09.24:", desc: "Initial release." }