Installation

Djehooty est distribué sous la forme d'une image Docker, qui inclut les deux briques logicielles djehooty-backend et le djehooty-frontend. C'est pour le moment la façon la plus simple et la plus rapide de distribuer l'application dans les premières phases du projet.

Djehooty tourne dans un conteneur en utilisant Docker ou Podman.

attention

Djehooty est actuellement en phase de développement actif et peut comporter des bugs ou des changements majeurs susceptibles d’impacter votre travail ou d’entraîner une perte de données lors de mises à jour futures. Je vous encourage vivement à tester l’application et à me faire part de vos retours pour contribuer à son amélioration. Cependant, je vous recommande de ne pas l’utiliser pour des usages critiques ou durables tant qu’une version considérée comme stable n’a pas été publiée (et que cet encard n'a pas été retiré).

Docker Desktop (Windows et MacOS)

Djehooty est développé et testé sous Linux. Il peut toutefois être installé sous Windows en utilisant Docker Desktop et WSL. Djehooty devrait aussi logiquement fonctionner sous MacOS. Il s'agit de suivre les instructions de Docker Desktop. L'image de Djehooty se trouve sur Docker Hub et peut être facilement retrouvée.

info

N'hésitez pas à contribuer à la documentation pour améliorer cette section dédiée à Windows et MacOS, car je suis sous Linux et ne souhaite pas travailler sur ces systèmes.

Docker (Linux)

Sous Linux, Docker doit être installé au préalable.

docker run

Votre utilisateur doit faire partie du groupe docker pour éviter d'utiliser sudo à chaque commande docker. Lancez donc la commande suivante dans une console :

sudo usermod -aG docker $USER

Créez ensuite un dossier pour y stocker les données de l'application :

mkdir ~/Djehooty

Puis, placez-vous dans ce dossier :

cd ~/Djehooty

Et enfin, lancez Djehooty avec la commande :

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

CTRL+C vous permet de stopper Djehooty.

info

En cas de problème à l'installation, n'hésitez pas consulter notre FAQ ou à me contacter.

docker compose

Pour installer et lancer Djehooty avec docker compose, suivez la même procédure que pour docker run pour créer le dossier Djehooty dans votre répertoire personnel.

Puis, placez-vous dans votre dossier :

cd ~/Djehooty

Ensuite, créez un fichier docker-compose.yml dans ce dossier avec le contenu suivant :

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

Lancez alors Djehooty avec

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

et arrêtez l'application avec

docker-compose down

Utilisation

Maintenant que votre conteneur Djehooty est lancé, rendez-vous sur votre navigateur web à l'adresse suivante : http://localhost:3000

Démarrage rapide

• Commencez par importer vos fichiers
• Organisez les en les regroupant sous la forme de documents.
• Ajoutez et modifiez des métadonnées sur vos documents.
• Créez et modifiez des individus, puis identifiez-les sur vos documents.
• Utilisez la barre de recherche pour retrouver facilement vos documents.

Si vous avez des remarques ou questions, n'hésitez pas à ouvrir un ticket sur Codeberg ou à me contacter.