BookStack Code Mirror - bookstack/blob

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.

6 # Application environment

7 # Can be 'production', 'development', 'testing' or 'demo'

8 APP_ENV=production

10 # Enable debug mode

11 # Shows advanced debug information and errors.

12 # CAN EXPOSE OTHER VARIABLES, LEAVE DISABLED

13 APP_DEBUG=false

15 # Application key

16 # Used for encryption where needed.

17 # Run `php artisan key:generate` to generate a valid key.

18 APP_KEY=SomeRandomString

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

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

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

35 # Application timezone

36 # Used where dates are displayed such as on exported content.

37 # Valid timezone values can be found here: https://www.php.net/manual/en/timezones.php

38 APP_TIMEZONE=UTC

40 # Database details

41 # Host can contain a port (localhost:3306) or a separate DB_PORT option can be used.

42 DB_HOST=localhost

43 DB_PORT=3306

44 DB_DATABASE=database_database

45 DB_USERNAME=database_username

46 DB_PASSWORD=database_user_password

48 # Mail system to use

49 # Can be 'smtp', 'mail' or 'sendmail'

50 MAIL_DRIVER=smtp

52 # Mail sending options

53 MAIL_FROM=mail@bookstackapp.com

54 MAIL_FROM_NAME=BookStack

56 # SMTP mail options

57 MAIL_HOST=localhost

58 MAIL_PORT=1025

59 MAIL_USERNAME=null

60 MAIL_PASSWORD=null

61 MAIL_ENCRYPTION=null

63 # Cache & Session driver to use

64 # Can be 'file', 'database', 'memcached' or 'redis'

65 CACHE_DRIVER=file

66 SESSION_DRIVER=file

68 # Session configuration

69 SESSION_LIFETIME=120

70 SESSION_COOKIE_NAME=bookstack_session

71 SESSION_SECURE_COOKIE=false

73 # Cache key prefix

74 # Can be used to prevent conflicts multiple BookStack instances use the same store.

75 CACHE_PREFIX=bookstack

77 # Memcached server configuration

78 # If using a UNIX socket path for the host, set the port to 0

79 # This follows the following format: HOST:PORT:WEIGHT

80 # For multiple servers separate with a comma

81 MEMCACHED_SERVERS=127.0.0.1:11211:100

83 # Redis server configuration

84 # This follows the following format: HOST:PORT:DATABASE

85 # or, if using a password: HOST:PORT:DATABASE:PASSWORD

86 # For multiple servers separate with a comma. These will be clustered.

87 REDIS_SERVERS=127.0.0.1:6379:0

89 # Queue driver to use

90 # Queue not really currently used but may be configurable in the future.

91 # Would advise not to change this for now.

92 QUEUE_DRIVER=sync

94 # Storage system to use

95 # Can be 'local', 'local_secure' or 's3'

96 STORAGE_TYPE=local

98 # Amazon S3 storage configuration

99 STORAGE_S3_KEY=your-s3-key

100 STORAGE_S3_SECRET=your-s3-secret

101 STORAGE_S3_BUCKET=s3-bucket-name

102 STORAGE_S3_REGION=s3-bucket-region

103

104 # S3 endpoint to use for storage calls

105 # Only set this if using a non-Amazon s3-compatible service such as Minio

106 STORAGE_S3_ENDPOINT=https://my-custom-s3-compatible.service.com:8001

107

108 # Storage URL prefix

109 # Used as a base for any generated image urls.

110 # An s3-format URL will be generated if not set.

111 STORAGE_URL=false

112

113 # Authentication method to use

114 # Can be 'standard' or 'ldap'

115 AUTH_METHOD=standard

116

117 # Social authentication configuration

118 # All disabled by default.

119 # Refer to https://www.bookstackapp.com/docs/admin/third-party-auth/

120

121 AZURE_APP_ID=false

122 AZURE_APP_SECRET=false

123 AZURE_TENANT=false

124 AZURE_AUTO_REGISTER=false

125 AZURE_AUTO_CONFIRM_EMAIL=false

126

127 DISCORD_APP_ID=false

128 DISCORD_APP_SECRET=false

129 DISCORD_AUTO_REGISTER=false

130 DISCORD_AUTO_CONFIRM_EMAIL=false

131

