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 # 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

43 # Mail system to use

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

45 MAIL_DRIVER=smtp

47 # Mail sending options

48 MAIL_FROM=mail@bookstackapp.com

49 MAIL_FROM_NAME=BookStack

51 # SMTP mail options

52 MAIL_HOST=localhost

53 MAIL_PORT=1025

54 MAIL_USERNAME=null

55 MAIL_PASSWORD=null

56 MAIL_ENCRYPTION=null

58 # Cache & Session driver to use

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

60 CACHE_DRIVER=file

61 SESSION_DRIVER=file

63 # Session configuration

64 SESSION_LIFETIME=120

65 SESSION_COOKIE_NAME=bookstack_session

66 SESSION_SECURE_COOKIE=false

68 # Cache key prefix

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

70 CACHE_PREFIX=bookstack

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

78 # Redis server configuration

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

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

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

82 REDIS_SERVERS=127.0.0.1:6379:0

84 # Queue driver to use

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

86 # Would advise not to change this for now.

87 QUEUE_DRIVER=sync

89 # Storage system to use

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

91 STORAGE_TYPE=local

93 # Amazon S3 storage configuration

94 STORAGE_S3_KEY=your-s3-key

95 STORAGE_S3_SECRET=your-s3-secret

96 STORAGE_S3_BUCKET=s3-bucket-name

97 STORAGE_S3_REGION=s3-bucket-region

99 # S3 endpoint to use for storage calls

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

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

102

103 # Storage URL prefix

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

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

106 STORAGE_URL=false

107

108 # Authentication method to use

109 # Can be 'standard' or 'ldap'

110 AUTH_METHOD=standard

111

112 # Social authentication configuration

113 # All disabled by default.

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

115

116 AZURE_APP_ID=false

117 AZURE_APP_SECRET=false

118 AZURE_TENANT=false

119 AZURE_AUTO_REGISTER=false

120 AZURE_AUTO_CONFIRM_EMAIL=false

121

122 DISCORD_APP_ID=false

123 DISCORD_APP_SECRET=false

124 DISCORD_AUTO_REGISTER=false

125 DISCORD_AUTO_CONFIRM_EMAIL=false

126

127 FACEBOOK_APP_ID=false

128 FACEBOOK_APP_SECRET=false

129 FACEBOOK_AUTO_REGISTER=false

130 FACEBOOK_AUTO_CONFIRM_EMAIL=false

131

132 GITHUB_APP_ID=false

133 GITHUB_APP_SECRET=false

134 GITHUB_AUTO_REGISTER=false

135 GITHUB_AUTO_CONFIRM_EMAIL=false

136

137 GITLAB_APP_ID=false

138 GITLAB_APP_SECRET=false

139 GITLAB_BASE_URI=false

140 GITLAB_AUTO_REGISTER=false

141 GITLAB_AUTO_CONFIRM_EMAIL=false

142

143 GOOGLE_APP_ID=false

144 GOOGLE_APP_SECRET=false

145 GOOGLE_SELECT_ACCOUNT=false

146 GOOGLE_AUTO_REGISTER=false

147 GOOGLE_AUTO_CONFIRM_EMAIL=false

148

149 OKTA_BASE_URL=false

150 OKTA_APP_ID=false

151 OKTA_APP_SECRET=false

152 OKTA_AUTO_REGISTER=false

153 OKTA_AUTO_CONFIRM_EMAIL=false

154

155 SLACK_APP_ID=false

156 SLACK_APP_SECRET=false

157 SLACK_AUTO_REGISTER=false

158 SLACK_AUTO_CONFIRM_EMAIL=false

159

160 TWITCH_APP_ID=false

161 TWITCH_APP_SECRET=false

162 TWITCH_AUTO_REGISTER=false

163 TWITCH_AUTO_CONFIRM_EMAIL=false

164

165 TWITTER_APP_ID=false

166 TWITTER_APP_SECRET=false

167 TWITTER_AUTO_REGISTER=false

168 TWITTER_AUTO_CONFIRM_EMAIL=false

169

170 # LDAP authentication configuration

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

172 LDAP_SERVER=false

173 LDAP_BASE_DN=false

174 LDAP_DN=false

175 LDAP_PASS=false

176 LDAP_USER_FILTER=false

177 LDAP_VERSION=false

178 LDAP_TLS_INSECURE=false

179 LDAP_EMAIL_ATTRIBUTE=mail

180 LDAP_DISPLAY_NAME_ATTRIBUTE=cn

181 LDAP_FOLLOW_REFERRALS=true

182

183 # LDAP group sync configuration

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

185 LDAP_USER_TO_GROUPS=false

186 LDAP_GROUP_ATTRIBUTE="memberOf"

187 LDAP_REMOVE_FROM_GROUPS=false

188

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

190 # Service-specific options will override this option

191 DISABLE_EXTERNAL_SERVICES=false

192

193 # Use custom avatar service, Sets fetch URL

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

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

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

197 AVATAR_URL=

198

199 # Enable Draw.io integration

200 DRAWIO=true

201

202 # Default item listing view

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

204 # Can be 'list' or 'grid'

205 APP_VIEWS_BOOKS=list

206 APP_VIEWS_BOOKSHELVES=grid

207

208 # Page revision limit

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

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

211 REVISION_LIMIT=50

212

213 # Allow <script> tags in page content

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

215 ALLOW_CONTENT_SCRIPTS=false

216

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

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

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

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

221 ALLOW_ROBOTS=null

222