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 [email protected]

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

83 # Storage system to use

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

85 STORAGE_TYPE=local

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

93 # Storage URL prefix

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

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

96 STORAGE_URL=false

98 # Authentication method to use

99 # Can be 'standard' or 'ldap'

100 AUTH_METHOD=standard

101

102 # Social authentication configuration

103 # All disabled by default.

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

105

106 AZURE_APP_ID=false

107 AZURE_APP_SECRET=false

108 AZURE_TENANT=false

109 AZURE_AUTO_REGISTER=false

110 AZURE_AUTO_CONFIRM_EMAIL=false

111

112 DISCORD_APP_ID=false

113 DISCORD_APP_SECRET=false

114 DISCORD_AUTO_REGISTER=false

115 DISCORD_AUTO_CONFIRM_EMAIL=false

116

117 FACEBOOK_APP_ID=false

118 FACEBOOK_APP_SECRET=false

119 FACEBOOK_AUTO_REGISTER=false

120 FACEBOOK_AUTO_CONFIRM_EMAIL=false

121

122 GITHUB_APP_ID=false

123 GITHUB_APP_SECRET=false

124 GITHUB_AUTO_REGISTER=false

125 GITHUB_AUTO_CONFIRM_EMAIL=false

126

127 GITLAB_APP_ID=false

128 GITLAB_APP_SECRET=false

129 GITLAB_BASE_URI=false

130 GITLAB_AUTO_REGISTER=false

131 GITLAB_AUTO_CONFIRM_EMAIL=false

132

133 GOOGLE_APP_ID=false

134 GOOGLE_APP_SECRET=false

135 GOOGLE_SELECT_ACCOUNT=false

136 GOOGLE_AUTO_REGISTER=false

137 GOOGLE_AUTO_CONFIRM_EMAIL=false

138

139 OKTA_BASE_URL=false

140 OKTA_APP_ID=false

141 OKTA_APP_SECRET=false

142 OKTA_AUTO_REGISTER=false

143 OKTA_AUTO_CONFIRM_EMAIL=false

144

145 SLACK_APP_ID=false

146 SLACK_APP_SECRET=false

147 SLACK_AUTO_REGISTER=false

148 SLACK_AUTO_CONFIRM_EMAIL=false

149

150 TWITCH_APP_ID=false

151 TWITCH_APP_SECRET=false

152 TWITCH_AUTO_REGISTER=false

153 TWITCH_AUTO_CONFIRM_EMAIL=false

154

155 TWITTER_APP_ID=false

156 TWITTER_APP_SECRET=false

157 TWITTER_AUTO_REGISTER=false

158 TWITTER_AUTO_CONFIRM_EMAIL=false

159

160 # LDAP authentication configuration

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

162 LDAP_SERVER=false

163 LDAP_BASE_DN=false

164 LDAP_DN=false

165 LDAP_PASS=false

166 LDAP_USER_FILTER=false

167 LDAP_VERSION=false

168 LDAP_TLS_INSECURE=false

169 LDAP_EMAIL_ATTRIBUTE=mail

170 LDAP_FOLLOW_REFERRALS=true

171

172 # LDAP group sync configuration

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

174 LDAP_USER_TO_GROUPS=false

175 LDAP_GROUP_ATTRIBUTE="memberOf"

176 LDAP_REMOVE_FROM_GROUPS=false

177

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

179 # Service-specific options will override this option

180 DISABLE_EXTERNAL_SERVICES=false

181

182 # Use custom avatar service, Sets fetch URL

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

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

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

186 AVATAR_URL=

187

188 # Enable Draw.io integration

189 DRAWIO=true

190

191 # Default item listing view

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

193 # Can be 'list' or 'grid'

194 APP_VIEWS_BOOKS=list

195 APP_VIEWS_BOOKSHELVES=grid

196

197 # Page revision limit

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

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

200 REVISION_LIMIT=50

201

202 # Allow <script> tags in page content

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

204 ALLOW_CONTENT_SCRIPTS=false

205

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

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

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

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

210 ALLOW_ROBOTS=null

211