---

# project information
project_name: heimdall
project_url: "https://heimdall.site"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/heimdall-banner.png"
project_blurb: |
  [{{ project_name|capitalize }}]({{ project_url }}) is a way to organise all those links to your most used web sites and web applications in a simple way.

  Simplicity is the key to Heimdall.

  Why not use it as your browser start page? It even has the ability to include a search bar using either Google, Bing or DuckDuckGo.
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_categories: "Dashboard"
# supported architectures
available_architectures:
  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# development version
development_versions: true
development_versions_items:
  - {tag: "latest", desc: "Stable Heimdall releases."}
  - {tag: "development", desc: "Latest commit from the github 2.x branch."}
# 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: "Persistent config files"}
param_usage_include_ports: true
param_ports:
  - {external_port: "80", internal_port: "80", port_desc: "http gui"}
  - {external_port: "443", internal_port: "443", port_desc: "https gui"}
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the web gui at http://SERVERIP:PORT

  ### Adding password protection

  This image now supports password protection through htpasswd. Run the following command on your host to generate the htpasswd file `docker exec -it heimdall htpasswd -c /config/nginx/.htpasswd <username>`. Replace <username> with a username of your choice and you will be asked to enter a password. Uncomment the `basic auth` lines in `/config/nginx/site-confs/default.conf` and restart the container.
# init diagram
init_diagram: |
  "heimdall: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-nginx-end -> init-config
    init-os-end -> init-config
    init-config -> init-config-end
    init-heimdall-config -> init-config-end
    init-os-end -> init-crontab-config
    init-mods-end -> init-custom-files
    init-adduser -> init-device-perms
    base -> init-envfile
    init-os-end -> init-folders
    init-nginx-end -> init-heimdall-config
    init-php -> init-keygen
    base -> init-migrations
    base -> init-mods
    init-config-end -> init-mods
    init-version-checks -> init-mods
    init-mods -> init-mods-end
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    init-samples -> init-nginx
    init-permissions -> init-nginx-end
    base -> init-os-end
    init-adduser -> init-os-end
    init-device-perms -> init-os-end
    init-envfile -> init-os-end
    init-migrations -> init-os-end
    init-keygen -> init-permissions
    init-nginx -> init-php
    init-folders -> init-samples
    init-custom-files -> init-services
    init-mods-end -> init-services
    init-config-end -> init-version-checks
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-nginx
    svc-nginx -> legacy-services
    init-services -> svc-php-fpm
    svc-php-fpm -> legacy-services
    init-services -> svc-queue
    svc-queue -> legacy-services
  }
  Base Images: {
    "baseimage-alpine-nginx:3.20" <- "baseimage-alpine:3.20"
  }
  "heimdall:latest" <- Base Images
# changelog
changelogs:
  - {date: "27.06.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings."}
  - {date: "07.03.24:", desc: "Enable the opcache and disable file revalidation."}
  - {date: "06.03.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf."}
  - {date: "23.12.23:", desc: "Rebase to Alpine 3.19 with php 8.3."}
  - {date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf."}
  - {date: "13.04.23:", desc: "Move ssl.conf include to default.conf."}
  - {date: "20.01.23:", desc: "Rebase to alpine 3.17 with php8.1."}
  - {date: "14.11.22:", desc: "Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base))."}
  - {date: "04.11.22:", desc: "Build commits to upstream branch 2.x for the `development` tag."}
  - {date: "13.03.21:", desc: "Make searchproviders.yaml user configurable."}
  - {date: "10.02.21:", desc: "Revert to alpine 3.12 as php 7.4 broke laravel."}
  - {date: "10.02.21:", desc: "Rebasing to alpine 3.13."}
  - {date: "17.08.20:", desc: "Add php7-curl."}
  - {date: "01.06.20:", desc: "Rebasing to alpine 3.12."}
  - {date: "17.01.20:", desc: "Use nginx from baseimage."}
  - {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
  - {date: "16.07.19:", desc: "Save laravel.log to /config/log/heimdall."}
  - {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
  - {date: "01.04.19:", desc: "Fix permission detect logic."}
  - {date: "26.03.19:", desc: "Install Heimdall during container start to prevent delayed start due to overlayfs bug with recursive chown."}
  - {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
  - {date: "15.03.19:", desc: "Clarify docker image tags in readme."}
  - {date: "22.02.19:", desc: "Rebasing to alpine 3.9."}
  - {date: "16.01.18:", desc: "Generate random app key in .env for new installs."}
  - {date: "20.11.18:", desc: "Upgrade baseimage packages during build."}
  - {date: "04.11.18:", desc: "Add php7-zip."}
  - {date: "31.10.18:", desc: "Add queue service."}
  - {date: "17.10.18:", desc: "Symlink avatars folder."}
  - {date: "16.10.18:", desc: "Updated fastcgi_params for user login support."}
  - {date: "07.10.18:", desc: "Symlink `.env` rather than copy. It now resides under `/config/www`"}
  - {date: "30.09.18:", desc: "Multi-arch image. Move `.env` to `/config`."}
  - {date: "05.09.18:", desc: "Rebase to alpine linux 3.8."}
  - {date: "06.03.18:", desc: "Use password protection if htpasswd is set. Existing users can delete their default site config at /config/nginx/site-confs/default.conf and restart the container, a new default site config with htpasswd support will be created in its place"}
  - {date: "12.02.18:", desc: "Initial Release."}