Vikunja

Vikunja

Official

Docker app from ImSkully's Repository

Overview

The open-source, self-hostable to-do app - organize everything, on all platforms. For advanced configuration, see all supported configuration options: (https://vikunja.io/docs/config-options/)

Build Status License: AGPL-3.0-or-later Install Docker Pulls Swagger Docs Go Report Card

Vikunja

The Todo-app to organize your life.

If Vikunja is useful to you, please consider buying me a coffee, sponsoring me on GitHub or buying a sticker pack. I'm also offering a hosted version of Vikunja if you want a hassle-free solution for yourself or your team.

Table of contents

Security Reports

If you find any security-related issues you don't want to disclose publicly, please use the contact information on our website.

Features

See the features page on our website for a more exhaustive list or try it on try.vikunja.io!

Docs

All docs can be found on the Vikunja home page.

Roadmap

See the roadmap (hosted on Vikunja!) for more!

Contributing

Please check out the contribution guidelines on the website.

License

Most of this repository is licensed under AGPL‑3.0‑or‑later. The contents of desktop/ are licensed under GPL‑3.0‑or‑later.

Unsplash Images

Background images from Unsplash are distributed under the Unsplash License. The license requires giving credit to the photographer and Unsplash. See Unsplash’s terms for more information.

Install Vikunja on Unraid in a few clicks.

Find Vikunja in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for Vikunja Review the template variables and paths Click Install

Download Statistics

8,372,700
Total Downloads
621,627
This Month
497,216
Avg / Month

Total Downloads Over Time

Loading chart...

Related apps

Details

Repository
vikunja/vikunja:latest
Last Updated2026-06-29
First Seen2024-02-12

Runtime arguments

Web UI
http://[IP]:[PORT:3456]
Network
bridge
Shell
sh
Privileged
false
Extra Params
--user 99:100

Template configuration

Web UI PortPorttcp

The port to serve the frontend WebUI.

Target
3456
Default
3456
Value
3456
Application Data DirectoryPathrw

The directory application data is saved.

Target
/app/vikunja/files
Default
/mnt/user/appdata/vikunja
Value
/mnt/user/appdata/vikunja
Configuration DirectoryPathrw

The directory where your config.yml is located.

Target
/etc/vikunja
Default
/mnt/user/appdata/vikunja/config
Value
/mnt/user/appdata/vikunja/config
Enable RegistrationVariable

Whether to let new users registering themselves or not.

Target
VIKUNJA_SERVICE_ENABLEREGISTRATION
Default
true|false
Value
true
Database TypeVariable

Database type to use, possible values are 'sqlite', 'mysql', or 'postgres'.

Target
VIKUNJA_DATABASE_TYPE
Default
sqlite
Value
sqlite
(SQLite) SQLite Database PathVariable

(SQLite) When using SQLite for database storage, this is the path to your database file.

Target
VIKUNJA_DATABASE_PATH
Default
/etc/vikunja/vikunja.db
Value
/etc/vikunja/vikunja.db
(MySQL/Postgres) Database HostVariable

(MySQL/Postgres) The host to use for your database.

Target
VIKUNJA_DATABASE_HOST
(MySQL/Postgres) Database UsernameVariable

(MySQL/Postgres) The database username to use.

Target
VIKUNJA_DATABASE_USER
(MySQL/Postgres) Database PasswordVariable

(MySQL/Postgres) The database account password.

Target
VIKUNJA_DATABASE_PASSWORD
(MySQL/Postgres) Database NameVariable

(MySQL/Postgres) The name of the database to use.

Target
VIKUNJA_DATABASE_DATABASE
Default
vikunja
Value
vikunja
Mailer EnabledVariable

Whether to enable the mailer or not. If it is disabled, all users are enabled right away and password reset is not possible.

Target
VIKUNJA_MAILER_ENABLED
Default
true|false
Value
false
Mailer HostVariable

The SMTP host name to use if the mailer is enabled.

Target
VIKUNJA_MAILER_HOST
Mailer PortVariable

The SMTP port value to use if the mailer is enabled.

Target
VIKUNJA_MAILER_PORT
Default
465
Value
465
Mailer Auth TypeVariable

SMTP Auth Type. Can be either 'plain', 'login' or 'cram-md5'.

Target
VIKUNJA_MAILER_AUTHTYPE
Default
plain
Value
plain
Mailer UsernameVariable

The SMTP username to use.

Target
VIKUNJA_MAILER_USERNAME
Mailer PasswordVariable

The SMTP password to use.

Target
VIKUNJA_MAILER_PASSWORD
Mailer Skip TLSVariable

Wether to skip verification of the TLS certificate on the server.

Target
VIKUNJA_MAILER_SKIPTLSVERIFY
Default
true|false
Value
false
Mailer Skip TLSVariable

The default from address when sending emails.

Target
VIKUNJA_MAILER_FROMEMAIL
Mailer Force SSLVariable

By default, vikunja will try to connect with starttls, use this option to force it to use SSL.

Target
VIKUNJA_MAILER_FORCESSL
Default
true|false
Value
false
Public URLVariable

The public facing URL where your users can reach Vikunja, used in emails and for the communication between API and frontend.

Target
VIKUNJA_SERVICE_PUBLICURL
Enable Email RemindersVariable

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.

Target
VIKUNJA_SERVICE_ENABLEEMAILREMINDERS
Default
true|false
Value
true
Enable User DeletionVariable

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.

Target
VIKUNJA_SERVICE_ENABLEUSERDELETION
Default
true|false
Value
true
Custom Logo URLVariable

Allow using a custom logo via external URL.

Target
VIKUNJA_SERVICE_CUSTOMLOGOURL
CORS EnabledVariable

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.

Target
VIKUNJA_CORS_ENABLE
Default
true|false
Value
false
CORS Allowed OriginsVariable

A list of origins which may access the API, these need to include the protocol (http:// or https://) and port, if any.

Target
VIKUNJA_CORS_ORIGINS
CORS Max AgeVariable

How long (in seconds) the results of a preflight request can be cached.

Target
VIKUNJA_CORS_MAXAGE
Default
0
Value
0