readme-vars.yml

---

# project information
project_name: dillinger
project_url: "https://github.com/joemccann/dillinger"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/dillinger.png"
project_blurb: |
  [{{ project_name|capitalize }}]({{ project_url }}) is a cloud-enabled, mobile-ready, offline-storage, AngularJS powered HTML5 Markdown editor.
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

project_deprecation_status: true

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

# container parameters
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "/path/to/configs", desc: "Dillinger plugin config files" }
param_usage_include_ports: true
param_ports:
  - { external_port: "8080", internal_port: "8080", port_desc: "The port for the Dillinger web interface" }
param_usage_include_env: true
param_env_vars:
  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the webui at http://your-ip:8080 , keep in mind that storage for this application is in your browser session not server side. Only plugin configurations will ever be stored server side.

  ## PDF Export

  If you need PDF export functionality you need to run the container with a custom seccomp profile because otherwise the headless Chrome instance it uses won't have sufficient permissions.

  Download the `pdf-export.json` [from this repo](https://raw.githubusercontent.com/linuxserver/docker-dillinger/master/pdf-export.json) onto your docker host and start the container with `--security-opt seccomp=/path/to/pdf-export.json`. If you're using compose the format is:

  ```yaml
      security_opt:
        - seccomp=/path/to/pdf-export.json
  ```

  The original source for this seccomp profile is [here](https://github.com/jessfraz/dotfiles/blob/master/etc/docker/seccomp/chrome.json).

# changelog
changelogs:
  - { date: "20.03.24:", desc: "Deprecate image." }
  - { date: "12.07.23:", desc: "Rebase to Alpine 3.18." }
  - { date: "13.02.23:", desc: "Rebase to Alpine 3.17, migrate to s6v3." }
  - { date: "19.04.22:", desc: "Rebase to Alpine." }
  - { date: "31.05.19:", desc: "Initial Release." }