132 FACEBOOK_APP_ID=false

133 FACEBOOK_APP_SECRET=false

134 FACEBOOK_AUTO_REGISTER=false

135 FACEBOOK_AUTO_CONFIRM_EMAIL=false

136

137 GITHUB_APP_ID=false

138 GITHUB_APP_SECRET=false

139 GITHUB_AUTO_REGISTER=false

140 GITHUB_AUTO_CONFIRM_EMAIL=false

141

142 GITLAB_APP_ID=false

143 GITLAB_APP_SECRET=false

144 GITLAB_BASE_URI=false

145 GITLAB_AUTO_REGISTER=false

146 GITLAB_AUTO_CONFIRM_EMAIL=false

147

148 GOOGLE_APP_ID=false

149 GOOGLE_APP_SECRET=false

150 GOOGLE_SELECT_ACCOUNT=false

151 GOOGLE_AUTO_REGISTER=false

152 GOOGLE_AUTO_CONFIRM_EMAIL=false

153

154 OKTA_BASE_URL=false

155 OKTA_APP_ID=false

156 OKTA_APP_SECRET=false

157 OKTA_AUTO_REGISTER=false

158 OKTA_AUTO_CONFIRM_EMAIL=false

159

160 SLACK_APP_ID=false

161 SLACK_APP_SECRET=false

162 SLACK_AUTO_REGISTER=false

163 SLACK_AUTO_CONFIRM_EMAIL=false

164

165 TWITCH_APP_ID=false

166 TWITCH_APP_SECRET=false

167 TWITCH_AUTO_REGISTER=false

168 TWITCH_AUTO_CONFIRM_EMAIL=false

169

170 TWITTER_APP_ID=false

171 TWITTER_APP_SECRET=false

172 TWITTER_AUTO_REGISTER=false

173 TWITTER_AUTO_CONFIRM_EMAIL=false

174

175 # LDAP authentication configuration

176 # Refer to https://www.bookstackapp.com/docs/admin/ldap-auth/

177 LDAP_SERVER=false

178 LDAP_BASE_DN=false

179 LDAP_DN=false

180 LDAP_PASS=false

181 LDAP_USER_FILTER=false

182 LDAP_VERSION=false

183 LDAP_TLS_INSECURE=false

184 LDAP_EMAIL_ATTRIBUTE=mail

185 LDAP_DISPLAY_NAME_ATTRIBUTE=cn

186 LDAP_FOLLOW_REFERRALS=true

187

188 # LDAP group sync configuration

189 # Refer to https://www.bookstackapp.com/docs/admin/ldap-auth/

190 LDAP_USER_TO_GROUPS=false

191 LDAP_GROUP_ATTRIBUTE="memberOf"

192 LDAP_REMOVE_FROM_GROUPS=false

193

194 # Disable default third-party services such as Gravatar and Draw.IO

195 # Service-specific options will override this option

196 DISABLE_EXTERNAL_SERVICES=false

197

198 # Use custom avatar service, Sets fetch URL

199 # Possible placeholders: ${hash} ${size} ${email}

200 # If set, Avatars will be fetched regardless of DISABLE_EXTERNAL_SERVICES option.

201 # Example: AVATAR_URL=https://seccdn.libravatar.org/avatar/${hash}?s=${size}&d=identicon

202 AVATAR_URL=

203

204 # Enable Draw.io integration

205 DRAWIO=true

206

207 # Default item listing view

208 # Used for public visitors and user's without a preference

209 # Can be 'list' or 'grid'

210 APP_VIEWS_BOOKS=list

211 APP_VIEWS_BOOKSHELVES=grid

212

213 # Page revision limit

214 # Number of page revisions to keep in the system before deleting old revisions.

215 # If set to 'false' a limit will not be enforced.

216 REVISION_LIMIT=50

217

218 # Allow <script> tags in page content

219 # Note, if set to 'true' the page editor may still escape scripts.

220 ALLOW_CONTENT_SCRIPTS=false

221

222 # Indicate if robots/crawlers should crawl your instance.

223 # Can be 'true', 'false' or 'null'.

224 # The behaviour of the default 'null' option will depend on the 'app-public' admin setting.

225 # Contents of the robots.txt file can be overridden, making this option obsolete.

226 ALLOW_ROBOTS=null

227