First Commit

wireguard/genconfig_simple.md

@@ -0,0 +1,34 @@
+1) Le script fonctionne en partant du principe qu'il va sauver / utiliser un fichier INI et les fichiers Wireguard générés en relation avec ça dans un répertoire
+   Ça veut dire qu'on doit utiliser quelque chose qui ressemble à:
+   	Compagnie / router1
+   	Compagnie / router2
+   Donc, on fait un "cd" Compagnie/router1 et on utilise de là
+   On pourrait aussi avoir:  Compagnie / router1 / interface 1  (j'ai la plupart du temps WG_Users et WG_Routers!)
+
+2) Les paramètres sont contenus dans un array au début du script.  Je vais ajouter un champs sur chaque ligne pour un "nom de field" plus facile à comprendre
+
+PARAMS=(
+RtrInterface		Nom de l'interface Wireguard avec laquelle sera associée la config du client
+Rtr_Addr_Admin		L'adresse IP où le script va connecter pour ajouter la config du client (futur)
+Rtr_Addr_Public		L'adresse publique sur laquelle le client connecte: IP ou FQDN
+Rrt_Port		Le port de l'interface associée du router sur lequel le client connecte
+Rtr_Addr_Private	L'adresse du router, sur le subnet alloué au clients.  Mon standard, genre: 10.1.2.254 et le client #1 aura 10.1.2.1, client #2 10.1.2.2, etc
+Rtr_CIDR_Mask		Le masque du subnet associé à l'interface du router sur son interface
+Rtr_PUB_KEY		La clef publique associée à l'interface du router
+Rtr_DNS			Le/les DNS qu'on place dans la config du client
+Rtr_Route_Subnet	Le subnet qui est associé au routage pour la connexion client.  0.0.0.0/0 pour envoyer tout le trafic via cette connexion wireguard.
+)
+
+3) Je conseille d'utiliser des noms de user et routers avec un # de séquence associé.  Ça permet de savoir quel IP sera allouée à chaque client
+	Ex: 	U001-Guy, U002-Marc  (Users)
+		R001-Toronto, R002-Quebec  (Routers)
+
+4) Les paramètres de la CLI on beaucoup changé avec la dernière version, voir la manière actuelle dans l'exemple ci-bas
+
+## Utilisation
+~~~bash
+
+# Pour l'instant, minimal (autres paramètres = futur):
+../genconfig_simple -n 1 -u marc
+~~~
+