doc is a section

This commit is contained in:
julien 2025-01-17 12:02:00 +01:00
parent 7435545420
commit 786d0d8dd0
9 changed files with 88 additions and 73 deletions

12
src/content/doc/_index.md Normal file
View File

@ -0,0 +1,12 @@
+++
title = "Documentation"
template = "section.html"
+++
En cours d'écriture 📝...<br>
S'il vous manque une information, [contactez-moi](/contact).
<div class="col--1-1">
<a class="box box__link" href="doc/users">Utilisateurs</a>
<a class="box box__link" href="doc/admins">Administrateurs</a>
</div>

View File

@ -1,42 +1,10 @@
+++ +++
title = "Documentation" title = "Le coin de administrateurs"
slug = "documentation" slug = "admins"
template = "documentation.html" template = "documentation.html"
+++ +++
En cours d'écriture 📝...<br> ## Infrastructure {#infra}
S'il vous manque une information, [contactez-moi](/contact).
## Utilisateurs {#users}
Vous trouverez ici toutes les informations dont vous pourriez avoir besoin pour
utiliser les services de NETig.
### NETmail {#netmail}
Vous pouvez consulter vos mails depuis le [webmail](https://webmail.netig.net),
mais si vous souhaitez utiliser un client tel que Thunderbird, ou bien K-9 Mail
sur Android voici la configuration :
IMAP
* Serveur : mail.netig.net
* Type de sécurité : STARTTLS
* Port : 143
* Nom d'utilisateur : adresse mail complète
SMTP
* Serveur : mail.netig.net
* Type de sécurité : STARTTLS
* Port : 587
* Nom d'utilisateur : adresse mail complète
## Administrateurs {#admins}
Le coins des admins 👨‍💻 !
### Infrastructure {#infra}
L'infrastructure "matérielle" de NETig repose sur des VPS (Virtual Private L'infrastructure "matérielle" de NETig repose sur des VPS (Virtual Private
Server) de petite capacité afin de suivre les besoins au plus près, d'éviter les Server) de petite capacité afin de suivre les besoins au plus près, d'éviter les
@ -51,7 +19,7 @@ d'administration. Les services sont conteneurisés avec
s'agit d'une couche légère de virtualisation qui permet un niveau supplémentaire s'agit d'une couche légère de virtualisation qui permet un niveau supplémentaire
de cloisonnement mais également de simplifier les tâches de déploiement. de cloisonnement mais également de simplifier les tâches de déploiement.
#### Serveurs {#servers} ### Serveurs {#servers}
Actuellement les besoins sont faible, un seul VPS suffit, il est fournit par Actuellement les besoins sont faible, un seul VPS suffit, il est fournit par
[HostUp](https://hostup.se/en) en Suède avec Proxmox dans leur datacenter de [HostUp](https://hostup.se/en) en Suède avec Proxmox dans leur datacenter de
@ -63,7 +31,7 @@ Stockholm.
| RAM | 16Go | | RAM | 16Go |
| Stockage | 500Go | | Stockage | 500Go |
#### Réseau {#network} ### Réseau {#network}
Les connexion entrantes sont filtrées par un pare-feu, et redirigées sur le Les connexion entrantes sont filtrées par un pare-feu, et redirigées sur le
réseau local par un reverse proxy. réseau local par un reverse proxy.
@ -73,13 +41,13 @@ réseau local par un reverse proxy.
| IPv4 | 103.177.249.4 | | IPv4 | 103.177.249.4 |
| IPv6 | 2a13:7c81:157::2 | | IPv6 | 2a13:7c81:157::2 |
#### Sauvegardes {#backups} ### Sauvegardes {#backups}
Les données sont sauvegardées automatiquement une fois par jour et stockées sur Les données sont sauvegardées automatiquement une fois par jour et stockées sur
le serveur même, ainsi que sur un stockage distant en Allemagne chez le serveur même, ainsi que sur un stockage distant en Allemagne chez
[Hetzner](https://www.hetzner.com) dans leur datacenter de Falkenstein. [Hetzner](https://www.hetzner.com) dans leur datacenter de Falkenstein.
### Maintenance {#maintenance} ## Chimera Linux {#chimera}
Quelques petites choses à savoir concernant Chimera Linux avant de mettre les Quelques petites choses à savoir concernant Chimera Linux avant de mettre les
mains dans le cambouis : mains dans le cambouis :
@ -92,11 +60,7 @@ mains dans le cambouis :
commandes sont les mêmes mais attention certaines options peuvent parfois être commandes sont les mêmes mais attention certaines options peuvent parfois être
différentes. différentes.
#### Connexion aux serveurs {#connection} ### APK {#apk}
...
#### APK {#apk}
Le gestionnaire de paquets APK d'Alpine Linux est utilisé, il est simple, rapide Le gestionnaire de paquets APK d'Alpine Linux est utilisé, il est simple, rapide
et extrêmement fiable ! et extrêmement fiable !
@ -136,23 +100,21 @@ Supprimer un paquet :
> fichier `/etc/apk/world` qui contient la liste des paquets explicitement > fichier `/etc/apk/world` qui contient la liste des paquets explicitement
> installés, APK calcule les dépendances à partir de ce fichier. > installés, APK calcule les dépendances à partir de ce fichier.
#### Nerdctl {#nerdctl} ## Dinit {#dinit}
... ...
#### Services {#services} ## Maintenance {#maintenance}
### Connexion aux serveurs {#connection}
...
### Nerdctl {#nerdctl}
...
### Services {#services}
Si nécessaire la documentation spécifique à chaque service si se trouve dans le Si nécessaire la documentation spécifique à chaque service si se trouve dans le
`README.md` du service sur [NETgit](https://git.netig.net). `README.md` du service sur [NETgit](https://git.netig.net).
### Installation d'un serveur {#server-install}
...
#### Preparation {#preparation}
...
#### Installation du système {#install}
...

28
src/content/doc/users.md Normal file
View File

@ -0,0 +1,28 @@
+++
title = "Le coin des utilisateurs"
slug = "users"
template = "documentation.html"
+++
Vous trouverez ici toutes les informations dont vous pourriez avoir besoin pour
utiliser les services de NETig.
### NETmail {#netmail}
Vous pouvez consulter vos mails depuis le [webmail](https://webmail.netig.net),
mais si vous souhaitez utiliser un client tel que Thunderbird, ou bien K-9 Mail
sur Android voici la configuration :
IMAP
* Serveur : mail.netig.net
* Type de sécurité : STARTTLS
* Port : 143
* Nom d'utilisateur : adresse mail complète
SMTP
* Serveur : mail.netig.net
* Type de sécurité : STARTTLS
* Port : 587
* Nom d'utilisateur : adresse mail complète

View File

@ -109,13 +109,13 @@ h2 {
} }
h3 { h3 {
font-size: 2.2rem; font-size: 2rem;
line-height: 2.2rem; line-height: 2rem;
} }
h4 { h4 {
font-size: 1.8rem; font-size: 1.6rem;
line-height: 1.8rem; line-height: 1.6rem;
} }
/* Animations /* Animations

View File

@ -4,11 +4,14 @@
<div class="col--1-4"> <div class="col--1-4">
<div class="docnav"> <div class="docnav">
<ul> <ul>
<li><a href="#users">Utilisateurs</a></li> <a href="/doc"></a>
{% if current_path == "/doc/users/" %}
<li><a href="#users">Le coin des utilisateurs</a></li>
<ul> <ul>
<li><a href="#netmail">NETmail</a></li> <li><a href="#netmail">NETmail</a></li>
</ul> </ul>
<li><a href="#admins">Administrateurs</a></li> {% elif current_path == "/doc/admins/" %}
<li><a href="#admins">Le coin des administrateurs</a></li>
<ul> <ul>
<li><a href="#infra">Infrastructure</a></li> <li><a href="#infra">Infrastructure</a></li>
<ul> <ul>
@ -16,19 +19,21 @@
<li><a href="#network">Réseau</a></li> <li><a href="#network">Réseau</a></li>
<li><a href="#backups">Sauvegardes</a></li> <li><a href="#backups">Sauvegardes</a></li>
</ul> </ul>
<li><a href="#chimera">Chimera Linux</a></li>
<ul>
<li><a href="#apk">APK</a></li>
<li><a href="#dinit">Dinit</a></li>
</ul>
<li><a href="#maintenance">Maintenance</a></li> <li><a href="#maintenance">Maintenance</a></li>
<ul> <ul>
<li><a href="#connection">Connexion aux serveurs</a></li> <li><a href="#connection">Connexion aux serveurs</a></li>
<li><a href="#apk">APK</a></li>
<li><a href="#nerdctl">Nerdctl</a></li> <li><a href="#nerdctl">Nerdctl</a></li>
<li><a href="#services">Services</a></li> <li><a href="#services">Services</a></li>
</ul> </ul>
<li><a href="#server-install">Installation d'un serveur</a></li>
<ul>
<li><a href="#preparation">Preparation</a></li>
<li><a href="#install">Installation du système</a></li>
</ul>
</ul> </ul>
{% endif %}
</ul> </ul>
</div> </div>
<div class="content"> <div class="content">

View File

@ -1,4 +1,4 @@
{% if not page %} {% if current_path == "/" %}
<div class="content col--1-2"> <div class="content col--1-2">
<div> <div>
<a class="logo" href="/#"><img class="logo" src="{{ get_url(path="images/favicon.webp") }}" alt="Logo"></a> <a class="logo" href="/#"><img class="logo" src="{{ get_url(path="images/favicon.webp") }}" alt="Logo"></a>

View File

@ -29,7 +29,7 @@
<a href="/maintenance">Maintenance et incidents</a> <a href="/maintenance">Maintenance et incidents</a>
</li> </li>
<li> <li>
<a href="/documentation">Documentation</a> <a href="/doc">Documentation</a>
</li> </li>
<li> <li>
<a href="/contact">Contact</a> <a href="/contact">Contact</a>

View File

@ -1,5 +1,5 @@
<div class="topbar sticky"> <div class="topbar sticky">
{% if page %} {% if current_path != "/" %}
<a class="logo--min" href="/#"><img class="logo" src="{{ get_url(path="images/favicon.webp") }}" alt="Logo"></a> <a class="logo--min" href="/#"><img class="logo" src="{{ get_url(path="images/favicon.webp") }}" alt="Logo"></a>
{% endif %} {% endif %}
<a class="" href="https://webmail.netig.net" target="_blank">NETmail</a> <a class="" href="https://webmail.netig.net" target="_blank">NETmail</a>

View File

@ -0,0 +1,8 @@
{% extends "base.html" %}
{% block content %}
<div class="content">
<h1>{{ section.title }}</h1>
{{ section.content | safe }}
</div>
{% endblock content %}