serveur de hook HTTP
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 2.2KB

Logo Marang

Serveur de “webhooks” minimaliste

Prérequis

Démarrer

git clone https://forge.cadoles.com/cadoles/marang.git
cd marang
npm install
npm start

L’interface web sera disponible à l’adresse http://localhost:3000 et le serveur de hook à l’adresse http://localhost:3001.

Configuration

Marang utilise le module rc. Il peut donc être configuré en créant un fichier .marangrc à la racine du répertoire (voir la documentation de rc pour plus d’informations sur les autres possibilités).

La configuration par défaut est consultable dans /lib/config.js

Authentification

L’accès à l’interface de configuration est contrôlée par une authentification de type Basic Auth (il est donc fortement recommandé de servir celle ci en HTTPS).

Les identifiants par défaut sont marang / marang.

Les identifiants sont stockés dans le fichier de configuration dans la section webApp.credentials (voir plus haut pour personnaliser la configuration de Marang).

Le mot de passe est stocké sous sa forme haché (PBKDF2). Pour générer une empreinte pour votre nouveau mot de passe, vous pouvez utiliser l’utilitaire bin/hash-passwd qui s’exécute de la manière suivante:

cd marang
./bin/hash-passwd my_password my_password

L’utilitaire affichera une chaine de la forme <algorithm>:<iterations>:<salt>:<derived_key> que vous pourrez stocker dans votre fichier de configuration.

Sauvegarde et restauration

Deux utilitaires sont disponibles pour effectuer la sauvegarde et la restauration des données de Marang: bin/backup et bin/restore.

Utilisation

Créer une sauvegarde

MARANG_PASSWORD="Mot de passe Marang" ./bin/backup

Un fichier horodaté sera créé dans le répertoire de sauvegarde (par défaut ./backup, voir la configuration pour changer celui ci). Pour le moment, seuls les slots sont sauvegardés.

Restaurer une sauvegarde

MARANG_PASSWORD="Mot de passe Marang" MARANG_BACKUP_FILE="Chemin vers le fichier de sauvegarde à restaurer" ./bin/restore

Licence

AGPL-3.0