Installation Guide

You may be able to run MyFicDB outside of docker, but I haven't tested it and it's not currently officially supported. In theory though, you should not have any issues.

My recommended approach for installing MyFicDB is using docker compose. This guide is specific to Linux, however you should be able to follow along on Windows as well as long as you have Docker Desktop installed. I'm making the assumption that you have used docker before, therefore this isn't a 'noob' guide nor is it super detailed.

Installation

Download the docker-compose.example.yml file from the repo and rename it to docker-compose.yml.

Create a directory where you want your docker-compose file stored, as well as your database (sqlite) and logs. Mounting both of these is required to not lose any data during docker restarts.

Open the docker-compose.yml file and change your ports if you want different ones, and change the mount location at the bottom of the file. The file has comments on it, so if you get stuck they should give you some guidance - it's not overly complicated though.

• Open Terminal on your Server or SSH into it
• Locate your docker-compose.yml file
• Run: docker compose up -d

MyFicDB should now be available at {url}:{port} (localhost:8080, etc.)

First Steps

The first time you log into MyFicDB you will be asked to create a user account. Once this account has been created, registration is disabled. MyFicDB was designed as a single user system, hence registration being disabled. Depending on what you are going to to store in MyFicDB, it also has Two Factor Authentication support and I recommend setting this up as soon as possible.

Caution

Please note that currently if you lose access to your authenticator the only way to get back in is to use your back up keys, or modify data in the database directly. Please bare this in mind and don't lose your backup keys.

For a more detailed guide, click on the guide on the right hand side of this page.