diff --git a/config.yml.sample b/config.yml.sample index 8c59e0c4c..55db80fe5 100644 --- a/config.yml.sample +++ b/config.yml.sample @@ -3,7 +3,7 @@ service: # Default is a random token which will be generated at each startup of vikunja. # (This means all already issued tokens will be invalid once you restart vikunja) JWTSecret: "" - # The duration of the issed JWT tokens in seconds. + # The duration of the issued JWT tokens in seconds. # The default is 259200 seconds (3 Days). jwtttl: 259200 # The duration of the "remember me" time in seconds. When the login request is made with @@ -46,7 +46,7 @@ service: sentrydsn: '' # If not empty, this will enable `/test/{table}` endpoints which allow to put any content in the database. # Used to reset the db before frontend tests. Because this is quite a dangerous feature allowing for lots of harm, - # each request made to this endpoint neefs to provide an `Authorization: ` header with the token from below.
+ # each request made to this endpoint needs to provide an `Authorization: ` header with the token from below.
# **You should never use this unless you know exactly what you're doing** testingtoken: '' # If enabled, vikunja will send an email to everyone who is either assigned to a task or created it when a task reminder @@ -77,7 +77,7 @@ database: maxopenconnections: 100 # Sets the maximum number of idle connections to the db. maxidleconnections: 50 - # The maximum lifetime of a single db connection in miliseconds. + # The maximum lifetime of a single db connection in milliseconds. maxconnectionlifetime: 10000 # Secure connection mode. Only used with postgres. # (see https://pkg.go.dev/github.com/lib/pq?tab=doc#hdr-Connection_String_Parameters) @@ -96,7 +96,7 @@ cache: enabled: false # Cache type. Possible values are "keyvalue", "memory" or "redis". # When choosing "keyvalue" this setting follows the one configured in the "keyvalue" section. - # When choosing "redis" you will need to configure the redis connection seperately. + # When choosing "redis" you will need to configure the redis connection separately. type: keyvalue # When using memory this defines the maximum size an element can take maxelementsize: 1000 @@ -106,14 +106,14 @@ redis: enabled: false # The host of the redis server including its port. host: 'localhost:6379' - # The password used to authenicate against the redis server + # The password used to authenticate against the redis server password: '' # 0 means default database db: 0 cors: # Whether to enable or disable cors headers. - # Note: If you want to put the frontend and the api on seperate domains or ports, you will need to enable this. + # Note: If you want to put the frontend and the api on separate domains or ports, you will need to enable this. # Otherwise the frontend won't be able to make requests to the api through the browser. enable: true # A list of origins which may access the api. These need to include the protocol (`http://` or `https://`) and port, if any. @@ -210,7 +210,7 @@ migration: # Note that the vikunja frontend expects this to be /migrate/todoist redirecturl: /migrate/todoist trello: - # Wheter to enable the trello migrator or not + # Whether to enable the trello migrator or not enable: false # The client id, required for making requests to the trello api # You need to register your vikunja instance at https://trello.com/app-key (log in before you visit that link) to get this @@ -226,7 +226,7 @@ migration: enable: false # The client id, required for making requests to the microsoft graph api # See https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app#register-an-application - # for information about how to register your vikuinja instance. + # for information about how to register your Vikunja instance. clientid: # The client secret, also required for making requests to the microsoft graph api clientsecret: @@ -269,7 +269,7 @@ legal: # Key Value Storage settings # The Key Value Storage is used for different kinds of things like metrics and a few cache systems. keyvalue: - # The type of the storage backend. Can be either "memory" or "redis". If "redis" is chosen it needs to be configured seperately. + # The type of the storage backend. Can be either "memory" or "redis". If "redis" is chosen it needs to be configured separately. type: "memory" auth: @@ -284,7 +284,7 @@ auth: # If the email is not public in those cases, authenticating will fail. # **Note 2:** The frontend expects to be redirected after authentication by the third party # to /auth/openid/. Please make sure to configure the redirect url with your third party - # auth service accordingy if you're using the default vikunja frontend. + # auth service accordingly if you're using the default vikunja frontend. # Take a look at the [default config file](https://kolaente.dev/vikunja/api/src/branch/main/config.yml.sample) for more information about how to configure openid authentication. openid: # Enable or disable OpenID Connect authentication