macjuul/vindigo repository overview

⁠🚧 IMPORTANT DISCLAIMER 🚧

This project is currently in early development and is not useable in any way, shape or form. It quite literally cannot track your tasks yet!

Once the project is in a more stable shape, contribution guidelines will be published as well. You can follow our GitHub repository⁠ or join our Discord⁠ server in case you want to stay tuned! 📅

⁠

⁠Introducion

Vindigo is a next generation planning tool focused on productivity and usability for your team.

At its core, Vindigo offers an efficient way of creating, listing, and viewing your projects tasks. Inspired by other great planning tools, vindigo provides you with plenty of customization and extensibility, allowing it to fit your specific needs.

You can find Vindigo on GitHub:
https://github.com/ExodiusStudios/vindigo⁠

⁠Features

• Implements an easy to use task hierarchy (Boards - Lists - Tasks)
• Instant live syncing across multiple browsers
• User and account management on a per-board basis
• Self hosted for full control over your data and setup
• Support for theming and customized themes
• Extensible with plugins and an easy to use API
• Fully open source and licensed under MIT⁠

⁠Quick start guide

⁠First time setup

This guide assumes you already have Docker⁠ installed on your machine. Everything from here on out assumes the docker service is running (you may need to start the service after install).

Starting the docker container for the first time will generate a configuration file. It is important to update your config file with your database connection details which are necessary to run Vindigo.

docker run --rm -v /my/own/datadir:/vindigo/data macjuul/vindigo

Once the command is executed, the container will automatically exit. You can now find the config.toml in your data directory. It is recommended to use the sqlite database driver as it significantly simplifies the setup and maintenance. When intending to run a large Vindigo instance, you may want to use the docker-compose setup instead in order to manage a separate database container.

⁠Starting Vindigo

In order to start Vindigo you can run the following command.

docker run --name vindigo -d -p 8085:8085 -v /my/own/datadir:/vindigo/data macjuul/vindigo

NOTE: This will run Vindigo in the background using the -d flag, this means you can safely close your terminal.

You should now be able to access the Vindigo client on http://localhost:8085.

⁠Running with docker-compose

You can run Vindigo with docker-compose to run it alongside a database. Just like the regular setup, running the Vindigo server for the first time will generate the configuration file and exit.

Example docker-compose.yml:

version: "3.9"

services:
  vindigo:
    image: vindigo
    ports:
      - 8085:8085
    volumes:
      - ./vindigo-data:/vindigo/data
  database:
    image: mariadb:10.5
    volumes:
       - vindigo-data:/var/lib/mysql
    environment:
      - MYSQL_ROOT_PASSWORD
      - MYSQL_DATABASE
volumes:
  vindigo-data:

This setup expects the following database configuration in your config.toml:

[database]
driver = "mysql"
database = "vindigo"
hostname = "database"
username = "root"
password = "YourSuperSecretPassword"
port = 3306

You will also need to create a .env file holding your database details:

MYSQL_DATABASE=vindigo
MYSQL_ROOT_PASSWORD=YourSuperSecretPassword

Once you have finished the configuration, you can now start your instance.

docker-compose up -d