readme-vars.yml

---

# project information
project_name: obsidian
project_url: "https://obsidian.md"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/obsidian-logo.png"
project_blurb: "[Obsidian]({{ project_url }}) is a note-taking app that lets you create, link, and organize your notes on your device, with hundreds of plugins and themes to customize your workflow. You can also publish your notes online, access them offline, and sync them securely with end-to-end encryption."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_categories: "Content Management"
project_blurb_optional_extras_enabled: false
# supported architectures
available_architectures:
  - {arch: "{{ arch_x86_64 }}", tag: "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/config", desc: "Users home directory in the container, stores program settings and files."}
param_usage_include_ports: true
param_ports:
  - {external_port: "3000", internal_port: "3000", port_desc: "Obsidian desktop gui HTTP, must be proxied."}
  - {external_port: "3001", internal_port: "3001", port_desc: "Obsidian desktop gui HTTPS."}
custom_params:
  - {name: "shm-size", name_compose: "shm_size", value: "1gb", desc: "This is needed for electron applications to function properly."}
# Selkies blurb settings
selkies_blurb: true
show_nvidia: true
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  The application can be accessed at:

  * https://yourhost:3001/
# init diagram
init_diagram: |
  "obsidian: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-selkies-end -> init-config
    init-config -> init-config-end
    init-crontab-config -> init-config-end
    init-obsidian-config -> init-config-end
    init-config -> init-crontab-config
    init-mods-end -> init-custom-files
    init-adduser -> init-device-perms
    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-selkies -> init-nginx
    init-config -> init-obsidian-config
    init-adduser -> init-os-end
    init-device-perms -> init-os-end
    init-envfile -> init-os-end
    init-os-end -> init-selkies
    init-nginx -> init-selkies-config
    init-video -> init-selkies-end
    init-custom-files -> init-services
    init-selkies-config -> init-video
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-dbus
    svc-xorg -> svc-dbus
    svc-dbus -> legacy-services
    init-services -> svc-de
    svc-nginx -> svc-de
    svc-xorg -> svc-de
    svc-de -> legacy-services
    init-services -> svc-docker
    svc-docker -> legacy-services
    init-services -> svc-nginx
    svc-nginx -> legacy-services
    init-services -> svc-pulseaudio
    svc-pulseaudio -> legacy-services
    init-services -> svc-selkies
    svc-dbus -> svc-selkies
    svc-nginx -> svc-selkies
    svc-pulseaudio -> svc-selkies
    svc-xorg -> svc-selkies
    svc-selkies -> legacy-services
    init-services -> svc-watchdog
    svc-watchdog -> legacy-services
    init-services -> svc-xorg
    svc-xorg -> legacy-services
    init-services -> svc-xsettingsd
    svc-nginx -> svc-xsettingsd
    svc-xorg -> svc-xsettingsd
    svc-xsettingsd -> legacy-services
  }
  Base Images: {
    "baseimage-selkies:debiantrixie" <- "baseimage-debian:trixie"
  }
  "obsidian:latest" <- Base Images
# changelog
changelogs:
  - {date: "20.03.26:", desc: "Use Wayland ozone platform fixes scaling and acceleration."}
  - {date: "28.12.25:", desc: "Add Wayland init logic."}
  - {date: "21.09.25:", desc: "Rebase to Debian Trixie."}
  - {date: "12.07.25:", desc: "Rebase to Selkies add no sandbox to launcher, HTTPS IS NOW REQUIRED."}
  - {date: "03.04.25:", desc: "Update chromium launch options to improve performance."}
  - {date: "18.06.24:", desc: "Fix application init for Kasm."}
  - {date: "06.04.24:", desc: "Initial release."}