add language

conf/config.yml

@@ -3,21 +3,34 @@ 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: "__SECRET__"
+  # 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 
+  # the long param set, the token returned will be valid for this period.
+  # The default is 2592000 seconds (30 Days).
+  jwtttllong: 2592000
   # The interface on which to run the webserver
   interface: ":__PORT__"
+  # Path to Unix socket. If set, it will be created and used instead of tcp
+  unixsocket:
+  # Permission bits for the Unix socket. Note that octal values must be prefixed by "0o", e.g. 0o660
+  unixsocketmode:
   # The URL of the frontend, used to send password reset emails.
   frontendurl: "https://__DOMAIN__"
   # The base path on the file system where the binary and assets are.
   # Vikunja will also look in this path for a config file, so you could provide only this variable to point to a folder
   # with a config file which will then be used.
   rootpath: "/opt/vikunja/"
+  # Path on the file system to serve static files from. Set to the path of the frontend files to host frontend alongside the api.
+  staticpath: ""
   # The max number of items which can be returned per page
   maxitemsperpage: __MAXITEMSPERPAGE__
   # Enable the caldav endpoint, see the docs for more details
   enablecaldav: true
   # Set the motd message, available from the /info endpoint
-  motd: __SET_MOTD__
+  motd: "__SET_MOTD__"
-  # Enable sharing of lists via a link
+  # Enable sharing of project via a link
   enablelinksharing: __ENABLE_LINKSHARING__
   # Whether to let new users registering themselves or not
   enableregistration: __ENABLE_REGISTRATION__
@@ -33,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: <token>` header with the token from below. <br/>
+  # each request made to this endpoint needs to provide an `Authorization: <token>` header with the token from below. <br/>
   # **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
@@ -46,6 +59,9 @@ service:
   # The maximum size clients will be able to request for user avatars.
   # If clients request a size bigger than this, it will be changed on the fly.
   maxavatarsize: __MAXAVATARSIZE__
+  # If set to true, the frontend will show a big red warning not to use this instance for real data as it will be cleared out.
+  # You probably don't need to set this value, it was created specifically for usage on [try](https://try.vikunja.io).
+  demomode: false
 
 database:
   # Database type to use. Supported types are mysql, postgres and sqlite.
@@ -64,37 +80,45 @@ 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)
   sslmode: disable
+  # The path to the client cert. Only used with postgres.
+  #sslcert: ""
+  # The path to the client key. Only used with postgres.
+  #sslkey: ""
+  # The path to the ca cert. Only used with postgres.
+  sslrootcert: ""
   # Enable SSL/TLS for mysql connections. Options: false, true, skip-verify, preferred
   tls: false
 
-cache:
+typesense:
-  # If cache is enabled or not
+  # Whether to enable the Typesense integration. If true, all tasks will be synced to the configured Typesense
-  enabled: true
+  # instance and all search and filtering will run through Typesense instead of only through the database.
-  # Cache type. Possible values are "keyvalue", "memory" or "redis".
+  # Typesense allows fast fulltext search including fuzzy matching support. It may return different results than 
-  # When choosing "keyvalue" this setting follows the one configured in the "keyvalue" section.
+  # what you'd get with a database-only search.
-  # When choosing "redis" you will need to configure the redis connection seperately.
+  enabled: false
-  type: redis
+  # The url to the Typesense instance you want to use. Can be hosted locally or in Typesense Cloud as long
-  # When using memory this defines the maximum size an element can take
+  # as Vikunja is able to reach it.
-  maxelementsize: 1000
+  url: ''
+  # The Typesense API key you want to use.
+  apikey: ''
 
 redis:
   # Whether to enable redis or not
   enabled: true
   # 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: __REDIS_DB__
+  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.
@@ -108,8 +132,11 @@ mailer:
   enabled: true
   # SMTP Host
   host: "localhost"
-  # SMTP Host port
+  # SMTP Host port.
+  # **NOTE:** If you're unable to send mail and the only error you see in the logs is an `EOF`, try setting the port to `25`.
   port: 25
+  # SMTP Auth Type. Can be either `plain`, `login` or `cram-md5`.
+  authtype: "plain"
   # SMTP username
   username: ""
   # SMTP password
@@ -117,7 +144,7 @@ mailer:
   # Wether to skip verification of the tls certificate on the server
   skiptlsverify: true
   # The default from address when sending emails
-  fromemail: "vikunja@__DOMAIN__"
+  fromemail: "mail@__DOMAIN__"
   # The length of the mail queue.
   queuelength: 100
   # The timeout in seconds after which the current open connection to the mailserver will be closed.
@@ -140,12 +167,16 @@ log:
   databaselevel: "WARNING"
   # Whether to log http requests or not. Possible values are stdout, stderr, file or off to disable http logging.
   http: "stdout"
-  # 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 unnecessary, which is why it is disabled by default. Possible values are stdout, stderr, file or off to disable standard logging.
   echo: "off"
   # Whether or not to log events. Useful for debugging. Possible values are stdout, stderr, file or off to disable events logging.
-  events: "stdout"
+  events: "off"
   # The log level for event log messages. Possible values (case-insensitive) are ERROR, INFO, DEBUG.
   eventslevel: "info"
+  # Whether or not to log mail log messages. This will not log mail contents. Possible values are stdout, stderr, file or off to disable mail-related logging.
+  mail: "off"
+  # The log level for mail log messages. Possible values (case-insensitive) are ERROR, WARNING, INFO, DEBUG.
+  maillevel: "info"
 
 ratelimit:
   # whether or not to enable the rate limit
@@ -169,21 +200,6 @@ files:
   maxsize: 20MB
 
 migration:
-  # These are the settings for the wunderlist migrator
-  wunderlist:
-    # Wheter to enable the wunderlist migrator or not
-    enable: false
-    # The client id, required for making requests to the wunderlist api
-    # You need to register your vikunja instance at https://developer.wunderlist.com/apps/new to get this
-    clientid:
-    # The client secret, also required for making requests to the wunderlist api
-    clientsecret:
-    # The url where clients are redirected after they authorized Vikunja to access their wunderlist stuff.
-    # This needs to match the url you entered when registering your Vikunja instance at wunderlist.
-    # This is usually the frontend url where the frontend then makes a request to /migration/wunderlist/migrate
-    # with the code obtained from the wunderlist api.
-    # Note that the vikunja frontend expects this to be /migrate/wunderlist
-    redirecturl:
   todoist:
     # Wheter to enable the todoist migrator or not
     enable: false
@@ -197,9 +213,9 @@ migration:
     # This is usually the frontend url where the frontend then makes a request to /migration/todoist/migrate
     # with the code obtained from the todoist api.
     # Note that the vikunja frontend expects this to be /migrate/todoist
-    redirecturl:
+    redirecturl: <frontend url>/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
@@ -215,7 +231,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:
@@ -231,14 +247,14 @@ avatar:
   gravatarexpiration: 3600
 
 backgrounds:
-  # Whether to enable backgrounds for lists at all.
+  # Whether to enable backgrounds for projects at all.
   enabled: true
   providers:
     upload:
-      # Whethere to enable uploaded list backgrounds
+      # Whether to enable uploaded project backgrounds
       enabled: true
     unsplash:
-      # Whether to enable setting backgrounds from unsplash as list backgrounds
+      # Whether to enable setting backgrounds from unsplash as project backgrounds
       enabled: false
       # You need to create an application for your installation at https://unsplash.com/oauth/applications/new
       # and set the access token below.
@@ -258,7 +274,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:
@@ -273,13 +289,15 @@ 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 <frontend-url>/auth/openid/<auth key>. 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
     enabled: false
     # The url to redirect clients to. Defaults to the configured frontend url. If you're using Vikunja with the official
     # frontend, you don't need to change this value.
+    # **Note:** The redirect url must exactly match the configured redirect url with the third party provider.
+    # This includes all slashes at the end or protocols.
     redirecturl: <frontend url>
     # A list of enabled providers
     providers:
@@ -287,6 +305,9 @@ auth:
       - name:
         # The auth url to send users to if they want to authenticate using OpenID Connect.
         authurl:
+        # The oidc logouturl that users will be redirected to on logout.
+        # Leave empty or delete key, if you do not want to be redirected.
+        logouturl:
         # The client ID used to authenticate Vikunja at the OpenID Connect provider.
         clientid:
         # The client secret used to authenticate Vikunja at the OpenID Connect provider.
@@ -294,9 +315,34 @@ auth:
 
 # Prometheus metrics endpoint
 metrics:
-  # If set to true, enables a /metrics endpoint for prometheus to collect metrics about Vikunja.
+  # If set to true, enables a /metrics endpoint for prometheus to collect metrics about Vikunja. You can query it from `/api/v1/metrics`.
   enabled: false
   # 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.
   username:
   # 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.
   password:
+
+# Provide default settings for new users. When a new user is created, these settings will automatically be set for the user. If you change them in the config file afterwards they will not be changed back for existing users.
+defaultsettings:
+  # The avatar source for the user. Can be `gravatar`, `initials`, `upload` or `marble`. If you set this to `upload` you'll also need to specify `defaultsettings.avatar_file_id`.
+  avatar_provider: initials
+  # The id of the file used as avatar.
+  avatar_file_id: 0
+  # If set to true users will get task reminders via email.
+  email_reminders_enabled: false
+  # If set to true will allow other users to find this user when searching for parts of their name.
+  discoverable_by_name: false
+  # If set to true will allow other users to find this user when searching for their exact email.
+  discoverable_by_email: false
+  # If set to true will send an email every day with all overdue tasks at a configured time.
+  overdue_tasks_reminders_enabled: true
+  # When to send the overdue task reminder email.
+  overdue_tasks_reminders_time: 9:00
+  # The id of the default project. Make sure users actually have access to this project when setting this value.
+  default_project_id: 0
+  # Start of the week for the user. `0` is sunday, `1` is monday and so on.
+  week_start: 1
+  # The language of the user interface. Must be an ISO 639-1 language code. Will default to the browser language the user uses when signing up.
+  language: __LANGUAGE__
+  # The time zone of each individual user. This will affect when users get reminders and overdue task emails.
+  timezone: <time zone set at service.timezone>

manifest.toml

@@ -36,6 +36,13 @@ ram.runtime = "50M"
     type = "group"
     default = "visitors"
 
+    [install.language]
+    ask.en = "Choose the application language"
+    ask.fr = "Choisissez la langue de l'application"
+    type = "select"
+    choices = ["de", "en", "es", "fa", "fr", "it", "lt", "nl", "pl", "pt"]
+    default = "fr"
+
 [resources]
 
     [resources.sources]

scripts/upgrade

@@ -78,6 +78,11 @@ if [ -z "${maxitemsperpage:-}" ]; then
 	ynh_app_setting_set --app=$app --key=maxitemsperpage --value=$maxitemsperpage
 fi
 
+if [ -z "${language:-}" ]; then
+	language=en
+	ynh_app_setting_set --app=$app --key=language --value=$language
+fi
+
 #=================================================
 # STANDARD UPGRADE STEPS
 #=================================================