diff --git a/readme-vars.yml b/readme-vars.yml index 591491e..43393ba 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -6,38 +6,34 @@ project_url: "https://desktop.github.com/" project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/github-desktop-icon.png" project_blurb: "[Github Desktop]({{ project_url }}) is an open source Electron-based GitHub app. It is written in TypeScript and uses React." 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_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: "Users home directory in the container, stores local files and settings" } + - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Users home directory in the container, stores local files and settings"} param_usage_include_ports: true param_ports: - - { external_port: "3000", internal_port: "3000", port_desc: "Github Desktop gui." } - - { external_port: "3001", internal_port: "3001", port_desc: "HTTPS Github Desktop gui." } + - {external_port: "3000", internal_port: "3000", port_desc: "Github Desktop gui."} + - {external_port: "3001", internal_port: "3001", port_desc: "HTTPS Github Desktop gui."} custom_params: - - { name: "shm-size", name_compose: "shm_size", value: "1gb",desc: "This is needed for electron applications to function properly." } + - {name: "shm-size", name_compose: "shm_size", value: "1gb", desc: "This is needed for electron applications to function properly."} cap_add_param: true cap_add_param_vars: - - { cap_add_var: "IPC_LOCK", desc: "Required for keyring functionality." } + - {cap_add_var: "IPC_LOCK", desc: "Required for keyring functionality."} 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 on older hosts as syscalls are unknown to Docker. Github Desktop runs in no-sandbox mode without it." } - + - {run_var: "seccomp=unconfined", compose_var: "seccomp:unconfined", desc: "For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. Github Desktop runs in no-sandbox mode without it."} # Kasm blurb settings kasm_blurb: true show_nvidia: true external_http_port: "3000" external_https_port: "3001" noto_fonts: "fonts-noto-cjk" - # application setup block app_setup_block_enabled: true app_setup_block: | @@ -45,9 +41,70 @@ app_setup_block: | * http://yourhost:3000/ * https://yourhost:3001/ - +# init diagram +init_diagram: | + "github-desktop: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-kasmvnc-end -> init-config + init-os-end -> init-config + init-config -> init-config-end + init-os-end -> init-crontab-config + init-mods-end -> init-custom-files + base -> init-envfile + init-os-end -> init-kasmvnc + init-nginx -> init-kasmvnc-config + init-video -> init-kasmvnc-end + 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 + init-kasmvnc -> init-nginx + 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-kasmvnc-config -> init-video + init-services -> svc-cron + svc-cron -> legacy-services + init-services -> svc-de + svc-nginx -> svc-de + svc-de -> legacy-services + init-services -> svc-docker + svc-de -> svc-docker + svc-docker -> legacy-services + init-services -> svc-kasmvnc + svc-pulseaudio -> svc-kasmvnc + svc-kasmvnc -> legacy-services + init-services -> svc-kclient + svc-kasmvnc -> svc-kclient + svc-kclient -> legacy-services + init-services -> svc-nginx + svc-kclient -> svc-nginx + svc-nginx -> legacy-services + init-services -> svc-pulseaudio + svc-pulseaudio -> legacy-services + } + Base Images: { + "baseimage-kasmvnc:debianbookworm" <- "baseimage-debian:bookworm" + } + "github-desktop:latest" <- Base Images # changelog changelogs: - - { date: "10.02.24:", desc: "Update Readme with new env vars and ingest proper PWA icon." } - - { date: "03.08.23:", desc: "Rebase to Bookworm and multi arch." } - - { date: "01.04.23:", desc: "Initial release." } + - {date: "10.02.24:", desc: "Update Readme with new env vars and ingest proper PWA icon."} + - {date: "03.08.23:", desc: "Rebase to Bookworm and multi arch."} + - {date: "01.04.23:", desc: "Initial release."}