| Key | Description | Examples | Default |
|---|---|---|---|
config.site.display_name |
When displaying to the user, this is the name of the api | Open Booru, Gelbooru |
Open Booru |
config.site.hostname |
The hostname to use when providing links | localhost, api.openbooru.org |
localhost |
config.site.post |
The port to host the api on | 443, 8080 |
8080 |
config.ssl.enabled |
Make use of https? | localhost, api.openbooru.org |
false |
config.ssl.key |
The path to the ssl key file | ~/server.key, ./data/server.key |
./data/server.key |
config.ssl.cert |
The path to the ssl cert file | ~/server.crt, ./data/server.crt |
./data/server.crt |
config.hcaptcha.enabled |
Should hcaptcha be required for verified endpoints | false, true |
false |
config.hcaptcha.sitekey |
The hcaptcha sitekey | ffffffff-... |
|
config.hcaptcha.secret |
The hcaptcha secret | 0xff... |
|
config.aws.id |
Your AWS access key ID | FFFFFFFFFFFFFFFFFFFF |
|
config.aws.secret |
Your AWS secret key | ffff.../ffff... |
|
config.aws.region |
The AWS region to use | eu-west-2 |
|
config.mongodb.hostname |
The hostname of the mongodb server | localhost |
localhost |
config.mongodb.port |
The port of the mongodb server | 27017 |
27017 |
config.mongodb.name |
What database name to use in mongodb | openbooru |
openbooru |
config.mongodb.username |
The username to login into the database with | username |
|
config.mongodb.password |
The password to login into the database with | password |
|
config.wipe_on_startup |
Wipe all the databases on startup, useful for testing | false, true |
false |
email.template_paths.email_verification |
The email template used in account signup to verify a user owns an account | ./data/emails/email_verification.html |
./data/emails/email_verification.html |
email.template_paths.password_reset |
The email template used to reset a user's password | ./data/emails/password_reset.html |
./data/emails/password_reset.html |
posts.search.default_sort |
The default sort method if none is specified | id, created_at, views, upvotes |
created_at |
posts.search.max_limit |
Max number of results users a user gets per search | 100, 200 |
100 |
tags.minimum_count |
Minumum count for the tag before it has an entry created | 0, 20 |
5 |
tags.time_between_regenerations |
How often should the server regenerate the tag counts and namespaces in seconds | 3600, 86400 |
86400 |
tags.tagging_service.enabled |
Should the server make use of an AI tagging service such as deep danbooru or hydrus-dd | null, http://localhost:4443 |
null |
tags.tagging_service.url |
The url for the tagging service to be used | null, http://localhost:4443 |
null |
importers.local.enabled |
Import a set of local images. To import tags, have a file with the same name as image ending in .txt. Each tag should be on a new line. |
true,false |
false |
importers.local.local_path |
Where are the local images located? | ~/import, ./data/import |
./data/import |
importers.hydrus.enabled |
Should posts be imported from hydrus | false, true |
false |
importers.hydrus.access_key |
The hydrus access key to be used | fffff... |
|
importers.hydrus.url |
The hydrus endpoint url to be used | http://localhost:45869 |
http://localhost:45869/ |
importers.hydrus.tags |
The tag searches to be used | system:limit is 64 |
system:everything |
importers.safebooru.enabled |
Should you import images from safebooru? | true, false |
true |
importers.safebooru.searches |
What tag searches to perform | overwatch rating:safe |
["asami_sato yuri -bra -bikini",...] |
importers.safebooru.limit |
The maximum number of images to import, null for no limit | 1000, 20, null |
null |
importers.e621.enabled |
Is importing from a e621 dump (e621 api json format) | true, false |
true |
importers.e621.dump_location |
The location the e621 dump is stored | ./data/e621.json |
null |
importers.rule34.enabled |
Is importing from a rule34.xxx dump (rule34.xxx xml format) | true, false |
true |
importers.rule34.dump_location |
The location the rule34 dump is stored | ./data/r34.json |
null |
importers.rule34.proxy_format |
Rule34 requires a CORS proxy to function correctly, a string with {url} included in it should be provided |
http://localhost:8080/{url} |
null |
downloaders.e621.enabled |
Should posts be loaded from e621 | true, false |
false |
downloaders.rule34.enabled |
Should posts be imported from rule34.xxx | true, false |
false |
downloaders.safebooru.enabled |
Should posts be imported from safebooru | true, false |
false |
downloaders.file.enabled |
Should posts be imported from a generic file url | true, false |
false |
downloaders.twitter.enabled |
Should posts be imported from twitter | true, false |
false |
downloaders.twitter.bearer_token |
Your Twitter bearer token | true, false |
false |
downloaders.tubmlr.enabled |
Should posts be imported from tubmlr | true, false |
false |
downloaders.tubmlr.consumer_key |
The consumer key to be used | FFFF... |
|
downloaders.tubmlr.consumer_secret |
The consumer secret to be used | FFFF... |
|
storage.method |
Which method should media be stored with | s3, local |
local |
storage.local.path |
The location to store local files | ./data/storage, ~/store |
./data/storage |
storage.s3.bucket-name |
The bucket name to store media in, MUST BE UNIQUE | openbooru valid-bucket-name |
|
authentication.token_expiration |
The amount of time in seconds before login tokens expire | 86400, null |
null |
authentication.password_policy.min_length |
The minimum acceptable length for a password | 8, 4, 12 |
8 (OWASP recommendation) |
authentication.password_policy.max_length |
The maximum acceptable length for a password (to prevent DOS attacks) | 64, 256 |
128 |
authentication.password_policy.score |
The minimum zxcvbn score, 2 is recommended | 1, 2, 3, 4 |
2 |
You can set settings using enviroment variables. Replace any . in the setting's path with _ and convert to uppercase, this takes priority over the settings config. This is useful when using docker.
Most image settings are in the encoding section share them.
Should the media be webp lossless
Re-encoded webp quality (1-100/lossless)
Default: 80
max width before downscaling
max height before downscaling
The endoing settings for all thumbnails
The full sized image settings
The preview image settings
The full animation settings
The permissions granted to certain users levels, custom levels can be created
| Name | Description |
|---|---|
| canViewUsers | Can view other user's profiles |
| canSearchUsers | Can search for users |
| canEditUsers | Can edit other user's accounts |
| canDeleteUsers | Can delete other user's accounts |
| canCreatePosts | Can create posts |
| canViewPosts | Can view posts |
| canSearchPosts | Can search for posts |
| canEditPosts | Can make edits to posts |
| canDeletePosts | Can delete other people's posts |
| canCreateComments | Can create comments on posts |
| canViewComments | Can view other people's comments on posts |
| canDeleteComments | Can delete other people's comments on posts |
The default user levels are:
- Anonymous
- Anyone can access
- Default for unauthenticated users
- Users
- Anyone with a user account
- Admin
- The site owners or admins