]> BookStack Code Mirror - bookstack/blob - .env.example.complete
projects / bookstack / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Update Dutch password_hint translation to correspond with validation rule
[bookstack] / .env.example.complete
1 # Full list of environment variables that can be used with BookStack.
2 # Selectively copy these to your '.env' file as required.
3 # Each option is shown with it's default value.
4 # Do not copy this whole file to use as your '.env' file.
5
6 # Application environment
7 # Can be 'production', 'development', 'testing' or 'demo'
8 APP_ENV=production
9
10 # Enable debug mode
11 # Shows advanced debug information and errors.
12 # CAN EXPOSE OTHER VARIABLES, LEAVE DISABLED
13 APP_DEBUG=false
14
15 # Application key
16 # Used for encryption where needed.
17 # Run `php artisan key:generate` to generate a valid key.
18 APP_KEY=SomeRandomString
19
20 # Application URL
21 # This must be the root URL that you want to host BookStack on.
22 # All URL's in BookStack will be generated using this value.
23 APP_URL=https://example.com
24
25 # Application default language
26 # The default language choice to show.
27 # May be overridden by user-preference or visitor browser settings.
28 APP_LANG=en
29
30 # Auto-detect language for public visitors.
31 # Uses browser-sent headers to infer a language.
32 # APP_LANG will be used if such a header is not provided.
33 APP_AUTO_LANG_PUBLIC=true
34
35 # Database details
36 # Host can contain a port (localhost:3306) or a separate DB_PORT option can be used.
37 DB_HOST=localhost
38 DB_PORT=3306
39 DB_DATABASE=database_database
40 DB_USERNAME=database_username
41 DB_PASSWORD=database_user_password
42
43 # Mail system to use
44 # Can be 'smtp', 'mail' or 'sendmail'
45 MAIL_DRIVER=smtp
46
47 # Mail sending options
48 [email protected]
49 MAIL_FROM_NAME=BookStack
50
51 # SMTP mail options
52 MAIL_HOST=localhost
53 MAIL_PORT=1025
54 MAIL_USERNAME=null
55 MAIL_PASSWORD=null
56 MAIL_ENCRYPTION=null
57
58 # Cache & Session driver to use
59 # Can be 'file', 'database', 'memcached' or 'redis'
60 CACHE_DRIVER=file
61 SESSION_DRIVER=file
62
63 # Session configuration
64 SESSION_LIFETIME=120
65 SESSION_COOKIE_NAME=bookstack_session
66 SESSION_SECURE_COOKIE=false
67
68 # Cache key prefix
69 # Can be used to prevent conflicts multiple BookStack instances use the same store.
70 CACHE_PREFIX=bookstack
71
72 # Memcached server configuration
73 # If using a UNIX socket path for the host, set the port to 0
74 # This follows the following format: HOST:PORT:WEIGHT
75 # For multiple servers separate with a comma
76 MEMCACHED_SERVERS=127.0.0.1:11211:100
77
78 # Queue driver to use
79 # Queue not really currently used but may be configurable in the future.
80 # Would advise not to change this for now.
81 QUEUE_DRIVER=sync
82
83 # Storage system to use
84 # Can be 'local', 'local_secure' or 's3'
85 STORAGE_TYPE=local
86
87 # Amazon S3 storage configuration
88 STORAGE_S3_KEY=your-s3-key
89 STORAGE_S3_SECRET=your-s3-secret
90 STORAGE_S3_BUCKET=s3-bucket-name
91 STORAGE_S3_REGION=s3-bucket-region
92
93 # S3 endpoint to use for storage calls
94 # Only set this if using a non-Amazon s3-compatible service such as Minio
95 STORAGE_S3_ENDPOINT=https://my-custom-s3-compatible.service.com:8001
96
97 # Storage URL prefix
98 # Used as a base for any generated image urls.
99 # An s3-format URL will be generated if not set.
100 STORAGE_URL=false
101
102 # Authentication method to use
103 # Can be 'standard' or 'ldap'
104 AUTH_METHOD=standard
105
106 # Social authentication configuration
107 # All disabled by default.
108 # Refer to https://www.bookstackapp.com/docs/admin/third-party-auth/
109
110 AZURE_APP_ID=false
111 AZURE_APP_SECRET=false
112 AZURE_TENANT=false
113 AZURE_AUTO_REGISTER=false
114 AZURE_AUTO_CONFIRM_EMAIL=false
115
116 DISCORD_APP_ID=false
117 DISCORD_APP_SECRET=false
118 DISCORD_AUTO_REGISTER=false
119 DISCORD_AUTO_CONFIRM_EMAIL=false
120
121 FACEBOOK_APP_ID=false
122 FACEBOOK_APP_SECRET=false
123 FACEBOOK_AUTO_REGISTER=false
124 FACEBOOK_AUTO_CONFIRM_EMAIL=false
125
126 GITHUB_APP_ID=false
127 GITHUB_APP_SECRET=false
128 GITHUB_AUTO_REGISTER=false
129 GITHUB_AUTO_CONFIRM_EMAIL=false
130
131 GITLAB_APP_ID=false
132 GITLAB_APP_SECRET=false
133 GITLAB_BASE_URI=false
134 GITLAB_AUTO_REGISTER=false
135 GITLAB_AUTO_CONFIRM_EMAIL=false
136
137 GOOGLE_APP_ID=false
138 GOOGLE_APP_SECRET=false
139 GOOGLE_SELECT_ACCOUNT=false
140 GOOGLE_AUTO_REGISTER=false
141 GOOGLE_AUTO_CONFIRM_EMAIL=false
142
143 OKTA_BASE_URL=false
144 OKTA_APP_ID=false
145 OKTA_APP_SECRET=false
146 OKTA_AUTO_REGISTER=false
147 OKTA_AUTO_CONFIRM_EMAIL=false
148
149 SLACK_APP_ID=false
150 SLACK_APP_SECRET=false
151 SLACK_AUTO_REGISTER=false
152 SLACK_AUTO_CONFIRM_EMAIL=false
153
154 TWITCH_APP_ID=false
155 TWITCH_APP_SECRET=false
156 TWITCH_AUTO_REGISTER=false
157 TWITCH_AUTO_CONFIRM_EMAIL=false
158
159 TWITTER_APP_ID=false
160 TWITTER_APP_SECRET=false
161 TWITTER_AUTO_REGISTER=false
162 TWITTER_AUTO_CONFIRM_EMAIL=false
163
164 # LDAP authentication configuration
165 # Refer to https://www.bookstackapp.com/docs/admin/ldap-auth/
166 LDAP_SERVER=false
167 LDAP_BASE_DN=false
168 LDAP_DN=false
169 LDAP_PASS=false
170 LDAP_USER_FILTER=false
171 LDAP_VERSION=false
172 LDAP_TLS_INSECURE=false
173 LDAP_EMAIL_ATTRIBUTE=mail
174 LDAP_FOLLOW_REFERRALS=true
175
176 # LDAP group sync configuration
177 # Refer to https://www.bookstackapp.com/docs/admin/ldap-auth/
178 LDAP_USER_TO_GROUPS=false
179 LDAP_GROUP_ATTRIBUTE="memberOf"
180 LDAP_REMOVE_FROM_GROUPS=false
181
182 # Disable default third-party services such as Gravatar and Draw.IO
183 # Service-specific options will override this option
184 DISABLE_EXTERNAL_SERVICES=false
185
186 # Use custom avatar service, Sets fetch URL
187 # Possible placeholders: ${hash} ${size} ${email}
188 # If set, Avatars will be fetched regardless of DISABLE_EXTERNAL_SERVICES option.
189 # Example: AVATAR_URL=https://seccdn.libravatar.org/avatar/${hash}?s=${size}&d=identicon
190 AVATAR_URL=
191
192 # Enable Draw.io integration
193 DRAWIO=true
194
195 # Default item listing view
196 # Used for public visitors and user's without a preference
197 # Can be 'list' or 'grid'
198 APP_VIEWS_BOOKS=list
199 APP_VIEWS_BOOKSHELVES=grid
200
201 # Page revision limit
202 # Number of page revisions to keep in the system before deleting old revisions.
203 # If set to 'false' a limit will not be enforced.
204 REVISION_LIMIT=50
205
206 # Allow <script> tags in page content
207 # Note, if set to 'true' the page editor may still escape scripts.
208 ALLOW_CONTENT_SCRIPTS=false
209
210 # Indicate if robots/crawlers should crawl your instance.
211 # Can be 'true', 'false' or 'null'.
212 # The behaviour of the default 'null' option will depend on the 'app-public' admin setting.
213 # Contents of the robots.txt file can be overridden, making this option obsolete.
214 ALLOW_ROBOTS=null
215
The core source code for the BookStack project.