elestio/vikunja
Vikunja, verified and packaged by Elestio
10K+
Vikunja, the Todo-app to organize your life.
Deploy a fully managed Vikunja on elest.io if you want automated backups, reverse proxy with SSL termination, firewall, automated OS & Software updates, and a team of Linux experts and open source enthusiasts to ensure your services are always safe, and functional.
You can deploy it easily with the following command:
git clone https://github.com/elestio-examples/vikunja.git
Copy the .env file from tests folder to the project directory
cp ./tests/.env ./.env
Edit the .env file with your own values.
Run the project with the following command
docker-compose up -d
You can access the Web UI at: http://your-domain:7070
Here are some example snippets to help you get started creating a container.
version: "3"
services:
vikunja:
image: elestio/vikunja:${SOFTWARE_VERSION_TAG}
restart: always
environment:
VIKUNJA_SERVICE_PUBLICURL: https://${DOMAIN}
VIKUNJA_DATABASE_HOST: db
VIKUNJA_DATABASE_PASSWORD: ${POSTGRES_PASSWORD}
VIKUNJA_DATABASE_TYPE: postgres
VIKUNJA_DATABASE_USER: ${POSTGRES_USER}
VIKUNJA_DATABASE_DATABASE: ${POSTGRES_DB}
VIKUNJA_SERVICE_JWTSECRET: ${VIKUNJA_SERVICE_JWTSECRET}
VIKUNJA_MAILER_ENABLED: ${VIKUNJA_MAILER_ENABLED}
VIKUNJA_MAILER_HOST: ${VIKUNJA_MAILER_HOST}
VIKUNJA_MAILER_PORT: ${VIKUNJA_MAILER_PORT}
VIKUNJA_MAILER_USERNAME: ${VIKUNJA_MAILER_USERNAME}
VIKUNJA_MAILER_PASSWORD: ${VIKUNJA_MAILER_PASSWORD}
VIKUNJA_MAILER_SKIPTLSVERIFY: ${VIKUNJA_MAILER_SKIPTLSVERIFY}
VIKUNJA_MAILER_FROMEMAIL: ${VIKUNJA_MAILER_FROMEMAIL}
ports:
- 172.17.0.1:7070:3456
volumes:
- ./files:/app/vikunja/files
depends_on:
- db
db:
image: elestio/postgres:16
restart: always
environment:
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
POSTGRES_USER: ${POSTGRES_USER}
POSTGRES_DB: ${POSTGRES_DB}
ports:
- 172.17.0.1:37241:5432
volumes:
- ./db:/var/lib/postgresql/data
Variable | Value (example) |
---|---|
SOFTWARE_VERSION_TAG | latest |
ADMIN_EMAIL | your@email.com |
ADMIN_PASSWORD | your-password |
DOMAIN | your.domain |
POSTGRES_PASSWORD | your-password |
POSTGRES_USER | postgres |
POSTGRES_DB | vikunja |
VIKUNJA_SERVICE_JWTSECRET | your-strong-jwt |
VIKUNJA_MAILER_ENABLED | true |
VIKUNJA_MAILER_HOST | your.mail.host |
VIKUNJA_MAILER_PORT | your.mail.port |
VIKUNJA_MAILER_USERNAME | |
VIKUNJA_MAILER_PASSWORD | |
VIKUNJA_MAILER_SKIPTLSVERIFY | true |
VIKUNJA_MAILER_FROMEMAIL | your@sender.email.app |
The Elestio Vikunja Docker image sends the container logs to stdout. To view the logs, you can use the following command:
docker-compose logs -f
To stop the stack you can use the following command:
docker-compose down
To make backup and restore operations easier, we are using folder volume mounts. You can simply stop your stack with docker-compose down, then backup all the files and subfolders in the folder near the docker-compose.yml file.
Creating a ZIP Archive For example, if you want to create a ZIP archive, navigate to the folder where you have your docker-compose.yml file and use this command:
zip -r myarchive.zip .
Restoring from ZIP Archive To restore from a ZIP archive, unzip the archive into the original folder using the following command:
unzip myarchive.zip -d /path/to/original/folder
Starting Your Stack Once your backup is complete, you can start your stack again with the following command:
docker-compose up -d
That's it! With these simple steps, you can easily backup and restore your data volumes using Docker Compose.
docker pull elestio/vikunja