snipe-it/.env.example

# --------------------------------------------
# REQUIRED: BASIC APP SETTINGS
# --------------------------------------------
APP_ENV=production
APP_DEBUG=false
APP_KEY=ChangeMe
APP_URL=null
APP_TIMEZONE='UTC'
APP_LOCALE=en

# --------------------------------------------
# REQUIRED: DATABASE SETTINGS
# --------------------------------------------
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_DATABASE=null
DB_USERNAME=null
DB_PASSWORD=null
DB_PREFIX=null
DB_DUMP_PATH='/usr/bin'
DB_CHARSET=utf8mb4
DB_COLLATION=utf8mb4_unicode_ci

# --------------------------------------------
# OPTIONAL: SSL DATABASE SETTINGS
# --------------------------------------------
DB_SSL=false
DB_SSL_KEY_PATH=null
DB_SSL_CERT_PATH=null
DB_SSL_CA_PATH=null
DB_SSL_CIPHER=null

# --------------------------------------------
# REQUIRED: OUTGOING MAIL SERVER SETTINGS
# --------------------------------------------
MAIL_DRIVER=smtp
MAIL_HOST=email-smtp.us-west-2.amazonaws.com
MAIL_PORT=587
MAIL_USERNAME=YOURUSERNAME
MAIL_PASSWORD=YOURPASSWORD
MAIL_ENCRYPTION=null
MAIL_FROM_ADDR=you@example.com
MAIL_FROM_NAME='Snipe-IT'
MAIL_REPLYTO_ADDR=you@example.com
MAIL_REPLYTO_NAME='Snipe-IT'
MAIL_BACKUP_NOTIFICATION_ADDRESS=you@example.com

# --------------------------------------------
# REQUIRED: IMAGE LIBRARY
# This should be gd or imagick
# --------------------------------------------
IMAGE_LIB=gd

# --------------------------------------------
# OPTIONAL: SESSION SETTINGS
# --------------------------------------------
SESSION_LIFETIME=12000
EXPIRE_ON_CLOSE=false
ENCRYPT=false
COOKIE_NAME=snipeit_session
COOKIE_DOMAIN=null
SECURE_COOKIES=false

# --------------------------------------------
# OPTIONAL: SECURITY HEADER SETTINGS
# --------------------------------------------
REFERRER_POLICY=same-origin
ENABLE_CSP=false
CORS_ALLOWED_ORIGINS=null

# --------------------------------------------
# OPTIONAL: CACHE SETTINGS
# --------------------------------------------
CACHE_DRIVER=file
SESSION_DRIVER=file
QUEUE_DRIVER=sync
CACHE_PREFIX=snipeit

# --------------------------------------------
# OPTIONAL: REDIS SETTINGS
# --------------------------------------------
REDIS_HOST=null
REDIS_PASSWORD=null
REDIS_PORT=null

# --------------------------------------------
# OPTIONAL: MEMCACHED SETTINGS
# --------------------------------------------
MEMCACHED_HOST=null
MEMCACHED_PORT=null

# --------------------------------------------
# OPTIONAL: AWS S3 SETTINGS
# --------------------------------------------
AWS_SECRET=null
AWS_KEY=null
AWS_REGION=null
AWS_BUCKET=null

# --------------------------------------------
# OPTIONAL: LOGIN THROTTLING
# --------------------------------------------
LOGIN_MAX_ATTEMPTS=5
LOGIN_LOCKOUT_DURATION=60

# --------------------------------------------
# OPTIONAL: MISC
# --------------------------------------------
APP_LOG=single
APP_LOG_MAX_FILES=10
APP_LOCKED=false
FILESYSTEM_DISK=local
APP_TRUSTED_PROXIES=192.168.1.1,10.0.0.1
ALLOW_IFRAMING=false
APP_CIPHER=AES-256-CBC
GOOGLE_MAPS_API=
BACKUP_ENV=true
Version 3 - hold onto your butts 2016-03-25 01:18:05 -07:00			`# --------------------------------------------`
			`# REQUIRED: BASIC APP SETTINGS`
			`# --------------------------------------------`
			`APP_ENV=production`
			`APP_DEBUG=false`
			`APP_KEY=ChangeMe`
			`APP_URL=null`
