This repository was archived by the owner on Jun 27, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.env.example
More file actions
117 lines (103 loc) · 4.76 KB
/
Copy path.env.example
File metadata and controls
117 lines (103 loc) · 4.76 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# .env.example — reference file. To bootstrap:
#
# make init # creates .env, fills APP_KEY + random DB passwords (idempotent)
#
# `make init` never overwrites existing values, so it's safe to re-run
# after edits. APP_KEY in particular is preserved — regenerating it would
# invalidate every encrypted column and signed session in the DB.
# -----------------------------------------------------------------------
# Image
# -----------------------------------------------------------------------
SNIPE_IT_IMAGE_TAG=latest
# -----------------------------------------------------------------------
# Application
# -----------------------------------------------------------------------
# Generate with:
# docker run --rm ghcr.io/netresearch/snipe-it-php-fpm:latest \
# php /var/www/html/artisan key:generate --show
APP_KEY=
APP_URL=http://localhost:8000
APP_ENV=production
APP_DEBUG=false
# TZ sets the OS clock inside the container; APP_TIMEZONE is what Laravel
# reads for date/time display. If APP_TIMEZONE is unset, compose defaults
# it to TZ so a single value covers both.
TZ=Europe/Berlin
# APP_TIMEZONE=Europe/Berlin
# -----------------------------------------------------------------------
# Database
# -----------------------------------------------------------------------
DB_DATABASE=snipeit
DB_USERNAME=snipeit
DB_PASSWORD=
DB_ROOT_PASSWORD=
# -----------------------------------------------------------------------
# Valkey — used for cache / sessions / queues
# Valkey is the Linux Foundation fork of Redis; the Laravel driver is still
# named "redis" because it speaks the RESP protocol. Leave password empty
# unless you reconfigure the valkey service to require one.
# -----------------------------------------------------------------------
REDIS_PASSWORD=
# Drivers — Laravel's "redis" driver name = RESP protocol. Don't rename.
# Flip to file/file/sync if you remove the valkey service.
CACHE_DRIVER=redis
SESSION_DRIVER=redis
QUEUE_CONNECTION=redis
# -----------------------------------------------------------------------
# Mail (optional — Snipe-IT skips notifications if MAIL_HOST is empty)
# -----------------------------------------------------------------------
MAIL_HOST=
MAIL_PORT=587
MAIL_USERNAME=
MAIL_PASSWORD=
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDR=noreply@example.com
MAIL_FROM_NAME=Snipe-IT
# -----------------------------------------------------------------------
# Sentry / Bugsink (optional — empty DSN = error tracking disabled)
# -----------------------------------------------------------------------
# Snipe-IT ships with sentry/sentry-laravel pre-installed in this image.
# It auto-discovers via Laravel's ServiceProvider; the DSN is the only
# switch. Empty = SDK loaded but inactive (zero network calls).
#
# Compatible backends:
# - Bugsink (self-hosted, recommended): https://www.bugsink.com/
# - Sentry SaaS: https://sentry.io/
#
# DSN format: http(s)://<key>@<host>/<project-id>
# Get from your Bugsink project settings -> "Client Keys (DSN)".
# Internal compose-network Bugsink uses http://; external/TLS instances use https://.
SENTRY_LARAVEL_DSN=
# Performance / profiling sampling. Default 0.0 = errors only. Raise to
# capture traces/profiles — note volume scales with rate * request count.
SENTRY_TRACES_SAMPLE_RATE=0.0
SENTRY_PROFILES_SAMPLE_RATE=0.0
# -----------------------------------------------------------------------
# Bugsink overlay (only needed for examples/compose.bugsink.yml)
# -----------------------------------------------------------------------
# When this overlay is active, an init container auto-seeds a snipe-it
# project in Bugsink and writes its DSN into a shared volume — so you
# don't need to set SENTRY_LARAVEL_DSN above. Leave SENTRY_LARAVEL_DSN
# empty and let the overlay wire it.
#
# These vars are unused unless you start the stack with the overlay:
# docker compose -f compose.yml -f examples/compose.bugsink.yml up -d
BUGSINK_SECRET_KEY=
BUGSINK_ADMIN_EMAIL=admin@example.com
BUGSINK_ADMIN_PASSWORD=
# Optional — public Bugsink URL when fronted by a reverse proxy with TLS:
# BUGSINK_PUBLIC_URL=https://bugsink.example.com
# BUGSINK_BEHIND_HTTPS_PROXY=true
# -----------------------------------------------------------------------
# Networking
# -----------------------------------------------------------------------
SNIPEIT_HTTP_PORT=8000
# Used by examples/compose.traefik.yml — your public hostname
SNIPEIT_HOST=snipeit.example.com
# -----------------------------------------------------------------------
# Operational flags
# -----------------------------------------------------------------------
# SKIP_MIGRATIONS=true skips `artisan migrate --force` at container start.
# Useful with multi-replica setups: run migrate externally once, set true.
SKIP_MIGRATIONS=false
# COMPOSE_PROJECT_NAME=snipe-it