BookStack/.env.example

# Environment
APP_ENV=production
APP_DEBUG=false
APP_KEY=SomeRandomString

# The below url has to be set if using social auth options
# or if you are not using BookStack at the root path of your domain.
# APP_URL=http://bookstack.dev

# Database details
DB_HOST=localhost
DB_DATABASE=database_database
DB_USERNAME=database_username
DB_PASSWORD=database_user_password

# Cache and session
CACHE_DRIVER=file
SESSION_DRIVER=file
# If using Memcached, comment the above and uncomment these
#CACHE_DRIVER=memcached
#SESSION_DRIVER=memcached
QUEUE_DRIVER=sync
# A different prefix is useful when multiple BookStack instances use the same caching server
CACHE_PREFIX=bookstack

# Memcached settings
# If using a UNIX socket path for the host, set the port to 0
# This follows the following format: HOST:PORT:WEIGHT
# For multiple servers separate with a comma
MEMCACHED_SERVERS=127.0.0.1:11211:100

# Storage
STORAGE_TYPE=local
# Amazon S3 Config
STORAGE_S3_KEY=false
STORAGE_S3_SECRET=false
STORAGE_S3_REGION=false
STORAGE_S3_BUCKET=false
# Storage URL
# Used to prefix image urls for when using custom domains/cdns
STORAGE_URL=false

# General auth
AUTH_METHOD=standard

# Social Authentication information. Defaults as off.
GITHUB_APP_ID=false
GITHUB_APP_SECRET=false
GOOGLE_APP_ID=false
GOOGLE_APP_SECRET=false
OKTA_BASE_URL=false
OKTA_APP_ID=false
OKTA_APP_SECRET=false
TWITCH_APP_ID=false
TWITCH_APP_SECRET=false
GITLAB_APP_ID=false
GITLAB_APP_SECRET=false
GITLAB_BASE_URI=false

# External services such as Gravatar and Draw.IO
DISABLE_EXTERNAL_SERVICES=false

# LDAP Settings
LDAP_SERVER=false
LDAP_BASE_DN=false
LDAP_DN=false
LDAP_PASS=false
LDAP_USER_FILTER=false
LDAP_VERSION=false
# Do you want to sync LDAP groups to BookStack roles for a user
LDAP_USER_TO_GROUPS=false
# What is the LDAP attribute for group memberships
LDAP_GROUP_ATTRIBUTE="memberOf"
# Would you like to remove users from roles on BookStack if they do not match on LDAP
# If false, the ldap groups-roles sync will only add users to roles
LDAP_REMOVE_FROM_GROUPS=false

# Mail settings
MAIL_DRIVER=smtp
MAIL_HOST=localhost
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM=null
MAIL_FROM_NAME=null
Refactored Social auth into service, Made entity an abstract class 2015-09-04 12:50:52 -04:00			`# Environment`
			`APP_ENV=production`
			`APP_DEBUG=false`
Initial commit 2015-07-12 15:01:42 -04:00			`APP_KEY=SomeRandomString`

Updated all application urls to allow path prefix. Allows BookStack to be installed at a non-root location on a domain. Closes #40. 2016-08-14 07:29:35 -04:00			`# The below url has to be set if using social auth options`
			`# or if you are not using BookStack at the root path of your domain.`
			`# APP_URL=http://bookstack.dev`

Refactored Social auth into service, Made entity an abstract class 2015-09-04 12:50:52 -04:00			`# Database details`
Initial commit 2015-07-12 15:01:42 -04:00			`DB_HOST=localhost`
Refactored Social auth into service, Made entity an abstract class 2015-09-04 12:50:52 -04:00			`DB_DATABASE=database_database`
			`DB_USERNAME=database_username`
Updated readme with social & update instructions 2016-01-02 11:24:09 -05:00			`DB_PASSWORD=database_user_password`
Initial commit 2015-07-12 15:01:42 -04:00
Refactored Social auth into service, Made entity an abstract class 2015-09-04 12:50:52 -04:00			`# Cache and session`
Initial commit 2015-07-12 15:01:42 -04:00			`CACHE_DRIVER=file`
			`SESSION_DRIVER=file`
Closes #69. Implemented and tested memcached. 2016-03-02 21:44:00 -05:00			`# If using Memcached, comment the above and uncomment these`
			`#CACHE_DRIVER=memcached`
			`#SESSION_DRIVER=memcached`
Initial commit 2015-07-12 15:01:42 -04:00			`QUEUE_DRIVER=sync`
Update .env.example 2018-03-05 07:10:59 -05:00			`# A different prefix is useful when multiple BookStack instances use the same caching server`
Add CACHE_PREFIX to the .env.example file We had some problems with multiple BookStack instances using the same caching server. Perhaps it's a good idea to have this available in the `.env.example` file. 2018-02-26 03:51:53 -05:00			`CACHE_PREFIX=bookstack`
Initial commit 2015-07-12 15:01:42 -04:00
Made memcached config allow mulitple servers 2016-03-05 04:47:24 -05:00			`# Memcached settings`
			`# If using a UNIX socket path for the host, set the port to 0`
			`# This follows the following format: HOST:PORT:WEIGHT`
			`# For multiple servers separate with a comma`
			`MEMCACHED_SERVERS=127.0.0.1:11211:100`

