local-it/vikunja-api
0
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Show config full paths and env variables with config options

Browse source
This commit is contained in:
kolaente 2021-08-11 18:20:34 +02:00
parent 1fbd9b67e0
commit 77c2b77079
No known key found for this signature in database
GPG key ID: F40E70337AB24C9B
2 changed files with 433 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

417
docs/content/doc/setup/config.md
View file

@ -74,18 +74,55 @@ Default is a random token which will be generated at each startup of vikunja.
Default: `<jwt-secret>` Default: `<jwt-secret>`
Full path: `service.JWTSecret`
Environment path: `VIKUNJA_SERVICE_JWT_SECRET`
### interface ### interface
The interface on which to run the webserver The interface on which to run the webserver
Default: `:3456` Default: `:3456`
Full path: `service.interface`
Environment path: `VIKUNJA_SERVICE_INTERFACE`
### unixsocket
Path to Unix socket. If set, it will be created and used instead of tcp
Default: `<empty>`
Full path: `service.unixsocket`
Environment path: `VIKUNJA_SERVICE_UNIXSOCKET`
### unixsocketmode
Permission bits for the Unix socket. Note that octal values must be prefixed by "0o", e.g. 0o660
Default: `<empty>`
Full path: `service.unixsocketmode`
Environment path: `VIKUNJA_SERVICE_UNIXSOCKETMODE`
### frontendurl ### frontendurl
The URL of the frontend, used to send password reset emails. The URL of the frontend, used to send password reset emails.
Default: `<empty>` Default: `<empty>`
Full path: `service.frontendurl`
Environment path: `VIKUNJA_SERVICE_FRONTENDURL`
### rootpath ### rootpath
The base path on the file system where the binary and assets are. The base path on the file system where the binary and assets are.
@ -94,66 +131,121 @@ with a config file which will then be used.
Default: `<rootpath>` Default: `<rootpath>`
Full path: `service.rootpath`
Environment path: `VIKUNJA_SERVICE_ROOTPATH`
### maxitemsperpage ### maxitemsperpage
The max number of items which can be returned per page The max number of items which can be returned per page
Default: `50` Default: `50`
Full path: `service.maxitemsperpage`
Environment path: `VIKUNJA_SERVICE_MAXITEMSPERPAGE`
### enablecaldav ### enablecaldav
Enable the caldav endpoint, see the docs for more details Enable the caldav endpoint, see the docs for more details
Default: `true` Default: `true`
Full path: `service.enablecaldav`
Environment path: `VIKUNJA_SERVICE_ENABLECALDAV`
### motd ### motd
Set the motd message, available from the /info endpoint Set the motd message, available from the /info endpoint
Default: `<empty>` Default: `<empty>`
Full path: `service.motd`
Environment path: `VIKUNJA_SERVICE_MOTD`
### enablelinksharing ### enablelinksharing
Enable sharing of lists via a link Enable sharing of lists via a link
Default: `true` Default: `true`
Full path: `service.enablelinksharing`
Environment path: `VIKUNJA_SERVICE_ENABLELINKSHARING`
### enableregistration ### enableregistration
Whether to let new users registering themselves or not Whether to let new users registering themselves or not
Default: `true` Default: `true`
Full path: `service.enableregistration`
Environment path: `VIKUNJA_SERVICE_ENABLEREGISTRATION`
### enabletaskattachments ### enabletaskattachments
Whether to enable task attachments or not Whether to enable task attachments or not
Default: `true` Default: `true`
Full path: `service.enabletaskattachments`
Environment path: `VIKUNJA_SERVICE_ENABLETASKATTACHMENTS`
### timezone ### timezone
The time zone all timestamps are in. Please note that time zones have to use [the official tz database names](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). UTC or GMT offsets won't work. The time zone all timestamps are in. Please note that time zones have to use [the official tz database names](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). UTC or GMT offsets won't work.
Default: `GMT` Default: `GMT`
Full path: `service.timezone`
Environment path: `VIKUNJA_SERVICE_TIMEZONE`
### enabletaskcomments ### enabletaskcomments
Whether task comments should be enabled or not Whether task comments should be enabled or not
Default: `true` Default: `true`
Full path: `service.enabletaskcomments`
Environment path: `VIKUNJA_SERVICE_ENABLETASKCOMMENTS`
### enabletotp ### enabletotp
Whether totp is enabled. In most cases you want to leave that enabled. Whether totp is enabled. In most cases you want to leave that enabled.
Default: `true` Default: `true`
Full path: `service.enabletotp`
Environment path: `VIKUNJA_SERVICE_ENABLETOTP`
### sentrydsn ### sentrydsn
If not empty, enables logging of crashes and unhandled errors in sentry. If not empty, enables logging of crashes and unhandled errors in sentry.
Default: `<empty>` Default: `<empty>`
Full path: `service.sentrydsn`
Environment path: `VIKUNJA_SERVICE_SENTRYDSN`
### testingtoken ### testingtoken
If not empty, this will enable `/test/{table}` endpoints which allow to put any content in the database. If not empty, this will enable `/test/{table}` endpoints which allow to put any content in the database.
@ -163,6 +255,11 @@ each request made to this endpoint neefs to provide an `Authorization: <token>`
Default: `<empty>` Default: `<empty>`
Full path: `service.testingtoken`
Environment path: `VIKUNJA_SERVICE_TESTINGTOKEN`
### enableemailreminders ### enableemailreminders
If enabled, vikunja will send an email to everyone who is either assigned to a task or created it when a task reminder If enabled, vikunja will send an email to everyone who is either assigned to a task or created it when a task reminder
@ -170,6 +267,11 @@ is due.
Default: `true` Default: `true`
Full path: `service.enableemailreminders`
Environment path: `VIKUNJA_SERVICE_ENABLEEMAILREMINDERS`
--- ---
## database ## database
@ -182,54 +284,99 @@ Database type to use. Supported types are mysql, postgres and sqlite.
Default: `sqlite` Default: `sqlite`
Full path: `database.type`
Environment path: `VIKUNJA_DATABASE_TYPE`
### user ### user
Database user which is used to connect to the database. Database user which is used to connect to the database.
Default: `vikunja` Default: `vikunja`
Full path: `database.user`
Environment path: `VIKUNJA_DATABASE_USER`
### password ### password
Databse password Databse password
Default: `<empty>` Default: `<empty>`
Full path: `database.password`
Environment path: `VIKUNJA_DATABASE_PASSWORD`
### host ### host
Databse host Databse host
Default: `localhost` Default: `localhost`
Full path: `database.host`
Environment path: `VIKUNJA_DATABASE_HOST`
### database ### database
Databse to use Databse to use
Default: `vikunja` Default: `vikunja`
Full path: `database.database`
Environment path: `VIKUNJA_DATABASE_DATABASE`
### path ### path
When using sqlite, this is the path where to store the data When using sqlite, this is the path where to store the data
Default: `./vikunja.db` Default: `./vikunja.db`
Full path: `database.path`
Environment path: `VIKUNJA_DATABASE_PATH`
### maxopenconnections ### maxopenconnections
Sets the max open connections to the database. Only used when using mysql and postgres. Sets the max open connections to the database. Only used when using mysql and postgres.
Default: `100` Default: `100`
Full path: `database.maxopenconnections`
Environment path: `VIKUNJA_DATABASE_MAXOPENCONNECTIONS`
### maxidleconnections ### maxidleconnections
Sets the maximum number of idle connections to the db. Sets the maximum number of idle connections to the db.
Default: `50` Default: `50`
Full path: `database.maxidleconnections`
Environment path: `VIKUNJA_DATABASE_MAXIDLECONNECTIONS`
### maxconnectionlifetime ### maxconnectionlifetime
The maximum lifetime of a single db connection in miliseconds. The maximum lifetime of a single db connection in miliseconds.
Default: `10000` Default: `10000`
Full path: `database.maxconnectionlifetime`
Environment path: `VIKUNJA_DATABASE_MAXCONNECTIONLIFETIME`
### sslmode ### sslmode
Secure connection mode. Only used with postgres. Secure connection mode. Only used with postgres.
@ -237,12 +384,22 @@ Secure connection mode. Only used with postgres.
Default: `disable` Default: `disable`
Full path: `database.sslmode`
Environment path: `VIKUNJA_DATABASE_SSLMODE`
### tls ### tls
Enable SSL/TLS for mysql connections. Options: false, true, skip-verify, preferred Enable SSL/TLS for mysql connections. Options: false, true, skip-verify, preferred
Default: `false` Default: `false`
Full path: `database.tls`
Environment path: `VIKUNJA_DATABASE_TLS`
--- ---
## cache ## cache
@ -255,6 +412,11 @@ If cache is enabled or not
Default: `false` Default: `false`
Full path: `cache.enabled`
Environment path: `VIKUNJA_CACHE_ENABLED`
### type ### type
Cache type. Possible values are "keyvalue", "memory" or "redis". Cache type. Possible values are "keyvalue", "memory" or "redis".
@ -263,12 +425,22 @@ When choosing "redis" you will need to configure the redis connection seperately
Default: `keyvalue` Default: `keyvalue`
Full path: `cache.type`
Environment path: `VIKUNJA_CACHE_TYPE`
### maxelementsize ### maxelementsize
When using memory this defines the maximum size an element can take When using memory this defines the maximum size an element can take
Default: `1000` Default: `1000`
Full path: `cache.maxelementsize`
Environment path: `VIKUNJA_CACHE_MAXELEMENTSIZE`
--- ---
## redis ## redis
@ -281,24 +453,44 @@ Whether to enable redis or not
Default: `false` Default: `false`
Full path: `redis.enabled`
Environment path: `VIKUNJA_REDIS_ENABLED`
### host ### host
The host of the redis server including its port. The host of the redis server including its port.
Default: `localhost:6379` Default: `localhost:6379`
Full path: `redis.host`
Environment path: `VIKUNJA_REDIS_HOST`
### password ### password
The password used to authenicate against the redis server The password used to authenicate against the redis server
Default: `<empty>` Default: `<empty>`
Full path: `redis.password`
Environment path: `VIKUNJA_REDIS_PASSWORD`
### db ### db
0 means default database 0 means default database
Default: `0` Default: `0`
Full path: `redis.db`
Environment path: `VIKUNJA_REDIS_DB`
--- ---
## cors ## cors
@ -313,18 +505,33 @@ Note: If you want to put the frontend and the api on seperate domains or ports,
Default: `true` Default: `true`
Full path: `cors.enable`
Environment path: `VIKUNJA_CORS_ENABLE`
### origins ### origins
A list of origins which may access the api. These need to include the protocol (`http://` or `https://`) and port, if any. A list of origins which may access the api. These need to include the protocol (`http://` or `https://`) and port, if any.
Default: `<empty>` Default: `<empty>`
Full path: `cors.origins`
Environment path: `VIKUNJA_CORS_ORIGINS`
### maxage ### maxage
How long (in seconds) the results of a preflight request can be cached. How long (in seconds) the results of a preflight request can be cached.
Default: `0` Default: `0`
Full path: `cors.maxage`
Environment path: `VIKUNJA_CORS_MAXAGE`
--- ---
## mailer ## mailer
@ -337,60 +544,110 @@ Whether to enable the mailer or not. If it is disabled, all users are enabled ri
Default: `false` Default: `false`
Full path: `mailer.enabled`
Environment path: `VIKUNJA_MAILER_ENABLED`
### host ### host
SMTP Host SMTP Host
Default: `<empty>` Default: `<empty>`
Full path: `mailer.host`
Environment path: `VIKUNJA_MAILER_HOST`
### port ### port
SMTP Host port SMTP Host port
Default: `587` Default: `587`
Full path: `mailer.port`
Environment path: `VIKUNJA_MAILER_PORT`
### username ### username
SMTP username SMTP username
Default: `user` Default: `user`
Full path: `mailer.username`
Environment path: `VIKUNJA_MAILER_USERNAME`
### password ### password
SMTP password SMTP password
Default: `<empty>` Default: `<empty>`
Full path: `mailer.password`
Environment path: `VIKUNJA_MAILER_PASSWORD`
### skiptlsverify ### skiptlsverify
Wether to skip verification of the tls certificate on the server Wether to skip verification of the tls certificate on the server
Default: `false` Default: `false`
Full path: `mailer.skiptlsverify`
Environment path: `VIKUNJA_MAILER_SKIPTLSVERIFY`
### fromemail ### fromemail
The default from address when sending emails The default from address when sending emails
Default: `mail@vikunja` Default: `mail@vikunja`
Full path: `mailer.fromemail`
Environment path: `VIKUNJA_MAILER_FROMEMAIL`
### queuelength ### queuelength
The length of the mail queue. The length of the mail queue.
Default: `100` Default: `100`
Full path: `mailer.queuelength`
Environment path: `VIKUNJA_MAILER_QUEUELENGTH`
### queuetimeout ### queuetimeout
The timeout in seconds after which the current open connection to the mailserver will be closed. The timeout in seconds after which the current open connection to the mailserver will be closed.
Default: `30` Default: `30`
Full path: `mailer.queuetimeout`
Environment path: `VIKUNJA_MAILER_QUEUETIMEOUT`
### forcessl ### forcessl
By default, vikunja will try to connect with starttls, use this option to force it to use ssl. By default, vikunja will try to connect with starttls, use this option to force it to use ssl.
Default: `false` Default: `false`
Full path: `mailer.forcessl`
Environment path: `VIKUNJA_MAILER_FORCESSL`
--- ---
## log ## log
@ -403,60 +660,110 @@ A folder where all the logfiles should go.
Default: `<rootpath>logs` Default: `<rootpath>logs`
Full path: `log.path`
Environment path: `VIKUNJA_LOG_PATH`
### enabled ### enabled
Whether to show any logging at all or none Whether to show any logging at all or none
Default: `true` Default: `true`
Full path: `log.enabled`
Environment path: `VIKUNJA_LOG_ENABLED`
### standard ### standard
Where the normal log should go. Possible values are stdout, stderr, file or off to disable standard logging. Where the normal log should go. Possible values are stdout, stderr, file or off to disable standard logging.
Default: `stdout` Default: `stdout`
Full path: `log.standard`
Environment path: `VIKUNJA_LOG_STANDARD`
### level ### level
Change the log level. Possible values (case-insensitive) are CRITICAL, ERROR, WARNING, NOTICE, INFO, DEBUG. Change the log level. Possible values (case-insensitive) are CRITICAL, ERROR, WARNING, NOTICE, INFO, DEBUG.
Default: `INFO` Default: `INFO`
Full path: `log.level`
Environment path: `VIKUNJA_LOG_LEVEL`
### database ### database
Whether or not to log database queries. Useful for debugging. Possible values are stdout, stderr, file or off to disable database logging. Whether or not to log database queries. Useful for debugging. Possible values are stdout, stderr, file or off to disable database logging.
Default: `off` Default: `off`
Full path: `log.database`
Environment path: `VIKUNJA_LOG_DATABASE`
### databaselevel ### databaselevel
The log level for database log messages. Possible values (case-insensitive) are CRITICAL, ERROR, WARNING, NOTICE, INFO, DEBUG. The log level for database log messages. Possible values (case-insensitive) are CRITICAL, ERROR, WARNING, NOTICE, INFO, DEBUG.
Default: `WARNING` Default: `WARNING`
Full path: `log.databaselevel`
Environment path: `VIKUNJA_LOG_DATABASELEVEL`
### http ### http
Whether to log http requests or not. Possible values are stdout, stderr, file or off to disable http logging. Whether to log http requests or not. Possible values are stdout, stderr, file or off to disable http logging.
Default: `stdout` Default: `stdout`
Full path: `log.http`
Environment path: `VIKUNJA_LOG_HTTP`
### echo ### echo
Echo has its own logging which usually is unnessecary, which is why it is disabled by default. Possible values are stdout, stderr, file or off to disable standard logging. Echo has its own logging which usually is unnessecary, which is why it is disabled by default. Possible values are stdout, stderr, file or off to disable standard logging.
Default: `off` Default: `off`
Full path: `log.echo`
Environment path: `VIKUNJA_LOG_ECHO`
### events ### events
Whether or not to log events. Useful for debugging. Possible values are stdout, stderr, file or off to disable events logging. Whether or not to log events. Useful for debugging. Possible values are stdout, stderr, file or off to disable events logging.
Default: `stdout` Default: `stdout`
Full path: `log.events`
Environment path: `VIKUNJA_LOG_EVENTS`
### eventslevel ### eventslevel
The log level for event log messages. Possible values (case-insensitive) are ERROR, INFO, DEBUG. The log level for event log messages. Possible values (case-insensitive) are ERROR, INFO, DEBUG.
Default: `info` Default: `info`
Full path: `log.eventslevel`
Environment path: `VIKUNJA_LOG_EVENTSLEVEL`
--- ---
## ratelimit ## ratelimit
@ -469,24 +776,44 @@ whether or not to enable the rate limit
Default: `false` Default: `false`
Full path: `ratelimit.enabled`
Environment path: `VIKUNJA_RATELIMIT_ENABLED`
### kind ### kind
The kind on which rates are based. Can be either "user" for a rate limit per user or "ip" for an ip-based rate limit. The kind on which rates are based. Can be either "user" for a rate limit per user or "ip" for an ip-based rate limit.
Default: `user` Default: `user`
Full path: `ratelimit.kind`
Environment path: `VIKUNJA_RATELIMIT_KIND`
### period ### period
The time period in seconds for the limit The time period in seconds for the limit
Default: `60` Default: `60`
Full path: `ratelimit.period`
Environment path: `VIKUNJA_RATELIMIT_PERIOD`
### limit ### limit
The max number of requests a user is allowed to do in the configured time period The max number of requests a user is allowed to do in the configured time period
Default: `100` Default: `100`
Full path: `ratelimit.limit`
Environment path: `VIKUNJA_RATELIMIT_LIMIT`
### store ### store
The store where the limit counter for each user is stored. The store where the limit counter for each user is stored.
@ -495,6 +822,11 @@ When choosing "keyvalue" this setting follows the one configured in the "keyvalu
Default: `keyvalue` Default: `keyvalue`
Full path: `ratelimit.store`
Environment path: `VIKUNJA_RATELIMIT_STORE`
--- ---
## files ## files
@ -507,6 +839,11 @@ The path where files are stored
Default: `./files` Default: `./files`
Full path: `files.basepath`
Environment path: `VIKUNJA_FILES_BASEPATH`
### maxsize ### maxsize
The maximum size of a file, as a human-readable string. The maximum size of a file, as a human-readable string.
@ -514,6 +851,11 @@ Warning: The max size is limited 2^64-1 bytes due to the underlying datatype
Default: `20MB` Default: `20MB`
Full path: `files.maxsize`
Environment path: `VIKUNJA_FILES_MAXSIZE`
--- ---
## migration ## migration
@ -526,18 +868,38 @@ These are the settings for the wunderlist migrator
Default: `<empty>` Default: `<empty>`
Full path: `migration.wunderlist`
Environment path: `VIKUNJA_MIGRATION_WUNDERLIST`
### todoist ### todoist
Default: `<empty>` Default: `<empty>`
Full path: `migration.todoist`
Environment path: `VIKUNJA_MIGRATION_TODOIST`
### trello ### trello
Default: `<empty>` Default: `<empty>`
Full path: `migration.trello`
Environment path: `VIKUNJA_MIGRATION_TRELLO`
### microsofttodo ### microsofttodo
Default: `<empty>` Default: `<empty>`
Full path: `migration.microsofttodo`
Environment path: `VIKUNJA_MIGRATION_MICROSOFTTODO`
--- ---
## avatar ## avatar
@ -550,6 +912,11 @@ When using gravatar, this is the duration in seconds until a cached gravatar use
Default: `3600` Default: `3600`
Full path: `avatar.gravatarexpiration`
Environment path: `VIKUNJA_AVATAR_GRAVATAREXPIRATION`
--- ---
## backgrounds ## backgrounds
@ -562,10 +929,20 @@ Whether to enable backgrounds for lists at all.
Default: `true` Default: `true`
Full path: `backgrounds.enabled`
Environment path: `VIKUNJA_BACKGROUNDS_ENABLED`
### providers ### providers
Default: `<empty>` Default: `<empty>`
Full path: `backgrounds.providers`
Environment path: `VIKUNJA_BACKGROUNDS_PROVIDERS`
--- ---
## legal ## legal
@ -579,10 +956,20 @@ Will be shown in the frontend if configured here
Default: `<empty>` Default: `<empty>`
Full path: `legal.imprinturl`
Environment path: `VIKUNJA_LEGAL_IMPRINTURL`
### privacyurl ### privacyurl
Default: `<empty>` Default: `<empty>`
Full path: `legal.privacyurl`
Environment path: `VIKUNJA_LEGAL_PRIVACYURL`
--- ---
## keyvalue ## keyvalue
@ -598,6 +985,11 @@ The type of the storage backend. Can be either "memory" or "redis". If "redis" i
Default: `memory` Default: `memory`
Full path: `keyvalue.type`
Environment path: `VIKUNJA_KEYVALUE_TYPE`
--- ---
## auth ## auth
@ -611,6 +1003,11 @@ This is the default auth mechanism and does not require any additional configura
Default: `<empty>` Default: `<empty>`
Full path: `auth.local`
Environment path: `VIKUNJA_AUTH_LOCAL`
### openid ### openid
OpenID configuration will allow users to authenticate through a third-party OpenID Connect compatible provider.<br/> OpenID configuration will allow users to authenticate through a third-party OpenID Connect compatible provider.<br/>
@ -624,6 +1021,11 @@ Take a look at the [default config file](https://kolaente.dev/vikunja/api/src/br
Default: `<empty>` Default: `<empty>`
Full path: `auth.openid`
Environment path: `VIKUNJA_AUTH_OPENID`
--- ---
## metrics ## metrics
@ -638,15 +1040,30 @@ If set to true, enables a /metrics endpoint for prometheus to collect metrics ab
Default: `false` Default: `false`
Full path: `metrics.enabled`
Environment path: `VIKUNJA_METRICS_ENABLED`
### username ### username
If set to a non-empty value the /metrics endpoint will require this as a username via basic auth in combination with the password below. If set to a non-empty value the /metrics endpoint will require this as a username via basic auth in combination with the password below.
Default: `<empty>` Default: `<empty>`
Full path: `metrics.username`
Environment path: `VIKUNJA_METRICS_USERNAME`
### password ### password
If set to a non-empty value the /metrics endpoint will require this as a password via basic auth in combination with the username below. If set to a non-empty value the /metrics endpoint will require this as a password via basic auth in combination with the username below.
Default: `<empty>` Default: `<empty>`
Full path: `metrics.password`
Environment path: `VIKUNJA_METRICS_PASSWORD`

20
magefile.go
View file

@ -995,13 +995,20 @@ func parseYamlConfigNode(node *yaml.Node) (config *configOption) {
return config return config
} }
func printConfig(config []*configOption, level int) (rendered string) { func printConfig(config []*configOption, level int, parent string) (rendered string) {
// Keep track of what we already printed to prevent printing things twice // Keep track of what we already printed to prevent printing things twice
printed := make(map[string]bool) printed := make(map[string]bool)
for _, option := range config { for _, option := range config {
// FIXME: Not a good solution. Ideally this would work without the level check, but since generating config
// for more than two levels is currently broken anyway, I'll fix this after moving the config generation
// to a better format than yaml.
if level == 0 && option.key != "" {
parent = option.key
}
if option.key != "" { if option.key != "" {
// Filter out all config objects where the default value == key // Filter out all config objects where the default value == key
@ -1030,12 +1037,17 @@ func printConfig(config []*configOption, level int) (rendered string) {
if option.defaultValue == "" { if option.defaultValue == "" {
rendered += "<empty>" rendered += "<empty>"
} }
rendered += "`\n" rendered += "`\n\n"
fullPath := parent + "." + option.key
rendered += "Full path: `" + fullPath + "`\n\n"
rendered += "Environment path: `VIKUNJA_" + strcase.ToScreamingSnake(fullPath) + "`\n\n"
} }
} }
printed[option.key] = true printed[option.key] = true
rendered += "\n" + printConfig(option.children, level+1) rendered += "\n" + printConfig(option.children, level+1, parent)
} }
return return
@ -1069,7 +1081,7 @@ func GenerateDocs() error {
} }
} }
renderedConfig := printConfig(conf, 0) renderedConfig := printConfig(conf, 0, "")
// Rebuild the config // Rebuild the config
file, err := os.OpenFile(configDocPath, os.O_RDWR, 0) file, err := os.OpenFile(configDocPath, os.O_RDWR, 0)