]> BookStack Code Mirror - bookstack/blob - .env.example
Merge branch 'Vinrobot-custom-avatar-provider'
[bookstack] / .env.example
1 # Environment
2 APP_ENV=production
3 APP_DEBUG=false
4 APP_KEY=SomeRandomString
5
6 # The below url has to be set if using social auth options
7 # or if you are not using BookStack at the root path of your domain.
8 # APP_URL=http://bookstack.dev
9
10 # Database details
11 DB_HOST=localhost
12 DB_DATABASE=database_database
13 DB_USERNAME=database_username
14 DB_PASSWORD=database_user_password
15
16 # Cache and session
17 CACHE_DRIVER=file
18 SESSION_DRIVER=file
19 # If using Memcached, comment the above and uncomment these
20 #CACHE_DRIVER=memcached
21 #SESSION_DRIVER=memcached
22 QUEUE_DRIVER=sync
23 # A different prefix is useful when multiple BookStack instances use the same caching server
24 CACHE_PREFIX=bookstack
25
26 # Memcached settings
27 # If using a UNIX socket path for the host, set the port to 0
28 # This follows the following format: HOST:PORT:WEIGHT
29 # For multiple servers separate with a comma
30 MEMCACHED_SERVERS=127.0.0.1:11211:100
31
32 # Storage
33 STORAGE_TYPE=local
34 # Amazon S3 Config
35 STORAGE_S3_KEY=false
36 STORAGE_S3_SECRET=false
37 STORAGE_S3_REGION=false
38 STORAGE_S3_BUCKET=false
39 # Storage URL
40 # Used to prefix image urls for when using custom domains/cdns
41 STORAGE_URL=false
42
43 # General auth
44 AUTH_METHOD=standard
45
46 # Social Authentication information. Defaults as off.
47 GITHUB_APP_ID=false
48 GITHUB_APP_SECRET=false
49 GOOGLE_APP_ID=false
50 GOOGLE_APP_SECRET=false
51 GOOGLE_SELECT_ACCOUNT=false
52 OKTA_BASE_URL=false
53 OKTA_APP_ID=false
54 OKTA_APP_SECRET=false
55 TWITCH_APP_ID=false
56 TWITCH_APP_SECRET=false
57 GITLAB_APP_ID=false
58 GITLAB_APP_SECRET=false
59 GITLAB_BASE_URI=false
60 DISCORD_APP_ID=false
61 DISCORD_APP_SECRET=false
62
63
64 # Disable default services such as Gravatar and Draw.IO
65 DISABLE_EXTERNAL_SERVICES=false
66 # Use custom avatar service, Sets fetch URL
67 # Possible placeholders: ${hash} ${size} ${email}
68 # If set, Avatars will be fetched regardless of DISABLE_EXTERNAL_SERVICES option.
69 # AVATAR_URL=https://seccdn.libravatar.org/avatar/${hash}?s=${size}&d=identicon
70
71 # LDAP Settings
72 LDAP_SERVER=false
73 LDAP_BASE_DN=false
74 LDAP_DN=false
75 LDAP_PASS=false
76 LDAP_USER_FILTER=false
77 LDAP_VERSION=false
78 # Do you want to sync LDAP groups to BookStack roles for a user
79 LDAP_USER_TO_GROUPS=false
80 # What is the LDAP attribute for group memberships
81 LDAP_GROUP_ATTRIBUTE="memberOf"
82 # Would you like to remove users from roles on BookStack if they do not match on LDAP
83 # If false, the ldap groups-roles sync will only add users to roles
84 LDAP_REMOVE_FROM_GROUPS=false
85 # Set this option to disable LDAPS Certificate Verification
86 LDAP_TLS_INSECURE=false
87
88 # Mail settings
89 MAIL_DRIVER=smtp
90 MAIL_HOST=localhost
91 MAIL_PORT=1025
92 MAIL_USERNAME=null
93 MAIL_PASSWORD=null
94 MAIL_ENCRYPTION=null
95 MAIL_FROM=null
96 MAIL_FROM_NAME=null