Skip to main content

Installation

Djehooty is distributed as a Docker image, which includes both software components djehooty-backend and djehooty-frontend. This is currently the easiest and fastest way to distribute the application in the early phases of the project.

Djehooty runs in a container using Docker or Podman.

warning

Djehooty is currently in active development and may contain bugs or major changes that could impact your work or lead to data loss during future updates. I strongly encourage you to test the application and share your feedback to help improve it. However, I recommend not using it for critical or long-term purposes until a stable version has been released (and this notice has been removed).

Docker Desktop (Windows and MacOS)​

Djehooty is developed and tested on Linux. However, it can be installed on Windows by using Docker Desktop and WSL. Djehooty should also work on MacOS. Follow the Docker Desktop instructions. The Djehooty image can be found on Docker Hub and is easy to locate.

info

Feel free to contribute to the documentation to improve this section dedicated to Windows and MacOS, as I'm on Linux and don't wish to work on these systems.

Search for Djehooty on Docker Hub

Running Djehooty with Docker Desktop

Docker (Linux)​

On Linux, Docker must be installed beforehand.

docker run​

Your user must be part of the docker group to avoid using sudo with every docker command. Run the following command in a console:

sudo usermod -aG docker $USER

Then create a folder to store the application data:

mkdir ~/Djehooty

Next, navigate to this folder:

cd ~/Djehooty

Finally, launch Djehooty with the command:

docker run --rm \
  --user $(id -u):$(id -g) \
  --name djehooty \
  -p 8181:8181 \
  -p 3000:3000 \
  -v ".:/app/data" \
  djehooty/djehooty:latest

CTRL+C allows you to stop Djehooty.

info

If you encounter any issues during installation, feel free to consult our FAQ or contact me.

docker compose​

To install and launch Djehooty with docker compose, follow the same procedure as for docker run to create the Djehooty folder in your home directory.

Then, navigate to your folder:

cd ~/Djehooty

Next, create a docker-compose.yml file in this folder with the following content:

version: '3.3'
services:
  djehooty:
    image: djehooty/djehooty:latest
    ports:
      - '8181:8181'
      - '3000:3000'
    volumes:
      - .:/app/data
    user: "${UID}:${GID}"
    restart: unless-stopped

Then launch Djehooty with

UID=$(id -u) GID=$(id -g) docker-compose up

and stop the application with

docker-compose down

Usage​

Now that your Djehooty container is running, go to your web browser at the following address: http://localhost:3000

Quick Start​

If you have any comments or questions, feel free to open a ticket on Codeberg or contact me.