diff --git a/README.md b/README.md index abfa904..7c8f2d9 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,14 @@ Voici la méthode que j'utilise afin d'archiver une page web ou bien un site int J'utilise un serveur Kiwix afin de lire mes archives ZIM, l'outil Zimit pour créer les archives et celle-ci sont stockées sur un serveur externe au service. -:one: Créer un utilisateur/mdp sur le serveur de stockage ainsi qu'un dossier de partage smb/cifs avec les droits qui vont bien. +### :one: Configuration du serveur de stockage +- Créer un utilisateur + mot de passe +- Créer un dossier de partage smb/cifs +- Configurer les droits d'accès -:two: Installer le paquet `cifs-utils` sur le serveur Kiwix, puis monter le partage à l'emplacement voulu ici : `/srv/kiwix` +### :two: Configuration du serveur Kiwix +- Installer le paquet `cifs-utils` +- Monter le partage à l'emplacement voulu ici : `/srv/kiwix` > :arrow_forward: Exemple fstab : >``` >//serveur-de-stockage/kiwix /srv/kiwix cifs credentials=/etc/.smbcredentials-kiwix,uid=0000,gid=000,file_mode=0770,dir_mode=0770,iocharset=utf8 0 0 @@ -21,21 +26,23 @@ J'utilise un serveur Kiwix afin de lire mes archives ZIM, l'outil Zimit pour cr >password=MotDePasse >``` -:three: Dans notre répertoire `/srv/kiwix/zim` il est important d'y déposer une première archive ZIM avant le déploiement de Kiwix, +### :three: Première archive +- Dans notre répertoire `/srv/kiwix/zim` il est important d'y déposer une première archive ZIM avant le déploiement de Kiwix, voir ce dépot publique https://library.kiwix.org -:four: Ce [docker-compose](https://git.selfitdeploy.com/Willy/Archivage-ZIM/src/branch/main/docker-compose.yml) pour déployer le serveur Kiwix. +### :four: Déploiement du serveur Kiwix +- Ici le [docker-compose](https://git.selfitdeploy.com/Willy/Archivage-ZIM/src/branch/main/docker-compose.yml). -:five: Utilisation manuel de Zimit +### :five: Utilisation manuel de Zimit -Cette commande pour exécuter un archivage web en fichier ZIM : +- Cette commande pour exécuter un archivage web en fichier ZIM : ``` docker run --rm -it -v /srv/kiwix/zim:/output ghcr.io/openzim/zimit zimit --seeds="https://lien-du-site" --name="nom-de-l'archive" --title="titre-de-l'archive" --output=/output --pageLimit=20 --waitUntil=networkidle0 --workers=4 --scopeExcludeRx="(\?q=|signup-landing\?|\?cid=)" ``` > Plus d'infos sur les variables dans le dépot du projet https://github.com/openzim/zimit -:six: Utilisation d'une interface web +### :six: Utilisation d'une interface web - Mettre en place cette architecture de fichiers ``` @@ -51,4 +58,14 @@ zimit-web/ - Créer un environement virtuel Python `python3 -m venv menv` - Activer cet environement `menv/bin/activate` - Installer les dépendances `pip install -r requirements.txt` -- Démarrer le serveur `python app.py` \ No newline at end of file +- Démarrer le serveur `python app.py` + +### :seven: Aperçu de l'interface +- Interface accessible en `http://ip-du-serveur:8080` + +![Interface web](https://git.selfitdeploy.com/Willy/Archivage-ZIM/raw/branch/main/Capture_Archivage_Zimit.png) + +### :construction: Objectifs futurs +- Création d'un container pour simplifié sa mise en place et pour un usage en production. +- Amélioration esthétique de l'interface web +- Amélioration de la gestion des logs \ No newline at end of file