mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
Markdown formatting
This commit is contained in:
ericgaspar
parent
cb4626eab7
commit
a350faa7b5
14 changed files with 57 additions and 94 deletions
|
|
@ -1,41 +1,33 @@
|
|||
Applications
|
||||
============
|
||||
# Applications
|
||||
|
||||
One of the key feature of YunoHost is the ability to easily install applications which are then immediately usable. Example of applications include a blog system, a "cloud" (to host and sync files), a website, an RSS reader, ...
|
||||
One of the key feature of YunoHost is the ability to easily install applications which are then immediately usable. Example of applications include a blog system, a "cloud" (to host and sync files), a website, an RSS reader...
|
||||
|
||||
Applications must be packaged manually by application packagers/maintainers. Apps can be integrated with YunoHost to support upgrades, backup/restore and LDAP/SSO integration among other things.
|
||||
|
||||
Applications can be installed and managed through the webadmin interface in 'Applications' or through commands of the `yunohost app` category.
|
||||
|
||||
Application lists
|
||||
-----------------
|
||||
## Application lists
|
||||
|
||||
From the technical point of view, applications are public code repository (such as [this one](https://github.com/YunoHost-Apps/wordpress_ynh)). Existing applications are indexed using "application lists". Those lists can be managed in Applications > Install > Manage applications lists or with commands such as `yunohost app fetchlist`.
|
||||
|
||||
The full list of application can be browsed at [this page](/apps).
|
||||
|
||||
Integration and quality levels
|
||||
------------------------------
|
||||
## Integration and quality levels
|
||||
|
||||
Automated tests are being ran regularly to test the integration and quality of all official apps, as well as community apps who were declared to be 'working'. The result is a level between 0 and 7, whose meaning is detailed on [this page](/packaging_apps_levels). Some tests results may also be available [on this dashboard](https://dash.yunohost.org/appci/branch/stable).
|
||||
|
||||
LDAP / SSO integration
|
||||
----------------------
|
||||
## LDAP / SSO integration
|
||||
|
||||
Applications may support integration with the LDAP / Single Sign On system, such that users who connects to the user portal can be automatically logged in all those apps. Some applications however do not support this as it can be either not implemented in the upstream, or the package didn't work on this part yet.
|
||||
|
||||
Multi-instance applications
|
||||
---------------------------
|
||||
## Multi-instance applications
|
||||
|
||||
Some applications support the ability to be installed several times (at different locations) ! To do so, just go another time in Applications > Install, and select again the application to install.
|
||||
|
||||
|
||||
User access management
|
||||
----------------------
|
||||
## User access management
|
||||
|
||||
Access to apps can be restricted to some users only. This can be configured via the webadmin in the [Groups and permissions panel](/groups_and_permissions), or similarly via the command-line subcategory `yunohost user permission`.
|
||||
|
||||
Packaging applications
|
||||
----------------------
|
||||
## Packaging applications
|
||||
|
||||
If you want to learn or contribute to app packaging, please check the [contributor documentation](contributordoc).
|
||||
|
|
|
|||
|
|
@ -1,42 +1,33 @@
|
|||
Applications
|
||||
============
|
||||
# Applications
|
||||
|
||||
L'une des fonctionnalités principales de YunoHost est la possibilité d'installer facilement des applications immédiatement utilisables. Pour donner des exemples d'application, il est possible d'installer un système de blog, un "cloud" (pour héberger et synchroniser des fichiers), un site web, un lecteur RSS, ....
|
||||
L'une des fonctionnalités principales de YunoHost est la possibilité d'installer facilement des applications immédiatement utilisables. Pour donner des exemples d'application, il est possible d'installer un système de blog, un "cloud" (pour héberger et synchroniser des fichiers), un site web, un lecteur RSS...
|
||||
|
||||
Les applications doivent être packagées manuellement par les packageurs/mainteneurs d'applications. Les applications peuvent être intégrées avec YunoHost pour gérer les mise à jour, la sauvegarde/restauration et l'intégration LDAP/SSO, entre autres.
|
||||
|
||||
Les applications peuvent être installées et gérées via l'interface webadmin dans la partie 'Applications', ou via les commandes de la catégorie `yunohost app`.
|
||||
|
||||
Listes d'applications
|
||||
-----------------
|
||||
## Listes d'applications
|
||||
|
||||
Du point de vue technique, les applications sont des dépôts de code public (comme [celui-ci](https://github.com/YunoHost-Apps/wordpress_ynh)). Les applications existantes sont indexées à l'aide de "listes d'applications". Ces listes peuvent être gérées dans Applications > Installer > Gérer les listes d'applications, ou avec des commandes telles que `yunohost app fetchlist`.
|
||||
|
||||
La liste des applications existantes peut être consultée sur [cette page](/apps).
|
||||
|
||||
Niveaux d'intégration et de qualité
|
||||
------------------------------
|
||||
## Niveaux d'intégration et de qualité
|
||||
|
||||
Des tests automatisés sont exécutés régulièrement pour tester l'intégration et la qualité de toutes les applications officielles, ainsi que les applications communautaires qui ont été déclarées "working". Le résultat est un niveau entre 0 et 7, dont la signification est détaillée sur [cette page](/packaging_apps_levels). Certains résultats de tests peuvent également être disponibles sur [ce tableau de bord](https://dash.yunohost.org/appci/branch/stable).
|
||||
|
||||
Intégration LDAP / SSO
|
||||
----------------------
|
||||
## Intégration LDAP / SSO
|
||||
|
||||
Les applications peuvent prendre en charge l'intégration avec le système LDAP / Single Sign On, de sorte que les utilisateurs qui se connectent au portail utilisateur peuvent être automatiquement authentifiés sur toutes ces applications. Certaines applications ne le supportent pas car cette fonctionnalité n'est, soit pas implémentée en amont du logiciel de l'application, soit le mainteneur n'a pas encore travaillé sur cette partie.
|
||||
|
||||
Applications multi-instances
|
||||
---------------------------
|
||||
## Applications multi-instances
|
||||
|
||||
Certaines applications peuvent être installées plusieurs fois (à différents endroits) ! Pour ce faire, il suffit de retourner dans Applications > Installer, et de sélectionner à nouveau l'application à installer.
|
||||
|
||||
|
||||
Gestion de l'accès des utilisateurs
|
||||
----------------------
|
||||
## Gestion de l'accès des utilisateurs
|
||||
|
||||
L'accès aux applications peut être limité à certains utilisateurs seulement. Ceci peut être configuré via la webadmin sur la page [Groupes et permissions](groups_and_permissions), ou de la même manière via la sous-catégorie de commandes `yunohost user permission`.
|
||||
|
||||
Packaging d'applications
|
||||
------------------------
|
||||
## Packaging d'applications
|
||||
|
||||
Si vous voulez apprendre ou contribuer à l'empaquetage des applications, veuillez consulter la [documentation des contributeurs](contributordoc).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Backing up your server and apps
|
||||
|
||||
Backing up your server, apps and data is an important concern when administrating a server. This protects you from unexpected events that could happen (server lost in a fire, database corruption, loss of access, server compromised, ...). The backup policy you will put in place depends of the importance of the services and data hosted. For instance you won't care too much about having backup on a test server, but you will care about having a backup of critical data of your association or company, and having this backup *in a different physical place*.
|
||||
Backing up your server, apps and data is an important concern when administrating a server. This protects you from unexpected events that could happen (server lost in a fire, database corruption, loss of access, server compromised...). The backup policy you will put in place depends of the importance of the services and data hosted. For instance you won't care too much about having backup on a test server, but you will care about having a backup of critical data of your association or company, and having this backup *in a different physical place*.
|
||||
|
||||
## Backups in the context of YunoHost
|
||||
|
||||
|
|
@ -61,7 +61,6 @@ When performing an upgrade, apps with large quantity of data will, usually, do a
|
|||
|
||||
To manually disable the backup of large data, for application that implement that feature, you can set the variable `BACKUP_CORE_ONLY`. To do so, the variable have to be set before the backup command: `sudo BACKUP_CORE_ONLY=1 yunohost backup create --apps nextcloud`. Be careful though that mean you will have to backup user data yourself. But doing so, you will be able to do incremental or differential backups of this large amount of data (which is not an option provided by yunohost yet).
|
||||
|
||||
|
||||
## Downloading and uploading backups
|
||||
|
||||
After creating backup archives, it is possible to list and inspect them via the corresponding views in the webadmin, or via `yunohost backup list` and `yunohost backup info <archivename>` from the command line. By default, backups are stored in `/home/yunohost.backup/archives/`.
|
||||
|
|
@ -163,7 +162,7 @@ If you are using an ARM board, another method for doing a full backup can be to
|
|||
dd if=/dev/mmcblk0 of=./backup.img status=progress
|
||||
```
|
||||
|
||||
(replace `/dev/mmcblk0` with the actual device of your sd card)
|
||||
(replace `/dev/mmcblk0` with the actual device of your SD card)
|
||||
|
||||
You can also create a compressed image using gzip this way:
|
||||
```bash
|
||||
|
|
|
|||
21
backup_fr.md
21
backup_fr.md
|
|
@ -1,10 +1,8 @@
|
|||
Sauvegarder son serveur et ses apps
|
||||
===================================
|
||||
# Sauvegarder son serveur et ses apps
|
||||
|
||||
Dans le contexte de l'auto-hébergement, les sauvegardes (backup) sont un élément important pour pallier les événements inattendus (incendies, corruption de base de données, perte d'accès au serveur, serveur compromis, ...). La politique de sauvegardes à mettre en place dépend de l'importance des services et des données que vous gérez. Par exemple, sauvegarder un serveur de test aura peu d'intérêt, tandis que vous voudrez être très prudent si vous gérez des données critiques pour une association ou une entreprise - et dans ce genre de cas, vous souhaiterez stocker les sauvegardes *dans un endroit différent*.
|
||||
Dans le contexte de l'auto-hébergement, les sauvegardes (backup) sont un élément important pour pallier les événements inattendus (incendies, corruption de base de données, perte d'accès au serveur, serveur compromis...). La politique de sauvegardes à mettre en place dépend de l'importance des services et des données que vous gérez. Par exemple, sauvegarder un serveur de test aura peu d'intérêt, tandis que vous voudrez être très prudent si vous gérez des données critiques pour une association ou une entreprise - et dans ce genre de cas, vous souhaiterez stocker les sauvegardes *dans un endroit différent*.
|
||||
|
||||
Les sauvegardes avec YunoHost
|
||||
-----------------------------
|
||||
## Les sauvegardes avec YunoHost
|
||||
|
||||
YunoHost contient un système de sauvegarde, qui permet de sauvegarder (et restaurer) les configurations du système, les données "système" (comme les mails) et les applications si elles le supportent.
|
||||
|
||||
|
|
@ -12,8 +10,7 @@ Vous pouvez gérer vos sauvegardes via la ligne de commande (`yunohost backup --
|
|||
|
||||
La méthode de sauvegarde actuelle consiste à créer des archives `.tar.gz` qui contiennent les fichiers pertinents. Pour le futur, YunoHost envisage de supporter nativement [Borg](https://www.borgbackup.org/) qui est une solution plus flexible, performante et puissante pour gérer des sauvegardes.
|
||||
|
||||
Créer des sauvegardes
|
||||
---------------------
|
||||
## Créer des sauvegardes
|
||||
|
||||
#### Depuis la webadmin
|
||||
|
||||
|
|
@ -59,8 +56,7 @@ Lors d'une mise à jour, les apps contenant une grande quantité de données eff
|
|||
|
||||
Pour désactiver manuellement la sauvegarde des données volumineuses, pour les applications qui implémentent cette fonctionnalité, vous pouvez définir la variable `BACKUP_CORE_ONLY`. Pour ce faire, la variable doit être définie avant la commande de backup : `sudo BACKUP_CORE_ONLY=1 yunohost backup create --apps nextcloud`. Soyez prudent : il vous faudra alors sauvegarder vous-même les données des utilisateurs de Nextcloud. Choisir ce type de sauvegarde vous permettra de mettre en place manuellement des sauvegardes incrémentielles ou différentielles (que YunoHost ne permet pas encore de faire automatiquement).
|
||||
|
||||
Télécharger et téléverser des sauvegardes
|
||||
-----------------------------------------
|
||||
## Télécharger et téléverser des sauvegardes
|
||||
|
||||
Après avoir créé des sauvegardes, il est possible de les lister et de les inspecter grâce aux vues correspondantes dans la webadmin, ou via `yunohost backup list` et `yunohost backup info <nom_d'archive>` depuis la ligne de commande. Par défaut, les sauvegardes sont stockées dans `/home/yunohost.backup/archives/`.
|
||||
|
||||
|
|
@ -80,8 +76,7 @@ De façon similaire, vous pouvez téléverser une sauvegarde depuis une machine
|
|||
scp /path/to/your/<nom_d'archive>.tar.gz admin@your.domain.tld:/home/yunohost.backup/archives/
|
||||
```
|
||||
|
||||
Restaurer des sauvegardes
|
||||
-------------------------
|
||||
## Restaurer des sauvegardes
|
||||
|
||||
#### Depuis la webadmin
|
||||
|
||||
|
|
@ -115,9 +110,7 @@ mv /chemin/vers/<nom_d'archive> /home/yunohost.backup/archives/
|
|||
yunohost backup restore <nom_d'archive>
|
||||
```
|
||||
|
||||
|
||||
Pour aller plus loin
|
||||
--------------------
|
||||
## Pour aller plus loin
|
||||
|
||||
#### Stocker les archives sur un autre disque
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ Before setting up a server at home, it is recommended that you know the [possibl
|
|||
|
||||
## Pre-requisites
|
||||
|
||||
- An ARM board with 500MHz CPU and 512MB RAM ;
|
||||
- An ARM board with 500MHz CPU and 512 MB of RAM;
|
||||
- A power supply for your board;
|
||||
- A microSD card: **8GB** capacity (at least) and **Class 10** speed rate are highly recommended (like the [Transcend 300x](http://www.amazon.fr/Transcend-microSDHC-adaptateur-TS32GUSDU1E-Emballage/dp/B00CES44EO));
|
||||
- An ethernet cable (RJ-45) to connect your board to your router;
|
||||
|
|
|
|||
|
|
@ -62,4 +62,4 @@ yunohost tools regen-conf nsswitch nslcd --force
|
|||
|
||||
(we will try to do this automatically somehow)
|
||||
|
||||
- Sometimes the postgresql migration (that is supposed to happen automatically after the buster migration is ran) fails to run properly … Some users reported that re-launching manually the postgresql migration fixed the issue (we will try to understand and fix this somehow)
|
||||
- Sometimes the postgresql migration (that is supposed to happen automatically after the buster migration is ran) fails to run properly... Some users reported that re-launching manually the postgresql migration fixed the issue (we will try to understand and fix this somehow)
|
||||
|
|
|
|||
15
users.md
15
users.md
|
|
@ -1,8 +1,6 @@
|
|||
Users and the SSO
|
||||
=================
|
||||
# Users and the SSO
|
||||
|
||||
Users
|
||||
-----
|
||||
## Users
|
||||
|
||||
Users are human being who have access to applications and other services on your server. The administrator can add and manage users through the web administration (in the User category) or through the command line (see `yunohost user --help`). After that, users obtain a personal email address (chosen by the admin), an XMPP account, and can log in the user portal to access applications they have permissions over and configure other parameters.
|
||||
|
||||
|
|
@ -12,8 +10,7 @@ The first user created also automatically gets email aliases `root@main.domain.t
|
|||
You should be careful about who you give your server access to. In terms of security, this largely increase the attack surface for someone who wants to mess with the server one way or another.
|
||||
</div>
|
||||
|
||||
The user portal, or SSO
|
||||
-----------------------
|
||||
## The user portal, or SSO
|
||||
|
||||
<center><img src="images/user_panel.png" style="max-width: 650px; border-radius: 5px;border: 1px solid rgba(0,0,0,0.15);box-shadow: 0 5px 15px rgba(0,0,0,0.35);"></center>
|
||||
|
||||
|
|
@ -25,13 +22,11 @@ In the portal, users can also click on the avatar in the top-left to configure s
|
|||
You should be aware that the SSO can only be reached through the actual domain name (i.e. `https://the.domain.tld/yunohost/sso`), and NOT by just using the IP of the server (i.e. `https://11.22.33.44/yunohost/sso`), contrarily to the webadmin ! This is a bit confusing but is necessary for technical reason. If you are in a situation where you need to access the SSO without having your DNS properly configured for some reason, you might consider tweaking your `/etc/hosts` as described in [this page](dns_local_network).
|
||||
</div>
|
||||
|
||||
User groups and permissions
|
||||
---------------------------
|
||||
## User groups and permissions
|
||||
|
||||
See [this dedicated page](groups_and_permissions).
|
||||
|
||||
SSH access
|
||||
----------
|
||||
## SSH access
|
||||
|
||||
Users can also be allowed to connect through SSH, and SSH keys can be added for this purpose. So far, this can only be configured via the command line. See `yunohost user ssh --help` for specific commands.
|
||||
|
||||
|
|
|
|||
17
users_fr.md
17
users_fr.md
|
|
@ -1,8 +1,6 @@
|
|||
Les utilisateurs et le SSO
|
||||
==========================
|
||||
# Les utilisateurs et le SSO
|
||||
|
||||
Utilisateurs
|
||||
-----
|
||||
## Utilisateurs
|
||||
|
||||
Les utilisateurs sont les êtres humains qui ont accès aux applications et autres services sur votre serveur. L'administrateur peut ajouter et gérer des utilisateurs via l'administration web (dans la catégorie Utilisateurs) ou via la catégorie `yunohost user` de la ligne de commande. Après cela, les utilisateurs obtiennent une adresse e-mail personnelle (choisie par l'administrateur), un compte XMPP, et peuvent se connecter au portail utilisateur (SSO) pour accéder aux applications pour lesquelles ils ont des permissions et configurer d'autres paramètres.
|
||||
|
||||
|
|
@ -12,8 +10,7 @@ Le premier utilisateur créé reçoit aussi automatiquement les alias email `roo
|
|||
Vous devriez faire attention à qui vous donnez l'accès à votre serveur. En termes de sécurité, cela augmente considérablement la surface d'attaque pour quelqu'un qui veut perturber le serveur d'une manière ou d'une autre.
|
||||
</div>
|
||||
|
||||
Le portail utilisateur, ou SSO
|
||||
-----------------------
|
||||
## Le portail utilisateur, ou SSO
|
||||
|
||||
<center><img src="images/user_panel.png" style="max-width:100%;border-radius: 5px;border: 1px solid rgba(0,0,0,0.15);box-shadow: 0 5px 15px rgba(0,0,0,0.35);"></center>
|
||||
|
||||
|
|
@ -25,18 +22,14 @@ Dans le portail, les utilisateurs peuvent également cliquer sur l'avatar en hau
|
|||
Vous devez être conscient que le SSO ne peut être atteint que par le nom de domaine (c.-à-d. `https://the.domain.tld/yunohost/sso`), et non pas en utilisant l'IP du serveur (c.-à-d. `https://11.22.33.44/yunohost/sso`), contrairement à l'administrateur web ! C'est un peu déroutant dans certaines situations, mais c'est nécessaire pour des raisons techniques. Si vous êtes dans une situation où vous avez besoin d'accéder au SSO sans avoir votre DNS correctement configuré pour une raison quelconque, vous pouvez envisager de modifier votre `/etc/hosts` comme décrit dans [cette page](dns_local_network).
|
||||
</div>
|
||||
|
||||
Gestion des groupes d'utilisateurs et permissions
|
||||
---------------------------
|
||||
## Gestion des groupes d'utilisateurs et permissions
|
||||
|
||||
Voir [cette page de documentation dédiée](groups_and_permissions).
|
||||
|
||||
|
||||
Accès SSH
|
||||
----------
|
||||
## Accès SSH
|
||||
|
||||
Les utilisateurs peuvent également être autorisés à se connecter via SSH, et des clés SSH peuvent être ajoutées à cette fin. Jusqu'à présent, ceci ne peut être configuré que via la ligne de commande. Voir `yunohost user ssh --help` pour des commandes spécifiques.
|
||||
|
||||
<div class="alert alert-warning" markdown="1">
|
||||
Faites attention à qui vous donnez accès à SSH. Cela augmente encore plus la surface d'attaque disponible pour un utilisateur malveillant.
|
||||
</div>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue