diff --git a/content/introduction/_index.en.md b/content/introduction/_index.en.md new file mode 100644 index 0000000..df9754a --- /dev/null +++ b/content/introduction/_index.en.md @@ -0,0 +1,9 @@ +--- +date: 2025-06-15T10:30:00+02:00 +title: Get started +author: nemunaire +archetype: chapter +weight: 1 +--- + +{{% children %}} diff --git a/content/introduction/_index.fr.md b/content/introduction/_index.fr.md new file mode 100644 index 0000000..a2fd06a --- /dev/null +++ b/content/introduction/_index.fr.md @@ -0,0 +1,9 @@ +--- +date: 2025-06-15T10:30:00+02:00 +title: Premiers pas +author: nemunaire +archetype: chapter +weight: 1 +--- + +{{% children %}} diff --git a/content/deploy/_index.en.md b/content/introduction/deploy/_index.en.md similarity index 96% rename from content/deploy/_index.en.md rename to content/introduction/deploy/_index.en.md index 0ae34a5..7f64e4d 100644 --- a/content/deploy/_index.en.md +++ b/content/introduction/deploy/_index.en.md @@ -2,7 +2,7 @@ date: 2021-01-12T21:38:49+02:00 title: Installation and deployment archetype: chapter -weight: 4 +weight: 40 --- Depending on your concerns, happyDomain can be deployed in different kind of environment. diff --git a/content/deploy/_index.fr.md b/content/introduction/deploy/_index.fr.md similarity index 96% rename from content/deploy/_index.fr.md rename to content/introduction/deploy/_index.fr.md index fe3e226..474d5f3 100644 --- a/content/deploy/_index.fr.md +++ b/content/introduction/deploy/_index.fr.md @@ -2,7 +2,7 @@ date: 2020-12-09T19:23:38+01:00 title: Installation et deploiement archetype: chapter -weight: 4 +weight: 40 --- Selon vos besoins, happyDomain peut être déployé de différentes manières selon votre environnement. diff --git a/content/introduction/deploy/bind.en.md b/content/introduction/deploy/bind.en.md new file mode 100644 index 0000000..8dbe2d0 --- /dev/null +++ b/content/introduction/deploy/bind.en.md @@ -0,0 +1,102 @@ +--- +data: 2024-06-26T20:44:25+02:00 +title: Connect to a remote BIND server +weight: 30 +--- + +[BIND](https://www.isc.org/bind/) is an authoritative and recursive DNS server developed by the [Internet Systems Consortium](https://isc.org). + +It is possible to use it with happyDomain through [Dynamic DNS (RFC 2136)](https://www.rfc-editor.org/rfc/rfc2136). + +This documentation will guide you through configuring BIND to enable Dynamic DNS and connect your domains to happyDomain. + + +## Configure BIND to enable Dynamic DNS + +First, you need to edit the main BIND configuration file (usually `/etc/named.conf` or `/etc/bind/named.conf` depending on your distribution) to add a secret that will be shared between happyDomain and BIND to authenticate the changes. Then you must indicate which domains will be managed by happyDomain. + +### Adding a Shared Secret + +Under the main `key` section of your configuration, add the following key: + +```conf +key "happydomain" { + algorithm hmac-sha512; + secret ""; +}; +``` + +Replace `` with a string obtained using `openssl rand -base64 48`. + +### Creating an Authorization Rule for happyDomain + +In addition to the key, you must specify how the key can be used by defining an ACL and allowing updates from it. + +Add the following ACL to your configuration: + +```conf +acl "happydomain_acl" { + key happydomain; +}; +``` + +### Allowing Updates for Each Zone + +Now that you have created a rule allowing the `happydomain` key to make changes, you need to indicate to which zones this rule applies. + +For each zone, you must add an `update-policy` statement referencing the `happydomain_acl` ACL: + +For example, for an existing `happydomain.org` zone, add the `update-policy` statement as follows: + +```conf +zone "happydomain.org" { + type master; + file "/var/named/happydomain.org.db"; + update-policy { + grant happydomain_acl name happydomain.org. ANY; + }; +}; +``` + +The `update-policy` statement is a list, so you may already have other policies in this list. In this case, just add the `grant` statement for `happydomain_acl`. + +### Allowing Updates for All Zones + +If you manage many zones, it may be more convenient to set the default authorization for all zones. In this case, you can use a `global` `update-policy` in the `options` section: + +```conf +options { + update-policy { + grant happydomain_acl zonesub ANY; + }; +}; +``` + +This will apply the `update-policy` to all zones, allowing the `happydomain_acl` to update any record. + +### Apply the Configuration + +After modifying the configuration file, reload the BIND service to apply the changes: + +```sh +rndc reload +``` + +## Link happyDomain and BIND + +Once BIND is well configured, you can link it to happyDomain using [the *Dynamic DNS* connector]({{% ref "/pages/provider-new-choice.md" %}}) : + +![The Dynamic DNS connector on the host selection page](/img/choose-dynamic-dns.png) + +Follow these steps: + +1. Navigate to the Dynamic DNS connector on the host selection page in happyDomain. +2. Fill in the form with the address where your BIND server is accessible. +3. Fill in the Key fields with the information from the `key` section in the BIND configuration: + - **Key Name**: corresponds to the key name in BIND's configuration (e.g., `happydomain`). + - **Key Algorithm**: corresponds to the algorithm (e.g., `hmac-sha512`). + - **Secret Key**: corresponds to the secret. + +Once the provider is added, it does not allow you to list existing domains, but you can still manually add all your domains. + +By following these steps, you will have configured BIND to work with happyDomain using Dynamic DNS, ensuring secure and authenticated DNS updates. diff --git a/content/introduction/deploy/bind.fr.md b/content/introduction/deploy/bind.fr.md new file mode 100644 index 0000000..6de38a1 --- /dev/null +++ b/content/introduction/deploy/bind.fr.md @@ -0,0 +1,99 @@ +--- +data: 2024-06-26T20:44:25+02:00 +title: Connexion à un serveur BIND distant +weight: 30 +--- + +[BIND](https://www.isc.org/bind/) est un serveur DNS récursif et faisant autorité développé par l'[Internet Systems Consortium](https://isc.org). + +Il est possible de l'utiliser avec happyDomain en passant par le [Dynamic DNS (RFC 2136)](https://www.rfc-editor.org/rfc/rfc2136). + +Cette documentation vous guidera dans la configuration de BIND pour activer le DNS dynamique, puis pour relier ensemble happyDoain et votre serveur BIND. + + +## Configurer BIND pour activer le DNS dynamique + +Tout d'abord, vous devez modifier le fichier de configuration principal de BIND (généralement `/etc/named.conf` ou `/etc/bind/named.conf` selon votre distribution) pour ajouter un secret qui sera partagé entre happyDomain et BIND pour authentifier les modifications. Ensuite, vous devez indiquer quels domaines seront gérés par happyDomain. + +### Ajouter un secret partagé + +Sous la section principale `key` de votre configuration, ajoutez la clé suivante : + +```conf +key "happydomain" { + algorithm hmac-sha512; + secret ""; +}; +``` + +Remplacez `` par une chaîne obtenue en utilisant `openssl rand -base64 48`. + +### Créer une règle d'autorisation pour happyDomain + +En plus de la clé, vous devez spécifier comment la clé peut être utilisée en définissant une ACL et en autorisant les mises à jour à partir de celle-ci. + +Ajoutez l'ACL suivante à votre configuration : + +```conf +acl "happydomain_acl" { + key happydomain; +}; +``` + +### Autoriser les mises à jour pour chaque zone + +Maintenant que vous avez créé une règle permettant à la clé `happydomain` d'apporter des modifications, vous devez indiquer à quelles zones cette règle s'applique. + +Pour chaque zone, vous devez ajouter une déclaration `update-policy` référencant l'ACL `happydomain_acl` : + +Par exemple, pour une zone existante `happydomain.org`, ajoutez la déclaration `update-policy` comme suit : + +```conf +zone "happydomain.org" { + type master; + file "/var/named/happydomain.org.db"; + update-policy { + grant happydomain_acl name happydomain.org. ANY; + }; +}; +``` + +La déclaration `update-policy` est une liste, donc vous pouvez déjà avoir d'autres politiques dans cette liste. Dans ce cas, ajoutez simplement la déclaration `grant` pour `happydomain_acl`. + +### Autoriser les mises à jour pour routes les zones + +Si vous gérez de nombreuses zones, il peut être plus pratique de définir l'autorisation par défaut pour toutes les zones. Dans ce cas, vous pouvez utiliser une `update-policy` globale dans la section `options` : + +```conf +options { + update-policy { + grant happydomain_acl zonesub ANY; + }; +}; +``` + +Cela appliquera la `update-policy` à toutes les zones, permettant à l'ACL `happydomain_acl` de mettre à jour n'importe quel enregistrement. + +### Appliquer la configuration + +Après avoir modifié le fichier de configuration, rechargez le service BIND pour appliquer les modifications : + +```sh +rndc reload +``` + +## Lier happyDomain et BIND + +Une fois BIND bien configuré, vous pouvez le lier à happyDomain en utilisant [le connecteur *Dynamic DNS*]({{% ref "/pages/provider-new-choice.md" %}}) :. + +![Le connecteur Dynamic DNS sur la page de choix de l'hébergeur](/img/choose-dynamic-dns.png) + +Remplissez ensuite le formulaire avec l'adresse à laquelle votre serveur BIND est accessible, puis ensuite les différents champs *Key* avec les informations indiqués dans votre configuration : + +- **Key Name** : correspond au champ `id` ; +- **Key Algorithm** : correspond au champ `algorithm` ; +- **Secret Key** : correspond au champ `secret`. + +Une fois le fournisseur ajouté, il ne permet pas de lister les domaines existants, mais vous pouvez toujours ajouter manuellement tous vos domaines. + +En suivant ces étapes, vous aurez configuré BIND pour fonctionner avec happyDomain en utilisant le DNS dynamique, assurant des mises à jour DNS sécurisées et authentifiées. diff --git a/content/deploy/config.en.md b/content/introduction/deploy/config.en.md similarity index 100% rename from content/deploy/config.en.md rename to content/introduction/deploy/config.en.md diff --git a/content/deploy/config.fr.md b/content/introduction/deploy/config.fr.md similarity index 100% rename from content/deploy/config.fr.md rename to content/introduction/deploy/config.fr.md diff --git a/content/deploy/docker.en.md b/content/introduction/deploy/docker.en.md similarity index 97% rename from content/deploy/docker.en.md rename to content/introduction/deploy/docker.en.md index 9b7cce9..e07dacb 100644 --- a/content/deploy/docker.en.md +++ b/content/introduction/deploy/docker.en.md @@ -22,7 +22,7 @@ Currently, available tags are: ### For testing purpose -You can test happyDomain or use it for your own usage, with the option `HAPPYDOMAIN_NO_AUTH=1`: this will automatically creates a default account, and disable all features related to the user management (signup, login. ...). +You can test happyDomain or use it for your own usage, with the option `HAPPYDOMAIN_NO_AUTH=1`: this will automatically creates a default account, and disable all features related to the user management (signup, login, ...). ``` docker run -e HAPPYDOMAIN_NO_AUTH=1 -p 8081:8081 happydomain/happydomain @@ -44,6 +44,14 @@ Use the options `HAPPYDOMAIN_MAIL_SMTP_HOST`, `HAPPYDOMAIN_MAIL_SMTP_PORT` (defa docker run -e HAPPYDOMAIN_MAIL_SMTP_HOST=smtp.yourcompany.com -e HAPPYDOMAIN_MAIL_SMTP_USERNAME=happydomain -e HAPPYDOMAIN_MAIL_SMTP_PASSWORD=secret -v /var/lib/happydomain:/data -p 8081:8081 happydomain/happydomain ``` +If you prefer using a configuration file, you can place it either in `/data/happydomain.conf` to use the volume, or bind your file to `/etc/happydomain.conf`: + +``` +docker run -v happydomain.conf:/etc/happydomain.conf -p 8081:8081 happydomain/happydomain +``` + +#### Extend the base image + By default, happyDomain uses `sendmail`, if you prefer, you can create you own image with the package `ssmtp`: ``` @@ -52,11 +60,6 @@ RUN apk --no-cache add ssmtp COPY my_ssmtp.conf /etc/ssmtp/ssmtp.conf ``` -If you prefer using a configuration file, you can place it either in `/data/happydomain.conf` to use the volume, or bind your file to `/etc/happydomain.conf`: - -``` -docker run -v happydomain.conf:/etc/happydomain.conf -p 8081:8081 happydomain/happydomain -``` ## Admin Interface diff --git a/content/introduction/deploy/docker.fr.md b/content/introduction/deploy/docker.fr.md new file mode 100644 index 0000000..e66e19e --- /dev/null +++ b/content/introduction/deploy/docker.fr.md @@ -0,0 +1,81 @@ +--- +data: 2023-01-19T19:31:08+02:00 +title: Avec Docker +weight: 15 +--- + +happyDomain est sponsorisé Docker. +Vous trouverez notre image officielle sur [le Docker Hub](https://hub.docker.com/r/happydomain/happydomain/). + +Cette image exécutera happyDomain en tant que processus unique, avec une base de données LevelDB (similaire à sqlite, LevelDB est une base de données stockée sur le disque, il n'est pas nécessaire de configurer quoi que ce soit d'autre). + + +## Versions, étiquettes and architectures supportés + +Toutes les étiquettes (*tags*) sont construites pour les architectures de processeur les plus courantes (`amd64`, `arm64` et `arm/v7`). +Nous ne construisons des images uniquement basées sur la distribution Alpine Linux, ce qui assure des images de taille minimale. + +Actuellement, les étiquettes disponibles sont : + +- `latest`: il s'agit de la version la plus récente, correspondant à la branche `master` de notre dépôt de sources. + + +## Utilisation de l'image + +### À des fins de test + +Vous pouvez tester happyDomain ou l'utiliser pour votre usage personnel, avec l'option `HAPPYDOMAIN_NO_AUTH=1` : cela créera automatiquement un compte par défaut, et désactivera toutes les fonctionnalités liées à la gestion des utilisateurs (inscription, connexion, ...). + +``` +docker run -e HAPPYDOMAIN_NO_AUTH=1 -p 8081:8081 happydomain/happydomain +``` + +Les données sont stockées dans le répertoire `/data`. +Si vous souhaitez conserver vos paramètres d'une exécution à l'autre, vous devrez attacher ce répertoire à un volume géré par Docker ou à un répertoire sur votre hôte : + +``` +docker volume create happydomain_data +docker run -e HAPPYDOMAIN_NO_AUTH=1 -v happydomain_data:/data -p 8081:8081 happydomain/happydomain +``` + + +### En production + +happyDomain a besoin d'envoyer du courrier électronique, afin de vérifier les adresses et d'effectuer la récupération des mots de passe, vous devez donc configurer un relais SMTP. +Utilisez les options `HAPPYDOMAIN_MAIL_SMTP_HOST`, `HAPPYDOMAIN_MAIL_SMTP_PORT` (par défaut 25), `HAPPYDOMAIN_MAIL_SMTP_USERNAME` et `HAPPYDOMAIN_MAIL_SMTP_PASSWORD` à cette fin : + +``` +docker run -e HAPPYDOMAIN_MAIL_SMTP_HOST=smtp.yourcompany.com -e HAPPYDOMAIN_MAIL_SMTP_USERNAME=happydomain -e HAPPYDOMAIN_MAIL_SMTP_PASSWORD=secret -v /var/lib/happydomain:/data -p 8081:8081 happydomain/happydomain +``` + +Si vous préférez utiliser un fichier de configuration, vous pouvez le placer soit dans `/data/happydomain.conf` pour utiliser le volume, soit lier votre fichier à `/etc/happydomain.conf` : + +``` +docker run -v happydomain.conf:/etc/happydomain.conf -p 8081:8081 happydomain/happydomain +``` + + +#### Étendre l'image de base + +Par défaut, happyDomain utilise `sendmail`, si vous préférez, vous pouvez créer votre propre image avec le paquet `ssmtp` : + +``` +FROM happydomain/happydomain +RUN apk --no-cache add ssmtp +COPY my_ssmtp.conf /etc/ssmtp/ssmtp.conf +``` + + +## Interface d'administration + +happyDomain expose certaines commandes d'administration à travers un socket unix. +Le conteneur docker contient un script pour accéder à cette partie d'administration : `hadmin`. + +Vous pouvez l'utiliser de cette manière : + +``` +docker exec my_container hadmin /api/users +docker exec my_container hadmin /api/users/0123456789/send_validation_email -X POST +``` + +Il s'agit en fait d'une surcouche au-dessus de `curl`, mais vous devez commencer par l'URL, et placer les options après. diff --git a/content/deploy/knot.en.md b/content/introduction/deploy/knot.en.md similarity index 100% rename from content/deploy/knot.en.md rename to content/introduction/deploy/knot.en.md diff --git a/content/deploy/knot.fr.md b/content/introduction/deploy/knot.fr.md similarity index 100% rename from content/deploy/knot.fr.md rename to content/introduction/deploy/knot.fr.md diff --git a/content/deploy/oidc.en.md b/content/introduction/deploy/oidc.en.md similarity index 100% rename from content/deploy/oidc.en.md rename to content/introduction/deploy/oidc.en.md diff --git a/content/deploy/oidc.fr.md b/content/introduction/deploy/oidc.fr.md similarity index 100% rename from content/deploy/oidc.fr.md rename to content/introduction/deploy/oidc.fr.md diff --git a/content/deploy/ovh.en.md b/content/introduction/deploy/ovh.en.md similarity index 100% rename from content/deploy/ovh.en.md rename to content/introduction/deploy/ovh.en.md diff --git a/content/deploy/ovh.fr.md b/content/introduction/deploy/ovh.fr.md similarity index 100% rename from content/deploy/ovh.fr.md rename to content/introduction/deploy/ovh.fr.md diff --git a/content/deploy/testing.fr.md b/content/introduction/deploy/testing.fr.md similarity index 100% rename from content/deploy/testing.fr.md rename to content/introduction/deploy/testing.fr.md diff --git a/content/introduction/quickstart/_index.en.md b/content/introduction/quickstart/_index.en.md new file mode 100644 index 0000000..78d6035 --- /dev/null +++ b/content/introduction/quickstart/_index.en.md @@ -0,0 +1,93 @@ +--- +date: 2025-06-15T11:44:00+02:00 +title: Quickstart +author: nemunaire +weight: 1 +--- + +happyDomain is a service that centralizes the management of your domain names from different registrars, hosts or authoritative DNS servers. +It's a web interface and a REST API that offer a simpler domain experience than most of the interfaces we usually see for managing domains, including features we'd expect to see in 2025. + +At happyDomain, we want to make sure that domain names and DNS are no longer a daunting experience, but instead give you all the tools you need to understand and make changes in peace. + +Can't wait to get started? Follow the guide! + + +## 1. Online or on premise + +happyDomain is free (as in free speech) software. +This means, among other things, that you can install it at home. + +If you're familiar with Docker, you can follow the [dedicated installation guide]({{% relref "../deploy/docker" %}}). + +If you're not familiar with the command line, or if you'd like to evaluate the software quickly, we recommend that you create an account on our online service. + +Go to : + + +## 2. Add a domain to manage + +happyDomain will connect to your hosting provider (or local authoritative server). +Your domain remains hosted where it is today; using happyDomain does not imply any transfer or change of ownership. + +{{% notice style="info" title="I don't have a domain name yet" icon="question" %}} + +We don't sell domain names, you must already have one [with a supported hosting provider](https://app.happydomain.org/providers/features). + +{{% /notice %}} + +When you log on to happyDomain for the first time, a wizard will guide you through the process of linking your first domain. + +Depending on your hosting provider, the procedure will differ. +But for most, you'll need to go to your host's customer account, and request an API key. + +For OVH, the procedure is simplified, as all you have to do is follow the instructions and authorize happyDomain to access the domain-related part of your account. + +If you have your own authoritative server, you'll need to get the keys to interact with it either from the administrator or by looking in the configuration. + +Once the connection between happyDomain and your first host or server has been established, all you have to do is select the domains you want happyDomain to manage. + + +## 3. Consult the DNS zone + +The DNS zone refers to the technical content of your domain. + +To view the zone corresponding to a domain, click on the domain name that appears on the happyDomain home page. + +After a few seconds of fully automatic import and analysis, you'll immediately see a list of registrations or services as they are currently distributed to your visitors. + +{{% notice style="primary" title="About the “services”" %}} + +The complexity of DNS stems in part from the mismatch between purely technical constraints and the actual use of records. + +happyDomain tries to simplify this by grouping technical records under their concrete uses. This is what we call “service”. + +{{% /notice %}} + + +## 4. Modify a record + +In the zone display screen, click on a record to view its details. + +Each DNS record has particular characteristics and constraints. +Context-sensitive help tries as far as possible to give you the essential information to guide you through the modifications you need to make. + +When you make a modification to a record, it is not directly published to your host or server. + + +## 5. Distribute your changes + +Once you've made all the changes you need, click on the “Distribute my changes” button. + +A dialog box will appear showing you the exact changes that will be applied to your host. +At this point, there's still time to select the changes you don't want/no longer want to be applied. + +Before validating the window, you can add a message that will be recorded in the log, enabling you to quickly recall the reason for the change. + +After all, one of the advantages of happyDomain is that you can easily go back and undo a change if you see a mistake. +[History is the subject of a dedicated help page.]({{% relref "../../pages/domain-history" %}}) + +--- + +So now you know how to use happyDomain's main features. +If you encounter any problems or have any ideas for improvement, [please let us know](https://github.com/happyDomain/happyDomain/issues/new). diff --git a/content/introduction/quickstart/_index.fr.md b/content/introduction/quickstart/_index.fr.md new file mode 100644 index 0000000..7d9f484 --- /dev/null +++ b/content/introduction/quickstart/_index.fr.md @@ -0,0 +1,93 @@ +--- +date: 2025-06-15T11:44:00+02:00 +title: Démarrer rapidement +author: nemunaire +weight: 1 +--- + +happyDomain est un service qui centralise la gestion de vos noms de domaines depuis différents bureaux d'enregistrement, hébergeurs ou serveurs DNS faisant autorité. +Il s'agit d'une interface web et d'une API REST qui vous proposent d'avoir une expérience des domaines plus simple que la plupart des interfaces que l'on peut voir habituellement pour gérer ses domaines, avec notamment des fonctionnalités que l'on attendrait en 2025. + +Avec happyDomain, nous voulons faire en sorte que les noms de domaine et le DNS ne soient plus une expérience rebutante, mais au contraire vous redonner toutes les cartes en main pour comprendre et faire des modifications serainement. + +Vous avez hâtes de commencer ? suivez le guide ! + + +## 1. En ligne ou chez soi + +happyDomain est un logiciel libre. +Cela signifie entre-autre que vous pouvez l'installer chez vous. + +Si vous connaissez Docker, vous pouvez suivre le [guide d'installation dédié]({{% relref "../deploy/docker" %}}). + +Si vous n'êtes pas un habitué de la ligne de commande ou que vous souhaitez évaluer rapidement le logiciel, nous vous recommandons de vous créer un compte sur notre service en ligne. + +Rendez-vous sur : + + +## 2. Ajouter un domaine à gérer + +happyDomain va se connecter à votre hébergeur (ou à votre serveur local faisant autorité). +Votre domaine reste hébergé là où il est aujourd'hui, utiliser happyDomain n'implique aucun transfert ou changement de propriété. + +{{% notice style="info" title="Je n'ai pas encore de nom de domaine" icon="question" %}} + +Nous ne vendons pas de noms de domaine, il faut que vous en disposiez déjà d'un [chez un hébergeur supporté](https://app.happydomain.org/providers/features). + +{{% /notice %}} + +Lorsque vous vous connectez pour la première fois à happyDomain, un assistant vous guide pour relier votre premier domaine. + +Selon votre hébergeur, la procédure sera différente. +Mais pour la plupart, vous devrez vous rendre sur le compte client de votre hébergeur, et demander une clef d'API. + +Pour OVH, la procédure est simplifiée car il n'y a qu'à suivre les instructions et à vous autoriser happyDomain à accéder à la partie liée aux domaines de votre compte. + +Si vous avez votre propre serveur faisant autorité, vous devrez récupérer soit auprès de l'administrateur, soit en regardant dans la configuration, les clefs permettant d'interagir avec le serveur. + +Une fois la connexion entre happyDomain et votre premier hébergeur ou serveur établi, vous n'avez plus qu'à sélectionner les domaines que vous souhaitez voir gérer dans happyDomain. + + +## 3. Consulter la zone DNS + +On parle de zone DNS pour faire référence au contenu technique de votre domaine. + +Pour afficher la zone correspondant à un domaine, cliquez sur le nom de domaine qui apparaît sur la page d'accueil d'happyDomain. + +Après quelques secondes d'import et d'analyse entièrement automatique, vous verrez tout de suite une liste d'enregistrements ou de services tels qu'actuellement diffusés auprès de vos visiteurs. + +{{% notice style="primary" title="À propos des « services »" %}} + +La complexité du DNS vient en partie d'un décalage entre les contraintes purement techniques et l'usage concret des enregistrements. + +happyDomain essai de simplifier cela en regroupant les enregistrements techniques sous leurs usages concrets. C'est cela que l'on appel « service ». + +{{% /notice %}} + + +## 4. Modifier un enregistrement + +Dans l'écran montrant la zone, appuyer sur un enregistrement pour afficher les détails. + +Chaque enregistrement DNS a des caractéristiques et des contraintes particulières. +Les aides contextuelles essaient autant que possible de vous donner les informations essentielles pour vous guider dans les modifications dont vous avez besoin. + +Lorsque vous faites une modification sur un enregistrement, celle-ci n'est pas directement publiée auprès de votre hébergeur ou de votre serveur. + + +## 5. Propager vos modifications + +Une fois que vous avez fait toutes les modifications dont vous avez besoin, cliquez sur le bouton « Diffuser mes changements ». + +Une boîte de dialogue va s'afficher pour vous montrer les changements exacts qui seront appliqués auprès de votre hébergeur. +À ce stade, il est toujours temps de sélectionner les changements que vous ne souhaitez pas/plus voir appliqués. + +Avant de valider la fenêtre, vous pouvez ajouter un message qui sera enregistré dans le journal, ce qui vous permettra de vous rappeler rapidement quel était la raison de ce changement. + +Car l'un des avantages d'happyDomain, c'est que vous pouvez très facilement revenir en arrière, annuler une modification, s'il s'avère que vous voyez une erreur. +[L'historique fait l'objet d'une page d'aide dédiée.]({{% relref "../../pages/domain-history" %}}) + +--- + +Eh voilà, vous savez maintenant utilisé les principales fonctionnalités d'happyDomain. +Si vous rencontrez des problèmes ou si vous avez des idées d'amélioration, [pensez à nous le faire savoir](https://github.com/happyDomain/happyDomain/issues/new). diff --git a/content/pages/_index.en.md b/content/pages/_index.en.md index 28fffa9..81c09c9 100644 --- a/content/pages/_index.en.md +++ b/content/pages/_index.en.md @@ -1,9 +1,9 @@ --- date: 2021-01-12T21:38:49+02:00 -title: The main displays +title: Features author: Frederic archetype: chapter -weight: 1 +weight: 10 --- {{% children %}} diff --git a/content/pages/_index.fr.md b/content/pages/_index.fr.md index 6c0fd0a..cba0436 100644 --- a/content/pages/_index.fr.md +++ b/content/pages/_index.fr.md @@ -1,8 +1,8 @@ --- date: 2020-12-09T19:23:38+01:00 -title: Les principaux écrans +title: Fonctionnalités archetype: chapter -weight: 1 +weight: 10 --- {{% children %}} diff --git a/content/pages/domain-abstract.fr.md b/content/pages/domain-abstract.fr.md index c7f4eca..6f50052 100644 --- a/content/pages/domain-abstract.fr.md +++ b/content/pages/domain-abstract.fr.md @@ -1,6 +1,6 @@ --- date: 2020-12-09T18:12:45+01:00 -title: Votre domaine +title: Éditer votre zone weight: 30 --- diff --git a/content/pages/domain-history.en.md b/content/pages/domain-history.en.md new file mode 100644 index 0000000..88753d8 --- /dev/null +++ b/content/pages/domain-history.en.md @@ -0,0 +1,7 @@ +--- +date: 2025-06-15T11:06:00+02:00 +title: "View change history" +weight: 40 +--- + +Every time you [publish changes]({{% relref "publish-changes" %}}) with happyDomain, they are recorded in a log. This log allows you to easily retrieve the status of your domains as they were previously deployed, and to see when you made each change. diff --git a/content/pages/domain-history.fr.md b/content/pages/domain-history.fr.md new file mode 100644 index 0000000..08f97b3 --- /dev/null +++ b/content/pages/domain-history.fr.md @@ -0,0 +1,7 @@ +--- +date: 2025-06-15T11:06:00+02:00 +title: "Voir l'historique des changements" +weight: 40 +--- + +À chaque fois que vous [publiez des modifications]({{% relref "publish-changes" %}}) avec happyDomain, celles-ci sont enregistrées dans un journal. Ce journal vous permet de retrouver facilement l'état de vos domaines tels qu'ils étaient déployés précédemment, et de voir quand vous avez fait chaque modification. diff --git a/content/pages/domain-new.en.md b/content/pages/domain-new.en.md index 6d7c858..738330e 100644 --- a/content/pages/domain-new.en.md +++ b/content/pages/domain-new.en.md @@ -1,11 +1,13 @@ --- date: 2021-01-12T21:38:49+02:00 -title: Add a domain +title: Import a domain author: Frederic weight: 20 --- -You reach this screen after having validated on [home page]({{% relref "home#add-a-domain" %}}) the form to add a domain (and you didn' previously [selected a host in the right filter]({{% relref "home#your-registries-and-domain-hosters" %}})). +Importing a domain into happyDomain does not make happyDomain the owner of your domain. This action does not involve any changes to your usual hosting provider. happyDomain will contact your hosting provider or server to check which services are currently registered. + +You reach this screen after having validated on [home page]({{% relref "domains#add-a-domain" %}}) the form to add a domain (and you didn' previously [selected a host in the right filter]({{% relref "domains#your-registries-and-domain-hosters" %}})). ## Hosting provider selection diff --git a/content/pages/domain-new.fr.md b/content/pages/domain-new.fr.md index c3a3b90..78b3e0f 100644 --- a/content/pages/domain-new.fr.md +++ b/content/pages/domain-new.fr.md @@ -1,10 +1,12 @@ --- date: 2020-12-09T18:12:45+01:00 -title: Ajout d'un domaine +title: Importer un domaine weight: 20 --- -Vous accédez à cet écran après avoir validé sur [la page d'accueil]({{% relref "home#ajouter-un-domaine" %}}) le formulaire d'ajout de domaine (et que vous n'aviez pas préalablement [sélectionné d'hébergeur dans le filtre de droite]({{% relref "home#vos-registres-et-hébergeurs-de-domaines" %}})). +Importer un domaine dans happyDomain ne rend pas happyDomain propriétaire de votre domaine. Cette action n'implique aucune modification auprès de votre hébergeur habituel. happyDomain va communiquer avec votre hébergeur ou votre serveur afin de consulter les services qui sont actuellement enregistrés. + +Vous accédez à cet écran après avoir validé sur [la page d'accueil]({{% relref "domains#ajouter-un-domaine" %}}) le formulaire d'ajout de domaine (et que vous n'aviez pas préalablement [sélectionné d'hébergeur dans le filtre de droite]({{% relref "domains#vos-registres-et-hébergeurs-de-domaines" %}})). ## Choix de l'hébergeur diff --git a/content/pages/home/_index.en.md b/content/pages/domains/_index.en.md similarity index 98% rename from content/pages/home/_index.en.md rename to content/pages/domains/_index.en.md index 9fd015d..6170d54 100644 --- a/content/pages/home/_index.en.md +++ b/content/pages/domains/_index.en.md @@ -1,9 +1,9 @@ --- date: 2021-01-12T21:38:49+02:00 -title: The Home page +title: Centralize your domains author: Frederic aliases: - domains + home weight: 10 --- diff --git a/content/pages/home/_index.fr.md b/content/pages/domains/_index.fr.md similarity index 83% rename from content/pages/home/_index.fr.md rename to content/pages/domains/_index.fr.md index 693dae8..932d3fb 100644 --- a/content/pages/home/_index.fr.md +++ b/content/pages/domains/_index.fr.md @@ -1,11 +1,14 @@ --- date: 2020-12-09T18:12:45+01:00 -title: La page d'accueil +title: Regrouper vos domaines aliases: - domains + home weight: 10 --- +happyDomain vous apporte une interface graphique unifiée et avec des fonctionnalités modernes quelque soit l'endroit où sont hébergés vos noms de domaine. Ils peuvent être sur un serveur DNS (PowerDNS, bind, knot, ...) qui vous est propre, ou bien chez un ou plusieurs hébergeurs (une 50aine sont supportés à l'heure actuelle). + + ## Vos domaines La page d'accueil présente la liste de l'ensemble des domaines gérés par happyDomain, quelque soit leur hébergeur : @@ -15,7 +18,7 @@ La page d'accueil présente la liste de l'ensemble des domaines gérés par happ Cliquez sur l'un des domaines pour commencer à [y apporter des modifications]({{% relref "domain-abstract" %}}) (ajouter un sous-domaine, ajouter un service, ...). -## Vos registres et hébergeurs de domaines +## Vos hébergeurs de domaines Sur la droite, vous voyez la liste des différents hébergeurs de vos domaines : @@ -38,7 +41,7 @@ Si vous constatez une erreur ou n'avez plus besoin d'un hébergeur, cliquez sur ![Modification ou suppression d'un hébergeur](hoster-edit.png) -Notez que vous ne pourrez pas supprimer l'hébergeur tant que des domaines y faisant référence, existeront dans la liste de gauche. +Notez que vous ne pourrez pas supprimer l'hébergeur tant que des domaines y faisant référence existeront dans la liste de gauche. ## Ajouter un domaine diff --git a/content/pages/home/domain-list.png b/content/pages/domains/domain-list.png similarity index 100% rename from content/pages/home/domain-list.png rename to content/pages/domains/domain-list.png diff --git a/content/pages/home/hoster-edit.png b/content/pages/domains/hoster-edit.png similarity index 100% rename from content/pages/home/hoster-edit.png rename to content/pages/domains/hoster-edit.png diff --git a/content/pages/home/hoster-ovh.png b/content/pages/domains/hoster-ovh.png similarity index 100% rename from content/pages/home/hoster-ovh.png rename to content/pages/domains/hoster-ovh.png diff --git a/content/pages/home/hoster-self.png b/content/pages/domains/hoster-self.png similarity index 100% rename from content/pages/home/hoster-self.png rename to content/pages/domains/hoster-self.png diff --git a/content/pages/home/hosters-list.png b/content/pages/domains/hosters-list.png similarity index 100% rename from content/pages/home/hosters-list.png rename to content/pages/domains/hosters-list.png diff --git a/content/pages/home/new-domain.png b/content/pages/domains/new-domain.png similarity index 100% rename from content/pages/home/new-domain.png rename to content/pages/domains/new-domain.png diff --git a/content/pages/me.en.md b/content/pages/me.en.md index 4a73a82..60d36c7 100644 --- a/content/pages/me.en.md +++ b/content/pages/me.en.md @@ -1,6 +1,6 @@ --- date: 2021-01-12T21:38:49+02:00 -title: "My account" +title: "Set up your profile" author: Frederic weight: 40 --- diff --git a/content/pages/me.fr.md b/content/pages/me.fr.md index 0141e13..d5ae27f 100644 --- a/content/pages/me.fr.md +++ b/content/pages/me.fr.md @@ -1,6 +1,6 @@ --- date: 2020-12-10T10:26:54+01:00 -title: "Mon compte" +title: "Paramétrer son profil" weight: 40 --- diff --git a/content/pages/provider-list/_index.en.md b/content/pages/provider-list/_index.en.md index c9aa17d..09801ab 100644 --- a/content/pages/provider-list/_index.en.md +++ b/content/pages/provider-list/_index.en.md @@ -1,7 +1,7 @@ --- date: 2021-01-12T21:38:49+02:00 author: Frederic -title: Hosting providers +title: List your name providers aliases: hosters source-list diff --git a/content/pages/provider-list/_index.fr.md b/content/pages/provider-list/_index.fr.md index 889151b..009acb4 100644 --- a/content/pages/provider-list/_index.fr.md +++ b/content/pages/provider-list/_index.fr.md @@ -1,6 +1,6 @@ --- date: 2020-12-09T18:12:45+01:00 -title: Les hébergeurs +title: Lister vos hébergeurs de noms aliases: hosters source-list diff --git a/content/pages/provider-update.en.md b/content/pages/provider-update.en.md index 8fd1d6a..c1ad54f 100644 --- a/content/pages/provider-update.en.md +++ b/content/pages/provider-update.en.md @@ -11,7 +11,7 @@ weight: 19 You access this screen either: - when you want to add a host, after having selected the provider, -- when you want to change the connection settings between happyDomain and a host, for example on the [home page]({{% relref "home#modify-or-delete-a-host" %}}). +- when you want to change the connection settings between happyDomain and a host, for example on the [home page]({{% relref "domains#modify-or-delete-a-host" %}}). ## Connection name diff --git a/content/pages/provider-update.fr.md b/content/pages/provider-update.fr.md index d9ace6c..8ea360b 100644 --- a/content/pages/provider-update.fr.md +++ b/content/pages/provider-update.fr.md @@ -10,7 +10,7 @@ weight: 19 Vous accédez à cet écran soit : - lorsque vous souhaitez ajouter un hébergeur, après avoir sélectionné le fournisseur, -- lorsque vous souhaitez modifier les paramètres de connexion entre happyDomain et un hébergeur, par exemple sur la [page d'accueil]({{% relref "home#modifier-ou-supprimer-un-hébergeur" %}}). +- lorsque vous souhaitez modifier les paramètres de connexion entre happyDomain et un hébergeur, par exemple sur la [page d'accueil]({{% relref "domains#modifier-ou-supprimer-un-hébergeur" %}}). ## Nom de la connexion diff --git a/content/pages/publish-changes.en.md b/content/pages/publish-changes.en.md new file mode 100644 index 0000000..f99c5a2 --- /dev/null +++ b/content/pages/publish-changes.en.md @@ -0,0 +1,16 @@ +--- +date: 2025-06-15T11:08:00+02:00 +title: "Publish modifications" +weight: 40 +--- + +When you make a change in happyDomain, it is not directly passed on to your host or server. + +Once you've made all the changes you wish to be propagated, click on the “Distribute my changes” button. + +A window will open showing exactly which concrete changes will be passed on to your host or server. + +If at this stage you don't want to apply all the changes, you can uncheck some of them. + +Don't forget to enter a message in the appropriate field: this message will be recorded in your log. +Later, when you need to see what changes you've made, it might be simpler to read “Changing host from Wordpress to Alwaysdata” rather than trying to interpret IP changes, ... diff --git a/content/pages/publish-changes.fr.md b/content/pages/publish-changes.fr.md new file mode 100644 index 0000000..f42830f --- /dev/null +++ b/content/pages/publish-changes.fr.md @@ -0,0 +1,16 @@ +--- +date: 2025-06-15T11:08:00+02:00 +title: "Publier des modifications" +weight: 40 +--- + +Lorsque vous effectuez un changement dans happyDomain, celui-ci n'est pas directement répercuté auprès de votre hébergeur ou de votre serveur. + +Une fois que vous avez fait toutes les modifications que vous souhaitez voir propagées, cliquez sur le bouton « Diffuser mes changements ». + +Une fenêtre va s'ouvrir montrant précisément quelle modifications concrètes seront répercutées auprès de votre hébergeur ou de votre serveur. + +Si à ce stade vous ne voulez pas appliquer tous les changements, vous pouvez en décocher certains. + +N'oubliez pas d'indiquer un message dans le champs prévu à cet effet : ce message sera consigné dans votre journal. +Plus tard, lorsque vous aurez besoin de voir quelles ont été vos modifications, cela pourrait s'avérer plus simple de lire « Changement d'hébergeur de Wordpress vers Alwaysdata » plutôt que de chercher à interpréter les changements d'IP, ... diff --git a/content/pages/tools-client.en.md b/content/pages/tools-client.en.md index a42ce38..2ed133d 100644 --- a/content/pages/tools-client.en.md +++ b/content/pages/tools-client.en.md @@ -1,7 +1,7 @@ --- date: 2021-01-12T21:38:49+02:00 author: Frederic -title: "Tools: the DNS resolver" +title: Test a domain weight: 50 --- diff --git a/content/pages/tools-client.fr.md b/content/pages/tools-client.fr.md index cb29ea7..146ecf4 100644 --- a/content/pages/tools-client.fr.md +++ b/content/pages/tools-client.fr.md @@ -1,6 +1,6 @@ --- date: 2020-12-10T10:26:54+01:00 -title: "Outils : le résolveur DNS" +title: Tester un domaine weight: 50 --- diff --git a/content/reference/_index.en.md b/content/reference/_index.en.md new file mode 100644 index 0000000..8be8c49 --- /dev/null +++ b/content/reference/_index.en.md @@ -0,0 +1,9 @@ +--- +date: 2025-06-15T11:38:46+02:00 +title: Reference +author: nemunaire +archetype: chapter +weight: 20 +--- + +{{% children %}} diff --git a/content/reference/_index.fr.md b/content/reference/_index.fr.md new file mode 100644 index 0000000..a21afbf --- /dev/null +++ b/content/reference/_index.fr.md @@ -0,0 +1,9 @@ +--- +date: 2025-06-15T11:38:46+02:00 +title: Référence +author: nemunaire +archetype: chapter +weight: 20 +--- + +{{% children %}} diff --git a/content/records/SOA.en.md b/content/reference/records/SOA.en.md similarity index 86% rename from content/records/SOA.en.md rename to content/reference/records/SOA.en.md index 22b7337..45f1665 100644 --- a/content/records/SOA.en.md +++ b/content/reference/records/SOA.en.md @@ -3,6 +3,8 @@ date: 2021-01-12T21:38:49+02:00 author: Frederic title: SOA (Start Of Authority) weight: 10 +aliases: + records/SOA --- The Start of Authority-SOA is the first record of a zone. diff --git a/content/records/SOA.fr.md b/content/reference/records/SOA.fr.md similarity index 84% rename from content/records/SOA.fr.md rename to content/reference/records/SOA.fr.md index 75fe3b3..3f573d8 100644 --- a/content/records/SOA.fr.md +++ b/content/reference/records/SOA.fr.md @@ -2,6 +2,8 @@ date: 2020-12-15T01:01:08+01:00 title: SOA (Start Of Authority) weight: 10 +aliases: + records/SOA --- Le SOA est le premier enregistrement d'une zone. diff --git a/content/records/TXT.en.md b/content/reference/records/TXT.en.md similarity index 83% rename from content/records/TXT.en.md rename to content/reference/records/TXT.en.md index b4d65d7..cefc6b6 100644 --- a/content/records/TXT.en.md +++ b/content/reference/records/TXT.en.md @@ -3,6 +3,8 @@ date: 2021-01-12T21:38:49+02:00 author: Frederic title: TXT weight: 20 +aliases: + records/TXT --- Please, help us to write this Documentation screen diff --git a/content/records/TXT.fr.md b/content/reference/records/TXT.fr.md similarity index 77% rename from content/records/TXT.fr.md rename to content/reference/records/TXT.fr.md index 134e199..2dbb67e 100644 --- a/content/records/TXT.fr.md +++ b/content/reference/records/TXT.fr.md @@ -2,6 +2,8 @@ date: 2020-12-15T01:01:08+01:00 title: TXT weight: 20 +aliases: + records/TXT --- Documentation à faire diff --git a/content/records/_index.en.md b/content/reference/records/_index.en.md similarity index 91% rename from content/records/_index.en.md rename to content/reference/records/_index.en.md index 41618b0..0ed2f63 100644 --- a/content/records/_index.en.md +++ b/content/reference/records/_index.en.md @@ -3,7 +3,7 @@ date: 2021-01-12T21:38:49+02:00 author: Frederic title : DNS records archetype: chapter -weight: 2 +weight: 10 --- {{% children %}} diff --git a/content/records/_index.fr.md b/content/reference/records/_index.fr.md similarity index 79% rename from content/records/_index.fr.md rename to content/reference/records/_index.fr.md index 761f6d7..bfccab7 100644 --- a/content/records/_index.fr.md +++ b/content/reference/records/_index.fr.md @@ -3,7 +3,9 @@ date: 2020-12-09T19:23:38+01:00 title: Enregistrements DNS author: nemunaire archetype: chapter -weight: 2 +weight: 10 +aliases: + records --- {{% children %}} diff --git a/content/services/_index.en.md b/content/reference/services/_index.en.md similarity index 61% rename from content/services/_index.en.md rename to content/reference/services/_index.en.md index 1a52f3a..1792bff 100644 --- a/content/services/_index.en.md +++ b/content/reference/services/_index.en.md @@ -1,9 +1,11 @@ --- date: 2021-01-12T21:38:49+02:00 author: Frederic -title: The services +title: Abstract services archetype: chapter -weight: 3 +weight: 30 +aliases: + services --- {{% children %}} diff --git a/content/services/_index.fr.md b/content/reference/services/_index.fr.md similarity index 54% rename from content/services/_index.fr.md rename to content/reference/services/_index.fr.md index ec7cd8b..0e4947d 100644 --- a/content/services/_index.fr.md +++ b/content/reference/services/_index.fr.md @@ -1,8 +1,10 @@ --- date: 2020-12-09T19:23:38+01:00 -title: Les services +title: Abstractions de services archetype: chapter -weight: 3 +weight: 30 +aliases: + services --- {{% children %}} diff --git a/content/services/email.en.md b/content/reference/services/email.en.md similarity index 87% rename from content/services/email.en.md rename to content/reference/services/email.en.md index b96254c..67ab4d8 100644 --- a/content/services/email.en.md +++ b/content/reference/services/email.en.md @@ -2,6 +2,8 @@ date: 2021-01-12T21:38:49+02:00 author: Frederic title: E-Mail +aliases: + services/email --- The E-Mail service allows you to define an e-mail server on the zone, as well as the zone settings for sending/receiving e-mails. diff --git a/content/services/email.fr.md b/content/reference/services/email.fr.md similarity index 88% rename from content/services/email.fr.md rename to content/reference/services/email.fr.md index e550f61..6cd3b18 100644 --- a/content/services/email.fr.md +++ b/content/reference/services/email.fr.md @@ -1,6 +1,8 @@ --- date: 2020-12-15T01:01:08+01:00 title: E-Mail +aliases: + services/email --- Le service E-Mail permet de définir un serveur de courrier électronique sur la zone, ainsi que le paramétrage de la zone en vue d'envoyer/recevoir des courriels.