readme-vars.yml

---

# project information
project_name: snipe-it
project_deprecation_status: true
project_deprecation_message: |
  We recommend migrating to the official docker image from Grokability:
  https://snipe-it.readme.io/docs/docker
project_url: "https://github.com/grokability/snipe-it"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/snipe-it-logo.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) makes asset management easy. It was built by people solving real-world IT and asset management problems, and a solid UX has always been a top priority. Straightforward design and bulk actions mean getting things done faster."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_categories: "Administration"
# supported architectures
available_architectures:
  - {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 }}/data", desc: "Contains your config files and data storage for Snipe-IT"}
param_usage_include_ports: true
param_ports:
  - {external_port: "8080", internal_port: "80", port_desc: "Snipe-IT Web UI"}
param_usage_include_env: true
param_env_vars:
  - {env_var: "APP_KEY", env_value: "", desc: "App key used for encrypting stored data. Generate with `docker exec snipe-it php /app/www/artisan key:generate --show`."}
  - {env_var: "APP_URL", env_value: "http://localhost:8080", desc: "Hostname or IP and port if applicable, be sure to define https/http"}
  - {env_var: "MYSQL_PORT_3306_TCP_ADDR", env_value: "", desc: "Mysql hostname or IP to use"}
  - {env_var: "MYSQL_PORT_3306_TCP_PORT", env_value: "", desc: "Mysql port to use"}
  - {env_var: "MYSQL_DATABASE", env_value: "", desc: "Mysql database to use"}
  - {env_var: "MYSQL_USER", env_value: "", desc: "Mysql user to use"}
  - {env_var: "MYSQL_PASSWORD", env_value: "", desc: "Mysql password to use"}
opt_param_usage_include_env: true
opt_param_env_vars:
  - {env_var: "APP_DEBUG", env_value: "false", desc: "Set to `true` to see debugging output in the web UI."}
  - {env_var: "APP_ENV", env_value: "production", desc: "Default is `production` but can use `testing` or `develop`."}
  - {env_var: "APP_FORCE_TLS", env_value: "false", desc: "Set to `true` if running behind a reverse proxy"}
  - {env_var: "APP_LOCALE", env_value: "", desc: "Default is `en-US`. Set to a language from [this list](https://snipe-it.readme.io/docs/configuration#section-setting-a-language)."}
  - {env_var: "MAIL_PORT_587_TCP_ADDR", env_value: "", desc: "SMTP mail server ip or hostname."}
  - {env_var: "MAIL_PORT_587_TCP_PORT", env_value: "", desc: "SMTP mail server port."}
  - {env_var: "MAIL_ENV_FROM_ADDR", env_value: "", desc: "The email address mail should be replied to and listed when sent."}
  - {env_var: "MAIL_ENV_FROM_NAME", env_value: "", desc: "The name listed on email sent from the default account on the system."}
  - {env_var: "MAIL_ENV_ENCRYPTION", env_value: "", desc: "Mail encryption to use e.g. `tls`."}
  - {env_var: "MAIL_ENV_USERNAME", env_value: "", desc: "SMTP server login username."}
  - {env_var: "MAIL_ENV_PASSWORD", env_value: "", desc: "SMTP server login password."}
readonly_supported: false
nonroot_supported: false
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the webui at `<your-ip>:8080`, for more information check out [{{ project_name|capitalize }}]({{ project_url }}).

  **This container requires a MySQL or MariaDB server to connect to, we recommend [ours](https://github.com/linuxserver/docker-mariadb)**
# init diagram
init_diagram: |
  "snipe-it: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-crontab-config -> init-config-end
    init-snipe-it-config -> init-config-end
    init-config -> init-crontab-config
    init-mods-end -> init-custom-files
    init-config-end -> init-deprecate
    base -> init-envfile
    init-os-end -> init-folders
    init-php -> init-keygen
    base -> init-migrations
    init-config-end -> init-mods
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    init-samples -> init-nginx
    init-version-checks -> init-nginx-end
    init-adduser -> init-os-end
    init-envfile -> init-os-end
    init-keygen -> init-permissions
    init-nginx -> init-php
    init-folders -> init-samples
    init-custom-files -> init-services
    init-deprecate -> init-services
    init-nginx-end -> init-snipe-it-config
    init-permissions -> 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
  }
  Base Images: {
    "baseimage-alpine-nginx:3.21" <- "baseimage-alpine:3.21"
  }
  "snipe-it:latest" <- Base Images
# changelog
changelogs:
  - {date: "16.01.25:", desc: "Rebase to Alpine 3.21."}
  - {date: "17.06.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings."}
  - {date: "06.03.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf."}
  - {date: "17.02.24:", desc: "Add php81-exif."}
  - {date: "03.07.23:", desc: "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"}
  - {date: "13.04.23:", desc: "Move ssl.conf include to default.conf."}
  - {date: "13.04.23:", desc: "Add php81-pecl-redis for redis support."}
  - {date: "28.12.22:", desc: "Rebase to Alpine 3.17, migrate to s6v3."}
  - {date: "20.08.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: "14.05.22:", desc: "Add php7-sodium for v6."}
  - {date: "12.04.22:", desc: "Don't build development elements."}
  - {date: "02.03.22:", desc: "Rework init logic, do not show default compose."}
  - {date: "29.06.21:", desc: "Rebasing to alpine 3.14."}
  - {date: "30.04.21:", desc: "Rebasing to alpine 3.13, add artisan migrate on spinup."}
  - {date: "01.06.20:", desc: "Rebasing to alpine 3.12."}
  - {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
  - {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
  - {date: "10.04.19:", desc: "Add php deps for V4.7.0, ensure framework directories are available at build time."}
  - {date: "10.04.19:", desc: "Fix permissions for new bootstrap cache directory."}
  - {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
  - {date: "22.02.19:", desc: "Rebasing to alpine 3.9."}
  - {date: "31.10.18:", desc: "Rebasing to alpine 3.8"}
  - {date: "05.08.18:", desc: "Migration to live build server."}
  - {date: "13.06.18:", desc: "Initial Release."}