YunoHost's documentation has 2 different sections: diff --git a/docs_de.md b/docs_de.md index e8f57252..d3bf8e07 100644 --- a/docs_de.md +++ b/docs_de.md @@ -1,4 +1,4 @@ -#Documentation +# Documentation
Die YunoHost Dokumentation ist in 2 Bereiche aufgeteilt: diff --git a/docs_fr.md b/docs_fr.md index 91090732..8c946ed8 100644 --- a/docs_fr.md +++ b/docs_fr.md @@ -1,4 +1,4 @@ -#Documentation +# Documentation
La documentation de YunoHost s’articule autour de deux sections : diff --git a/docs_it.md b/docs_it.md index 89535377..6f9f5568 100644 --- a/docs_it.md +++ b/docs_it.md @@ -1,4 +1,4 @@ -#Documentazione +# Documentazione
La documentazione di YunoHost ha 2 differenti sezioni: diff --git a/domains.md b/domains.md index f9527a1d..c98175cb 100644 --- a/domains.md +++ b/domains.md @@ -1,5 +1,4 @@ -Domains, DNS conf and certificate -================================= +# Domains, DNS conf and certificate YunoHost allows you to manage and serve several domains on the same server. For instance, you can host a blog and Nextcloud on a first domain `yolo.com`, and a web mail client on a second domain `swag.nohost.me`. Each domain is automatically configured to handle web services, mail services and XMPP services. @@ -9,25 +8,21 @@ The domain chosen during the postinstall is defined as the main domain of the se Finally, take note that, in the context of YunoHost, there is no hierarchy between the domains it knows. In the previous example, you may add a third domain `foo.yolo.com` - but it would be considered as a domain independent of `yolo.com`. -Non-latin characters ------------------ +## Non-latin characters If your domain has special, non-latin characters, you need to use its [internationalized version](https://en.wikipedia.org/wiki/Internationalized_domain_name) through [Punycode](https://en.wikipedia.org/wiki/Punycode). You can use [this converter](https://www.charset.org/punycode), and use the converted domain name in your YunoHost configuration. -DNS configuration ------------------ +## DNS configuration DNS (Domain Name System) is a system that allows computers from around the world to translate human-readable domain names (such as `yolo.com`) to machine-understandable adresses called IP addresses (such as `11.22.33.44`). For this translation (and other features) to work, you must carefully configure DNS records. YunoHost can generate a recommended DNS configuration for each domain, including elements needed for mail and XMPP. The recommended DNS configuration is available in the webadmin via Domain > (the domain) > DNS configuration, or with the command `yunohost domain dns-conf the.domain.tld`. -SSL/HTTPS certificates ----------------------- +## SSL/HTTPS certificates Another important aspect of domain configuration is the SSL/HTTPS certificate. YunoHost is integrated with Let's Encrypt, so once your server is correctly reachable from anybody on the internet through the domain name, the administrator can request a Let's Encrypt certificate. See the documentation about [certificates](certificate) for more information. -Subpaths vs. individual domains per apps ----------------------------------------- +## Subpaths vs. individual domains per apps In the context of YunoHost, it is quite common to have a single (or a few) domains on which several apps are installed in "subpaths", so that you end up with something like this: diff --git a/domains_fr.md b/domains_fr.md index f03b6e4b..f1469e4c 100644 --- a/domains_fr.md +++ b/domains_fr.md @@ -1,5 +1,4 @@ -Domaines, configuration DNS et certificats -========================================== +# Domaines, configuration DNS et certificats YunoHost permet de gérer et de servir plusieurs domaines sur un même serveur. Vous pouvez donc héberger, par exemple, un blog et un Nextcloud sur un premier domaine `yolo.com`, et un client de messagerie web sur un second domaine `swag.nohost.me`. Chaque domaine est automatiquement configuré pour pouvoir gérer des services web, des courriels et une messagerie instantannée XMPP. @@ -9,25 +8,21 @@ Le domaine choisi lors de la postinstall est défini comme le domaine principal Enfin, il faut noter que, dans le contexte de YunoHost, il n'y a pas de hiérarchie entre les domaines qu'il connaît. Dans l'exemple précédent, on peut ajouter un troisième domaine `foo.yolo.com` - mais il serait considéré comme un domaine indépendant de `yolo.com`. -Caractères non latins ------------------ +## Caractères non latins Si votre domain contient des caractères spéciaux, non latins, vous devez utiliser sa [version internationalisée](https://fr.wikipedia.org/wiki/Nom_de_domaine_internationalis%C3%A9) en [Punycode](https://fr.wikipedia.org/wiki/Punycode). Vous pouvez utiliser [ce convertisseur](https://www.charset.org/punycode), et utiliser le nom de domaine converti dans YunoHost. -Configuration DNS ------------------ +## Configuration DNS DNS (Domain Name System) est un système qui permet aux ordinateurs du monde entier de traduire les noms de domaine lisibles par l'homme (comme `yolo.com`) en adresses IP compréhensibles par les machines (comme `11.22.33.44`). Pour que cette traduction (et d'autres fonctionnalités) fonctionne, il faut configurer soigneusement les enregistrements DNS. YunoHost peut générer une configuration DNS recommandée pour chaque domaine, y compris les enregistrements nécessaires pour les parties emails et XMPP. La configuration DNS recommandée est disponible dans l'administrateur web via Domaine > (le domaine) > configuration DNS, ou avec la commande `yunohost domain dns-conf the.domain.tld`. -Certificats SSL/HTTPS ----------------------- +## Certificats SSL/HTTPS Un autre aspect important de la configuration des domaines est le certificat SSL/HTTPS. YunoHost est intégré avec Let's Encrypt, de sorte qu'une fois que votre serveur est correctement accessible depuis n'importe qui sur Internet via le nom de domaine, l'administrateur peut demander l'installation d'un certificat Let's Encrypt. Voir la documentation sur les [certificats](/certificate) pour plus d'informations. -Sous-chemins vs. domaines individuels par application ------------------------------------------------------ +## Sous-chemins vs. domaines individuels par application Dans le contexte de YunoHost, il est assez courant d'avoir un seul (ou quelques) domaines sur lesquels plusieurs applications sont installées dans des "sous-chemins", de sorte que l'on se retrouve avec quelque chose comme ceci : diff --git a/email.md b/email.md index 813064ad..84d0fadd 100644 --- a/email.md +++ b/email.md @@ -1,12 +1,10 @@ -Emails -====== +# Emails YunoHost comes with a complete mail stack allowing you to host your own email server, and therefore to have your own email addresses in `something@your.domain.tld`. The mail stack includes a SMTP server (postfix), an IMAP server (Dovecot), an antispam (rspamd) and DKIM configuration. -Making sure your setup is right -------------------------------- +## Making sure your setup is right Email is a complicated ecosystem and quite a few details can prevent it from working properly. @@ -18,22 +16,19 @@ To validate your setup: A score of at least 8~9/10 is a reasonnable goal. -Email clients -------------- +## Email clients To interact with the email sever (read and send emails), you can either install a webclient such as Roundcube or Rainloop on your server - or configure a desktop/mobile client as described in [this page](email_configure_client). Desktop and mobile clients have the advantage of copying your emails to the device, allowing offline viewing and relative protection against possible hardware failures of your server. -Configuring email aliases and auto-forwards -------------------------------------------- +## Configuring email aliases and auto-forwards Mail aliases and forwards can be configured for each users. For instance, the first user created on the server automatically has an alias `root@the.domain.tld` configured - meaning that an email sent to this adress will end in the inbox of the first user. Automatic forwards may be configured, for instance if an user doesn't want to configure an additional email account and just wants to receive emails from the server on, say, his/her gmail address. Another feature which few people know about is the use of suffixes beginning with "+". For example, emails sent to `johndoe+booking@the.domain.tld` will automatically land in the `booking` dir (lowercase) of John Doe's mailbox or in John Doe's inbox if `booking` directory doesn't exist . It is a practical technique for example to provide an e-mail address to a website, then easily sort (via automatic filters) the mail coming from this website. -What happens if my server becomes unavailable ? ------------------------------------------------ +## What happens if my server becomes unavailable? If your server becomes unavailable, emails sent to your server will stay in a pending queue on the sender's side for as long as ~5 days. The sender's hoster will regularly try to resend the email, until it drops it if it was unable to send it. @@ -42,7 +37,6 @@ It is possible that the sent emails from your YunoHost instance are considered a Is it possible that the IP address from your server have been previously been used to sent spam or that these email services consider your server as a spam sender. To ensure that your servers’ IP address isn’t into this blacklists and to remove it from them, follow this [link](/blacklist_forms). -Migrating email from an email provider to a YunoHost instance -------------------------------------------------------------- +## Migrating email from an email provider to a YunoHost instance See [this page](email_migration). diff --git a/email_configure_client_fr.md b/email_configure_client_fr.md index 8e6cd5b4..185173df 100644 --- a/email_configure_client_fr.md +++ b/email_configure_client_fr.md @@ -1,12 +1,12 @@ -## Configurer un client mail +## Configurer un client email Vous pouvez récupérer et envoyer des emails avec votre instance YunoHost grâce à des logiciels comme Mozilla Thunderbird, ou sur votre smartphone grâce à des applications comme K-9 Mail. -Normalement, votre client mail devrait recevoir la configuration automatiquement lorsque vous ajoutez un compte. Si cela ne fonctionne pas, il est possible de le faire manuellement en suivant les quelques étapes suivantes. (Cependant, cela devrait être compris comme étant un bug dans YunoHost, et le cas échéant, c'est cool si vous nous notifiez du problème pour que nous puissions tenter de reproduire et corriger le problème !) +Normalement, votre client email devrait recevoir la configuration automatiquement lorsque vous ajoutez un compte. Si cela ne fonctionne pas, il est possible de le faire manuellement en suivant les quelques étapes suivantes. (Cependant, cela devrait être compris comme étant un bug dans YunoHost, et le cas échéant, c'est cool si vous nous notifiez du problème pour que nous puissions tenter de reproduire et corriger le problème !) ### Réglages génériques -Voici les éléments que vous devrez entrer pour configurer manuellement votre client mail (`domain.tld` fait référence à ce qui est après le @ dans votre adresse mail, et `nom_dutilisateur` ce qui est avant @). +Voici les éléments que vous devrez entrer pour configurer manuellement votre client email (`domain.tld` fait référence à ce qui est après le @ dans votre adresse email, et `nom_dutilisateur` ce qui est avant @). | Protocole | Port | Chiffrement | Authentification | Login | | :--: | :-: | :--: | :--: | :--: | @@ -35,7 +35,7 @@ Suivez les instructions suivantes. (Comme pour Thunderbird, il vous faudra peut- La première fois, vous pouvez simplement choisir "Ajouter un compte". Si vous avez déjà un compte configuré, appuyez sur le menu hamburger puis sur le rouage, choisissez Courrier, Comptes et appuyez sur le symbole " + ". -Sélectionnez ensuite IMAP. Remplissez les champs et appuyez sur Suivant. Dekko va ensuite chercher la configuration. Vérifiez que tous les champs sont corrects. Assurez-vous d'avoir votre nom d'utilisateur yunohost, PAS votre adresse e-mail et choisissez "Autoriser les certificats non fiables". Faites ceci pour IMAP et SMTP et appuyez sur Suivant. Dekko va ensuite synchroniser le compte après quoi vous aurez terminé. Félicitations ! +Sélectionnez ensuite IMAP. Remplissez les champs et appuyez sur Suivant. Dekko va ensuite chercher la configuration. Vérifiez que tous les champs sont corrects. Assurez-vous d'avoir votre nom d'utilisateur yunohost, PAS votre adresse email et choisissez "Autoriser les certificats non fiables". Faites ceci pour IMAP et SMTP et appuyez sur Suivant. Dekko va ensuite synchroniser le compte après quoi vous aurez terminé. Félicitations ! diff --git a/email_migration_fr.md b/email_migration_fr.md index 7e0151c6..7e81a4d4 100644 --- a/email_migration_fr.md +++ b/email_migration_fr.md @@ -1,4 +1,4 @@ -# Migrer ses emails d'un ancien serveur mail vers YunoHost +# Migrer ses emails d’un ancien serveur mail vers YunoHost *[Documentation en rapport avec l’email de YunoHost](/email)*. diff --git a/faq.md b/faq.md index 19ec5b7a..d88c2f94 100644 --- a/faq.md +++ b/faq.md @@ -1,6 +1,5 @@ # Frequently Asked Questions - #### Under which license is YunoHost distributed? YunoHost packages are under free licenses GNU AGPL v.3. @@ -28,10 +27,10 @@ YunoHost may be called a distribution or an operating system, but it's actually "just" a simple layer added over the top of Debian, which does most of the hard work for you. -For instance, if you wanted to install Wordpress, you would need to type a bunch +For instance, if you wanted to install WordPress, you would need to type a bunch of commands to create some users, setup a web server, setup a SQL server, -download the Wordpress archive, uncompress it, configure the web server, -configure the SQL database, and finally configure Wordpress. YunoHost handles +download the WordPress archive, uncompress it, configure the web server, +configure the SQL database, and finally configure WordPress. YunoHost handles the technical details and "types all these commands for you", so that you can focus on what really matters. diff --git a/filezilla.md b/filezilla.md index 9f7f67db..9782dd65 100644 --- a/filezilla.md +++ b/filezilla.md @@ -1,7 +1,7 @@ # Exchange files with your server using a graphical interface This page explains how to exchange files (backup archives, music, pictures, -movies, ...) with your server using a graphical interface for the (S)FTP protocol. +movies...) with your server using a graphical interface for the (S)FTP protocol. This is an alternative to using `scp` which can be deemed technical and cryptic, or using an app like Nextcloud. @@ -80,6 +80,6 @@ Nautilus from Gnome3 has features similar to FileZilla, out of the box. * [WinSCP](https://winscp.net/) is also a nice candidate for Windows -### MacOS +### macOS -* [Cyberduck](https://cyberduck.io/) is a free software available on MacOS +* [Cyberduck](https://cyberduck.io/) is a free software available on macOS diff --git a/filezilla_fr.md b/filezilla_fr.md index c659d460..d600d5ce 100644 --- a/filezilla_fr.md +++ b/filezilla_fr.md @@ -1,7 +1,7 @@ -# Échanger des fichiers avec son serveur à l'aide d'une interface graphique +# Échanger des fichiers avec son serveur à l’aide d’une interface graphique Cette page explique comment échanger des fichiers (sauvegardes, musiques, -photos, films, ...) avec son serveur à l'aide d'un outil graphique. C'est donc +photos, films...) avec son serveur à l'aide d'un outil graphique. C'est donc une méthode alternative au fait d'utiliser la commande `scp` qui peut être jugée technique et cryptique, ou de devoir installer Nextcloud. diff --git a/groups_and_permissions.md b/groups_and_permissions.md index da15dc13..6aab3813 100644 --- a/groups_and_permissions.md +++ b/groups_and_permissions.md @@ -1,15 +1,13 @@ -User groups and permissions -=========================== +# User groups and permissions You can access the *groups and permissions* management interface from the webadmin by going into the 'Users' section and clicking the corresponding button: ![](./images/button_to_go_to_permission_interface.png) -Managing groups ---------------- +## Managing groups -The group mechanism can be used to define groups of users which then can be used to restrict permissions for applications and other services (such as mail or xmpp). Note that it is *not* mandatory to create a group to do so: you can also restrict access to an app or service on a user-per-user basis. +The group mechanism can be used to define groups of users which then can be used to restrict permissions for applications and other services (such as mail or XMPP). Note that it is *not* mandatory to create a group to do so: you can also restrict access to an app or service on a user-per-user basis. Using groups is however useful for semantics, for example if you host multiple groups of friends, associations or businesses on your server, you might want to create groups like `association1` and `association2` and add members of each association to the relevant group. @@ -71,7 +69,7 @@ $ yunohost user group update yolo_crew --add charlie delphine (similarly, `--remove` can be used to remove members from a group) -Now in the group list we should see : +Now in the group list we should see: ```shell $ yunohost user group list @@ -100,10 +98,9 @@ To delete the group `yolo_crew` in CLI, you may run $ yunohost user group delete yolo_crew ``` -Managing permissions --------------------- +## Managing permissions -The permission mechanism allow to restrict access to services (for example mail, xmpp, ...) and apps, or even specific parts of the apps (for example the administration interface of wordpress). +The permission mechanism allow to restrict access to services (for example mail, XMPP...) and apps, or even specific parts of the apps (for example the administration interface of WordPress). ### List permissions @@ -126,7 +123,7 @@ permissions: allowed: all_users ``` -Here, we find that all registered users can use email, xmpp, and access the wordpress blog. However, nobody can access the wordpress admin interface. +Here, we find that all registered users can use email, XMPP, and access the WordPress blog. However, nobody can access the WordPress admin interface. More details can be displayed by adding the `--full` option which will display the list of users corresponding to groups allowed, as well as urls associated to a permission (relevant for web apps). @@ -136,7 +133,7 @@ To add a permission to a group, simply click the "+" button in the group panel, ![](./images/groups_add-permission-group.png) -To allow a group to access the wordpress admin interface in CLI: +To allow a group to access the WordPress admin interface in CLI: ```shell $ yunohost user permission update wordpress.admin --add yolo_crew @@ -152,7 +149,7 @@ or in CLI: $ yunohost user permission update wordpress.admin --add alice ``` -And now we may see that both the YoloCrew and Alice have access to the wordpress admin interface : +And now we may see that both the YoloCrew and Alice have access to the WordPress admin interface: ```shell $ yunohost user permission list @@ -164,7 +161,7 @@ $ yunohost user permission list [...] ``` -Note that, for example, if we want to restrict permission for email so that only Bob is allowed to email, we should also remove `all_users` from the permission, by deleting it from the `all_users` group panel, or in CLI : +Note that, for example, if we want to restrict permission for email so that only Bob is allowed to email, we should also remove `all_users` from the permission, by deleting it from the `all_users` group panel, or in CLI: ```shell $ yunohost user permission update mail --remove all_users --add bob @@ -174,8 +171,7 @@ The webadmin will issue a warning if you set a permission that is superseeded by ![](./images/groups_alerte-permission.png) -Notes for apps packagers ------------------------- +## Notes for apps packagers Installing an app creates the permission `app.main` with `all_users` allowed by default. @@ -228,7 +224,7 @@ If you still need to use regex to protect or unprotect urls, you can't use the n But you can create a fake permission and use hooks to handle if there is a change in this faked permission. -In the install script, create the fake permission (with no url): +In the install script, create the fake permission (with no URL): `ynh_permission_create --permission="create poll" --allowed "visitors" "all_users"` diff --git a/groups_and_permissions_fr.md b/groups_and_permissions_fr.md index dee23089..b435de35 100644 --- a/groups_and_permissions_fr.md +++ b/groups_and_permissions_fr.md @@ -1,14 +1,13 @@ -Groupes et permissions -=========================== +# Groupes et permissions Vous pouvez accéder à l'interface de gestion des *groupes et des permissions* depuis la webadmin en allant dans la section "Utilisateurs" et en cliquant sur le bouton correspondant : ![](./images/button_to_go_to_permission_interface_fr.png) -Gestion des groupes ---------------- -Le mécanisme de groupe peut être utilisé pour définir des groupes d'utilisateurs qui peuvent ensuite être utilisés pour restreindre les autorisations pour les applications et autres services (tels que l'email ou xmpp). Notez qu'il n'est *pas* obligatoire de créer un groupe pour ce faire : vous pouvez également restreindre l'accès à une application ou à un service de manière individuelle. +## Gestion des groupes + +Le mécanisme de groupe peut être utilisé pour définir des groupes d'utilisateurs qui peuvent ensuite être utilisés pour restreindre les autorisations pour les applications et autres services (tels que l'email ou XMPP). Notez qu'il n'est *pas* obligatoire de créer un groupe pour ce faire : vous pouvez également restreindre l'accès à une application ou à un service de manière individuelle. L'utilisation de groupes est cependant utile pour la sémantique, par exemple si vous hébergez plusieurs groupes d'amis, des associations ou des entreprises sur votre serveur, vous pouvez créer des groupes comme "association1" et "association2" et ajouter les membres de chaque association au groupe concerné. @@ -96,10 +95,9 @@ Pour supprimer le groupe `yolo_crew` dans CLI, vous pouvez exécuter $ yunohost user group delete yolo_crew ``` -Gestion des permissions --------------------- +## Gestion des permissions -Le mécanisme de permissions permet de restreindre l'accès aux services (par exemple mail, xmpp, ...) et aux applications, ou même à des parties spécifiques des applications (par exemple l'interface d'administration de wordpress). +Le mécanisme de permissions permet de restreindre l'accès aux services (par exemple mail, XMPP...) et aux applications, ou même à des parties spécifiques des applications (par exemple l'interface d'administration de WordPress). ### Liste des permissions @@ -120,7 +118,7 @@ permissions: xmpp.main: allowed: all_users ``` -Ici, nous constatons que tous les utilisateurs enregistrés peuvent utiliser le courrier électronique, xmpp, et accéder au blog wordpress. Cependant, personne ne peut accéder à l'interface d'administration de wordpress. +Ici, nous constatons que tous les utilisateurs enregistrés peuvent utiliser le courrier électronique, XMPP, et accéder au blog WordPress. Cependant, personne ne peut accéder à l'interface d'administration de WordPress. Plus de détails peuvent être affichés en ajoutant l'option `--full` qui affichera la liste des utilisateurs correspondant aux groupes autorisés, ainsi que les urls associées à une permission (pertinent pour les applications web). @@ -130,7 +128,7 @@ Pour ajouter une permission à un groupe, il suffit de cliquer sur le bouton "+" ![](./images/groups_add-permission-group.png) -Pour permettre à un groupe d'accéder à l'interface d'administration de wordpress via la CLI : +Pour permettre à un groupe d'accéder à l'interface d'administration de WordPress via la CLI : ```shell $ yunohost user permission update wordpress.admin --add yolo_crew @@ -146,7 +144,7 @@ ou en CLI : $ yunohost user permission update wordpress.admin --add alice ``` -Et maintenant, nous pouvons voir que YoloCrew et Alice ont tous deux accès à l'interface d'administration de Wordpress : +Et maintenant, nous pouvons voir que YoloCrew et Alice ont tous deux accès à l'interface d'administration de WordPress : ```shell $ yunohost user permission list @@ -171,8 +169,7 @@ La webadmin émettra un avertissement si vous définissez une permission qui est ![](./images/groups_alerte-permission.png) -Notes aux packageurs d'applications ------------------------- +## Notes aux packageurs d'applications L'installation d'une application crée l'autorisation `app.main` avec `all_users` autorisée par défaut. @@ -249,7 +246,7 @@ fi Dans cet exemple, si l'application est publique, le groupe `visitors` a accès à l'autorisation `create poll`, sinon le groupe est supprimé de cette autorisation. -Créez ensuite deux fichiers dans le répertoire `hooks` à la racine du dépôt git de l'application : `post_app_addaccess` et `post_app_removeaccess`. Dans ces hooks, vous supprimerez ou rajouterez la protection contre les regex si le groupe `visitors` est ajouté ou supprimé de cette autorisation : +Créez ensuite deux fichiers dans le répertoire `hooks` à la racine du dépôt Git de l'application : `post_app_addaccess` et `post_app_removeaccess`. Dans ces hooks, vous supprimerez ou rajouterez la protection contre les regex si le groupe `visitors` est ajouté ou supprimé de cette autorisation : `post_app_addaccess` diff --git a/help_fr.md b/help_fr.md index 0810f740..48df5bcf 100644 --- a/help_fr.md +++ b/help_fr.md @@ -1,4 +1,4 @@ -# Besoin d'aide ? +# Besoin d’aide ?