Reshape the documentation
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
This commit is contained in:
parent
922e77da81
commit
7e86d6f369
56 changed files with 615 additions and 37 deletions
93
content/introduction/quickstart/_index.en.md
Normal file
93
content/introduction/quickstart/_index.en.md
Normal file
|
|
@ -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 : <https://app.happydomain.org/join>
|
||||
|
||||
|
||||
## 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).
|
||||
93
content/introduction/quickstart/_index.fr.md
Normal file
93
content/introduction/quickstart/_index.fr.md
Normal file
|
|
@ -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 : <https://app.happydomain.org/join>
|
||||
|
||||
|
||||
## 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).
|
||||
Loading…
Add table
Add a link
Reference in a new issue