Default timezone back to UTC 2016-05-20 14:29:15 -07:00			`APP_TIMEZONE='UTC'`
Version 3 - hold onto your butts 2016-03-25 01:18:05 -07:00			`APP_LOCALE=en`

			`# --------------------------------------------`
			`# REQUIRED: DATABASE SETTINGS`
			`# --------------------------------------------`
			`DB_CONNECTION=mysql`
Default DB_HOST 127.0.0.1 instead of localhost (#4324) 2017-10-26 16:30:48 -07:00			`DB_HOST=127.0.0.1`
Version 3 - hold onto your butts 2016-03-25 01:18:05 -07:00			`DB_DATABASE=null`
			`DB_USERNAME=null`
			`DB_PASSWORD=null`
Set DB prefix in env 2016-04-19 00:47:12 -07:00			`DB_PREFIX=null`
Better default mysqldump path 2016-06-02 17:17:33 -07:00			`DB_DUMP_PATH='/usr/bin'`
Make collation and charset for mysql an env variable 2017-09-26 16:02:55 -07:00			`DB_CHARSET=utf8mb4`
			`DB_COLLATION=utf8mb4_unicode_ci`
Version 3 - hold onto your butts 2016-03-25 01:18:05 -07:00
Fixes #2980 - enable MySQL SSL settings 2016-11-28 19:25:26 -08:00			`# --------------------------------------------`
			`# OPTIONAL: SSL DATABASE SETTINGS`
			`# --------------------------------------------`
Set DB_SSL to false for config 2016-12-03 17:33:36 -08:00			`DB_SSL=false`
Fixes #2980 - enable MySQL SSL settings 2016-11-28 19:25:26 -08:00			`DB_SSL_KEY_PATH=null`
			`DB_SSL_CERT_PATH=null`
			`DB_SSL_CA_PATH=null`
			`DB_SSL_CIPHER=null`

Version 3 - hold onto your butts 2016-03-25 01:18:05 -07:00			`# --------------------------------------------`
			`# REQUIRED: OUTGOING MAIL SERVER SETTINGS`
			`# --------------------------------------------`
			`MAIL_DRIVER=smtp`
			`MAIL_HOST=email-smtp.us-west-2.amazonaws.com`
			`MAIL_PORT=587`
			`MAIL_USERNAME=YOURUSERNAME`
			`MAIL_PASSWORD=YOURPASSWORD`
			`MAIL_ENCRYPTION=null`
			`MAIL_FROM_ADDR=you@example.com`
Added single quotes to env for mail sender 2016-08-23 16:03:57 -07:00			`MAIL_FROM_NAME='Snipe-IT'`
Add reply-to config setting 2016-09-20 07:20:10 -07:00			`MAIL_REPLYTO_ADDR=you@example.com`
			`MAIL_REPLYTO_NAME='Snipe-IT'`
Fixed #7099 - set email to null by default for backup notifications 2019-05-29 19:09:37 -07:00			`MAIL_BACKUP_NOTIFICATION_ADDRESS=you@example.com`
Version 3 - hold onto your butts 2016-03-25 01:18:05 -07:00
			`# --------------------------------------------`
			`# REQUIRED: IMAGE LIBRARY`
			`# This should be gd or imagick`
			`# --------------------------------------------`
			`IMAGE_LIB=gd`

			`# --------------------------------------------`
			`# OPTIONAL: SESSION SETTINGS`
			`# --------------------------------------------`
			`SESSION_LIFETIME=12000`
			`EXPIRE_ON_CLOSE=false`
			`ENCRYPT=false`
			`COOKIE_NAME=snipeit_session`
			`COOKIE_DOMAIN=null`
			`SECURE_COOKIES=false`
Added content security middleware 2017-09-28 19:45:15 -07:00
			`# --------------------------------------------`
			`# OPTIONAL: SECURITY HEADER SETTINGS`
			`# --------------------------------------------`
Set polict to same-origin in example env 2017-10-02 16:47:19 -07:00			`REFERRER_POLICY=same-origin`
Update example env with CSP default 2017-10-02 13:29:42 -07:00			`ENABLE_CSP=false`
CORS for api (#7292) * Added CORS support to API * Changed order so CORS will still work if throttle hit * Added APP_CORS_ALLOWED_ORIGINS env option * Fixed typo * Clarified header comments * More clarification * DIsable CORS allowed origins by default to replicate existing behavior * Change variable name to be clearer 2019-07-26 12:38:31 -07:00			`CORS_ALLOWED_ORIGINS=null`
Version 3 - hold onto your butts 2016-03-25 01:18:05 -07:00
			`# --------------------------------------------`
			`# OPTIONAL: CACHE SETTINGS`
			`# --------------------------------------------`
			`CACHE_DRIVER=file`
			`SESSION_DRIVER=file`
			`QUEUE_DRIVER=sync`
Improve Memcached settings (#6485) * Improved memcached settings * Improved memcached settings 2018-12-06 14:39:14 -08:00			`CACHE_PREFIX=snipeit`
Version 3 - hold onto your butts 2016-03-25 01:18:05 -07:00
Added Redis vairables to example env 2017-10-09 15:44:08 -07:00			`# --------------------------------------------`
			`# OPTIONAL: REDIS SETTINGS`
			`# --------------------------------------------`
			`REDIS_HOST=null`
			`REDIS_PASSWORD=null`
Improve Memcached settings (#6485) * Improved memcached settings * Improved memcached settings 2018-12-06 14:39:14 -08:00			`REDIS_PORT=null`

			`# --------------------------------------------`
			`# OPTIONAL: MEMCACHED SETTINGS`
			`# --------------------------------------------`
			`MEMCACHED_HOST=null`
			`MEMCACHED_PORT=null`
Version 3 - hold onto your butts 2016-03-25 01:18:05 -07:00
			`# --------------------------------------------`
			`# OPTIONAL: AWS S3 SETTINGS`
			`# --------------------------------------------`
			`AWS_SECRET=null`
			`AWS_KEY=null`
			`AWS_REGION=null`
			`AWS_BUCKET=null`

Fixes #2995 - adds max login attempts/duration as .env option 2016-12-01 02:04:15 -08:00			`# --------------------------------------------`
			`# OPTIONAL: LOGIN THROTTLING`
			`# --------------------------------------------`
			`LOGIN_MAX_ATTEMPTS=5`
			`LOGIN_LOCKOUT_DURATION=60`
Version 3 - hold onto your butts 2016-03-25 01:18:05 -07:00
			`# --------------------------------------------`
			`# OPTIONAL: MISC`
			`# --------------------------------------------`
Changed log fomrat in example env to single 2017-11-08 11:08:11 -08:00			`APP_LOG=single`
Fixes #4226 - adds log_max_files to app config and sample env 2017-10-17 20:04:07 -07:00			`APP_LOG_MAX_FILES=10`
Version 3 - hold onto your butts 2016-03-25 01:18:05 -07:00			`APP_LOCKED=false`
			`FILESYSTEM_DISK=local`
Added single quotes to env for mail sender 2016-08-23 16:03:57 -07:00			`APP_TRUSTED_PROXIES=192.168.1.1,10.0.0.1`
Allow X-Frame-Options to be disabled via env if necessary 2016-08-29 22:57:29 -07:00			`ALLOW_IFRAMING=false`
Move cipher into the .env 2017-01-09 19:41:24 -08:00			`APP_CIPHER=AES-256-CBC`
Fixes #4508 - adds image to location view (and google map, if address and API key exist) 2017-12-01 19:12:35 -08:00			`GOOGLE_MAPS_API=`
Backup the .env if BACKUP_ENV is set to true 2018-02-26 18:12:48 -08:00			`BACKUP_ENV=true`