Skip to content

Commit a2097ed

Browse files
committed
update(docs): améliorations mineures
1 parent ec40764 commit a2097ed

File tree

3 files changed

+33
-22
lines changed

3 files changed

+33
-22
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,3 +229,4 @@ images_uploader/*.log.*
229229
*.retry
230230
password_file
231231
comments/__pycache__/__init__.cpython-310.pyc
232+
*.lock

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1-
# CDN minimaliste de Geotribu
1+
# Infra Geotribu
22

3-
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/geotribu/minimalist-cdn/master.svg)](https://results.pre-commit.ci/latest/github/geotribu/minimalist-cdn/master)
3+
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/geotribu/infra/master.svg)](https://results.pre-commit.ci/latest/github/geotribu/infra/master)
44

5-
Fichiers de configuration pour <https://cdn.geotribu.fr> et des outils liés : sauvegarde, notifications, indexation...
5+
Fichiers de configuration et de déploiement des différents composants constituant l'infra du projet [Geotribu](https://geotribu.fr/) :
6+
7+
- principalement le site d'hébergement des fichiers statiques (images...) <https://cdn.geotribu.fr>
8+
- scripts de sauvegarde
9+
- commentaires
10+
- notifications
11+
- indexation des contenus
612

713
## Déploiement
814

15+
- le serveur est gracieusement prêté par GeoRezo et hébergé chez [Altinea](https://altinea.fr/) jusqu'à l'été 2025 puis chez [Ataraxie](https://www.ataraxie.fr/)
916
- OS serveur à date : Ubuntu Server 22.04
1017

1118
### Prérequis
@@ -17,8 +24,8 @@ Fichiers de configuration pour <https://cdn.geotribu.fr> et des outils liés : s
1724
1825
Host geotribu
1926
HostName vps383.altinea.eu
20-
User geotribu
2127
IdentityFile ~/.ssh/id_rsa_elgeopaso
28+
User geotribu
2229
```
2330
2431
- Ansible : voir [le README dédié](ansible/README.md)
@@ -44,4 +51,4 @@ Voir [le README dédié](notifications/README.md).
4451
4552
Afin de faciliter la recherche de la bonne image lors de la rédaction des contenus, un index des fichiers du CDN est réalisé avec [lunr](https://lunrjs.com/) (son implémentation Python).
4653
47-
Voir [le README dédié](search-index/README.md).
54+
Voir [le script](ansible/roles/cdn-indexer/files/search_indexer.py).

ansible/README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,33 @@
22

33
## Prérequis
44

5-
- [ansible]()
5+
- [ansible](https://docs.ansible.com/ansible/latest/index.html)
6+
- [vagrant](https://developer.hashicorp.com/vagrant/install) et [virtualbox](https://doc.ubuntu-fr.org/%20virtualbox) pour le développement local
67

7-
Sur Ubuntu 24.04, c'est pratique d'installer Ansible avec [pipx](https://pipx.pypa.io/) :
8+
## Installer Ansible
89

9-
> [!TIP]
10-
> [pipx](https://pipx.pypa.io/stable/installation/) est l'outil moderne du groupe Python packaging de la fondation Python pour installer proprement les outils en ligne de commande en respectant les pratiques et contraintes des différents OS.
11-
> Pour l'installer sur Ubuntu :
12-
>
13-
> ```sh
14-
> sudo apt install pipx
15-
> pipx ensurepath
16-
> ```
10+
> Exemples sur Ubuntu
1711
18-
Puis :
12+
### Avec pipx
1913

20-
```sh
21-
pipx install ansible-core ansible-lint pre-commit
22-
```
14+
Sur Ubuntu 24.04 et suivants, c'est pratique d'installer Ansible avec [pipx](https://pipx.pypa.io/) :
2315

24-
- [vagrant](https://developer.hashicorp.com/vagrant/install) et [virtualbox](https://doc.ubuntu-fr.org/%20virtualbox) pour le développement local
16+
> [!TIP]
17+
> [pipx](https://pipx.pypa.io/stable/installation/) est l'outil moderne du groupe Python packaging de la fondation Python pour installer proprement les outils en ligne de commande en respectant les pratiques et contraintes des différents OS.
18+
> Pour l'installer sur Ubuntu :
19+
>
20+
> ```sh
21+
> sudo apt install pipx
22+
> pipx ensurepath
23+
> ```
24+
25+
Puis, après avoir redémarré son terminal :
2526
26-
## Installer Ansible - Exemple sur Ubuntu
27+
```sh
28+
pipx install ansible-core ansible-lint pre-commit
29+
```
2730
28-
Créer un environnement virtuel :
31+
### Avec un environnement virtuel
2932

3033
```sh
3134
python3 -m venv .venv

0 commit comments

Comments
 (0)