-[](https://drone1.kolaente.de/vikunja/api)
-[](LICENSE)
-[](https://dl.vikunja.io)
+[](https://drone.kolaente.de/vikunja/api)
+[](LICENSE)
+[](https://dl.vikunja.io)
[](https://hub.docker.com/r/vikunja/api/)
[](https://try.vikunja.io/api/v1/docs)
-[](https://goreportcard.com/report/git.kolaente.de/vikunja/api)
+[](https://goreportcard.com/report/kolaente.dev/vikunja/api)
# Vikunja API
@@ -13,21 +13,20 @@
# Table of contents
+* [Security Reports](#security-reports)
* [Features](#features)
* [Docs](#docs)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
+## Security Reports
+
+If you find any security-related issues you don't want to disclose publicly, please use [the contact information on our website](https://vikunja.io/contact/#security).
+
## Features
-* Create TODO lists with tasks
- * Reminder for tasks
-* Namespaces: A "group" which bundels multiple lists
-* Share lists and namespaces with teams and users with granular permissions
-* Plenty of details for tasks
-
-See [the features page](https://vikunja.io/en/features/) on our website for a more exaustive list or
+See [the features page](https://vikunja.io/features/) on our website for a more exaustive list or
try it on [try.vikunja.io](https://try.vikunja.io)!
## Docs
@@ -35,46 +34,22 @@ try it on [try.vikunja.io](https://try.vikunja.io)!
* [Installing](https://vikunja.io/docs/installing/)
* [Build from source](https://vikunja.io/docs/build-from-sources/)
* [Development setup](https://vikunja.io/docs/development/)
-* [Makefile](https://vikunja.io/docs/makefile/)
+* [Magefile](https://vikunja.io/docs/magefile/)
* [Testing](https://vikunja.io/docs/testing/)
-All docs can be found on [the vikunja home page](https://vikunja.io/docs/).
+All docs can be found on [the Vikunja home page](https://vikunja.io/docs/).
### Roadmap
-> I know, it's still a long way to go. I'm currently working on a lot of "basic" features, the exiting things will come later. Don't worry, they'll come.
+See [the roadmap](https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth) (hosted on Vikunja!) for more!
-* [x] Prioritize tasks
-* [x] Subtasks
-* [x] Repeating tasks
-* [x] Get tasks via caldav
-* [x] Get all your tasks for an interval (day/month/period)
-* [x] Labels for tasks
-* [x] Assign users to tasks
-* [x] Attachments on tasks
-* [x] More sharing features
- * [x] Share with individual users
- * [x] Share via a world-readable link with or without password, like Nextcloud
-* [x] Disable registration, making an instance "invite-only"
-* [ ] SSE to notify multiple clients of updates when something was changed
-* [ ] "Smart Lists" - Create lists based on filters
-* [ ] IMAP-Integration - Send an email to Vikunja to create a new task
-* [ ] Webhooks - Trigger other events when an action is done (like completing a task)
-* [ ] Performace statistics - Get an overview and beautiful charts about what you got done this month
-* [ ] Activity feeds - Get a quick overview about who did what
-* [ ] Bulk-edit multiple tasks at once
-* [ ] Team-efforts - Requiring a task to be marked as done by multiple members until it's done
-* [ ] Global limits for namespaces/lists/tasks
-
-See [our roadmap](https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth) (hosted on Vikunja!) for even more!
-
-* [ ] [Mobile apps](https://code.vikunja.io/app) (seperate repo) *In Progress*
-* [ ] [Webapp](https://code.vikunja.io/frontend) (seperate repo) *In Progress*
+* [ ] [Mobile apps](https://code.vikunja.io/app) (separate repo) *In Progress*
+* [ ] [Webapp](https://code.vikunja.io/frontend) (separate repo) *In Progress*
## Contributing
-Fork -> Push -> Pull-Request. Also see the [dev docs](https://vikunja.io/docs/development/) for more infos.
+Fork -> Push -> Pull-Request. Also see the [dev docs](https://vikunja.io/docs/development/) for more info.
## License
-This project is licensed under the GPLv3 License. See the [LICENSE](LICENSE) file for the full license text.
+This project is licensed under the AGPLv3 License. See the [LICENSE](LICENSE) file for the full license text.
diff --git a/build/after-install.sh b/build/after-install.sh
index 8e0097605..4dc24b15c 100644
--- a/build/after-install.sh
+++ b/build/after-install.sh
@@ -1,5 +1,6 @@
#!/bin/bash
-ln -s /opt/vikunja/vikunja /usr/bin/vikunja
+
+systemctl enable vikunja.service
# Fix the config to contain proper values
NEW_SECRET=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)
diff --git a/build/reprepro-dist-conf b/build/reprepro-dist-conf
index 8ea7e4c7b..92b4fa20b 100644
--- a/build/reprepro-dist-conf
+++ b/build/reprepro-dist-conf
@@ -1,8 +1,8 @@
Origin: dl.vikunja.io
Label: Vikunja
-Codename: strech
+Codename: buster
Architectures: amd64
Components: main
Description: The debian repo for Vikunja builds.
SignWith: yes
-Pull: strech
+Pull: buster
diff --git a/cliff.toml b/cliff.toml
new file mode 100644
index 000000000..02cfdb85a
--- /dev/null
+++ b/cliff.toml
@@ -0,0 +1,59 @@
+[changelog]
+body = """
+{% if version %}\
+ ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+ ## [unreleased]
+{% endif %}\
+
+
+{% for group, commits in commits | group_by(attribute="group") %}
+ ### {{ group | upper_first }}
+ {% for commit in commits
+ | filter(attribute="scope")
+ | sort(attribute="scope") %}
+ * *({{commit.scope}})* {{ commit.message | upper_first }}
+ {%- if commit.breaking %}
+ {% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
+ {%- endif -%}
+ {%- endfor -%}
+ {%- for commit in commits %}
+ {%- if commit.scope -%}
+ {% else -%}
+ * {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))
+ {% if commit.breaking -%}
+ {% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
+ {% endif -%}
+ {% endif -%}
+ {% endfor -%}
+ {% raw %}\n{% endraw %}\
+{% endfor %}\n
+
+"""
+#{% for group, commits in commits | group_by(attribute="group") %}
+# ### {{ group | upper_first }}
+# {% for commit in commits %}\
+# - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))
+# {% endfor %}\
+#{% endfor %}\n
+# remove the leading and trailing whitespace from the template
+trim = true
+
+[git]
+conventional_commits = true
+filter_unconventional = false
+commit_parsers = [
+ { message = ".*(deps).*", group = "Dependencies"},
+ { message = "^feat", group = "Features"},
+ { message = "^fix", group = "Bug Fixes"},
+ { message = "^doc", group = "Documentation"},
+ { message = "^perf", group = "Performance"},
+ { message = "^refactor", group = "Refactor"},
+ { message = "^style", group = "Styling"},
+ { message = "^test", group = "Testing"},
+ { message = "^chore\\(release\\): prepare for", skip = true},
+ { message = "^chore", group = "Miscellaneous Tasks"},
+ { body = ".*security", group = "Security"},
+ { message = ".*", group = "Other", default_scope = "other"}, # Everything that's not a conventional commit goes into the "Other" category
+]
+
diff --git a/code-header-template.txt b/code-header-template.txt
new file mode 100644
index 000000000..9a2d19a76
--- /dev/null
+++ b/code-header-template.txt
@@ -0,0 +1,15 @@
+Vikunja is a to-do list application to facilitate your life.
+Copyright 2018-2021 Vikunja and contributors. All rights reserved.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public Licensee as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public Licensee for more details.
+
+You should have received a copy of the GNU Affero General Public Licensee
+along with this program. If not, see + # **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 + # is due. + enableemailreminders: true + # If true, will allow users to request the complete deletion of their account. When using external authentication methods + # it may be required to coordinate with them in order to delete the account. This setting will not affect the cli commands + # for user deletion. + enableuserdeletion: true + # 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: 1024 database: # Database type to use. Supported types are mysql, postgres and sqlite. type: "sqlite" # Database user which is used to connect to the database. user: "vikunja" - # Databse password + # Database password password: "" - # Databse host + # Database host host: "localhost" - # Databse to use + # Database to use database: "vikunja" # When using sqlite, this is the path where to store the data - Path: "./vikunja.db" + path: "./vikunja.db" # Sets the max open connections to the database. Only used when using mysql and postgres. 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: # If cache is enabled or not enabled: false - # Cache type. Possible values are memory or redis, you'll need to enable redis below when using redis - type: memory + # 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 separately. + type: keyvalue # When using memory this defines the maximum size an element can take maxelementsize: 1000 @@ -67,15 +106,17 @@ 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 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. + # A list of origins which may access the api. These need to include the protocol (`http://` or `https://`) and port, if any. origins: - "*" # How long (in seconds) the results of a preflight request can be cached. @@ -86,8 +127,11 @@ mailer: enabled: false # SMTP Host host: "" - # 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: 587 + # SMTP Auth Type. Can be either `plain`, `login` or `cram-md5`. + authtype: "plain" # SMTP username username: "user" # SMTP password @@ -100,22 +144,34 @@ mailer: queuelength: 100 # The timeout in seconds after which the current open connection to the mailserver will be closed. queuetimeout: 30 + # By default, vikunja will try to connect with starttls, use this option to force it to use ssl. + forcessl: false log: # A folder where all the logfiles should go. path:
+ # The provider needs to support the `openid`, `profile` and `email` scopes.
+ # **Note:** Some openid providers (like gitlab) only make the email of the user available through openid claims if they have set it to be publicly visible. + # 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