Revamped image system to use driver-agnotstic storage and be more efficent 2015-12-07 18:00:34 -05:00			`# Storage`
			`STORAGE_TYPE=local`
			`# Amazon S3 Config`
			`STORAGE_S3_KEY=false`
			`STORAGE_S3_SECRET=false`
			`STORAGE_S3_REGION=false`
			`STORAGE_S3_BUCKET=false`
			`# Storage URL`
			`# Used to prefix image urls for when using custom domains/cdns`
			`STORAGE_URL=false`

Increased LDAP testing and fixed any Auth-based bugs found 2016-01-17 10:20:07 -05:00			`# General auth`
			`AUTH_METHOD=standard`

Updated readme with more details 2015-11-21 13:49:29 -05:00			`# Social Authentication information. Defaults as off.`
Refactored Social auth into service, Made entity an abstract class 2015-09-04 12:50:52 -04:00			`GITHUB_APP_ID=false`
			`GITHUB_APP_SECRET=false`
			`GOOGLE_APP_ID=false`
			`GOOGLE_APP_SECRET=false`
Add socialite authentication for okta 2017-11-26 10:41:29 -05:00			`OKTA_BASE_URL=false`
Corrected the keys for okta auth 2018-01-31 15:11:17 -05:00			`OKTA_APP_ID=false`
			`OKTA_APP_SECRET=false`
Update .env.example 2018-02-01 02:53:08 -05:00			`TWITCH_APP_ID=false`
			`TWITCH_APP_SECRET=false`
add missing icon, fix name conventions 2018-02-01 12:26:19 -05:00			`GITLAB_APP_ID=false`
			`GITLAB_APP_SECRET=false`
			`GITLAB_BASE_URI=false`
add support for gitlab authentification 2018-01-31 10:02:07 -05:00
Tweaked some comments 2018-02-11 13:18:16 -05:00			`# External services such as Gravatar and Draw.IO`
Updated readme with social & update instructions 2016-01-02 11:24:09 -05:00			`DISABLE_EXTERNAL_SERVICES=false`
Added custom user avatars 2015-12-09 17:30:55 -05:00
Cleaned tests up, Started LDAP tests, Created LDAP wrapper 2016-01-15 18:21:47 -05:00			`# LDAP Settings`
			`LDAP_SERVER=false`
			`LDAP_BASE_DN=false`
			`LDAP_DN=false`
			`LDAP_PASS=false`
			`LDAP_USER_FILTER=false`
			`LDAP_VERSION=false`
Added tests to cover ldap group mapping Also updated .env.example formatting. Updated how LdapRepo uses Ldap so can be mocked by testing. 2018-07-15 12:57:25 -04:00			`# Do you want to sync LDAP groups to BookStack roles for a user`
LDAP groups sync to Bookstack roles. Closes #75 2018-07-02 13:09:39 -04:00			`LDAP_USER_TO_GROUPS=false`
Added tests to cover ldap group mapping Also updated .env.example formatting. Updated how LdapRepo uses Ldap so can be mocked by testing. 2018-07-15 12:57:25 -04:00			`# What is the LDAP attribute for group memberships`
LDAP groups sync to Bookstack roles. Closes #75 2018-07-02 13:09:39 -04:00			`LDAP_GROUP_ATTRIBUTE="memberOf"`
Added tests to cover ldap group mapping Also updated .env.example formatting. Updated how LdapRepo uses Ldap so can be mocked by testing. 2018-07-15 12:57:25 -04:00			`# Would you like to remove users from roles on BookStack if they do not match on LDAP`
			`# If false, the ldap groups-roles sync will only add users to roles`
LDAP groups sync to Bookstack roles. Closes #75 2018-07-02 13:09:39 -04:00			`LDAP_REMOVE_FROM_GROUPS=false`
Cleaned tests up, Started LDAP tests, Created LDAP wrapper 2016-01-15 18:21:47 -05:00
Refactored Social auth into service, Made entity an abstract class 2015-09-04 12:50:52 -04:00			`# Mail settings`
Initial commit 2015-07-12 15:01:42 -04:00			`MAIL_DRIVER=smtp`
Refactored Social auth into service, Made entity an abstract class 2015-09-04 12:50:52 -04:00			`MAIL_HOST=localhost`
			`MAIL_PORT=1025`
Initial commit 2015-07-12 15:01:42 -04:00			`MAIL_USERNAME=null`
			`MAIL_PASSWORD=null`
add support for gitlab authentification 2018-01-31 10:02:07 -05:00			`MAIL_ENCRYPTION=null`
Added ability to configure email sender name Added env variable MAIL_FROM_NAME to allow the email sender name to be customised. Also added MAIL_FROM to .env.example 2018-02-21 04:24:19 -05:00			`MAIL_FROM=null`
			`MAIL_FROM_NAME=null`