1. Installation

Le fichier README.md contient une procédure rapide mais allons plus en détails ici.

La page paraît longue, mais elle est très simple et rapide !

1.1. Assistant

Si vous voulez installer Pwic.wiki en mode console et de façon guidée, vous pouvez suivre l'assistant. Répondez à quelques questions, lancez le script téléchargé sur votre hôte, et sautez au chapitre suivant.

Sinon continuez la lecture.

1.2. Interpréteur et outils

Installez Python ≥3.7 avec un compte administrateur :
- Linux : apt-get install python3 python3-pip --no-install-recommends sous Debian
- Windows : allez sur Python.org et utilisez ci-dessous la commande python au lieu de python3
Mettez à jour le gestionnaire de paquets : python3 -m pip install --upgrade pip
Installez gzip si vous voulez faire tourner les logs HTTP :
- Linux : apt-get install gzip sous Debian
- Windows : cet outil Linux a été porté ici

1.3. Fichiers

Utiliser Git est recommandé pour récupérer le bon code source et fusionner les modifications. Clonez le dépôt : git clone https://github.com/gitbra/pwic.git
- Pour mettre à jour, lancez git pull, fusionnez votre code et ajustez la base de données (si nécessaire)
Sinon décompressez simplement les dernières modifications dans un dossier de votre choix
- Pour mettre à jour, téléchargez les nouveaux fichiers, ajustez votre code et la base de données (si nécessaire)
Installez les dépendances de Python : python3 -m pip install --upgrade -r requirements.txt, ou apt-get install python3-[nom_du_paquet] si les paquets sont gérés par le système
- aiohttp est le serveur web
- aiohttp-cors permet d'utiliser l'API à partir d'un autre site avec JavaScript
- aiohttp-session gère la connexion au site
- imagesize lit les propriétés des images chargées pour les exporter correctement vers HTML et OpenDocument
- jinja2 gère la mise en page générale
- PrettyTable améliore l'affichage en tableau dans la console d'administration
- pygments est un colorateur syntaxique facultatif
- cryptography est utilisé par aiohttp pour crypter les cookies
- setuptools est optionnel mais peut être requis pour l'installation de parsimonious
Pour améliorer la sécurité, modifiez le fichier pwic_lib.py :
- Le mot de passe par défaut dans PwicConst.DEFAULTS['password'] doit être unique. Les nouveaux comptes sont toujours créés en tant que lecteur par défaut
- Tapez éventuellement des caractères aléatoires dans PwicConst.SALT pour saler les mots de passe. Mais si vous modifiez la valeur ultérieurement, tous les mots de passe ne seront plus reconnus et vous devrez les réinitialiser en ligne de commande

1.4. Base de données

Une fois seulement, initialisez la base de données : python3 pwic_admin.py init-db
- Un sous-dossier db/ est créé pour stocker toutes vos données
- La structure de la base de données dépend de la version du logiciel
Créez un nouveau projet demo pour l'utilisateur admin with python3 pwic_admin.py create-project demo "Projet de démonstration" admin
Démarrez le serveur localement : python3 pwic.py
Profitez de Pwic.wiki sur http://127.0.0.1:8080 par défaut
Attention : vous devez changer votre mot de passe avant de pouvoir modifier les autorisations ou créer des pages

1.5. Configuration

Vous pouvez utiliser les nombreuses variables globales et dépendantes d'un projet décrites dans le fichier d'aide. Par conception, les plus sensibles ou les globales ne peuvent pas être modifiées en ligne.

Toutes les options peuvent être définies en ligne de commande, ce qui rend Pwic.wiki très pratique à déployer et à maintenir par console : python3 pwic_admin.py set-env --help

Une fois que vous avez sécurisé votre instance, vous pouvez laisser le serveur écouter l'adresse publique 0.0.0.0 ou ::1 et modifier le port dans la ligne de commande : python3 pwic.py --host 0.0.0.0 --port 8080. Sous Linux, les ports inférieurs à 1024 nécessitent un accès en tant que root, ce qui n'est pas recommandé par principe pour Pwic.wiki. L'utilisation facultative mais recommandée d'un reverse proxy ou de règles NAT résout cette problématique.

2. Traductions

Pwic.wiki contient quelques langues par défaut (EN, FR, DE). Vous pouvez contribuer à déployer d'autres langues en suivant une procédure simple.

3. HTTPS

L'activation de HTTPS se fait dans un second temps après que votre instance fonctionne déjà bien avec le HTTP classique. Parce que l'obtention d'un certificat TLS/SSL est compliquée, une page dédiée explique la marche à suivre.

4. Authentification fédérée (SSO)

Vous pouvez vous connecter à Pwic.wiki en utilisant un serveur distant d'entreprise. Une page dédiée explique la procédure une fois que vous avez terminé les précédentes étapes.

5. Double authentification (2FA)

Vous pouvez utiliser un mot de passe secondaire aléatoire pour sécuriser certains comptes. Une page dédiée explique la procédure.

6. Reporting BI

La procédure est expliquée sur cette page.

7. Scripts avancés (optionnel)

Pour voir nos scripts utilisés pour maintenir Pwic.wiki depuis notre console, cliquez ici.

8. Hébergement avancé avec Docker

Une page dédiée explique la procédure.

Revision #1 was last modified by gitbra
on 2024-11-30 at 00:00:00 — 903cb7eac39f043e