Typo README
This commit is contained in:
parent
ad3e4d1ede
commit
770a95b045
16
README.md
16
README.md
|
@ -1,5 +1,5 @@
|
||||||
# Indexation de la blockchain Duniter/Ḡ1
|
# Indexation de la blockchain Duniter/Ḡ1
|
||||||
## Sous forme d'un fichier JSON journalier et d'outils d'exploitation de ce JSON
|
## 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/)
|
### 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).
|
||||||
|
@ -10,7 +10,7 @@ A exécuter dans un environnement Bash Debian/Ubuntu.
|
||||||
## Exécution
|
## Exécution
|
||||||
|
|
||||||
Lancer le scan ainsi que tout le processus d'indexation depuis le début de la blockchain jusqu'à aujourd'hui
|
Lancer le scan ainsi que tout le processus d'indexation depuis le début de la blockchain jusqu'à aujourd'hui
|
||||||
`./g1-stats.sh`
|
```./g1-stats.sh```
|
||||||
*A la première execution, ce scan peut durer plusieurs heures!*
|
*A la première execution, ce scan peut durer plusieurs heures!*
|
||||||
Pour pourrez suivre la progression du scan en temps réel.
|
Pour pourrez suivre la progression du scan en temps réel.
|
||||||
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.
|
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.
|
||||||
|
@ -18,26 +18,26 @@ Pour les exécutions ultérieures, un cache est géneré permettant de reprendre
|
||||||
Le fichier JSON est alors généré: `db/daily.json`
|
Le fichier JSON est alors généré: `db/daily.json`
|
||||||
|
|
||||||
Pour générer la page web static:
|
Pour générer la page web static:
|
||||||
`./g1-stats.sh web`
|
```./g1-stats.sh web```
|
||||||
|
|
||||||
|
|
||||||
## Exploration
|
## 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 l'exploiter via la commande:
|
||||||
`./explorer.sh`
|
```./explorer.sh```
|
||||||
|
|
||||||
*TODO: Plus détailler cette partie ...*
|
*TODO: Détailler cette partie ...*
|
||||||
|
|
||||||
## Sauvegarde/Restauration
|
## Sauvegarde/Restauration
|
||||||
|
|
||||||
Un script de sauvegarde se trouve dans le dossier `scripts`:
|
Un script de sauvegarde se trouve dans le dossier `scripts`:
|
||||||
`./scripts/backup-cache.sh`
|
```./scripts/backup-cache.sh```
|
||||||
Permettant le faire une copie de votre fichier json actuel ainsi que du cache qui lui correspond
|
Permettant le faire une copie de votre fichier json actuel ainsi que du cache qui lui correspond
|
||||||
|
|
||||||
Pour restaurer le backup le plus récent:
|
Pour restaurer le backup le plus récent:
|
||||||
`./scripts/restore-cache.sh`
|
```./scripts/restore-cache.sh```
|
||||||
Pour restaurer un backup à partir d'un bloc précis, par exemple le bloc 4242 (le numéro du bloc se trouve dans le nom du backup du cache):
|
Pour restaurer un backup à partir d'un bloc précis, par exemple le bloc 4242 (le numéro du bloc se trouve dans le nom du backup du cache):
|
||||||
`./scripts/restore-cache.sh 4242`
|
```./scripts/restore-cache.sh 4242```
|
||||||
|
|
||||||
## Automatisation
|
## Automatisation
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue