axiom-team
/
g1-stats
7
1
Fork 1
Code Issues Pull Requests Releases Activity

Update REAMDE.md

This commit is contained in:
poka 2020-10-03 05:27:46 +02:00
parent 4f18443702
commit 26d42e19e0
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -2,7 +2,7 @@
## Sous forme d'un fichier JSON journalisé et d'outils d'exploitation de ce JSON
### Visible sur: [https://g1-stats.axiom-team.fr/](https://g1-stats.axiom-team.fr/)
Utilise l'[API BMA](https://github.com/duniter/duniter-bma/blob/master/doc/API.md) pour l'extraction et l'indexation des données de la [blockchain Duniter/Ḡ1](https://duniter.org).
Utilise l'[API BMA](https://github.com/duniter/duniter-bma/blob/master/doc/API.md) pour l'extraction et l'indexation des données de la [blockchain Duniter/Ḡ1](https://duniter.org).<br>
A exécuter dans un environnement Bash Debian/Ubuntu.
*Si vous souhaitez modifier les paramètres par defaut, copiez le fichier .env.example en .env et adaptez les variables selon votre usage.*
@ -13,8 +13,8 @@ Lancer le scan ainsi que tout le processus d'indexation depuis le début de la b
```
./g1-stats.sh
```
*A la première execution, ce scan peut durer plusieurs heures!*
Pour pourrez suivre la progression du scan en temps réel.
*A la première execution, ce scan peut durer plusieurs heures!*<br>
Pour pourrez suivre la progression du scan en temps réel.<br>
Pour les exécutions ultérieures, un cache est géneré permettant de reprendre le scan là où il s'est arrêté, diminuant drastiquement le temps d'execution.
Le fichier JSON est alors généré: `db/daily.json`
@ -27,12 +27,17 @@ Pour générer la page web static:
## Exploration
Une fois le fichier JSON correctement généré, vous pouvez l'exploiter via la commande:
Une fois le fichier JSON correctement généré, vous pouvez utiliser `explorer.sh` pour l'exploiter.<br>
Pour obtenir l'aide:
```
./explorer.sh
./explorer.sh -h
```
**Ce script explorer.sh fonctionne de manière standalone, c'est à dire que vous pouvez l'utiliser en dehors de l'environnement Ḡ1Stats sans aucune dépendance:**
*TODO: Détailler cette partie ...*
```
wget https://git.p2p.legal/axiom-team/g1-stats/raw/master/explorer.sh
chmod u+x explorer.sh
```
## Sauvegarde/Restauration
@ -53,7 +58,7 @@ Pour restaurer un backup à partir d'un bloc précis, par exemple le bloc 4242 (
## Automatisation
Vous pouvez décider d'exécuter ce script régulièrement grâce à une tache cron.
Vous pouvez décider d'exécuter ce script régulièrement grâce à une tache cron.<br>
Par exemple pour l'exécuter toutes les 3 heures:
```