From 6ac37654c4538f968176f24089125eef38709e03 Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Fri, 1 Mar 2024 23:00:03 +0100 Subject: [PATCH] markdown format --- orphaned/default.es.md | 6 +- orphaned/default.fr.md | 6 +- orphaned/default.it.md | 4 +- orphaned/default.md | 4 +- orphaned/dns.es.md | 1 - orphaned/dns.fr.md | 5 +- orphaned/dns.md | 2 - orphaned/index.ar.md | 10 +- orphaned/index.de.md | 10 +- orphaned/index.es.md | 11 +- orphaned/index.fr.md | 10 +- orphaned/index.it.md | 10 +- orphaned/index.md | 9 +- orphaned/index.oc.md | 10 +- orphaned/news.md | 2 +- orphaned/registrar.fr.md | 1 + orphaned/registrar.md | 1 + pages/00.home/docs.de.md | 2 - pages/00.home/docs.es.md | 1 - pages/00.home/docs.fr.md | 1 - pages/00.home/docs.it.md | 1 - pages/00.home/docs.md | 1 - pages/00.home/docs.ru.md | 1 - .../05.self_hosting/self_hosting.de.md | 2 +- .../05.self_hosting/self_hosting.es.md | 35 +- .../05.self_hosting/self_hosting.it.md | 2 - .../05.self_hosting/self_hosting.ru.md | 6 +- .../what_is_yunohost.ar.md | 8 +- .../what_is_yunohost.de.md | 3 +- .../what_is_yunohost.es.md | 6 +- .../what_is_yunohost.fr.md | 4 +- .../what_is_yunohost.it.md | 11 +- .../10.what_is_yunohost/what_is_yunohost.md | 4 +- .../what_is_yunohost.ru.md | 4 +- .../how_to_host_yourself.de.md | 2 +- .../how_to_host_yourself.md | 4 +- .../how_to_host_yourself.ru.md | 6 +- .../10.install/05.images/docs.fr.md | 4 +- .../10.install/05.images/images.de.md | 4 +- .../10.install/05.images/images.es.md | 5 +- .../10.install/05.images/images.fr.md | 4 +- .../10.install/05.images/images.md | 4 +- .../10.install/05.images/images.ru.md | 4 +- .../finding_the_local_ip.de.md | 4 + .../finding_the_local_ip.fr.md | 5 + .../finding_the_local_ip.md | 4 + .../finding_the_local_ip.ru.md | 8 +- .../15.isp_box_config/isp_box_config.de.md | 12 +- .../15.isp_box_config/isp_box_config.es.md | 17 +- .../15.isp_box_config/isp_box_config.fr.md | 13 +- .../15.isp_box_config/isp_box_config.md | 13 +- .../15.isp_box_config/isp_box_config.ru.md | 13 +- .../10.install/20.dns_config/dns_config.de.md | 10 +- .../10.install/20.dns_config/dns_config.es.md | 10 +- .../10.install/20.dns_config/dns_config.fr.md | 6 +- .../10.install/20.dns_config/dns_config.md | 4 +- .../10.install/20.dns_config/dns_config.ru.md | 4 +- .../25.installing_debian/installing_debian.md | 4 +- pages/02.administer/10.install/install.de.md | 120 ++-- pages/02.administer/10.install/install.fr.md | 113 ++-- pages/02.administer/10.install/install.md | 124 ++-- pages/02.administer/10.install/install.ru.md | 119 ++-- .../05.guidelines/guidelines.de.md | 8 +- .../05.guidelines/guidelines.fr.md | 6 +- .../05.guidelines/guidelines.it.md | 6 +- .../05.guidelines/guidelines.md | 16 +- .../15.admin_guide/10.admin/admin.de.md | 2 +- .../15.admin_guide/10.admin/admin.es.md | 2 +- .../15.admin_guide/10.admin/admin.fr.md | 3 +- .../15.admin_guide/10.admin/admin.it.md | 3 +- .../15.admin_guide/10.admin/admin.md | 2 +- .../15.command_line/command_line.de.md | 12 +- .../15.command_line/command_line.es.md | 8 +- .../15.command_line/command_line.fr.md | 18 +- .../15.command_line/command_line.it.md | 5 +- .../15.command_line/command_line.md | 29 +- .../groups_and_permissions.fr.md | 36 +- .../groups_and_permissions.md | 29 +- .../15.admin_guide/20.users/users.fr.md | 1 - .../01.certificate/certificate.de.md | 6 +- .../01.certificate/certificate.es.md | 2 +- .../01.certificate/certificate.it.md | 3 +- .../25.domains/01.certificate/certificate.md | 1 - .../15.admin_guide/25.domains/domains.de.md | 6 +- .../15.admin_guide/25.domains/domains.fr.md | 2 +- .../15.admin_guide/25.domains/domains.it.md | 9 +- .../15.admin_guide/25.domains/domains.md | 12 +- .../15.admin_guide/30.apps/apps.fr.md | 3 +- .../15.admin_guide/30.apps/apps.it.md | 19 +- .../15.admin_guide/30.apps/apps.md | 18 +- .../15.admin_guide/35.nginx/nginx.md | 4 +- .../15.admin_guide/40.xmpp/xmpp.es.md | 6 +- .../15.admin_guide/40.xmpp/xmpp.fr.md | 2 +- .../15.admin_guide/40.xmpp/xmpp.md | 2 +- .../15.admin_guide/45.emails/email.de.md | 3 +- .../15.admin_guide/45.emails/email.es.md | 7 +- .../15.admin_guide/45.emails/email.fr.md | 1 + .../15.admin_guide/45.emails/email.md | 4 +- .../15.admin_guide/50.backups/backup.fr.md | 32 +- .../15.admin_guide/50.backups/backup.it.md | 16 +- .../15.admin_guide/50.backups/backup.md | 24 +- .../stretch_buster_migration.fr.md | 16 +- .../stretch_buster_migration.md | 20 +- .../buster_bullseye_migration.fr.md | 48 +- .../buster_bullseye_migration.md | 58 +- .../jessie_stretch_migration.fr.md | 16 +- .../jessie_stretch_migration.md | 18 +- .../15.admin_guide/admin_guide.de.md | 3 +- .../15.admin_guide/admin_guide.md | 2 - .../20.backups/05.evaluate/evaluate.fr.md | 57 +- .../20.backups/05.evaluate/evaluate.it.md | 54 +- .../20.backups/05.evaluate/evaluate.md | 65 +- .../01.borgbackup/borgbackup.fr.md | 30 +- .../01.borgbackup/borgbackup.it.md | 30 +- .../01.borgbackup/borgbackup.md | 30 +- .../10.backup_methods/02.restic/restic.fr.md | 9 +- .../10.backup_methods/02.restic/restic.it.md | 6 +- .../10.backup_methods/02.restic/restic.md | 8 +- .../03.archivist/archivist.fr.md | 8 +- .../03.archivist/archivist.md | 9 +- .../10.backup_methods/backup_methods.md | 26 +- .../clone_filesystem.fr.md | 37 +- .../clone_filesystem.it.md | 38 +- .../15.clone_filesystem/clone_filesystem.md | 40 +- .../avoid_hardware_failure.fr.md | 16 +- .../avoid_hardware_failure.it.md | 16 +- .../avoid_hardware_failure.md | 16 +- .../include_exclude_files.fr.md | 13 +- .../include_exclude_files.it.md | 12 +- .../include_exclude_files.md | 13 +- .../custom_backup_methods.fr.md | 2 + .../custom_backup_methods.it.md | 2 + .../custom_backup_methods.md | 2 + .../migrate_or_merge_servers.fr.md | 3 +- .../migrate_or_merge_servers.it.md | 1 + .../migrate_or_merge_servers.md | 3 +- .../01.dns_nohost_me/dns_nohost_me.es.md | 4 +- .../01.dns_nohost_me/dns_nohost_me.fr.md | 4 +- .../01.dns_nohost_me/dns_nohost_me.it.md | 8 +- .../01.dns_nohost_me/dns_nohost_me.md | 5 +- .../02.dns_dynamic_ip/dns_dynamicip.fr.md | 31 +- .../02.dns_dynamic_ip/dns_dynamicip.it.md | 59 +- .../02.dns_dynamic_ip/dns_dynamicip.md | 30 +- .../03.dns_subdomains/dns_subdomains.fr.md | 4 +- .../03.dns_subdomains/dns_subdomains.md | 8 +- .../dns_local_network.es.md | 5 +- .../dns_local_network.fr.md | 7 +- .../dns_local_network.it.md | 11 +- .../04.dns_local_network/dns_local_network.md | 5 +- .../45.tutorials/15.filezilla/filezilla.it.md | 12 +- .../external_storage.fr.md | 12 +- .../external_storage.it.md | 16 +- .../25.external_storage/external_storage.md | 13 +- .../email_configure_relay.fr.md | 13 +- .../35.email_relay/email_configure_relay.md | 13 +- .../40.tor/torhiddenservice.fr.md | 12 +- .../40.tor/torhiddenservice.it.md | 10 +- .../45.tutorials/40.tor/torhiddenservice.md | 15 +- .../certificate_custom.fr.md | 6 +- .../certificate_custom.md | 7 +- .../moving_app_folder.fr.md | 13 +- .../55.moving_app_folder/moving_app_folder.md | 11 +- .../45.tutorials/60.security/security.it.md | 13 +- .../65.sftp_on_apps/sftp_on_apps.it.md | 3 - .../65.sftp_on_apps/sftp_on_apps.md | 2 - .../change_admin_password.fr.md | 5 +- .../change_admin_password.it.md | 2 - .../change_admin_password.md | 2 - .../15.noaccess/noaccess.fr.md | 33 +- .../15.noaccess/noaccess.it.md | 13 +- .../15.noaccess/noaccess.md | 15 +- .../50.troubleshooting/20.ipv6/ipv6.fr.md | 12 +- .../50.troubleshooting/20.ipv6/ipv6.it.md | 6 +- .../50.troubleshooting/20.ipv6/ipv6.md | 8 +- .../25.unblacklisting/blacklist_forms.fr.md | 6 +- .../25.unblacklisting/blacklist_forms.it.md | 5 +- .../25.unblacklisting/blacklist_forms.md | 48 +- .../50.troubleshooting/troubleshooting.fr.md | 4 +- .../50.troubleshooting/troubleshooting.it.md | 6 +- .../50.troubleshooting/troubleshooting.md | 6 +- .../05.registrar/gandi/autodns.it.md | 10 +- .../05.registrar/gandi/autodns.md | 8 +- .../05.registrar/namecheap/autodns.md | 8 +- .../05.registrar/ovh/autodns/autodns.fr.md | 10 +- .../05.registrar/ovh/autodns/autodns.it.md | 13 +- .../05.registrar/ovh/autodns/autodns.md | 10 +- .../ovh/manualdns/manualdns.fr.md | 6 +- .../ovh/manualdns/manualdns.it.md | 7 +- .../05.registrar/ovh/manualdns/manualdns.md | 6 +- .../55.providers/05.registrar/registrar.it.md | 1 - .../55.providers/05.registrar/registrar.md | 1 - .../55.providers/10.isp/free/isp_free.fr.md | 18 +- .../02.administer/55.providers/10.isp/isp.md | 95 ++- .../10.isp/orange/isp_orange.fr.md | 5 +- .../55.providers/10.isp/sfr/isp_sfr.fr.md | 4 +- .../15.vpn/01.vpn/vpn_advantage.de.md | 13 +- .../15.vpn/01.vpn/vpn_advantage.es.md | 4 +- .../15.vpn/01.vpn/vpn_advantage.fr.md | 13 +- .../15.vpn/01.vpn/vpn_advantage.it.md | 11 +- .../15.vpn/01.vpn/vpn_advantage.md | 13 +- .../02.administer/55.providers/15.vpn/vpn.md | 15 +- .../55.providers/20.server/server.md | 10 +- .../install_unpackaged_app.md | 2 +- .../60.extend/15.theming/theming.fr.md | 10 +- .../60.extend/15.theming/theming.md | 14 +- .../60.extend/30.api/admin_api.fr.md | 2 +- .../60.extend/30.api/admin_api.md | 6 +- pages/02.administer/admindoc.es.md | 2 +- pages/02.administer/admindoc.it.md | 4 +- .../email_configure_client.de.md | 7 +- .../email_configure_client.es.md | 1 - .../email_configure_client.fr.md | 7 +- .../email_configure_client.it.md | 8 +- .../05.emailclients/email_configure_client.md | 7 +- .../10.email_migration/email_migration.fr.md | 7 + .../10.email_migration/email_migration.md | 7 + pages/03.user_guide/15.xmpp/xmpp.es.md | 21 +- pages/03.user_guide/15.xmpp/xmpp.fr.md | 3 +- pages/03.user_guide/15.xmpp/xmpp.it.md | 5 +- pages/03.user_guide/15.xmpp/xmpp.md | 3 +- pages/03.user_guide/user_overview.fr.md | 2 +- pages/03.user_guide/user_overview.md | 2 +- .../15.framasoft/apps_framasoft.md | 68 +-- .../use_case_non-profit_organisations.ca.md | 42 +- .../use_case_non-profit_organisations.fr.md | 11 + .../use_case_non-profit_organisations.md | 13 +- .../use_case_non-profit_organisations.oc.md | 11 + .../20.app_bundle/app_bundle.md | 2 +- .../10.chat_rooms/chat_rooms.es.md | 10 +- .../10.chat_rooms/chat_rooms.fr.md | 10 +- .../05.community/10.chat_rooms/chat_rooms.md | 8 +- pages/05.community/15.help/help.fr.md | 2 +- pages/05.community/15.help/help.it.md | 1 - pages/05.community/15.help/help.md | 2 +- pages/05.community/20.faq/faq.de.md | 11 - pages/05.community/20.faq/faq.fr.md | 10 +- pages/05.community/20.faq/faq.it.md | 13 +- pages/05.community/20.faq/faq.md | 17 +- .../sponsors_partners.fr.md | 4 +- .../30.project_sponsors/sponsors_partners.md | 2 + .../35.project_budget/project_budget.fr.md | 34 +- .../35.project_budget/project_budget.md | 26 +- .../35.security_team/security_team.fr.md | 2 +- .../35.security_team/security_team.md | 2 +- pages/05.community/40.press_kit/press_kit.md | 43 +- .../doc_writing_guide.fr.md | 12 +- .../doc_writing_guide.md | 10 +- .../doc_markdown_guide.fr.md | 43 +- .../02.markdown_guide/doc_markdown_guide.md | 44 +- .../03.git/doc_use_git.fr.md | 13 +- .../03.git/doc_use_git.md | 12 +- .../write_documentation.de.md | 90 +-- .../write_documentation.fr.md | 9 +- .../write_documentation.md | 9 +- .../10.packaging_apps/10.manifest/docs.md | 20 +- .../10.packaging_apps/20.scripts/scripts.md | 10 +- .../10.packaging_apps/40.testing/testing.md | 12 +- .../50.publishing/publishing.md | 2 +- .../20.config_panels/config_panels.md | 48 +- .../sso_ldap_integration.md | 4 +- .../50.hooks/packaging_apps_hooks.fr.md | 10 +- .../50.hooks/packaging_apps_hooks.md | 258 ++++---- .../03.git/packaging_apps_git.fr.md | 44 +- .../80.resources/03.git/packaging_apps_git.md | 44 +- .../packaging_apps_virtualbox.fr.md | 3 +- .../packaging_apps_virtualbox.md | 1 + .../11.helpers/packaging_apps_helpers.md | 563 ++++++++---------- .../packaging_apps_resources.md | 49 +- .../20.bash_tips/shell_variables_scope.fr.md | 123 ++-- .../20.bash_tips/shell_variables_scope.md | 123 ++-- .../packaging_apps_intro.de.md | 33 +- .../packaging_apps_intro.fr.md | 29 +- .../10.packaging_apps/packaging_apps_intro.md | 31 +- .../15.dev/02.maindomain/maindomain.md | 11 +- pages/06.contribute/15.dev/03.forms/forms.md | 33 +- pages/07.help/help.it.md | 23 +- 276 files changed, 2680 insertions(+), 2233 deletions(-) diff --git a/orphaned/default.es.md b/orphaned/default.es.md index 41876311b..b1021d46d 100644 --- a/orphaned/default.es.md +++ b/orphaned/default.es.md @@ -2,10 +2,10 @@ Esta página todavía no existe, puedes editarla tecleando `````` en tu teclado, o clicando en el botón "Editar" abajo a la derecha de tu pantalla. Puedes echar un vistazo a los cambios que has efectuado empujando de nuevo la tecla `````` o clicando en el botón "Vistazo". -** Nota : ** Necesitarás una dirección email para validar tu propuesta. - +**Nota :** Necesitarás una dirección email para validar tu propuesta. ### Sintaxis + Esta página utiliza la sintaxis Markdown, refiérete a la documentación para más informaciones : -http://daringfireball.net/projects/markdown/syntax + diff --git a/orphaned/default.fr.md b/orphaned/default.fr.md index 270beabee..6bcd506e8 100644 --- a/orphaned/default.fr.md +++ b/orphaned/default.fr.md @@ -2,10 +2,10 @@ Cette page n’existe pas encore, vous pouvez l’éditer en appuyant sur la touche ```<Échap>``` de votre clavier, ou en cliquant sur le bouton "Éditer" en bas à droite de votre écran. Vous pourrez avoir un aperçu de vos changements en appuyant à nouveau sur la touche ```<Échap>``` ou en cliquant sur le bouton "Aperçu". -** Note : ** Vous aurez besoin d'une adresse email pour valider votre proposition. - +**Note :** Vous aurez besoin d'une adresse email pour valider votre proposition. ### Syntaxe + Cette page utilise la syntaxe Markdown, veuillez vous référer à la documentation pour plus d’informations : -http://daringfireball.net/projects/markdown/syntax + diff --git a/orphaned/default.it.md b/orphaned/default.it.md index 89f495de7..a22f67757 100644 --- a/orphaned/default.it.md +++ b/orphaned/default.it.md @@ -2,10 +2,10 @@ Questa pagina non è ancora stata creata, puoi modificarla premendo `````` sulla tua tastiera o cliccando il pulsante "Modifica" in basso a destra del tuo schermo. Potrai vedere l'anteprima delle tue modifiche premendo ancora `````` o cliccando il pulsante "Anteprima". -** Nota: ** Devi fornire un indirizzo email per confermare le tue modifiche. +**Nota:** Devi fornire un indirizzo email per confermare le tue modifiche. ### Sintassi Questa pagina usa la sintassi markdown, per favore fai riferimento alla documentazione per ulteriori informazioni: -http://daringfireball.net/projects/markdown/syntax + diff --git a/orphaned/default.md b/orphaned/default.md index 08ee4d984..0d7b19404 100644 --- a/orphaned/default.md +++ b/orphaned/default.md @@ -2,10 +2,10 @@ This page is not created yet, you can edit it by pressing `````` on your keyboard or by clicking the "edit" button on the bottom-right side of your screen. You will be able to preview your changes by pressing `````` again or by clicking the "preview" button. -** Note: ** You will need to provide an email address to validate your submission. +**Note:** You will need to provide an email address to validate your submission. ### Syntax This page use the markdown syntax, please refer to the documentation for further informations: -http://daringfireball.net/projects/markdown/syntax + diff --git a/orphaned/dns.es.md b/orphaned/dns.es.md index b4a5f53be..814795935 100644 --- a/orphaned/dns.es.md +++ b/orphaned/dns.es.md @@ -20,7 +20,6 @@ También existen **tipos** de registros DNS, lo que significa que un dominio pue **Por ejemplo** : `www.yunohost.org` apunta hacia `yunohost.org` - ### ¿ Cómo (bien) hacer la configuración ? Tienes varias opciones. Nota que puedes cumular estas soluciones si posees varios dominios : por ejemplo, puedes tener `mi-servidor.nohost.me` utilizando la solución **1.**, et `mi-servidor.org` utilizando la solución **2.**, redirigiéndolos hacia el mismo servidor YunoHost. diff --git a/orphaned/dns.fr.md b/orphaned/dns.fr.md index 444ceadfb..a7bf8a43d 100644 --- a/orphaned/dns.fr.md +++ b/orphaned/dns.fr.md @@ -6,9 +6,9 @@ La configuration des DNS est une étape cruciale pour que votre serveur soit acc ### Qu’est-ce que c’est ? -**N’hésitez pas à regarder la très bonne conférence de Stéphane Bortzmeyer :** +**N’hésitez pas à regarder la très bonne conférence de Stéphane Bortzmeyer :** -https://www.iletaitunefoisinternet.fr/post/1-dns-bortzmeyer/ + DNS signifie « Domain Name Server » en anglais, et est souvent employé pour désigner la configuration de vos noms de domaine. Vos noms de domaines doivent en effet pointer vers quelque chose (en général une adresse IP). @@ -23,7 +23,6 @@ Il existe également des **types** d’enregistrement DNS, ce qui veut dire qu **Par exemple** : `www.yunohost.org` renvoie vers `yunohost.org` - ### Comment (bien) faire la configuration ? Plusieurs choix s’offrent à vous. Notez que vous pouvez cumuler ces solutions si vous possédez plusieurs domaines : par exemple vous pouvez avoir `mon-serveur.nohost.me` en utilisant la solution **1.**, et `mon-serveur.org` en utilisant la solution **2.**, redirigeant vers le même serveur YunoHost. diff --git a/orphaned/dns.md b/orphaned/dns.md index 9666ec73f..8911c4b77 100644 --- a/orphaned/dns.md +++ b/orphaned/dns.md @@ -34,5 +34,3 @@ You can also check out these pages for specific [registrar](/registrar) document 3. (Advanced, not 100% supported...) Your YunoHost instance has its own DNS service, which means it will automatically configure its own DNS records, and that you can leave the setup to the instance itself. To do this, you must explain to your **registrar** that your YunoHost instance is the authoritative DNS server for your domain name. **Warning**: If you choose this option, all configuration options will be done automatically, you will retain a good deal of flexibility, but if your server gets knocked offline you will run into many problems. **Choose this only if you understand the implications.** - - diff --git a/orphaned/index.ar.md b/orphaned/index.ar.md index af4854209..45860a7c3 100644 --- a/orphaned/index.ar.md +++ b/orphaned/index.ar.md @@ -1,4 +1,4 @@ -
+
@@ -107,7 +107,6 @@

تذكروا ! نحن بشر !
إن كان عندكم تساؤل أو واجهتكم مشكلة أو ربما يهمُّكُم المشروع فقط، انضموا إلينا عبر غرفة المحادثة الخاصة بنا لتبليغنا التحية بالنقر على الزر أدناه  

-

Donation button

@@ -136,7 +135,6 @@
-
- diff --git a/orphaned/index.es.md b/orphaned/index.es.md index 3a29ed7b9..1f8038732 100644 --- a/orphaned/index.es.md +++ b/orphaned/index.es.md @@ -1,4 +1,4 @@ -
+
@@ -134,7 +134,6 @@
- + diff --git a/orphaned/index.fr.md b/orphaned/index.fr.md index 54333a4df..f9ee49cf0 100644 --- a/orphaned/index.fr.md +++ b/orphaned/index.fr.md @@ -1,4 +1,4 @@ -
+
@@ -118,7 +118,6 @@
- - diff --git a/orphaned/index.it.md b/orphaned/index.it.md index e0884761a..c60f1765b 100644 --- a/orphaned/index.it.md +++ b/orphaned/index.it.md @@ -1,4 +1,4 @@ -
+
@@ -135,7 +135,6 @@
- - diff --git a/orphaned/index.md b/orphaned/index.md index c18bd0333..3ae652272 100644 --- a/orphaned/index.md +++ b/orphaned/index.md @@ -1,4 +1,4 @@ -
+
@@ -44,7 +44,6 @@

Latest news

-

Setup your server with ease, you already have everything at home

diff --git a/orphaned/index.oc.md b/orphaned/index.oc.md index 80c1c013f..fa9d419ea 100644 --- a/orphaned/index.oc.md +++ b/orphaned/index.oc.md @@ -1,4 +1,4 @@ -
+
@@ -108,7 +108,7 @@

Donation button

- +
@@ -133,7 +133,6 @@
-
- diff --git a/orphaned/news.md b/orphaned/news.md index a3975fc3e..57db71c2d 100644 --- a/orphaned/news.md +++ b/orphaned/news.md @@ -33,7 +33,7 @@ $(document).ready(function() { $(data).find("item").each(function(_, item) { var description = $(item).find("description"); // yes this is a NIGHTMARE - var blockquote_content = $("
" + description[0].textContent + "
").find("blockquote")[0].innerHTML + var blockquote_content = $("
" + description[0].textContent + "
").find["blockquote"](0).innerHTML // blockquote_content = blockquote_content.replace(" Zurück zur Homepage [/center] diff --git a/pages/00.home/docs.es.md b/pages/00.home/docs.es.md index 55b981432..d3f557af2 100644 --- a/pages/00.home/docs.es.md +++ b/pages/00.home/docs.es.md @@ -27,7 +27,6 @@ La [Comunidad](/community) esta disponible para ayudarte : entra en el [chat](/c [/center] - [center] Volver a la página principal [/center] diff --git a/pages/00.home/docs.fr.md b/pages/00.home/docs.fr.md index 58ab6ccbf..2fecadc58 100644 --- a/pages/00.home/docs.fr.md +++ b/pages/00.home/docs.fr.md @@ -31,5 +31,4 @@ La [communauté](/community) est là si vous avez besoin d'aide : venez discuter Retourner à la page d'accueil du site [/center] - !!!! Pour naviguer dans cette documentation, vous pouvez utiliser les flèches gauches et droites. Utilisez le [fa=bars /] panneau latéral pour aller directement dans les sections qui vous intéresse ou en utilisant la [fa=search /] barre de recherche. Enjoy! diff --git a/pages/00.home/docs.it.md b/pages/00.home/docs.it.md index 769846af8..63d0bd8e3 100644 --- a/pages/00.home/docs.it.md +++ b/pages/00.home/docs.it.md @@ -30,4 +30,3 @@ La [comunità](/community) è disponibile se avete bisogno di aiuto: potete veni [/center] !!!! Per navigare in questa documentazione potete utilizzare i tasti freccia destra e sinistra. Navigate direttamente nella sezione che vi interessa con il [fa=bars /] pannello laterale o utilizzate il [fa=search /] box di ricerca. Enjoy! - diff --git a/pages/00.home/docs.md b/pages/00.home/docs.md index 3f2534c9d..19ce54ad0 100644 --- a/pages/00.home/docs.md +++ b/pages/00.home/docs.md @@ -27,7 +27,6 @@ The [Community](/community) is here for you if you need some help : come [chat]( [/center] - [center] Go back to the homepage [/center] diff --git a/pages/00.home/docs.ru.md b/pages/00.home/docs.ru.md index 6428ad0fc..db4b97586 100644 --- a/pages/00.home/docs.ru.md +++ b/pages/00.home/docs.ru.md @@ -27,7 +27,6 @@ visible: false [/center] - [center] Вернуться на главную [/center] diff --git a/pages/01.overview/05.self_hosting/self_hosting.de.md b/pages/01.overview/05.self_hosting/self_hosting.de.md index 593f9bdb0..9e1e3eabe 100644 --- a/pages/01.overview/05.self_hosting/self_hosting.de.md +++ b/pages/01.overview/05.self_hosting/self_hosting.de.md @@ -18,7 +18,7 @@ Beim Self-Hosting geht es nicht darum, "Ihr Internet" sicherer zu machen, und es - **Sie glauben an ein freies, offenes und dezentrales Internet.** In einem zentralisierten Internet können private Unternehmen und Behörden Personen ausspähen, analysieren und beeinflussen, indem sie diktieren, wie Sie sich miteinander verbinden, und indem sie Inhalte filtern. YunoHost wird von einer Community entwickelt, die an ein offenes und dezentrales Internet glaubt, und wir hoffen, dass Sie dies auch tun! -- **Sie möchten die Kontrolle über Ihre Daten und Dienste haben.** Ihre Bilder, Chatnachrichten, der Browserverlauf und der Text, den Sie für die Schule schreiben, haben auf dem Server eines anderen Benutzers (a.k.a. The Cloud) nichts zu suchen. Sie sind Teil Ihres Privatlebens, aber auch Teil des Lebens Ihrer Familie, Ihres Partners und so weiter. Diese Daten sollten von * Ihnen * verwaltet werden, nicht von einem zufälligen Unternehmen in den USA, dass Ihre Daten analysieren und die Ergebnisse verkaufen möchte. +- **Sie möchten die Kontrolle über Ihre Daten und Dienste haben.** Ihre Bilder, Chatnachrichten, der Browserverlauf und der Text, den Sie für die Schule schreiben, haben auf dem Server eines anderen Benutzers (a.k.a. The Cloud) nichts zu suchen. Sie sind Teil Ihres Privatlebens, aber auch Teil des Lebens Ihrer Familie, Ihres Partners und so weiter. Diese Daten sollten von *Ihnen* verwaltet werden, nicht von einem zufälligen Unternehmen in den USA, dass Ihre Daten analysieren und die Ergebnisse verkaufen möchte. - **Sie möchten lernen, wie Computer und das Internet funktionieren.** Der Betrieb eines eigenen Servers ist ein guter Kontext, um die grundlegenden Mechanismen von Betriebssystemen und dem Internet zu verstehen. Möglicherweise müssen Sie sich mit der Befehlszeilenschnittstelle, der Netzwerkarchitektur, der DNS-Konfiguration und mit SSH usw. befassen. diff --git a/pages/01.overview/05.self_hosting/self_hosting.es.md b/pages/01.overview/05.self_hosting/self_hosting.es.md index 1bc421494..7faabb725 100644 --- a/pages/01.overview/05.self_hosting/self_hosting.es.md +++ b/pages/01.overview/05.self_hosting/self_hosting.es.md @@ -6,59 +6,28 @@ taxonomy: routes: default: '/selfhosting' --- - -El auto-alojamiento se refiere al hecho de tener y administrar tú tu propio servidor, normalmente en tu casa, para hospedar tus datos personales y servicios, en lugar de depender de terceros. Por ejemplo, es posible el auto-hospedaje de tu blog, de manera que este "viva" dentro de una máquina que controlas, en lugar de que se aloje en un ordenador de otra persona/empresa (alias La Nube) contra dinero, publicidad o cesión de datos privados. - +El auto-alojamiento se refiere al hecho de tener y administrar tú tu propio servidor, normalmente en tu casa, para hospedar tus datos personales y servicios, en lugar de depender de terceros. Por ejemplo, es posible el auto-hospedaje de tu blog, de manera que este "viva" dentro de una máquina que controlas, en lugar de que se aloje en un ordenador de otra persona/empresa (alias La Nube) contra dinero, publicidad o cesión de datos privados. Auto-alojar implica disponer de un servidor. Un servidor es un ordenador destinado a ser accesible en la red las 24 horas del día y que normalmente no tiene ni pantalla ni teclado, ya que se controla a distancia. Contrariamente a una creencia extendida, los servidores no son necesariamente máquinas enormes y muy potentes: en la actualidad, una pequeña placa ARM de unos ~30€/$ es suficiente para el auto-hospedaje. - La práctica del auto-alojamiento no convierte "tu internet" más segura y tampoco proporciona anonimato por si mismo. El objetivo es generalmente generar autonomía y control de tus servicios y tus datos - lo que también implica una responsabilidad. ## ¿Cuáles son los beneficios del auto-alojamiento? - - **Crées en una internet libre, abierta y descentralizada.** En una internet centralizada, entidades privadas y gobiernos pueden espiar, analizar e influir en nosotras dictando como iteraccionamos entre nosotras o filtrando contenidos. A YunoHost lo desarrolla por una comunidad que cree en una internet abierta y descentralizada. ¡Esperamos que tú también! - - **Quieres tener control de tus datos y servicios.** Tus fotos, mensajes de chat, el historial de navegación y ese trabajo del colegio no tienen nada que hacer en el ordenador de otra persona (alias La Nube). Esos datos forman parte de tu vida privada, pero también de la de tu familia, de tus amistades, etc. Estos datos deberían ser gestionados por *ti*, y no por una empresa americana cualquiera que busca analizar tus datos para vender los resultados. - - **Quieres aprender cómo funcionan los ordenadores e internet.** Operar tu propio servidor es un ejercicio muy enriquecedor para entender los mecanismos básicos en el corazón de los sistemas operativos y de internet. Es posible que tengas que escribir en la línea de comandos o a segmentos de configuración de la red y de DNS. - - - **Quieres explorar las nuevas posibilidades y personalizar tu espacio.** ¿Alguna vez has soñado con tener tu propio servidor de Minecraft para jugar con tus amistades, o un cliente sw IRC o XMPP persistente? Con tu propio servidor, puedes instalar manualmente y ejecutar prácticamente cualquier programa que quieras y personalizar cada parte. ## ¿Qué implica el auto-alojamiento? - - **Auto-alojarse requiere del trabajo y de la paciencia.** Auto-alojarte es algo parecido a cultivar tu propio jardín o huerto: requiere del trabajo y de la paciencia. Mientras que YunoHost pretende hacer todo el trabajo duro por ti, necesitarás tomarte el tiempo para aprender y configurar pequeños detalles para que tu instalación funcione correctamente. También necesitarás realizar algunas tareas de mantenimiento (como actualizaciones) de vez en cuando, o pedir soporte si las cosas no funcionan. - - **Un gran servidor conlleva una gran responsabilidad.** Operar un servidor significa que eres responsable de los datos que alojas. Nadie podrá recuperarlos por ti si se pierden. YunoHost proporciona funciones de copia de seguridad, que es recomendable utilizar regularmente para hacer copias de seguridad de las configuraciones y de los datos importantes. También deberías echar un ojo a las noticias y recomendaciones de seguridad, para que tu servidor o tus datos no se vean comprometidos. - -- **La calidad y el rendimiento probablemente no serán tan buenos como los de los servicios "premium".** YunoHost (y la mayoría de las aplicaciones empaquetadas) son programas libres basados de código abierto, desarrollados por comunidades de personas de manera voluntaria. No hay garantía absoluta de que el software funcione en todas las circunstancias posibles. El rendimiento de su servidor autohospedado también está relacionado con su procesador, a la memoria RAM y la conectividad a internet. \ No newline at end of file +- **La calidad y el rendimiento probablemente no serán tan buenos como los de los servicios "premium".** YunoHost (y la mayoría de las aplicaciones empaquetadas) son programas libres basados de código abierto, desarrollados por comunidades de personas de manera voluntaria. No hay garantía absoluta de que el software funcione en todas las circunstancias posibles. El rendimiento de su servidor autohospedado también está relacionado con su procesador, a la memoria RAM y la conectividad a internet. diff --git a/pages/01.overview/05.self_hosting/self_hosting.it.md b/pages/01.overview/05.self_hosting/self_hosting.it.md index 45c2b5950..ebb3c4466 100644 --- a/pages/01.overview/05.self_hosting/self_hosting.it.md +++ b/pages/01.overview/05.self_hosting/self_hosting.it.md @@ -30,5 +30,3 @@ Praticare il self-hosting non rende il "tuo internet" più sicuro e non fornisce - **Con grandi server derivano grandi responsabilità.** Gestire un server implica l'essere responsabile dei dati che ospiti: nessuno potrà recuperare i dati al tuo posto se li perderai. YunoHost offre funzionalità di salvataggio che è raccomandato utilizzare per memorizzare le configurazioni e i dati importanti. Devi tenere controllate le raccomandazioni e le novità riguardo la sicurezza perché il tuo server o i tuoi dati non vengano compromessi. - **La qualità e le performances probabilmente non saranno le stesse dei servizi premium.** YunoHost (e la maggior parte delle applicazioni che sono predisposte) sono programmi liberi e open-source, sviluppati da comunità di volontari. Non c'è la garanzia assoluta che i programmi funzionino in tutte le possibili situazioni. Le performance del tuo server self-hosting sono legate anche al processore, alla memoria RAM e alla connessione internet. - - diff --git a/pages/01.overview/05.self_hosting/self_hosting.ru.md b/pages/01.overview/05.self_hosting/self_hosting.ru.md index 7f3d68026..e8d9880b1 100644 --- a/pages/01.overview/05.self_hosting/self_hosting.ru.md +++ b/pages/01.overview/05.self_hosting/self_hosting.ru.md @@ -17,16 +17,16 @@ routes: - **Вы верите в свободный, открытый и децентрализованный Интернет.** В централизованном Интернете частные компании и правительство могут шпионить, анализировать людей и влиять на них, диктуя, как они взаимодействуют друг с другом, и фильтруя контент. YunoHost разработан сообществом, которое верит в открытый и децентрализованный Интернет, и мы надеемся, что вы тоже верите! -- **Вы хотите иметь контроль над своими данными и сервисами.** Вашим фотографиям, сообщениям в чате, истории посещенных страниц и тексту, который вы пишете для школы, нечего делать на чужом сервере (он же Облако). Они являются частью вашей личной жизни, но также и частью жизни вашей семьи, жизни вашего друга и так далее. Этими данными должны управлять * вы*, а не случайная компания в США, которая хочет, чтобы ваши данные анализировались и продавались результаты. +- **Вы хотите иметь контроль над своими данными и сервисами.** Вашим фотографиям, сообщениям в чате, истории посещенных страниц и тексту, который вы пишете для школы, нечего делать на чужом сервере (он же Облако). Они являются частью вашей личной жизни, но также и частью жизни вашей семьи, жизни вашего друга и так далее. Этими данными должны управлять *вы*, а не случайная компания в США, которая хочет, чтобы ваши данные анализировались и продавались результаты. - **Вы хотите узнать о том, как работают компьютеры и Интернет.** Управление собственным сервером - довольно хороший контекст для понимания основных механизмов, лежащих в основе операционных систем и Интернета. Возможно, вам придется иметь дело с интерфейсом командной строки, сетевой архитектурой, конфигурацией DNS, SSH и так далее. - **Вы хотите исследовать новые возможности и настраивать вещи.** Вы когда-нибудь мечтали запустить сервер Minecraft для своих друзей или постоянный IRC или XMPP-клиент? Имея свой собственный сервер, вы можете вручную установить и запустить практически любую программу, которую пожелаете, и настроить все до мелочей. -## Почему вы * не должны* принимать гостей сами? +## Почему вы *не должны* принимать гостей сами? - **Самостоятельный хостинг требует некоторой работы и терпения.** Самостоятельный хостинг немного похож на выращивание собственного сада или овощей: это требует работы и терпения. В то время как YunoHost стремится выполнить всю тяжелую работу за вас, самостоятельный хостинг по-прежнему требует, чтобы вы потратили время на изучение и настройку нескольких вещей для правильной настройки вашего сервера. Вам также нужно будет время от времени выполнять задачи технического обслуживания (например, обновления) или обращаться за поддержкой, если что-то выйдет из строя. - **С отличными серверами приходит большая ответственность.** Эксплуатация сервера означает, что вы несете ответственность за данные, которые размещаете. Никто не сможет восстановить их для вас, если они потеряются. YunoHost предоставляет функции резервного копирования, которые вы должны регулярно использовать для резервного копирования нужных вам конфигураций и данных. Вам также следует следить за новостями и рекомендациями по безопасности, чтобы ваш сервер или критически важные данные не были скомпрометированы. -- **Качество и производительность, вероятно, будут не так хороши, как услуги премиум-класса.** YunoHost (и большинство приложений, упакованных для него) - это бесплатное программное обеспечение с открытым исходным кодом, разработанное сообществами людей в свободное время и на основе наилучших усилий. Нет абсолютной гарантии, что программное обеспечение будет работать при любых возможных обстоятельствах. Производительность вашего автономного сервера также зависит от его центрального процессора и оперативной памяти, а также от доступного подключения к Интернету. \ No newline at end of file +- **Качество и производительность, вероятно, будут не так хороши, как услуги премиум-класса.** YunoHost (и большинство приложений, упакованных для него) - это бесплатное программное обеспечение с открытым исходным кодом, разработанное сообществами людей в свободное время и на основе наилучших усилий. Нет абсолютной гарантии, что программное обеспечение будет работать при любых возможных обстоятельствах. Производительность вашего автономного сервера также зависит от его центрального процессора и оперативной памяти, а также от доступного подключения к Интернету. diff --git a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.ar.md b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.ar.md index dc13bdf28..3bf9d3e8a 100644 --- a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.ar.md +++ b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.ar.md @@ -29,11 +29,10 @@ routes: ### أصل فكرة المشروع - تعود نشأة فكرة مشروع واي يونوهوست YunoHost إلى شهر فيفري مِن عام 2012 بعد محادثة بدأت على هذا الشكل تقريبًا : -
« تبًا، لقد سئِمتُ مِن إعادة إعداد خادم البريد الإلكتروني ... Beudbeud، كيف قُمتَ بإعداد خادومك الجميل حول LDAP ؟ » -Kload، فيفري 2012
+> « تبًا، لقد سئِمتُ مِن إعادة إعداد خادم البريد الإلكتروني ... Beudbeud، كيف قُمتَ بإعداد خادومك الجميل حول LDAP ؟ » +> Kload، فيفري 2012 Il ne manquait en fait qu’une interface d’administration au serveur de Beudbeud pour en faire quelque chose d’exploitable, alors Kload a décidé de la développer. Finalement, après l’automatisation de quelques configurations et le packaging de quelques applications web, la première version de YunoHost était sortie. @@ -43,7 +42,7 @@ Constatant l’engouement croissant autour de YunoHost et de l’auto-hébergeme ### الهدف -يهدف واي يونوهوست YunoHost إلى تسهيل عملية تنصيب و تثبيت و إدارة أي خادمٍ لأكبر عدد ممكن مِن الناس و ذلك دون المساس بجودة و موثوقية البرمجيات. +يهدف واي يونوهوست YunoHost إلى تسهيل عملية تنصيب و تثبيت و إدارة أي خادمٍ لأكبر عدد ممكن مِن الناس و ذلك دون المساس بجودة و موثوقية البرمجيات. لم يُدَّخر أي جهد لتسهيل عملية التنصيب و الإنبساط وذلك على أكبر عدد ممكن مِن الأجهزة مهما اختلفت مميزات كل جهاز (في المنزل أو على خادوم إستضافة أو على خادوم شخصي إفتراضي) @@ -79,4 +78,3 @@ Même si YunoHost est multi-domaine et multi-utilisateur, il reste **inappropri Premièrement parce que le logiciel est trop jeune, donc non-testé et non-optimisé pour être mis en production pour des centaines d’utilisateurs en même temps. Et quand bien même, ce n’est pas le chemin que l’on souhaite faire suivre à YunoHost. La virtualisation se démocratise, et c’est une façon bien plus étanche et sécurisée de faire de la mutualisation. Vous pouvez héberger vos amis, votre famille ou votre entreprise sans problème, mais vous devez **avoir confiance** en vos utilisateurs, et ils doivent de la même façon avoir confiance en vous. Si vous souhaitez tout de même fournir des services YunoHost à des inconnus, **un VPS entier par utilisateur** sera la meilleure solution. - diff --git a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.de.md b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.de.md index 6ab273485..2abdcfd6d 100644 --- a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.de.md +++ b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.de.md @@ -29,7 +29,8 @@ YunoHost ist ein **Betriebssystem**, das auf die einfachste Verwaltung eines **S YunoHost wurde im Februar 2012 aus folgender Situation heraus erstellt: -

"Scheiße, ich bin zu faul, um meinen Mailserver neu zu konfigurieren ... Beudbeud, wie hast Du deinen kleinen Server mit LDAP zum Laufen gebracht?"

Kload, Februar 2012
+> "Scheiße, ich bin zu faul, um meinen Mailserver neu zu konfigurieren ... Beudbeud, wie hast Du deinen kleinen Server mit LDAP zum Laufen gebracht?" +> Kload, Februar 2012 Alles, was benötigt wurde, war eine Administrationsoberfläche für Beudbeud's Server, um etwas nutzbar zu machen, also entschied sich Kload, eine zu entwickeln. Schließlich wurde YunoHost v1, nach der Automatisierung mehrerer Konfigurationen und der Paketierung in einigen Webanwendungen, fertiggestellt. diff --git a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.es.md b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.es.md index 0a85df238..beaf85880 100644 --- a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.es.md +++ b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.es.md @@ -29,14 +29,14 @@ YunoHost es un **sistema operativo** que persigue simplificar la administración YunoHost se creó en Febrero de 2012 tras algo así: -

"¡Mierda, soy muy vago para reconfigurar mi servidor de correo!… Beudbeud, ¿Cómo hiciste para conectar tu pequeño servidor a LDAP?"

-Kload, Febrero de 2012
+> "¡Mierda, soy muy vago para reconfigurar mi servidor de correo!… Beudbeud, ¿Cómo hiciste para conectar tu pequeño servidor a LDAP?" +> Kload, Febrero de 2012 Lo único que necesitaba era un interfaz de administración para el servidor de Beudbeud para tener algo usable, así que Kload decidió desarrollar uno. Finalmente, tras automatizar varias configuraciones y empaquetar algunas aplicaciones web, YunoHost v1 quedó terminado. Notando un entusiasmo creciente alrededor de YunoHost y del autoalojamiento en general, los desarrolladores originales junto con nuevas personas contribuyentes decidieron comenzar a trabajar en la versión 2, una versión más extensible, más potente, más fácil de usar, y ya de paso, una que prepare ricas tazas de café de comercio justo para los elfos de Laponia. -El nombre **YunoHost** viene de la jerga "Y U NO Host". El [meme de Internet ](https://en.wikipedia.org/wiki/Internet_meme) debería ilustrarlo: +El nombre **YunoHost** viene de la jerga "Y U NO Host". El [meme de Internet](https://en.wikipedia.org/wiki/Internet_meme) debería ilustrarlo: ![](image://dude_yunohost.jpg) ## ¿Qué no es YunoHost? diff --git a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.fr.md b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.fr.md index 829547cf6..9454b64fc 100644 --- a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.fr.md +++ b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.fr.md @@ -29,8 +29,8 @@ YunoHost est un **système d’exploitation** qui vise à simplifier autant que YunoHost est un projet né en février 2012 à la suite d’à peu près ça : -

« Merde, j’ai la flemme de me reconfigurer un serveur mail... Beudbeud, comment t’as fait pour configurer ton joli serveur sous LDAP ? »

-Kload, février 2012
+> « Merde, j’ai la flemme de me reconfigurer un serveur mail... Beudbeud, comment t’as fait pour configurer ton joli serveur sous LDAP ? » +> Kload, février 2012 Il ne manquait en fait qu’une interface d’administration au serveur de Beudbeud pour en faire quelque chose d’exploitable, alors Kload a décidé de la développer. Finalement, après l’automatisation de quelques configurations et le packaging de quelques applications web, la première version de YunoHost était sortie. diff --git a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.it.md b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.it.md index 67e89db9f..2c62052ec 100644 --- a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.it.md +++ b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.it.md @@ -13,10 +13,10 @@ YunoHost è un **sistema operativo** che mira a rendere il più semplice possibi ## Caratteristiche -- ![](image://icon-debian.png?resize=32&classes=inline) Basato su Debian; +- ![](image://icon-debian.png?resize=32&classes=inline) Basato su Debian; - ![](image://icon-tools.png?resize=32&classes=inline) Amministra il tuo server attraverso **un'interfaccia web amichevole** ; - ![](image://icon-package.png?resize=32&classes=inline) Installa le **applicazioni in pochi clic**; -- ![](image://icon-users.png?resize=32&classes=inline) Gestisci **gli utenti ** (basato su LDAP); +- ![](image://icon-users.png?resize=32&classes=inline) Gestisci **gli utenti** (basato su LDAP); - ![](image://icon-globe.png?resize=32&classes=inline) Gestisci **i nomi di dominio**; - ![](image://icon-medic.png?resize=32&classes=inline) Crea e ripristina **i backup**; - ![](image://icon-door.png?resize=32&classes=inline) Connettiti contemporaneamente a tutte le applicazioni attraverso **il portale utente** (NGINX, SSOwat); @@ -26,16 +26,17 @@ YunoHost è un **sistema operativo** che mira a rendere il più semplice possibi - ![](image://icon-shield.png?resize=32&classes=inline)... e i **sistemi di sicurezza** (Fail2ban, yunohost-firewall); ## Origine + YunoHost è stata creata nel febbraio 2012 dopo qualcosa del genere: -

"Merda, sono troppo pigro per riconfigurare il mio server di posta... Beudbeud, come sei riuscito a far funzionare il tuo piccolo server con LDAP?"

-Kload, Febbraio 2012
+> "Merda, sono troppo pigro per riconfigurare il mio server di posta... Beudbeud, come sei riuscito a far funzionare il tuo piccolo server con LDAP?" +> Kload, Febbraio 2012 Tutto ciò che serviva era un'interfaccia di amministrazione per il server di Beudbeud per creare qualcosa di utilizzabile, così Kload ha deciso di svilupparne una. Alla fine, dopo aver automatizzato diverse configurazioni e aver inserito alcune applicazioni web, YunoHost versione 1 è stato completato. Notando il crescente entusiasmo intorno a YunoHost e al self-hosting in generale, gli sviluppatori originari e i nuovi collaboratori hanno deciso di iniziare a lavorare alla versione 2, una versione più estensibile, più potente, più facile da usare e che prepara una bella tazza di caffè equo-solidale per gli elfi della Lapponia. -Il nome **YunoHost** deriva dal gergo "Y U NO Host". Il [meme Internet](https://en.wikipedia.org/wiki/Internet_meme) dovrebbe illustrarlo: +Il nome **YunoHost** deriva dal gergo "Y U NO Host". Il [meme Internet](https://en.wikipedia.org/wiki/Internet_meme) dovrebbe illustrarlo: ![](image://dude_yunohost.jpg) ## Cosa non è YunoHost? diff --git a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.md b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.md index 7c4657a27..ae77f095e 100644 --- a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.md +++ b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.md @@ -29,8 +29,8 @@ YunoHost is an **operating system** aiming for the simplest administration of a YunoHost was created in February 2012 after something like this: -

"Shit, I'm too lazy to reconfigure my mail server... Beudbeud, how were you able to get your little server running with LDAP?"

-Kload, February 2012
+> "Shit, I'm too lazy to reconfigure my mail server... Beudbeud, how were you able to get your little server running with LDAP?" +> Kload, February 2012 All that was needed was an admin interface for Beudbeud's server to make something usable, so Kload decided to develop one. Finally, after automating several configs and packaging in some web apps, YunoHost v1 was finished. diff --git a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.ru.md b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.ru.md index c0925cf09..b29da5514 100644 --- a/pages/01.overview/10.what_is_yunohost/what_is_yunohost.ru.md +++ b/pages/01.overview/10.what_is_yunohost/what_is_yunohost.ru.md @@ -29,8 +29,8 @@ YunoHost это **операционная система** позволяюща YunoHost был создан в Феврале 2012 после чего-то вроде: -

"Блин, Я слишком ленив чтобы перенастроить мой почтовый сервер... Beudbeud, как вам удалось запустить свой малеький сервер LDAP?"

-Kload, Февраль 2012
+> "Блин, Я слишком ленив чтобы перенастроить мой почтовый сервер... Beudbeud, как вам удалось запустить свой малеький сервер LDAP?" +> Kload, Февраль 2012 Всё что было нужно - админ панель для сервера Beudbeud-а чтобы сделать что-то юзабельное, поэтому Kload решил её разработать. В итоге, после автоматизации нескольких конфигураций и упаковки некоторых Веб-приложений, YunoHost v1 был завершён. diff --git a/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.de.md b/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.de.md index e1016ed96..66c48787f 100644 --- a/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.de.md +++ b/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.de.md @@ -11,7 +11,7 @@ Sie können zu Hause (auf einem kleinen Computer) oder auf einem Remote-Server h ### Zu Hause, zum Beispiel auf einem Einplatinencomputer oder einem alten Computer -Sie können zu Hause mit einem Einplatinencomputer oder einem überarbeiteten regulären Computer, der mit Ihrem Heimrouter verbunden ist, hosten. +Sie können zu Hause mit einem Einplatinencomputer oder einem überarbeiteten regulären Computer, der mit Ihrem Heimrouter verbunden ist, hosten. - **Pros** : Sie haben die physische Kontrolle über die Maschine und müssen nur die Hardware kaufen; - **Cons** : Sie müssen [Ihre Internet-Router manuell konfigurieren](/isp_box_config) und [sind möglicherweise von Ihrem Internet-Service-Provider eingeschränkt](/isp). diff --git a/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.md b/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.md index 7f4e8af1b..38f7f2ff5 100644 --- a/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.md +++ b/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.md @@ -11,7 +11,7 @@ You can host yourself at home (on a small computer), or on a remote server. Each ### At home, for instance on an ARM board or an old computer -You can host yourself at home with an ARM board or a re-purposed regular computer, connected to your home router/box. +You can host yourself at home with an ARM board or a re-purposed regular computer, connected to your home router/box. - **Pros** : you will have physical control of the machine and only need to buy the hardware; - **Cons** : you will have to [manually configure your internet box](/isp_box_config) and [might be limited by your ISP](/isp). @@ -87,4 +87,4 @@ You can rent a virtual private server or a dedicated machine from [associative]( Typically pretty good - \ No newline at end of file + diff --git a/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.ru.md b/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.ru.md index 6ffe5c3c3..2923cbfca 100644 --- a/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.ru.md +++ b/pages/02.administer/05.how_to_host_yourself/how_to_host_yourself.ru.md @@ -12,6 +12,7 @@ routes: ### Дома, например, на плате ARM или старом компьютере Вы можете запустить YunoHost у себя дома с помощью платы ARM или переоборудованного обычного компьютера, подключенного к вашему домашнему роутеру. + - **Плюсы** : у вас будет физический контроль над машиной, и вам нужно будет только купить оборудование; - **Минусы** : вам придется [вручную настроить свой роутер](/isp_box_config) и [возможные ограничения вашим провайдером](/isp). @@ -21,7 +22,8 @@ VPN - это зашифрованный туннель между двумя к - **Плюсы** : у вас будет физический контроль над машиной, а VPN скрывает ваш трафик от вашего интернет-провайдера и позволяет вам обойти его ограничения; - **Минусы** : вам придется оплатить ежемесячную подписку на VPN. -- +- + ### На удалённом сервере (VPS или выделенный) Вы можете арендовать виртуальный частный сервер (VPS) или выделенную машину у [ассоциации](https://db.ffdn.org/) или [коммерческие](/providers/server) облачные провайдеры. @@ -86,4 +88,4 @@ VPN - это зашифрованный туннель между двумя к Обычно достаточно хорошее - \ No newline at end of file + diff --git a/pages/02.administer/10.install/05.images/docs.fr.md b/pages/02.administer/10.install/05.images/docs.fr.md index d0cbe91bb..c96fa7569 100644 --- a/pages/02.administer/10.install/05.images/docs.fr.md +++ b/pages/02.administer/10.install/05.images/docs.fr.md @@ -45,7 +45,6 @@ Cette page requiert que Javascript soit activé pour s'afficher correctement :s.
- - diff --git a/pages/02.administer/10.install/05.images/images.de.md b/pages/02.administer/10.install/05.images/images.de.md index 1edddfeb2..45168002f 100644 --- a/pages/02.administer/10.install/05.images/images.de.md +++ b/pages/02.administer/10.install/05.images/images.de.md @@ -39,7 +39,6 @@ N B : Auch wenn das Image nicht der neuesten Version von YunoHost entspricht, k - - diff --git a/pages/02.administer/10.install/05.images/images.es.md b/pages/02.administer/10.install/05.images/images.es.md index c78f35242..b65b9cf89 100644 --- a/pages/02.administer/10.install/05.images/images.es.md +++ b/pages/02.administer/10.install/05.images/images.es.md @@ -38,7 +38,6 @@ N.B. : Incluso si la imagen no corresponde con la última versión de YunoHost, - - - diff --git a/pages/02.administer/10.install/05.images/images.fr.md b/pages/02.administer/10.install/05.images/images.fr.md index 8a4df6b54..af5458212 100644 --- a/pages/02.administer/10.install/05.images/images.fr.md +++ b/pages/02.administer/10.install/05.images/images.fr.md @@ -40,7 +40,6 @@ Cette page requiert que Javascript soit activé pour s'afficher correctement :s. - - diff --git a/pages/02.administer/10.install/05.images/images.md b/pages/02.administer/10.install/05.images/images.md index 7e9efb0dc..618e7826e 100644 --- a/pages/02.administer/10.install/05.images/images.md +++ b/pages/02.administer/10.install/05.images/images.md @@ -40,7 +40,6 @@ This page requires Javascript enabled to display properly :s. - - diff --git a/pages/02.administer/10.install/05.images/images.ru.md b/pages/02.administer/10.install/05.images/images.ru.md index 6c7ef88dd..baeb36afc 100644 --- a/pages/02.administer/10.install/05.images/images.ru.md +++ b/pages/02.administer/10.install/05.images/images.ru.md @@ -40,7 +40,6 @@ routes: - - diff --git a/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.de.md b/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.de.md index 0c4d9b269..d3785a60e 100644 --- a/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.de.md +++ b/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.de.md @@ -10,14 +10,17 @@ routes: Bei einer Installation zu Hause sollte Ihr Server normalerweise über die Domäne`yunohost.local` erreichbar sein. Wenn dies aus irgendeinem Grund nicht funktioniert, müssen Sie möglicherweise die *lokale* IP-Adresse Ihres Servers ermitteln. ## Was ist ein locales IP ? + Die lokale IP-Adresse ist die, die verwendet wird, um auf Ihren Server innerhalb des lokalen Netzwerks (typischerweise Ihr Zuhause) zu verweisen, wo mehrere Geräte an einen Router (Ihre Internetbox) angeschlossen sind. Die lokale IP-Adresse sieht typischerweise so aus `192.168.x.y` (oder manchmal `10.0.x.y` oder `172.16.x.y`) ## Wie findet man es? + Jeder dieser Tricks sollte es Ihnen ermöglichen, die lokale IP-Adresse Ihres Servers zu finden: [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="(Empfohlen) Mit Angry IP Scanner"] Verwenden Sie dazu die [AngryIP](https://angryip.org/download/) Software. Sie Brauchen nur diese lokalen IP-Bereiche in dieser Reihenfolge durchsuchen, bis Sie die aktive IP-Adresse finden, die Ihrem Server entspricht: + - `192.168.0.0` -> `192.168.0.255` - `192.168.1.0` -> `192.168.1.255` - `192.168.2.0` -> `192.168.255.255` @@ -44,6 +47,7 @@ Wenn der Befehl `arp-scan` viele Geräte anzeigt, können Sie dann mit dem Befeh Bildschirm auf den Server anschliessen, sich einloggen und diesen Befehl eingeben`hostname --all-ip-address`. Die Standard-Anmeldedaten (vor der Nachinstallation!) zum Einloggen sind: + - login: root - password: yunohost diff --git a/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.fr.md b/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.fr.md index d6f28e4e1..361dbcd25 100644 --- a/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.fr.md +++ b/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.fr.md @@ -10,14 +10,17 @@ routes: Dans le cas d'une installation à la maison, votre serveur devrait typiquement être accessible (depuis son réseau local) avec le domaine `yunohost.local`. Si pour une raison quelconque cela ne fonctionne pas, il vous faut peut-être trouver l'IP locale de votre serveur. ## Qu'est ce qu'une IP locale ? + L'IP locale d'une machine est utilisée pour y faire référence à l'intérieur d'un réseau local (typiquement le réseau dans une maison) où plusieurs appareils se connectent à un même routeur (votre box internet). Une adresse IP locale ressemble généralement à `192.168.x.y` (ou parfois `10.0.x.y` ou `172.16.x.y`) ## Comment la trouver ? + L'une de ces astuces devrait permettre de trouver l'IP locale de votre serveur : [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="(Recommandé) Avec AngryIP"] Vous pouvez utiliser le logiciel [AngryIP](https://angryip.org/download/) pour y parvenir. Vous devez juste scanner ces plages d'IP dans cet ordre jusqu'à trouver l'IP correspondante à votre serveur : + - `192.168.0.0` -> `192.168.0.255` - `192.168.1.0` -> `192.168.1.255` - `192.168.2.0` -> `192.168.255.255` @@ -44,6 +47,7 @@ Si la commande `arp-scan` vous affiche beaucoup de machines, vous pouvez vérifi Branchez un écran sur votre serveur, loggez-vous et tapez `hostname --all-ip-address`. Les identifiants par défaut (avant la post-installation!) sont : + - login : root - mot de passe : yunohost @@ -53,6 +57,7 @@ Les identifiants par défaut (avant la post-installation!) sont : [/ui-tabs] ## Je ne trouve toujours pas mon IP locale + Si vous n'êtes pas capable de trouver votre serveur avec les méthodes précédentes, alors peut-être que votre serveur n'a pas démarré correctement. - Assurez-vous que le serveur est correctement branché ; diff --git a/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.md b/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.md index c7b608fe5..123fb34e2 100644 --- a/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.md +++ b/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.md @@ -10,14 +10,17 @@ routes: On an installation at home, your server should typically be accessible using the `yunohost.local` domain. If for any reason this does not work, you may need to find the *local* IP of your server. ## What is a local IP ? + The local IP is the address used to refer to your server inside the local network (typically your home) where multiple devices are connected to a router (your internet box). The local IP typically looks like `192.168.x.y` (or sometimes `10.0.x.y` or `172.16.x.y`) ## How to find it ? + Any of these tricks should allow you to find the local IP of your server: [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="(Recommended) With AngryIP"] You can use the [AngryIP](https://angryip.org/download/) software to achieve that. You just need to scan these local ip ranges in this order until you find the active IP corresponding to your server: + - `192.168.0.0` -> `192.168.0.255` - `192.168.1.0` -> `192.168.1.255` - `192.168.2.0` -> `192.168.255.255` @@ -44,6 +47,7 @@ If the `arp-scan` command displays a confusing number of devices, you can check Plug a screen on your server, log in and type `hostname --all-ip-address`. The default credentials (before post-installation!) to log in are: + - login: root - password: yunohost diff --git a/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.ru.md b/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.ru.md index cf90aa615..5a5c41f5d 100644 --- a/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.ru.md +++ b/pages/02.administer/10.install/10.finding_the_local_ip/finding_the_local_ip.ru.md @@ -10,14 +10,17 @@ routes: При установке дома ваш сервер, как правило, должен быть доступен с использованием домена `yunohost.local`. Если по какой-либо причине это не сработает, возможно, вам потребуется найти *локальный* IP-адрес вашего сервера. ## Что такое локальный IP-адрес ? + Локальный IP-адрес - это адрес, используемый для обращения к вашему серверу внутри локальной сети (обычно вашего дома), где несколько устройств подключены к маршрутизатору. Локальный IP-адрес обычно выглядит как `192.168.x.y` (или иногда `10.0.x.y` или `172.16.x.y`). ## Как его найти ? + Любой из этих приемов должен позволить вам найти локальный IP-адрес вашего сервера: [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="(Рекомендуемый) используя AngryIP"] Вы можете использовать [AngryIP](https://angryip.org/download/) для достижения этой цели. Вам просто нужно сканировать эти локальные диапазоны ip-адресов в таком порядке, пока вы не найдете активный IP-адрес, соответствующий вашему серверу: + - `192.168.0.0` -> `192.168.0.255` - `192.168.1.0` -> `192.168.1.255` - `192.168.2.0` -> `192.168.255.255` @@ -27,7 +30,7 @@ routes: !!! **Советы**: !!! - вы можете сделать отсортировать по ping, как показано на этом скриншоте, чтобы легко увидеть используемый IP. !!! - обычно ваш сервер должен отображаться как прослушивающий на портах 80 и 443 -!!! - в случае сомнений просто введите `https://192.168.x.y " в вашем браузере, чтобы проверить, является ли это YunoHost или нет. +!!! - в случае сомнений просто введите ` " в вашем браузере, чтобы проверить, является ли это YunoHost или нет. ![](image://angryip.png?class=inline) @@ -44,6 +47,7 @@ routes: Подключите экран к своему серверу, войдите в систему и введите `hostname --all-ip-address`. Учетные данные по умолчанию (перед постустановкой!) для входа в систему: + - логин: root - пароль: yunohost @@ -59,4 +63,4 @@ routes: - Убедитесь, что ваш сервер правильно подключен; - Если вы используете SD-карту, убедитесь, что разъем не слишком запылился; - Подключите экран к вашему серверу и попробуйте перезагрузиться, чтобы проверить, правильно ли он загружается; -- Убедитесь, что ваш кабель Ethernet исправен и правильно подключен; \ No newline at end of file +- Убедитесь, что ваш кабель Ethernet исправен и правильно подключен; diff --git a/pages/02.administer/10.install/15.isp_box_config/isp_box_config.de.md b/pages/02.administer/10.install/15.isp_box_config/isp_box_config.de.md index abe7f8b1d..28d595108 100644 --- a/pages/02.administer/10.install/15.isp_box_config/isp_box_config.de.md +++ b/pages/02.administer/10.install/15.isp_box_config/isp_box_config.de.md @@ -11,7 +11,7 @@ routes: Wenn Sie zu Hause selbst hosten und kein VPN nutzen, müssen Sie die Ports Ihres Routers umleiten ("Internet box"). Das folgende Schema versucht, die Rolle der Portweiterleitung beim Einrichten eines Servers zu Hause kurz zu erklären. -[figure caption="Abbildung der Wichtigkeit von Port-Weiterleitung"]![](image://portForwarding_en.png)[/figure] +[figure caption="Abbildung der Wichtigkeit von Port-Weiterleitung"]![][image://portForwarding_en.png](/figure) ### 0. Offene Ports diagnostizieren @@ -25,6 +25,7 @@ Ihre Box/Router-Administrationsoberfläche ist in der Regel erreichbar über [ht ### 2. Die lokale IP Ihres Servers finden Identifizieren Sie die lokale IP Ihres Servers, entweder : + - von Ihrer Box/Router-Schnittstelle, die möglicherweise angeschlossene Geräte auflistet - über die YunoHost-Schnittstelle, Abschnitt "Internetkonnektivität", dann auf "Details" im IPv4-Bericht klicken. - von der Befehlszeile Ihres Servers aus, indem Sie `hostname -I` ausführen @@ -39,12 +40,13 @@ Suchen Sie in der Verwaltungsoberfläche Ihres Routers nach etwas wie "Router-Ko Das Öffnen der unten aufgeführten Ports ist notwendig, damit die verschiedenen in YunoHost verfügbaren Dienste funktionieren. Für jeden von ihnen wird die 'TCP'-Weiterleitung benötigt. Einige Schnittstellen beziehen sich auf 'externe' und 'interne' Ports : diese sind in unserem Fall gleich. -* Web: 80 (HTTP), 443 (HTTPS) -* [SSH](/ssh): 22 -* [XMPP](/XMPP): 5222 (clients), 5269 (servers) -* [Email](/email): 25, 587 (SMTP), 993 (IMAP) +- Web: 80 (HTTP), 443 (HTTPS) +- [SSH](/ssh): 22 +- [XMPP](/XMPP): 5222 (clients), 5269 (servers) +- [Email](/email): 25, 587 (SMTP), 993 (IMAP) Wenn Sie sowohl ein Modem als auch einen Router verwenden, dann müssen Sie Folgendes tun: + 1. zuerst auf dem Modem (der Box, die dem Internet am nächsten ist) Regeln erstellen, um die oben genannten Ports an Ihren Router weiterzuleiten; 2. dann auf dem Router (der Box zwischen dem Modem und Ihren Geräten) Regeln erstellen, um die oben genannten Ports an die statische IP-Adresse für Ihren Server weiterzuleiten. diff --git a/pages/02.administer/10.install/15.isp_box_config/isp_box_config.es.md b/pages/02.administer/10.install/15.isp_box_config/isp_box_config.es.md index e8fc229b4..4a40136fe 100644 --- a/pages/02.administer/10.install/15.isp_box_config/isp_box_config.es.md +++ b/pages/02.administer/10.install/15.isp_box_config/isp_box_config.es.md @@ -13,24 +13,25 @@ Si te estás auto-alojando en casa y sin VPN, tienes que redirigirse los puertos El esquema aquí abajo intenta explicar brevemente el rol de la redirección de los puertos durante la instalación de un servidor en tu casa. -[figure caption="Ilustración de la importancia del redirección de puertos"]![](image://portForwarding_en.png)[/figure] +[figure caption="Ilustración de la importancia del redirección de puertos"]![][image://portForwarding_en.png](/figure) [Esta página](https://www.testdevelocidad.es/configuraciones/abrir-correctamente-los-puertos-router/) también propone explicaciones detalladas sobre el funcionamiento de los puertos, y las etapas de configuración para un router genérico. ### 0. Diagnosticar los puertos abiertos -Una vez que tienes la redirección configurada, deberías poder comprobar que los puertos están bien abiertos con esta herramienta : +Una vez que tienes la redirección configurada, deberías poder comprobar que los puertos están bien abiertos con esta herramienta : Comprobar la redirección de los puertos ### 1. Acceder a la interfaz de administración de tu router/caja/box -En general la interfaz de administración está accesible desde http://192.168.0.1 o http://192.168.1.1. +En general la interfaz de administración está accesible desde o . Luego, es posible que tengas que autenticarte con los ID provechos pour tu proveedor de acceso a Internet. ### 2. Descubrir la IP local del servidor Identifica cuál es la IP local de tu servidor, o sea : + - desde la interfaz de tu router/caja/box, donde tal vez estén listados los dipositivos conectados a la red local - desde la webadmin de YunoHost, en 'Estado del servidor', 'Red' - desde la línea de comandos en tu servidor, por ejemplo con `ip a | grep "scope global" | awk '{print $2}'` @@ -43,10 +44,10 @@ En la interfaz de administración de tu router/caja/box, tienes que encontrar un Luego tienes que redirigir cada uno de los puertos listados a continuación hacia la IP local de tu router para que los varios servicios de YunoHost funcionen. Para cada uno de ellos, una redirección 'TCP' es necesaria. En algunas interfaces, tal vez encontrarás referencias a un puerto 'externo' y un puerto 'interno' : en nuestro caso, se trata del mismo número de puerto, que sea interno o externo. -* Web: 80 (HTTP), 443 (HTTPS) -* [SSH](/ssh): 22 -* [XMPP](/XMPP): 5222 (clients), 5269 (servers) -* [Email](/email): 25, 587 (SMTP), 993 (IMAP) +- Web: 80 (HTTP), 443 (HTTPS) +- [SSH](/ssh): 22 +- [XMPP](/XMPP): 5222 (clients), 5269 (servers) +- [Email](/email): 25, 587 (SMTP), 993 (IMAP) ! [fa=exclamation-triangle /] Algunos proveedores de acceso a Internet bloquean el puerto 25 (mail SMTP) por defecto para luchar con el spam. Otros (más escasos) no permiten utilizar libremente los puertos 80/443. Dependiendo de tu proveedor, puede ser posible de abrir estos puertos en la interfaz... Ver [esta página](/isp) por más informaciones. @@ -54,8 +55,6 @@ Luego tienes que redirigir cada uno de los puertos listados a continuación haci Una tecnología llamada UPnP está disponible en algunos routers/cajas/box y permite redirigir automáticamente puertos hacia una máquina que lo pide. Si UPnP está activado en tu casa, ejecutar este comando debería automáticamente redirigir los puertos correctos : - ```bash sudo yunohost firewall reload ``` - diff --git a/pages/02.administer/10.install/15.isp_box_config/isp_box_config.fr.md b/pages/02.administer/10.install/15.isp_box_config/isp_box_config.fr.md index 4ab88031d..d85822aad 100644 --- a/pages/02.administer/10.install/15.isp_box_config/isp_box_config.fr.md +++ b/pages/02.administer/10.install/15.isp_box_config/isp_box_config.fr.md @@ -11,7 +11,7 @@ routes: Si vous vous auto-hébergez à la maison et sans VPN, il vous faut rediriger les ports de votre routeur ("machin-box"). Le schéma ci-dessous tente d'expliquer brièvement le rôle de la redirection des ports lors de la mise en place d'un serveur à la maison. -[figure caption="Illustration de l'importance de la redirection des ports"]![](image://portForwarding_fr.png)[/figure] +[figure caption="Illustration de l'importance de la redirection des ports"]![][image://portForwarding_fr.png](/figure) [Cette page](https://craym.eu/tutoriels/utilitaires/ouvrir_les_ports_de_sa_box.html) propose également des explications détaillées sur le fonctionnement des ports, et les étapes de configuration pour différents routeurs. @@ -22,13 +22,14 @@ YunoHost 3.8 vous permettra de vérifier si les ports sont correctement exposés ### 2. Accéder à l'interface d'administration de votre box/routeur -L'interface d'administration est généralement accessible via http://192.168.0.1 ou http://192.168.1.1. +L'interface d'administration est généralement accessible via ou . Ensuite, il vous faudra peut-être vous authentifier avec les identifiants fournis par votre fournisseur d'accès à Internet (FAI). ### 3. Trouver l'IP locale de votre serveur Identifiez quelle est l'IP locale de votre serveur, soit : + - depuis l'interface de votre routeur/box, qui liste peut-être les dispositifs connectés; - depuis la webadmin de YunoHost, dans 'Diagnostic', section 'Connectivité Internet', cliquer sur 'Détails' à côté de la ligne sur IPv4. @@ -44,10 +45,10 @@ nom diffère suivant le type / marque de la box... Il vous faut ensuite rediriger chacun des ports listés ci-dessous vers l'IP locale de votre serveur pour que les différents services de YunoHost fonctionnent. Pour chacun d'eux, une redirection 'TCP' est nécessaire. Certaines interfaces font référence à un port « externe » et un port « interne » : dans notre cas il s'agit du même. -* Web: 80 (HTTP), 443 (HTTPS) -* [SSH](/ssh): 22 -* [XMPP](/XMPP): 5222 (clients), 5269 (serveurs) -* [Email](/email): 25, 587 (SMTP), 993 (IMAP) +- Web: 80 (HTTP), 443 (HTTPS) +- [SSH](/ssh): 22 +- [XMPP](/XMPP): 5222 (clients), 5269 (serveurs) +- [Email](/email): 25, 587 (SMTP), 993 (IMAP) ! [fa=exclamation-triangle /] Certains fournisseurs d'accès à Internet bloquent le port 25 (mail SMTP) par défaut pour combattre le spam. D'autres (plus rares) ne permettent pas d'utiliser librement les ports 80/443. En fonction de votre FAI, il peut être possible d'ouvrir ces ports dans l'interface... Voir [cette page](/isp) pour plus d'informations. diff --git a/pages/02.administer/10.install/15.isp_box_config/isp_box_config.md b/pages/02.administer/10.install/15.isp_box_config/isp_box_config.md index 9b64dfd7f..222b5b1aa 100644 --- a/pages/02.administer/10.install/15.isp_box_config/isp_box_config.md +++ b/pages/02.administer/10.install/15.isp_box_config/isp_box_config.md @@ -11,7 +11,7 @@ routes: If you are self-hosting at home and without a VPN, you need to forward ports on your home router ("Internet box"). The sketch below tries to briefly summarize the role and necessity of port forwarding when setting up a server at home. -[figure caption="Illustration of the importance of port-forwarding"]![](image://portForwarding_en.png)[/figure] +[figure caption="Illustration of the importance of port-forwarding"]![][image://portForwarding_en.png](/figure) ### 0. Diagnose ports opened @@ -25,6 +25,7 @@ Your box/router admin interface is usually reachable via [http://192.168.0.1](ht ### 2. Find the local IP of your server Identify what is thei *local* IP of your server, either : + - from your box/router interface, which might list devices connected - from the YunoHost webadmin, in 'Diagnosis', section 'Internet connectivity', click on 'Details' on the IPv4 report. - from the command line in your server, by running `hostname -I` @@ -39,12 +40,13 @@ In your router admin interface, look for something like 'router configuration' o Opening the ports listed below is necessary for the various services available in YunoHost to work. For each of them, the 'TCP' forwarding is needed. Some interfaces refer to 'external' and 'internal' ports : these are the same in our case. -* Web: 80 (HTTP), 443 (HTTPS) -* [SSH](/ssh): 22 -* [XMPP](/XMPP): 5222 (clients), 5269 (servers) -* [Email](/email): 25, 587 (SMTP), 993 (IMAP) +- Web: 80 (HTTP), 443 (HTTPS) +- [SSH](/ssh): 22 +- [XMPP](/XMPP): 5222 (clients), 5269 (servers) +- [Email](/email): 25, 587 (SMTP), 993 (IMAP) If you use both a modem and a router, then you need to do the following: + 1. first on the modem (the box closest to the internet) create rules to forward the above ports to your router; 2. then on the router (the box between the modem and your devices) create rules to forward the above ports to the static IP address for your server. @@ -57,4 +59,3 @@ A technology called UPnP is available on some internet boxes / routers and allow ```bash sudo yunohost firewall reload ``` - diff --git a/pages/02.administer/10.install/15.isp_box_config/isp_box_config.ru.md b/pages/02.administer/10.install/15.isp_box_config/isp_box_config.ru.md index 10390dcb8..ccee2aec0 100644 --- a/pages/02.administer/10.install/15.isp_box_config/isp_box_config.ru.md +++ b/pages/02.administer/10.install/15.isp_box_config/isp_box_config.ru.md @@ -11,7 +11,7 @@ routes: Если вы самостоятельно размещаетесь дома и у вас нет VPN, вам необходимо перенаправить порты на вашем домашнем маршрутизаторе. В приведенном ниже наброске предпринята попытка кратко описать роль и необходимость переадресации портов при настройке сервера дома. -[figure caption="Иллюстрация важности переадресации портов"]![](image://portForwarding_en.png)[/figure] +[figure caption="Иллюстрация важности переадресации портов"]![][image://portForwarding_en.png](/figure) ### 0. Диагностировать открытые порты @@ -24,6 +24,7 @@ routes: ### 2. Найдите локальный IP-адрес вашего сервера Определите, каков *локальный* IP вашего сервера, либо : + - из вашего интерфейса box / router, в котором может быть список подключенных устройств - в веб-администраторе YunoHost, в разделе "Диагностика", "Подключение к Интернету", нажмите "Подробности" в отчете IPv4. - из командной строки на вашем сервере, запустив `hostname -I` @@ -38,12 +39,13 @@ routes: Открытие перечисленных ниже портов необходимо для работы различных сервисов, доступных в YunoHost. Для каждого из них необходима переадресация "TCP". Некоторые интерфейсы относятся к "внешним" и "внутренним" портам: в нашем случае это одно и то же. -* Веб: 80 (HTTP), 443 (HTTPS) -* [SSH](/ssh): 22 -* [XMPP](/XMPP): 5222 (клиенты), 5269 (серверы) -* [Почтовые](/email): 25, 587 (SMTP), 993 (IMAP) +- Веб: 80 (HTTP), 443 (HTTPS) +- [SSH](/ssh): 22 +- [XMPP](/XMPP): 5222 (клиенты), 5269 (серверы) +- [Почтовые](/email): 25, 587 (SMTP), 993 (IMAP) Если вы используете и модем, и маршрутизатор, то вам необходимо выполнить следующее: + 1. сначала на модеме (поле, расположенном ближе всего к Интернету) создайте правила для перенаправления вышеуказанных портов на ваш маршрутизатор; 2. затем на маршрутизаторе (поле между модемом и вашими устройствами) создайте правила для пересылки вышеуказанных портов на статический IP-адрес вашего сервера. @@ -56,4 +58,3 @@ routes: ```bash sudo yunohost firewall reload ``` - diff --git a/pages/02.administer/10.install/20.dns_config/dns_config.de.md b/pages/02.administer/10.install/20.dns_config/dns_config.de.md index 75f8271b2..db74f34ef 100644 --- a/pages/02.administer/10.install/20.dns_config/dns_config.de.md +++ b/pages/02.administer/10.install/20.dns_config/dns_config.de.md @@ -17,13 +17,15 @@ sollte die Konfiguration automatisch erfolgen. Wenn Sie Ihren eigenen Domainname Domain über die Schnittstelle Ihres Registrars konfigurieren. ## Empfohlene DNS-Konfiguration + _N.B. : Die Beispiele hier verwenden den Text: `your.domain.tld`, der durch Ihre eigene Domain (z. B.`www.yunohost.org`) zu ersetzen ist._ YunoHost bietet eine empfohlene DNS-Konfiguration, die auf zwei Arten zugänglich ist : + - mit dem Webadmin, unter Domänen > your.domain.tld > DNS-Konfiguration ; - oder auf der Kommandozeile `yunohost domain dns-conf your.domain.tld` -Für einige spezielle Anforderungen oder Installationen und wenn Sie wissen, +Für einige spezielle Anforderungen oder Installationen und wenn Sie wissen, was Sie tun, müssen Sie diese Empfehlung möglicherweise ändern oder andere Datensätze hinzufügen (z. B. zur Behandlung von Subdomains). @@ -87,7 +89,7 @@ dargestellt wird: - Die hier gezeigten Werte sind nur Beispiele! Beziehen Sie sich auf die generierte Konfiguration, um herauszufinden, welche Werte zu verwenden sind; - Wir empfehlen eine [TTL](https://de.wikipedia.org/wiki/Time_to_Live#Domain_Name_System) von 3600 (1 Stunde). Es ist aber auch möglich einen anderen Wert zu verwenden, wenn Sie wissen, was Sie tun ; - Legen Sie keinen IPv6-Eintrag an, wenn Sie nicht sicher sind, daß IPv6 auf Ihrem Server funktioniert! Sie werden Probleme mit Let's Encrypt haben, wenn dies nicht der Fall ist. -- If you're using the domain provider Namecheap the SRV DNS entries are formatted as **Service**: _xmpp-client **Protocol**: _tcp **Priority**: 0 **Weight**: 5 **Port**: 5222 **Target**: your.domain.tld +- If you're using the domain provider Namecheap the SRV DNS entries are formatted as **Service**: _xmpp-client **Protocol**:_tcp **Priority**: 0 **Weight**: 5 **Port**: 5222 **Target**: your.domain.tld ### Reverse DNS @@ -95,10 +97,10 @@ Wenn Ihr ISP oder Host dies zulässt, empfehlen wir Ihnen, eine [Reverse-DNS-Konfiguration](https://de.wikipedia.org/wiki/Reverse_DNS) für Ihre öffentlichen IPv4- und/oder IPv6-Adressen. Dadurch wird verhindert, dass Sie als Spammer von den Anti-Spam-Filtersystemen markiert werden. -**N.B. : Die Reverse-DNS-Konfiguration erfolgt bei Ihrem Internet Service Provider bzw. VPS-Host. Es betrifft *nicht* den Registrar Ihres Domainnamens.** +**N.B. : Die Reverse-DNS-Konfiguration erfolgt bei Ihrem Internet Service Provider bzw. VPS-Host. Es betrifft _nicht_ den Registrar Ihres Domainnamens.** Das heißt, wenn Ihre öffentliche IPv4-Adresse `111.222.333.444`ist und Ihr -Domänename `domain.tld`ist, sollten Sie mit dem Befehl +Domänename `domain.tld`ist, sollten Sie mit dem Befehl `nslookup` das folgende Ergebnis erhalten : ```shell diff --git a/pages/02.administer/10.install/20.dns_config/dns_config.es.md b/pages/02.administer/10.install/20.dns_config/dns_config.es.md index 913d858f7..609ca32b0 100644 --- a/pages/02.administer/10.install/20.dns_config/dns_config.es.md +++ b/pages/02.administer/10.install/20.dns_config/dns_config.es.md @@ -13,11 +13,12 @@ DNS (sistema de nombre de dominios) es un elemento esencial de Internet que perm Si utilizas un [dominio automático](/dns_nohost_me) provecho por el Proyecto YunoHost, la configuración debería ser automática. Si quieres utilizar tu propio nombre de dominio (comprado a un registrar), hay que configurar manualmente tu proprio nombre de dominio vía la interfaz de tu registrar. - ## Configuración DNS recomendada + _Nota: los ejemplos utilizan el marcador `tu.dominio.tld`, debe ser reemplazado por su propio dominio, como `www.yunohost.org`._ YunoHost provee una configuración DNS recomendada, accesible vía : + - la webadmin, en Dominios > tu.dominio.tld > Configuración DNS ; - o la linea de comando, `yunohost domain dns-conf tu.dominio.tld` @@ -57,7 +58,6 @@ _dmarc 3600 IN TXT "v=DMARC1; p=none" Pero puede ser un poco más fácil entenderla viéndola de esta manera : - | Tipo | Nombre | Valor | | :-----: | :--------------------: | :----------------------------------------------------: | | **A** | **@** | `111.222.333.444` (tu IPv4) | @@ -65,7 +65,7 @@ Pero puede ser un poco más fácil entenderla viéndola de esta manera : | AAAA | @ | `2222:444:8888:3333:bbbb:5555:3333:1111` (tu IPv6) | | AAAA | * | `2222:444:8888:3333:bbbb:5555:3333:1111` (tu IPv6) | | **SRV** | **_xmpp-client._tcp** | `0 5 5222 tu.dominio.tld.` | -| **SRV** | **_xmpp-server._tcp** | `0 5 5269 tu.dominio.tld.` | +| **SRV** | **_xmpp-server._tcp** | `0 5 5269 tu.dominio.tld.` | | CNAME | muc | `@` | | CNAME | pubsub | `@` | | CNAME | vjud | `@` | @@ -75,7 +75,7 @@ Pero puede ser un poco más fácil entenderla viéndola de esta manera : | TXT | mail._domainkey | `"v=DKIM1; k=rsa; p=uneGrannnndeClef"` | | TXT | _dmarc | `"v=DMARC1; p=none"` | -#### Algunas notas a propósito de esta tabla : +#### Algunas notas a propósito de esta tabla - Todos los registros no son necesarios. Para una instalación mínima, solos los registros en negrita son necesarios. - El punto al final de `tu.dominio.tld.` es importante ;) ; @@ -83,7 +83,7 @@ Pero puede ser un poco más fácil entenderla viéndola de esta manera : - ¡ Los valores mostrados son ejemplos ! Refiérete a la configuración generada por tu servidor qué valores utilizar. - Recomendamos un [TTL](https://en.wikipedia.org/wiki/Time_to_live) de 3600 (1 hora). Pero puedes utilizar otro valor si sabes lo que estás haciendo ; - ¡ No pongas registros IPv6 si no estás seguro que el IPv6 funcione en tu servidor ! Tendrás problemas con Let's Encrypt si no es el caso :-) -- If you're using the domain provider Namecheap the SRV DNS entries are formatted as **Service**: _xmpp-client **Protocol**: _tcp **Priority**: 0 **Weight**: 5 **Port**: 5222 **Target**: your.domain.tld +- If you're using the domain provider Namecheap the SRV DNS entries are formatted as **Service**: _xmpp-client **Protocol**:_tcp **Priority**: 0 **Weight**: 5 **Port**: 5222 **Target**: your.domain.tld ### IP Dinámica diff --git a/pages/02.administer/10.install/20.dns_config/dns_config.fr.md b/pages/02.administer/10.install/20.dns_config/dns_config.fr.md index 1b501accf..7367cb22e 100644 --- a/pages/02.administer/10.install/20.dns_config/dns_config.fr.md +++ b/pages/02.administer/10.install/20.dns_config/dns_config.fr.md @@ -22,9 +22,11 @@ la configuration devrait être faite automatiquement. Si vous utilisez votre pro domaine via l'interface de votre registrar. ## Configuration DNS recommandée + _NB : les exemples utilisent ici le texte `votre.domaine.tld`, à remplacer par votre propre domaine (par exemple `www.yunohost.org`)._ YunoHost fournit une configuration DNS recommandée, accessible via : + - la webadmin, dans Domaines > votre.domain.tld > Configuration DNS ; - ou la ligne de commande, `yunohost domain dns-conf votre.domaine.tld` @@ -92,7 +94,7 @@ suivante : - Les valeurs montrées ici sont des valeurs d'exemple ! Référez-vous à la configuration générée chez vous pour savoir quelles valeurs utiliser ; - Nous recommandons un [TTL](https://fr.wikipedia.org/wiki/Time_to_Live#Le_Time_to_Live_dans_le_DNS) de 3600 (1 heure). Mais vous pouvez utiliser une autre valeur si vous savez ce que vous faîtes ; - Ne mettez pas d'enregistrement IPv6 si vous n'êtes pas certain que l'IPv6 fonctionne sur votre serveur ! Vous aurez des problèmes avec Let's Encrypt si ce n'est pas le cas. -- Si vous utilisez le registrar Namecheap, les entrées SRV sont formattées comme **Service**: _xmpp-client **Protocol**: _tcp **Priority**: 0 **Weight**: 5 **Port**: 5222 **Target**: votre.domaine.tld +- Si vous utilisez le registrar Namecheap, les entrées SRV sont formattées comme **Service**: _xmpp-client **Protocol**:_tcp **Priority**: 0 **Weight**: 5 **Port**: 5222 **Target**: votre.domaine.tld ### Résolution DNS inverse @@ -102,7 +104,7 @@ inverse](https://fr.wikipedia.org/wiki/Domain_Name_System#R%C3%A9solution_invers pour vos adresses publiques IPv4 et/ou IPv6. Ceci vous évitera d'être marqué comme spammeur par les systèmes de filtrage anti-spams. -**N.B. : la configuration du DNS inverse se passe au niveau de votre fournisseur d'accès à Internet, ou de votre hébergeur de VPS. Elle ne se fait *pas* sur le registrar de votre nom de domaine.** +**N.B. : la configuration du DNS inverse se passe au niveau de votre fournisseur d'accès à Internet, ou de votre hébergeur de VPS. Elle ne se fait _pas_ sur le registrar de votre nom de domaine.** Cela signifie que si votre adresse IPv4 publique est `111.222.333.444` et que votre nom de domaine est `domain.tld`, vous devez obtenir le résultat suivant diff --git a/pages/02.administer/10.install/20.dns_config/dns_config.md b/pages/02.administer/10.install/20.dns_config/dns_config.md index 061855d54..c1434701b 100644 --- a/pages/02.administer/10.install/20.dns_config/dns_config.md +++ b/pages/02.administer/10.install/20.dns_config/dns_config.md @@ -24,6 +24,7 @@ interface. NB: Examples here use the placeholder `your.domain.tld`, you have to replace it with your real domain, such as `www.yunohost.org`. YunoHost provides a recommended DNS configuration, available via: + - the webadmin, in Domain > your.domain.tld > DNS configuration; - or the command line, `yunohost domain dns-conf your.domain.tld` @@ -65,7 +66,6 @@ _dmarc 3600 IN TXT "v=DMARC1; p=none" Though it might be easier to understand it if displayed like this: - | Type | Name | Value | | :-----: | :--------------------: | :--------------------------------------------------: | | **A** | **@** | `111.222.333.444` (your IPv4) | @@ -91,7 +91,7 @@ Though it might be easier to understand it if displayed like this: - These are example values ! See your generated conf for the actual values you should use; - We recommend a [TTL](https://en.wikipedia.org/wiki/Time_to_live#DNS_records) of 3600 (1 hour). But you can use something else if you know what you're doing; - Don't put an IPv6 record if you're not sure IPv6 really works on your server! You might have issues with Let's Encrypt if it doesn't. -- If you're using the domain provider Namecheap the SRV DNS entries are formatted as **Service**: _xmpp-client **Protocol**: _tcp **Priority**: 0 **Weight**: 5 **Port**: 5222 **Target**: your.domain.tld +- If you're using the domain provider Namecheap the SRV DNS entries are formatted as **Service**: _xmpp-client **Protocol**:_tcp **Priority**: 0 **Weight**: 5 **Port**: 5222 **Target**: your.domain.tld ### Reverse DNS diff --git a/pages/02.administer/10.install/20.dns_config/dns_config.ru.md b/pages/02.administer/10.install/20.dns_config/dns_config.ru.md index 1e3238c6f..c0586294f 100644 --- a/pages/02.administer/10.install/20.dns_config/dns_config.ru.md +++ b/pages/02.administer/10.install/20.dns_config/dns_config.ru.md @@ -24,6 +24,7 @@ DNS (система доменных имен) - это система, кото ПРИМЕЧАНИЕ: В примерах здесь используется заполнитель `your.domain.tld`, вы должны заменить его своим реальным доменом, например `www.yunohost.org`. YunoHost предоставляет рекомендуемую конфигурацию DNS, доступную через: + - веб-администратор, Домены > `your.domain.tld` > DNS; - или в командной строке: `yunohost domain dns-conf your.domain.tld` @@ -65,7 +66,6 @@ _dmarc 3600 IN TXT "v=DMARC1; p=none" Хотя, возможно, было бы легче понять это, если бы оно отображалось следующим образом: - | Тип | Название | Значение | | :-----: | :--------------------: | :--------------------------------------------------: | | **A** | **@** | `111.222.333.444` (ваш IPv4) | @@ -91,7 +91,7 @@ _dmarc 3600 IN TXT "v=DMARC1; p=none" - Это примерные значения! Смотрите сгенерированный вами conf для получения фактических значений, которые вы должны использовать; - Мы рекомендуем использовать [TTL](https://en.wikipedia.org/wiki/Time_to_live#DNS_records ) 3600 (1 час). Но вы можете использовать что-то еще, если знаете, что делаете; - Не размещайте запись IPv6, если вы не уверены, что IPv6 действительно работает на вашем сервере! У вас могут возникнуть проблемы с Let's Encrypt, если это не так. -- Если вы используете Namecheap поставщика домена, записи SRV DNS форматируются как **Сервис**: _xmpp-client **Протокол**: _tcp **Приоритет**: 0 **Вес**: 5 **Порт**: 5222 **Цель**: your.domain.tld +- Если вы используете Namecheap поставщика домена, записи SRV DNS форматируются как **Сервис**: _xmpp-client **Протокол**:_tcp **Приоритет**: 0 **Вес**: 5 **Порт**: 5222 **Цель**: your.domain.tld ### Обратный DNS diff --git a/pages/02.administer/10.install/25.installing_debian/installing_debian.md b/pages/02.administer/10.install/25.installing_debian/installing_debian.md index 919359c72..e23af2e9b 100644 --- a/pages/02.administer/10.install/25.installing_debian/installing_debian.md +++ b/pages/02.administer/10.install/25.installing_debian/installing_debian.md @@ -47,9 +47,9 @@ The installer will ask about which **desktop environment** you want. You should ## After installing Debian -1. Remove the installation media (unplug the USB stick) +1. Remove the installation media (unplug the USB stick) 2. Reboot 3. Login as `root` with the long complex password you created earlier. 4. Install curl by typing `apt install curl` -5. Proceed to install Yunohost on Debian using these instructions: https://yunohost.org/en/install/hardware:vps_debian +5. Proceed to install Yunohost on Debian using these instructions: - The installer will ask for permission to overwrite some configuration files. Select Yes. diff --git a/pages/02.administer/10.install/install.de.md b/pages/02.administer/10.install/install.de.md index f76e74efd..4661dc456 100644 --- a/pages/02.administer/10.install/install.de.md +++ b/pages/02.administer/10.install/install.de.md @@ -70,27 +70,27 @@ Wähle die Hardware, auf der du YunoHost installieren willst : [div class="flex-container"] [div class="flex-child hardware{%if virtualbox %} active{% endif %}"] -[[figure caption="VirtualBox"]![](image://virtualbox.png?height=75)[/figure]](/install/hardware:virtualbox) +[[figure caption="VirtualBox"]![][image://virtualbox.png?height=75](/figure)](/install/hardware:virtualbox) [/div] [div class="flex-child hardware{%if rpi012 or rpi34 %} active{% endif %}"] -[[figure caption="Raspberry Pi"]![](image://raspberrypi.png?height=75)[/figure]](/install/hardware:rpi34) +[[figure caption="Raspberry Pi"]![][image://raspberrypi.png?height=75](/figure)](/install/hardware:rpi34) [/div] [div class="flex-child hardware{%if arm_sup or (arm_unsup and not rpi012) or internetcube %} active{% endif %}"] -[[figure caption="ARM Board"]![](image://olinuxino.png?height=75)[/figure]](/install/hardware:arm) +[[figure caption="ARM Board"]![][image://olinuxino.png?height=75](/figure)](/install/hardware:arm) [/div] [div class="flex-child hardware{%if regular %} active{% endif %}"] -[[figure caption="Normaler Computer"]![](image://computer.png?height=75)[/figure]](/install/hardware:regular) +[[figure caption="Normaler Computer"]![][image://computer.png?height=75](/figure)](/install/hardware:regular) [/div] [div class="flex-child hardware{%if wsl %} active{% endif %}"] -[[figure caption="WSL"]![](image://wsl.png?height=75)[/figure]](/install/hardware:wsl) +[[figure caption="WSL"]![][image://wsl.png?height=75](/figure)](/install/hardware:wsl) [/div] [div class="flex-child hardware{%if vps_debian or vps_ynh %} active{% endif %}"] -[[figure caption="Remote Server"]![](image://vps.png?height=75)[/figure]](/install/hardware:vps_debian) +[[figure caption="Remote Server"]![][image://vps.png?height=75](/figure)](/install/hardware:vps_debian) [/div] [/div] @@ -98,56 +98,55 @@ Wähle die Hardware, auf der du YunoHost installieren willst : {% if rpi012 or rpi34 %} [div class="flex-child hardware{%if rpi34 %} active{% endif %}"] -[[figure caption="Raspberry Pi 3 oder 4"]![](image://raspberrypi.png?height=50)[/figure]](/install/hardware:rpi34) +[[figure caption="Raspberry Pi 3 oder 4"]![][image://raspberrypi.png?height=50](/figure)](/install/hardware:rpi34) [/div] [div class="flex-child hardware{%if rpi012 %} active{% endif %}"] -[[figure caption="Raspberry Pi 0, 1 oder 2"]![](image://rpi1.png?height=50)[/figure]](/install/hardware:rpi012) +[[figure caption="Raspberry Pi 0, 1 oder 2"]![][image://rpi1.png?height=50](/figure)](/install/hardware:rpi012) [/div] {% elseif show_legacy_arm_menu %} [div class="flex-child hardware{%if internetcube %} active{% endif %}"] -[[figure caption="Internet cube mit VPN"]![](image://internetcube.png?height=50)[/figure]](/install/hardware:internetcube) +[[figure caption="Internet cube mit VPN"]![][image://internetcube.png?height=50](/figure)](/install/hardware:internetcube) [/div] [div class="flex-child hardware{%if arm_sup and not internetcube %} active{% endif %}"] -[[figure caption="Olinuxino lime1&2 oder Orange Pi PC+"]![](image://olinuxino.png?height=50)[/figure]](/install/hardware:arm_sup) +[[figure caption="Olinuxino lime1&2 oder Orange Pi PC+"]![][image://olinuxino.png?height=50](/figure)](/install/hardware:arm_sup) [/div] [div class="flex-child hardware{%if arm_unsup %} active{% endif %}"] -[[figure caption="Andere Boards"]![](image://odroidhc4.png?height=50)[/figure]](/install/hardware:arm_unsup) +[[figure caption="Andere Boards"]![][image://odroidhc4.png?height=50](/figure)](/install/hardware:arm_unsup) [/div] {% elseif vps_debian or vps_ynh %} [div class="flex-child hardware{%if vps_debian %} active{% endif %}"] -[[figure caption="VPS oder dedizierter Server mit Debian 11"]![](image://debian-logo.png?height=50)[/figure]](/install/hardware:vps_debian) +[[figure caption="VPS oder dedizierter Server mit Debian 11"]![][image://debian-logo.png?height=50](/figure)](/install/hardware:vps_debian) [/div] [div class="flex-child hardware{%if vps_ynh %} active{% endif %}"] -[[figure caption="VPS oder dedizierter Server mit YunoHost vorinstalliert"]![](image://logo.png?height=50)[/figure]](/install/hardware:vps_ynh) +[[figure caption="VPS oder dedizierter Server mit YunoHost vorinstalliert"]![][image://logo.png?height=50](/figure)](/install/hardware:vps_ynh) [/div] {% endif %} [/div] - {% if hardware != '' %} {% if wsl %} !! Dieses Setup ist vorwiegend für lokales Testing durch fortgeschrittene Benutzer gedacht. Aufgrund Limitierungen auf WSL Seite (insbesondere veränderliche IP Adresse), selfhosting kann damit knifflig sein und wird hier nicht weiter beschrieben. {% endif %} - ## [fa=list-alt /] Pre-requisites {% if regular %} + * Eine x86-kompatible für YunoHost bestimmte (dedizierte) Hardware: Laptop, Nettop, Netbook, Desktop mit 512MB RAM und 16GB Speicherkapazität (Minimum) {% elseif rpi34 %} * Ein Raspberry Pi 3 oder 4 {% elseif rpi012 %} -* Ein Raspberry Pi 0, 1 oder 2 mit mindestens 512MB RAM +* Ein Raspberry Pi 0, 1 oder 2 mit mindestens 512MB RAM {% elseif internetcube %} * Ein Orange Pi PC+ oder ein Olinuxino Lime 1 oder 2 * Ein VPN mit einer festen öffentlichen IP Adresse und einer `.cube` Datei @@ -190,7 +189,9 @@ Wähle die Hardware, auf der du YunoHost installieren willst : {% endif %} {% if wsl %} + ## Vorstellung + WSL ist ein cooles Windows 10 Feature, das Linux pseudo-Distributionen durch die Kommandozeile verfügbar macht. Lass es uns pseudo nennen, weil auch obwohl sie nicht wirklich wie virtuelle Maschinen sind, sind sie auf Virtualisierungskapazitäten angewiesen, die deren Integration mit Windows fast nahtlos machen. So kann z.B. Docker für Windows jetzt auf WSL bauen, anstatt auf Hyper-V. @@ -216,7 +217,7 @@ rmdir .\debian -R Nun kannst du darauf zugreifen: Führe `wsl.exe -d YunoHost` aus. -Da es Debian 9 Stretch ist, lass uns ein Upgrade auf Debian 11 Bullseye machen: +Da es Debian 9 Stretch ist, lass uns ein Upgrade auf Debian 11 Bullseye machen: ```bash # In WSL @@ -225,6 +226,7 @@ sudo apt update sudo apt upgrade sudo apt dist-upgrade ``` + ## Verhindern, dass WSL an Konfigurationsdateien herumfeilt Bearbeite `/etc/wsl.conf` und füge den folgenden Code darin ein: @@ -252,6 +254,7 @@ Unter WSL fehlt Debian `systemd`, eine Service-Konfigurations-Software. Diese ist ein Schlüsselelement für YunoHost, und für jede anständige Debian Distro (also ernsthaft Microsoft, was zum Henker). Lass es uns installieren: 1. Installation der dotNET Runtime: + ```bash # In WSL wget https://packages.microsoft.com/config/debian/11/packages-microsoft-prod.deb -O packages-microsoft-prod.deb @@ -263,6 +266,7 @@ sudo apt install -y dotnet-sdk-3.1 ``` 2. Installation von [Genie](https://github.com/arkane-systems/genie): + ```bash # In WSL # Das repository hinzufügen @@ -291,8 +295,10 @@ Rufe `genie -s` immer während des Startes deiner Distro auf. `wsl -d YunoHost -e genie -s` -## Backup und Wiederherstellung der Distro +## Backup und Wiederherstellung der Distro + ### Mache dein erstes Distro Backup + Wie zuvor gesagt, gibt es keine Rollback Möglichkeit. Lass uns deshal deine frische Distro exportieren. In PowerShell: ``` @@ -307,10 +313,11 @@ cd ~ wsl --unregister YunoHost wsl --import YunoHost .\WSL\YunoHost .\WSL\YunoHost.tar.gz --version 2 ``` -{% endif %} +{% endif %} {% if vps_ynh %} + ## YunoHost VPS Provider Hier sind ein paar VPS Provider, die YunoHost nativ unterstützen : @@ -318,19 +325,19 @@ Hier sind ein paar VPS Provider, die YunoHost nativ unterstützen : [div class="flex-container"] [div class="flex-child"] -[[figure caption="Alsace Réseau Neutre - FR"]![](image://vps_ynh_arn.png?height=50)[/figure]](https://vps.arn-fai.net) +[[figure caption="Alsace Réseau Neutre - FR"]![][image://vps_ynh_arn.png?height=50](/figure)](https://vps.arn-fai.net) [/div] [div class="flex-child"] -[[figure caption="FAImaison - FR"]![](image://vps_ynh_faimaison.svg?height=50)[/figure]](https://www.faimaison.net/services/vm.html) +[[figure caption="FAImaison - FR"]![][image://vps_ynh_faimaison.svg?height=50](/figure)](https://www.faimaison.net/services/vm.html) [/div] [div class="flex-child"] -[[figure caption="Association ECOWAN - FR"]![](image://vps_ynh_ecowan.png?height=50)[/figure]](https://www.ecowan.fr/vps-linux) +[[figure caption="Association ECOWAN - FR"]![][image://vps_ynh_ecowan.png?height=50](/figure)](https://www.ecowan.fr/vps-linux) [/div] [/div] {% endif %} - {% if at_home %} + ## [fa=download /] Lade das {{image_type}} Image herunter {% if rpi012 %} @@ -396,7 +403,7 @@ $(document).ready(function () { .replace('%7Bimage%7D', infos.image) .replace('{image}', infos.image) .replace('{version}', infos.version); - + if (!infos.file.startsWith("http")) infos.file="https://build.yunohost.org/"+infos.file; html = html.replace(/%7Bfile%7D/g, infos.file).replace(/{file}/g, infos.file); @@ -413,17 +420,16 @@ $(document).ready(function () { }); - - - - - {% if not virtualbox %} {% if arm %} + ## ![microSD Karte mit Adapter](image://sdcard_with_adapter.png?resize=100,75&class=inline) Flash das {{image_type}} Image + {% else %} + ## ![USB Stick](image://usb_key.png?resize=100,100&class=inline) Flash das YunoHost Image + {% endif %} Jetzt wo du das Image von {{image_type}} heruntergeladen hast, solltest du es auf {% if arm %}einer microSD Karte{% else %}einem USB stick oder einer CD/DVD flashen.{% endif %} @@ -457,6 +463,7 @@ Führe dann Folgendes aus : # Ersetze /dev/mmcblk0 durch das richtige Device, wenn der Name deines Device anders ist... dd if=/path/to/yunohost.img of=/dev/mmcblk0 ``` + [/ui-tab] {% if regular %} [ui-tab title="Eine CD/DVD brennen"] @@ -493,19 +500,12 @@ Gehe zu **Settings** > **Network**: {% endif %} - - - - - - - - {% if arm %} + ## [fa=plug /] Das Board einschalten * Schließe das Ethernet Kabel an (ein Ende an deinem Router, das andere an deinem Board). - * Fortgeschrittene Nutzer, die das Board konfigurieren möchten, um sich stattdessen per WiFi zu verbinden, können bspw. [hier](https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md) nachlesen. + * Fortgeschrittene Nutzer, die das Board konfigurieren möchten, um sich stattdessen per WiFi zu verbinden, können bspw. [hier](https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md) nachlesen. * Stecke die SD Karte in dein Board. * (Optional) Du kannst Bildschirm+Tastatur direkt an deinem Board anschließen, wenn du Fehler am Boot Prozess beheben willst oder wenn du dich wohler fühlst zu "sehen was passiert" oder du direkten Zugriff auf das Board haben willst. * Schalte das Board ein. @@ -513,6 +513,7 @@ Gehe zu **Settings** > **Network**: * Stelle sicher, dass dein Computer (Desktop/Laptop) mit dem selben lokalen Netzwerk verbunden ist (z.B. mit der selben Internet Box) wie dein Server. {% elseif virtualbox %} + ## [fa=plug /] Die virtuelle Maschine hochfahren Starte die virtuelle Maschine nach der Auswahl des YunoHost Image. @@ -521,17 +522,18 @@ Starte die virtuelle Maschine nach der Auswahl des YunoHost Image. ! Wenn du an den Fehler "VT-x ist nicht erreichbar" gerätst, musst du wahrscheinlich Virtualisierung im BIOS deines Computers einschalten. - {% else %} + ## [fa=plug /] Die Maschine von deinem USB Stick booten * Schließe das Ethernet Kabel an (ein Ende an deinem Router, das andere an deinem Board). * Fahre deinen Server mit dem USB Stick oder einer eingesteckten CD-ROM hoch und wähle es durch Drücken einer der folgenden (Hardware spezifischen) Tasten als **bootable device** aus: ``, ``, ``, ``, `` oder ``. - * Anmerkung: Wenn auf dem Server zuvor eine aktuelle Windows Version (8+) installiert war, musst du Windows zuerst "actually reboot" sagen. Das kann irgendwo in "Advanced startup options" gemacht werden. + * Anmerkung: Wenn auf dem Server zuvor eine aktuelle Windows Version (8+) installiert war, musst du Windows zuerst "actually reboot" sagen. Das kann irgendwo in "Advanced startup options" gemacht werden. {% endif %} {% if regular or virtualbox %} + ## [fa=rocket /] Die grafische Installation starten Du solltest einen Bildschirm wie diesen sehen: @@ -554,9 +556,10 @@ Du solltest einen Bildschirm wie diesen sehen: Das YunoHost-Projekt hat die klassische Installation so weit wie möglich vereinfacht, damit sich möglichst viele Menschen nicht in zu technischen oder fallbezogenen Fragen verlieren. -Mit der Installation im Expertenmodus hast du mehr Möglichkeiten, insbesondere was die genaue Partitionierung deiner Speichermedien betrifft. Du kannst dich auch für den klassischen Modus entscheiden und [deine Festplatten anschließend hinzufügen](/external_storage). +Mit der Installation im Expertenmodus hast du mehr Möglichkeiten, insbesondere was die genaue Partitionierung deiner Speichermedien betrifft. Du kannst dich auch für den klassischen Modus entscheiden und [deine Festplatten anschließend hinzufügen](/external_storage). + +### Zusammenfassung der Schritte im Expertenmodus -### Zusammenfassung der Schritte im Expertenmodus: 1. Wähle `Expert graphical install` aus. 2. Wähle deine Sprache, deinen Standort, dein Tastaturlayout und möglicherweise deine Zeitzone aus. 3. Partitioniere deine Festplatten. Hier kanst du ein RAID einrichten oder den Server ganz oder teilweise verschlüsseln. @@ -582,32 +585,39 @@ Wenn du über eine oder mehrere Festplatten zum Speichern von Daten verfügst, k Wenn du Flexibilität haben möchtest und die Größe von Partitionen nicht (verändern) möchtest, kannst du dich auch dafür entscheiden, auf `/mnt/hdd` zu mounten und dieser [Anleitung zum Mounten aller dieser Ordner mit `mount --bind`](/external_storage) zu folgen. ### Über Verschlüsselung + Beachte: Wenn du deine Festplatten ganz oder teilweise verschlüsselst, musst du bei jedem Neustart deines Servers die Passphrase eingeben. Das kann ein Problem darstellen, wenn du nicht vor Ort bist. Es gibt jedoch (ziemlich schwierig zu implementierende) Lösungen, die es dir ermöglichen, die Passphrase über SSH oder über eine Webseite einzugeben (suche nach "Dropbear Encrypted Disk"). ### Über RAID + Denk daran, dass: - * die Festplatten in deinen RAIDs von unterschiedlichen Marken, Abnutzungserscheinungen oder Chargen sein müssen (insbesondere, wenn es sich um SSDs handelt). - * ein RAID 1 (auch ohne Ersatz) aus Wahrscheinlichkeitssicht zuverlässiger als ein RAID 5 ist. - * und Hardware-Raids von der Raid-Karte abhängen. Wenn die Karte ausfällt, benötigst du einen Ersatz, um das Array zu lesen und neu aufzubauen. + +* die Festplatten in deinen RAIDs von unterschiedlichen Marken, Abnutzungserscheinungen oder Chargen sein müssen (insbesondere, wenn es sich um SSDs handelt). +* ein RAID 1 (auch ohne Ersatz) aus Wahrscheinlichkeitssicht zuverlässiger als ein RAID 5 ist. +* und Hardware-Raids von der Raid-Karte abhängen. Wenn die Karte ausfällt, benötigst du einen Ersatz, um das Array zu lesen und neu aufzubauen. [/ui-tab] [/ui-tabs] {% endif %} - {% if rpi012 %} + ## [fa=bug /] Mit dem Board verbinden und das Image per Hotfix reparieren + Raspberry Pi 1 und 0 werden aufgrund von [Kompilierungsproblemen für diese Architektur](https://github.com/YunoHost/issues/issues/1423) nicht vollständig unterstützt. Es ist jedoch möglich, das Image selbst zu reparieren, bevor du die Erstkonfiguration ausführst. Um das zu erreichen, musst du dich auf deinem Raspberry Pi als Root-Benutzer [über SSH](/ssh) mit dem temporären Passwort „yunohost“ verbinden: + ``` ssh root@yunohost.local ``` + (oder „yunohost-2.local“ usw., wenn sich mehrere YunoHost-Server in deinem Netzwerk befinden) Führe dann die folgenden Befehle aus, um das Metronomproblem zu umgehen: + ``` mv /usr/bin/metronome{,.bkp} mv /usr/bin/metronomectl{,.bkp} @@ -616,6 +626,7 @@ ln -s /usr/bin/true /usr/bin/metronomectl ``` Und diesen hier, um das UpnPC-Problem zu umgehen: + ``` sed -i 's/import miniupnpc/#import miniupnpc/g' /usr/lib/moulinette/yunohost/firewall.py ``` @@ -623,6 +634,7 @@ sed -i 's/import miniupnpc/#import miniupnpc/g' /usr/lib/moulinette/yunohost/fir ! Der letzte Befehl muss nach jedem Yunohost-Upgrade ausgeführt werden :/ {% elseif arm_unsup %} + ## [fa=terminal /] Verbindung zum Board Als nächstes musst du [die lokale IP-Adresse deines Servers finden](/finding_the_local_ip), um dich als Root-Benutzer [über SSH](/ssh) mit dem temporären Passwort `1234` zu verbinden. @@ -635,13 +647,13 @@ ssh root@192.168.x.xxx {% endif %} - {% if vps_debian or arm_unsup %} + ## [fa=rocket /] Das Installationsskript ausführen -- Öffne eine Kommandozeile auf deinem Server (entweder direkt oder [über SSH](/ssh)) -- Stelle sicher, dass du Root bist (oder gib „sudo -i“ ein, um Root zu werden) -- Führe den folgenden Befehl aus: +* Öffne eine Kommandozeile auf deinem Server (entweder direkt oder [über SSH](/ssh)) +* Stelle sicher, dass du Root bist (oder gib „sudo -i“ ein, um Root zu werden) +* Führe den folgenden Befehl aus: ```bash curl https://install.yunohost.org | bash @@ -729,7 +741,6 @@ Wenn du Subdomains erstellen möchtest, denk daran, diese auch in der Datei `hos Dieser Benutzer ersetzt den alten `admin` Benutzer, auf den sich einige alte Dokumentationsseiten möglicherweise noch beziehen. In diesem Fall: Ersetzen Sie einfach `admin` durch Ihren Benutzernamen. - ## [fa=stethoscope /] Die Erstdiagnose durchführen Sobald die Post-Installation abgeschlossen ist, solltest du dich tatsächlich mit den Credentials des ersten Benutzers, den du gerade erstellt hast, bei der Webadministrationsoberfläche anmelden können. @@ -747,7 +758,6 @@ Das Diagnosesystem soll eine einfache Möglichkeit bieten, zu überprüfen, ob a !!! Ist eine Warnung für dich nicht relevant (z.B. weil du nicht vor hast, eine bestimmte Funktion zu verwenden), ist es völlig in Ordnung, das Problem als 'ignoriert' zu markieren, indem du im Webadmin > Diagnose auf den "Ignorieren" Button (für diese bestimmte Funktion) klickst. - [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="(Empfohlen) Über die Weboberfläche"] Um eine Diagnose auszuführen, gehe im Web Admin auf den Abschnitt "Diagnose". Klicke auf "Erstdiagnose ausführen". Du solltest nun einen Bildschirm wie diesen erhalten: @@ -758,10 +768,12 @@ Um eine Diagnose auszuführen, gehe im Web Admin auf den Abschnitt "Diagnose". K [/ui-tab] [ui-tab title="In der Kommandozeile"] + ``` yunohost diagnosis run yunohost diagnosis show --issues --human-readable ``` + [/ui-tab] [/ui-tabs] @@ -782,13 +794,15 @@ Gehe zu Domains > Klicke auf deine Domain > SSL Zertifikat [/ui-tab] [ui-tab title="In der Kommandozeile"] + ``` yunohost domain cert install ``` + [/ui-tab] [/ui-tabs] -## ![](image://tada.png?resize=32&classes=inline) Gratulation! +## ![](image://tada.png?resize=32&classes=inline) Gratulation Jetzt hast du ein sehr gut konfigurierten Server. Wenn du neu bei YunoHost bist, empfehlen wir dir, einen Blick auf [die geführte Tour](/overview) zu werfen. Du solltest auch in der Lage sein, [deine Lieblingsanwendungen zu installieren](/apps). Vergiss nicht, [Backups zu planen](/backup)! diff --git a/pages/02.administer/10.install/install.fr.md b/pages/02.administer/10.install/install.fr.md index 80299e72d..a79b848cc 100644 --- a/pages/02.administer/10.install/install.fr.md +++ b/pages/02.administer/10.install/install.fr.md @@ -68,23 +68,23 @@ Sélectionnez le matériel sur lequel vous souhaitez installer YunoHost : [div class="flex-container"] [div class="flex-child hardware{%if virtualbox %} active{% endif %}"] -[[figure caption="VirtualBox"]![](image://virtualbox.png?height=75)[/figure]](/install/hardware:virtualbox) +[[figure caption="VirtualBox"]![][image://virtualbox.png?height=75](/figure)](/install/hardware:virtualbox) [/div] [div class="flex-child hardware{%if rpi34 or rpi012 %} active{% endif %}"] -[[figure caption="Raspberry Pi"]![](image://raspberrypi.png?height=75)[/figure]](/install/hardware:rpi34) +[[figure caption="Raspberry Pi"]![][image://raspberrypi.png?height=75](/figure)](/install/hardware:rpi34) [/div] [div class="flex-child hardware{%if arm_sup or (arm_unsup and not rpi012) or internetcube %} active{% endif %}"] -[[figure caption="Carte ARM"]![](image://olinuxino.png?height=75)[/figure]](/install/hardware:arm) +[[figure caption="Carte ARM"]![][image://olinuxino.png?height=75](/figure)](/install/hardware:arm) [/div] [div class="flex-child hardware{%if regular %} active{% endif %}"] -[[figure caption="Ordinateur standard"]![](image://computer.png?height=75)[/figure]](/install/hardware:regular) +[[figure caption="Ordinateur standard"]![][image://computer.png?height=75](/figure)](/install/hardware:regular) [/div] [div class="flex-child hardware{%if vps_debian or vps_ynh %} active{% endif %}"] -[[figure caption="Serveur distant"]![](image://vps.png?height=75)[/figure]](/install/hardware:vps_debian) +[[figure caption="Serveur distant"]![][image://vps.png?height=75](/figure)](/install/hardware:vps_debian) [/div] [/div] @@ -92,46 +92,46 @@ Sélectionnez le matériel sur lequel vous souhaitez installer YunoHost : {% if rpi34 or rpi012 %} [div class="flex-child hardware{%if rpi34 %} active{% endif %}"] -[[figure caption="Raspberry Pi 3 ou 4"]![](image://raspberrypi.png?height=50)[/figure]](/install/hardware:rpi34) +[[figure caption="Raspberry Pi 3 ou 4"]![][image://raspberrypi.png?height=50](/figure)](/install/hardware:rpi34) [/div] [div class="flex-child hardware{%if rpi012 %} active{% endif %}"] -[[figure caption="Raspberry Pi 0, 1 or 2"]![](image://rpi1.png?height=50)[/figure]](/install/hardware:rpi012) +[[figure caption="Raspberry Pi 0, 1 or 2"]![][image://rpi1.png?height=50](/figure)](/install/hardware:rpi012) [/div] {% elseif show_legacy_arm_menu %} [div class="flex-child hardware{%if internetcube %} active{% endif %}"] -[[figure caption="La Brique Internet avec un VPN"]![](image://internetcube.png?height=50)[/figure]](/install/hardware:internetcube) +[[figure caption="La Brique Internet avec un VPN"]![][image://internetcube.png?height=50](/figure)](/install/hardware:internetcube) [/div] [div class="flex-child hardware{%if arm_sup and not internetcube %} active{% endif %}"] -[[figure caption="Olinuxino lime1&2 ou Orange Pi PC+"]![](image://olinuxino.png?height=50)[/figure]](/install/hardware:arm_sup) +[[figure caption="Olinuxino lime1&2 ou Orange Pi PC+"]![][image://olinuxino.png?height=50](/figure)](/install/hardware:arm_sup) [/div] [div class="flex-child hardware{%if arm_unsup %} active{% endif %}"] -[[figure caption="Autres cartes ARM"]![](image://odroidhc4.png?height=50)[/figure]](/install/hardware:arm_unsup) +[[figure caption="Autres cartes ARM"]![][image://odroidhc4.png?height=50](/figure)](/install/hardware:arm_unsup) [/div] {% elseif vps_debian or vps_ynh %} [div class="flex-child hardware{%if vps_debian %} active{% endif %}"] -[[figure caption="VPS ou serveur dédié avec Debian 11"]![](image://debian-logo.png?height=50)[/figure]](/install/hardware:vps_debian) +[[figure caption="VPS ou serveur dédié avec Debian 11"]![][image://debian-logo.png?height=50](/figure)](/install/hardware:vps_debian) [/div] [div class="flex-child hardware{%if vps_ynh %} active{% endif %}"] -[[figure caption="VPS ou serveur dédié avec YunoHost pre-installé"]![](image://logo.png?height=50)[/figure]](/install/hardware:vps_ynh) +[[figure caption="VPS ou serveur dédié avec YunoHost pre-installé"]![][image://logo.png?height=50](/figure)](/install/hardware:vps_ynh) [/div] {% endif %} [/div] - {% if hardware != '' %} ## [fa=list-alt /] Pré-requis {% if regular %} + * Un matériel compatible x86 dédié à YunoHost : portable, netbook, ordinateur avec 512Mo de RAM et 16Go de capacité de stockage (au moins) ; {% elseif rpi34 %} * Un Raspberry Pi 3 ou 4 ; @@ -172,10 +172,8 @@ Sélectionnez le matériel sur lequel vous souhaitez installer YunoHost : ! N.B. : Installer YunoHost dans une VirtualBox est généralement destiné à tester la distribution ou pour développer. VirtualBox n'est pas pratique pour faire tourner un 'vrai' serveur sur le long terme car la machine surlaquelle il est installé ne sera sans doute pas allumé 24h/24, et parce que Virtualbox rajoute une couche de complexité supplémentaire pour ce qui est d'exposer la machine sur Internet. {% endif %} - - - {% if vps_ynh %} + ## Fournisseurs de VPS YunoHost Ci-dessous une liste de fournisseurs de VPS supportant nativement YunoHost : @@ -183,19 +181,19 @@ Ci-dessous une liste de fournisseurs de VPS supportant nativement YunoHost : [div class="flex-container"] [div class="flex-child"] -[[figure caption="Alsace Réseau Neutre - FR"]![](image://vps_ynh_arn.png?height=50)[/figure]](https://vps.arn-fai.net) +[[figure caption="Alsace Réseau Neutre - FR"]![][image://vps_ynh_arn.png?height=50](/figure)]() [/div] [div class="flex-child"] -[[figure caption="FAImaison - FR"]![](image://vps_ynh_faimaison.svg?height=50)[/figure]](https://www.faimaison.net/services/vm.html) +[[figure caption="FAImaison - FR"]![][image://vps_ynh_faimaison.svg?height=50](/figure)]() [/div] [div class="flex-child"] -[[figure caption="ECOWAN - FR"]![](image://vps_ynh_ecowan.png?height=50)[/figure]](https://www.ecowan.fr/vps-linux) +[[figure caption="ECOWAN - FR"]![][image://vps_ynh_ecowan.png?height=50](/figure)]() [/div] [/div] {% endif %} - {% if at_home %} + ## [fa=download /] Télécharger l'image {{image_type}} {% if rpi012 %} @@ -261,7 +259,7 @@ $(document).ready(function () { .replace('%7Bimage%7D', infos.image) .replace('{image}', infos.image) .replace('{version}', infos.version); - + if (!infos.file.startsWith("http")) infos.file="https://build.yunohost.org/"+infos.file; html = html.replace(/%7Bfile%7D/g, infos.file).replace(/{file}/g, infos.file); @@ -278,17 +276,16 @@ $(document).ready(function () { }); - - - - - {% if not virtualbox %} {% if arm %} + ## ![microSD card with adapter](image://sdcard_with_adapter.png?resize=100,75&class=inline) Flasher l'image {{image_type}} + {% else %} + ## ![USB drive](image://usb_key.png?resize=100,100&class=inline) Flasher l'image YunoHost + {% endif %} Maintenant que vous avez téléchargé l’image de {{image_type}}, vous devez la mettre sur {% if arm %}une carte microSD{% else %}une clé USB ou un CD/DVD.{% endif %} @@ -339,10 +336,11 @@ Pour les anciens matériels, il vous faut peut-être utiliser un CD/DVD. Le logi Ventoy sera utile si vous n'arrivez pas à démarrer l'image de Yunohost en utilisant les autres méthodes [Ventoy](https://www.ventoy.net/) est un outil pratique qui permet de mettre plusieurs images Linux sur une même clé USB et démarrer ces images sans devoir re-flasher la clé USB à chaque fois. C'est aussi pratique pour démarer une image qui refuse de démarrer: Ventoy réussi habituellement à tout démarrer! + 1. Installer [Ventoy](https://www.ventoy.net/) sur la clé USB. Référez-vous aux [instructions d'installation](https://www.ventoy.net/en/doc_start.html). - - Cela va créer 2 partition sur la clé USB. + * Cela va créer 2 partition sur la clé USB. 3. En utilisant votre application de fichiers préférée, copiez l'image Yunohost sur la grande partition "Ventoy (pas celle "VTOYEFI") - - N'utilisez pas *Balena Etcher*, USBImager ou `dd` pour faire ça! + * N'utilisez pas *Balena Etcher*, USBImager ou `dd` pour faire ça! Insérez cette clé USB dans l'ordinateur et démarrez en utisant celle-ci. Ventoy va apparaitre et lister toutes les images qui sont sur la clé USB. Sélectionnez l'image de Yunohost. Sélectionnez ensuite "GRUB2" comme option de démarrage (ou utilisez n'importe laquelle qui fonctionnera sur votre ordinateur 😉) [/ui-tab] @@ -371,19 +369,12 @@ Allez dans **Réglages** > **Réseau** : {% endif %} - - - - - - - - {% if arm %} + ## [fa=plug /] Démarrer la carte * Branchez le câble Ethernet (un côté sur votre box, l'autre côté à votre carte). - * Pour les utilisateurs et utilisatrices souhaitant configurer la carte pour la connecter via le WiFi à la place, voir [cet exemple](https://www.raspberrypi.com/documentation/computers/configuration.html#connect-to-a-wireless-network) ([ou là avant YunoHost12/bookworm](https://www.raspberryme.com/configurer-le-wifi-sur-un-pi-manuellement-a-laide-de-wpa_supplicant-conf/). + * Pour les utilisateurs et utilisatrices souhaitant configurer la carte pour la connecter via le WiFi à la place, voir [cet exemple](https://www.raspberrypi.com/documentation/computers/configuration.html#connect-to-a-wireless-network) ([ou là avant YunoHost12/bookworm](https://www.raspberryme.com/configurer-le-wifi-sur-un-pi-manuellement-a-laide-de-wpa_supplicant-conf/). * Mettez la carte SD dans le serveur. * (Facultatif) Il est possible de brancher un écran et un clavier sur votre serveur en cas de soucis, pour vérifier que le processus de démarrage (boot) se passe bien, ou encore pour avoir un accès direct en console. * Branchez l'alimentation. @@ -391,6 +382,7 @@ Allez dans **Réglages** > **Réseau** : * Assurez-vous que votre ordinateur (de bureau ou portable) est connecté au même réseau local (c'est-à-dire la même box Internet) que votre serveur. {% elseif virtualbox %} + ## [fa=plug /] Lancer la machine virtuelle Démarrez votre machine virtuelle après avoir sélectionné l'image YunoHost. @@ -400,19 +392,20 @@ Démarrez votre machine virtuelle après avoir sélectionné l'image YunoHost. ! Si vous rencontrez l'erreur "VT-x is not available", il vous faut probablement activer (enable) la virtualisation dans les options du BIOS de votre ordinateur. {% else %} + ## [fa=plug /] Démarrer la machine sur la clé USB * Branchez le câble Ethernet (un côté à votre box, de l'autre côté à votre carte). * Démarrez votre serveur avec la clé USB ou le CD-ROM inséré, et sélectionnez-le comme **périphérique de démarrage (bootable device)** en pressant l’une des touches suivantes (dépendant de votre ordinateur) : ``, ``, ``, ``, ``, `` ou . - * N.B. : si le serveur était précédemment installé avec une version récente de Windows (8+), vous devez d'abord demander à Windows de « redémarrer réellement ». Vous pouvez le faire dans une option du menu « Options de démarrage avancées ». - + * N.B. : si le serveur était précédemment installé avec une version récente de Windows (8+), vous devez d'abord demander à Windows de « redémarrer réellement ». Vous pouvez le faire dans une option du menu « Options de démarrage avancées ». + !!! Si vous n'arrivez pas à démarrer l'image Yunohost, essayez d'utiliser Ventoy (sélectionnez "Ventoy" dans la section "Flasher l'image YunoHost" ci-dessus). {% endif %} {% if regular or virtualbox %} -## [fa=rocket /] Lancer l’installation graphique +## [fa=rocket /] Lancer l’installation graphique Votre écran devrait ressembler à la capture ci-dessous : @@ -432,9 +425,10 @@ Votre écran devrait ressembler à la capture ci-dessous : Le projet YunoHost a simplifié au maximum l'installation classique afin d'éviter au plus grand nombre d'être perdu avec des questions trop techniques ou liées à des cas particuliers. -Avec l'installation en mode expert, vous avez plus de possibilités notamment concernant le partitionnement exact de vos supports de stockages. Vous pouvez aussi décider d'utiliser le mode classique et [ajouter vos disques après coup](/external_storage). +Avec l'installation en mode expert, vous avez plus de possibilités notamment concernant le partitionnement exact de vos supports de stockages. Vous pouvez aussi décider d'utiliser le mode classique et [ajouter vos disques après coup](/external_storage). + +### Résumé des étapes en mode expert -### Résumé des étapes en mode expert: 1. Sélectionnez `Expert graphical install` 2. Sélectionnez votre langue, votre localisation, votre agencement de clavier et éventuellement votre timezone. 3. Partitionner vos disques. C'est à cette étape que vous pouvez configurer un RAID ou chiffrer tout ou partie du serveur. @@ -460,13 +454,16 @@ Si vous avez un ou des disques durs pour stocker les données, vous pouvez chois Si vous souhaitez de la souplesse et ne pas avoir à (re-)dimensionner des partitions, vous pouvez aussi choisir de monter sur `/mnt/hdd` et de suivre ce [tutoriel pour monter l'ensemble de ces dossiers avec `mount --bind`](/external_storage). ### A propos du chiffrement + Prenez bien en compte que si vous chiffrez tout ou partie de vos disques, vous aurez à taper la phrase de passe à chaque redémarrage de votre serveur, ce qui peut poser problème si vous n'êtes pas sur place. Il existe toutefois des solutions (assez difficiles à mettre en oeuvre) qui permettent de tapper la phrase via SSH ou via une page web (cherchez "dropbear encrypted disk"). ### A propos du RAID + Ne perdez pas de vue que: - * les disques de vos RAID doivent être de marque, d'usure ou de lots distincts (surtout si ce sont des SSD) - * un RAID 1 (même sans disque de spare) est plus fiable qu'un RAID5 d'un point de vue probabilité - * les raid matériels sont dépendant de la carte raid, si celle-ci fait défaut il en faudra une de remplacement pour pouvoir lire et reconstruire la grappe + +* les disques de vos RAID doivent être de marque, d'usure ou de lots distincts (surtout si ce sont des SSD) +* un RAID 1 (même sans disque de spare) est plus fiable qu'un RAID5 d'un point de vue probabilité +* les raid matériels sont dépendant de la carte raid, si celle-ci fait défaut il en faudra une de remplacement pour pouvoir lire et reconstruire la grappe [/ui-tab] [/ui-tabs] @@ -474,20 +471,24 @@ Ne perdez pas de vue que: !!! Si l'installation de Yunohost échoue sur votre machine et que vous n'arrivez pas à résoudre le problème, sachez qu'il est aussi possible d'installer Debian et ensuite d'installer Yunohost dessus. Pour les instructions, au sommet de cette page, sélectionnez "Serveur distant" puis "VPS ou serveur dédié avec Debian". {% endif %} - {% if rpi012 %} + ## [fa=bug /] Se connecter à la carte et corriger l'image + Les Raspberry Pi 1 et Zero ne sont pas totalement supportés à cause de [problèmes de compilation pour cette architecture](https://github.com/YunoHost/issues/issues/1423). Cependant, il est possible de corriger l'image par vous-même avant de lancer la configuration initiale. Pour y parvenir, vous devez vous connecter à votre Raspberry Pi en tant que root [via SSH](/ssh) avec le mot de passe temporaire `yunohost`: + ``` ssh root@yunohost.local ``` + (utilisez `yunohost-2.local`, etc. s'il y a plusieurs serveurs YunoHost sur le réseau) Ensuite, lancez les commandes suivantes pour contourner le dysfonctionnement de Metronome : + ``` mv /usr/bin/metronome{,.bkp} mv /usr/bin/metronomectl{,.bkp} @@ -496,6 +497,7 @@ ln -s /usr/bin/true /usr/bin/metronomectl ``` Et celle-ci pour contourner celui de upnpc : + ``` sed -i 's/import miniupnpc/#import miniupnpc/g' /usr/lib/moulinette/yunohost/firewall.py ``` @@ -503,6 +505,7 @@ sed -i 's/import miniupnpc/#import miniupnpc/g' /usr/lib/moulinette/yunohost/fir ! Cette dernière commande nécessite d'être lancée après chaque mise à jour de YunoHost :/ {% elseif arm_unsup %} + ## [fa=terminal /] Se connecter à la carte Ensuite, il vous faut [trouver l'adresse IP locale de votre serveur](/finding_the_local_ip) pour vous connecter en tant que root [via SSH](/ssh) avec le mot de passe temporaire `1234`. @@ -515,17 +518,18 @@ ssh root@192.168.x.xxx {% endif %} - {% if vps_debian or arm_unsup %} + ## [fa=rocket /] Lancer le script d'installation -- Ouvrez la ligne de commande sur votre serveur (soit directement, soit avec [SSH](/ssh)) -- Assurez-vous d'être connecté en tant que root (ou tapez `sudo -i` pour le devenir) -- Lancez la commande suivante : +* Ouvrez la ligne de commande sur votre serveur (soit directement, soit avec [SSH](/ssh)) +* Assurez-vous d'être connecté en tant que root (ou tapez `sudo -i` pour le devenir) +* Lancez la commande suivante : ```bash curl https://install.yunohost.org | bash ``` + !!! Si `curl` n'est pas installé sur votre système, il vous faudra peut-être l'installer avec `apt install curl`. !!! Autrement, si la commande n'affiche rien du tout, vous pouvez tenter `apt install ca-certificates` @@ -533,7 +537,6 @@ curl https://install.yunohost.org | bash {% endif %} - ## [fa=cog /] Lancer la configuration initiale !!! Si vous êtes en train de restaurer une sauvegarde YunoHost, vous devez sauter cette étape et vous référer à la section [Restaurer durant la post-installation à la place de cette étape de configuration initiale](/backup#restoring-during-the-postinstall). @@ -585,7 +588,7 @@ C’est le nom de domaine qui permettra l’accès à votre serveur ainsi qu’a ##### [fa=key /] Premier compte utilisateur [Depuis YunoHost 11.1](https://forum.yunohost.org/t/yunohost-11-1-release-sortie-de-yunohost-11-1/23378), le premier compte utilisateur est créé à cette étape. Il vous faudra choisir un nom d'utilisateur et un mot de passe raisonablement complexe. (Nous ne pouvons que souligner l'importance du choix d'un mot de passe **robuste** !) Ce compte utilisateur sera ajouté au groupe Admins, et pourra se connecter au portail utilisateur, à la webadmin, et se connecter [via **SSH**](/ssh) ou [**SFTP**](/filezilla). Les admins recevront aussi les mails envoyés à `root@votredomaine.tld` et `admin@votredomaine.tld` : ces emails peuvent être utilisés pour envoyer des informations ou des alertes techniques. Vous pourrez plus tard ajouter d'autres comptes utilisateur supplémentaire, qu'il est aussi possible d'ajouter au groupe Admins. - + Ce compte remplace l'ancien compte `admin`, qui est peut être toujours mentionné dans certaines pages de documentation. Dans ce cas, remplacez simplement `admin` par votre identifiant. ## [fa=stethoscope /] Lancer le diagnostic @@ -612,10 +615,12 @@ Pour lancer le diagnostic, allez dans l'Administration Web dans la partie Diagno [/ui-tab] [ui-tab title="À partir de la ligne de commande"] + ``` yunohost diagnosis run yunohost diagnosis show --issues --human-readable ``` + [/ui-tab] [/ui-tabs] @@ -634,13 +639,15 @@ Pour plus d'instructions détaillées, ou pour en savoir plus à propos des cert [/ui-tab] [ui-tab title="À partir de la ligne de commande"] + ``` yunohost domain cert install ``` + [/ui-tab] [/ui-tabs] -## ![](image://tada.png?resize=32&classes=inline) Félicitations ! +## ![](image://tada.png?resize=32&classes=inline) Félicitations Vous avez maintenant un serveur plutôt bien configuré. Si vous découvrez YunoHost, nous vous recommandons de jeter un œil à [la visite guidée](/overview). Vous devriez aussi être en mesure d'[installer vos applications favorites](/apps). N'oubliez pas de [prévoir des sauvegardes](/backup) ! diff --git a/pages/02.administer/10.install/install.md b/pages/02.administer/10.install/install.md index d9890a3ad..6e09f29f0 100644 --- a/pages/02.administer/10.install/install.md +++ b/pages/02.administer/10.install/install.md @@ -70,27 +70,27 @@ Select the hardware on which you want install YunoHost : [div class="flex-container"] [div class="flex-child hardware{%if virtualbox %} active{% endif %}"] -[[figure caption="VirtualBox"]![](image://virtualbox.png?height=75)[/figure]](/install/hardware:virtualbox) +[[figure caption="VirtualBox"]![][image://virtualbox.png?height=75](/figure)](/install/hardware:virtualbox) [/div] [div class="flex-child hardware{%if rpi012 or rpi34 %} active{% endif %}"] -[[figure caption="Raspberry Pi"]![](image://raspberrypi.png?height=75)[/figure]](/install/hardware:rpi34) +[[figure caption="Raspberry Pi"]![][image://raspberrypi.png?height=75](/figure)](/install/hardware:rpi34) [/div] [div class="flex-child hardware{%if arm_sup or (arm_unsup and not rpi012) or internetcube %} active{% endif %}"] -[[figure caption="ARM board"]![](image://olinuxino.png?height=75)[/figure]](/install/hardware:arm) +[[figure caption="ARM board"]![][image://olinuxino.png?height=75](/figure)](/install/hardware:arm) [/div] [div class="flex-child hardware{%if regular %} active{% endif %}"] -[[figure caption="Regular computer"]![](image://computer.png?height=75)[/figure]](/install/hardware:regular) +[[figure caption="Regular computer"]![][image://computer.png?height=75](/figure)](/install/hardware:regular) [/div] [div class="flex-child hardware{%if wsl %} active{% endif %}"] -[[figure caption="WSL"]![](image://wsl.png?height=75)[/figure]](/install/hardware:wsl) +[[figure caption="WSL"]![][image://wsl.png?height=75](/figure)](/install/hardware:wsl) [/div] [div class="flex-child hardware{%if vps_debian or vps_ynh %} active{% endif %}"] -[[figure caption="Remote server"]![](image://vps.png?height=75)[/figure]](/install/hardware:vps_debian) +[[figure caption="Remote server"]![][image://vps.png?height=75](/figure)](/install/hardware:vps_debian) [/div] [/div] @@ -98,56 +98,55 @@ Select the hardware on which you want install YunoHost : {% if rpi012 or rpi34 %} [div class="flex-child hardware{%if rpi34 %} active{% endif %}"] -[[figure caption="Raspberry Pi 3 or 4"]![](image://raspberrypi.png?height=50)[/figure]](/install/hardware:rpi34) +[[figure caption="Raspberry Pi 3 or 4"]![][image://raspberrypi.png?height=50](/figure)](/install/hardware:rpi34) [/div] [div class="flex-child hardware{%if rpi012 %} active{% endif %}"] -[[figure caption="Raspberry Pi 0, 1 or 2"]![](image://rpi1.png?height=50)[/figure]](/install/hardware:rpi012) +[[figure caption="Raspberry Pi 0, 1 or 2"]![][image://rpi1.png?height=50](/figure)](/install/hardware:rpi012) [/div] {% elseif show_legacy_arm_menu %} [div class="flex-child hardware{%if internetcube %} active{% endif %}"] -[[figure caption="Internet cube With VPN"]![](image://internetcube.png?height=50)[/figure]](/install/hardware:internetcube) +[[figure caption="Internet cube With VPN"]![][image://internetcube.png?height=50](/figure)](/install/hardware:internetcube) [/div] [div class="flex-child hardware{%if arm_sup and not internetcube %} active{% endif %}"] -[[figure caption="Olinuxino lime1&2 or Orange Pi PC+"]![](image://olinuxino.png?height=50)[/figure]](/install/hardware:arm_sup) +[[figure caption="Olinuxino lime1&2 or Orange Pi PC+"]![][image://olinuxino.png?height=50](/figure)](/install/hardware:arm_sup) [/div] [div class="flex-child hardware{%if arm_unsup %} active{% endif %}"] -[[figure caption="Others boards"]![](image://odroidhc4.png?height=50)[/figure]](/install/hardware:arm_unsup) +[[figure caption="Others boards"]![][image://odroidhc4.png?height=50](/figure)](/install/hardware:arm_unsup) [/div] {% elseif vps_debian or vps_ynh %} [div class="flex-child hardware{%if vps_debian %} active{% endif %}"] -[[figure caption="VPS or dedicated server with Debian 11"]![](image://debian-logo.png?height=50)[/figure]](/install/hardware:vps_debian) +[[figure caption="VPS or dedicated server with Debian 11"]![][image://debian-logo.png?height=50](/figure)](/install/hardware:vps_debian) [/div] [div class="flex-child hardware{%if vps_ynh %} active{% endif %}"] -[[figure caption="VPS or dedicated server with YunoHost pre-installed"]![](image://logo.png?height=50)[/figure]](/install/hardware:vps_ynh) +[[figure caption="VPS or dedicated server with YunoHost pre-installed"]![][image://logo.png?height=50](/figure)](/install/hardware:vps_ynh) [/div] {% endif %} [/div] - {% if hardware != '' %} {% if wsl %} !! This setup is mainly meant for local testing by advanced users. Due to limitations on WSL's side (changing IP address, notably), selfhosting from it can be tricky and will not be described here. {% endif %} - ## [fa=list-alt /] Pre-requisites {% if regular %} + * A x86-compatible hardware dedicated to YunoHost: laptop, nettop, netbook, desktop with 512MB RAM and 16GB capacity (at least) {% elseif rpi34 %} * A Raspberry Pi 3 or 4 {% elseif rpi012 %} -* A Raspberry Pi 0, 1 or 2 with at least 512MB RAM +* A Raspberry Pi 0, 1 or 2 with at least 512MB RAM {% elseif internetcube %} * An Orange Pi PC+ or an Olinuxino Lime 1 or 2 * A VPN with a dedicated public IP and a `.cube` file @@ -190,7 +189,9 @@ Select the hardware on which you want install YunoHost : {% endif %} {% if wsl %} + ## Introduction + WSL is a nice feature of Windows 10, making Linux pseudo-distributions available through command line. Let's say pseudo, because even though they are not really like virtual machines, they rely on virtualization capacities that make their integration with Windows almost seamless. Docker for Windows can now rely on WSL instead of Hyper-V, for example. @@ -216,7 +217,7 @@ rmdir .\debian -R You can now access it: run `wsl.exe -d YunoHost` -It is under Debian 9 Stretch, so let's upgrade it: +It is under Debian 9 Stretch, so let's upgrade it: ```bash # In WSL @@ -225,6 +226,7 @@ sudo apt update sudo apt upgrade sudo apt dist-upgrade ``` + ## Prevent WSL from tweaking configuration files Edit `/etc/wsl.conf` and put the following code in it: @@ -252,6 +254,7 @@ Debian on WSL does not have `systemd`, a service configuration software. This is a key element for YunoHost, and for any decent Debian distro (seriously MS, what the heck). Let's install it: 1. Install dotNET runtime: + ```bash # In WSL wget https://packages.microsoft.com/config/debian/11/packages-microsoft-prod.deb -O packages-microsoft-prod.deb @@ -263,6 +266,7 @@ sudo apt install -y dotnet-sdk-3.1 ``` 2. Install [Genie](https://github.com/arkane-systems/genie): + ```bash # In WSL # Add their repository @@ -291,8 +295,10 @@ Always call `genie -s` while starting your distro. `wsl -d YunoHost -e genie -s` -## Backup and restore the distro +## Backup and restore the distro + ### Make your first distro backup + As said before, there is no rollback capability. So let's export your fresh distro. In PowerShell: ``` @@ -307,10 +313,11 @@ cd ~ wsl --unregister YunoHost wsl --import YunoHost .\WSL\YunoHost .\WSL\YunoHost.tar.gz --version 2 ``` -{% endif %} +{% endif %} {% if vps_ynh %} + ## YunoHost VPS providers Here are some VPS providers supporting YunoHost natively : @@ -318,19 +325,19 @@ Here are some VPS providers supporting YunoHost natively : [div class="flex-container"] [div class="flex-child"] -[[figure caption="Alsace Réseau Neutre - FR"]![](image://vps_ynh_arn.png?height=50)[/figure]](https://vps.arn-fai.net) +[[figure caption="Alsace Réseau Neutre - FR"]![][image://vps_ynh_arn.png?height=50](/figure)]() [/div] [div class="flex-child"] -[[figure caption="FAImaison - FR"]![](image://vps_ynh_faimaison.svg?height=50)[/figure]](https://www.faimaison.net/services/vm.html) +[[figure caption="FAImaison - FR"]![][image://vps_ynh_faimaison.svg?height=50](/figure)]() [/div] [div class="flex-child"] -[[figure caption="ECOWAN - FR"]![](image://vps_ynh_ecowan.png?height=50)[/figure]](https://www.ecowan.fr/vps-linux) +[[figure caption="ECOWAN - FR"]![][image://vps_ynh_ecowan.png?height=50](/figure)]() [/div] [/div] {% endif %} - {% if at_home %} + ## [fa=download /] Download the {{image_type}} image {% if rpi012 %} @@ -396,7 +403,7 @@ $(document).ready(function () { .replace('%7Bimage%7D', infos.image) .replace('{image}', infos.image) .replace('{version}', infos.version); - + if (!infos.file.startsWith("http")) infos.file="https://build.yunohost.org/"+infos.file; html = html.replace(/%7Bfile%7D/g, infos.file).replace(/{file}/g, infos.file); @@ -413,17 +420,16 @@ $(document).ready(function () { }); - - - - - {% if not virtualbox %} {% if arm %} + ## ![microSD card with adapter](image://sdcard_with_adapter.png?resize=100,75&class=inline) Flash the {{image_type}} image + {% else %} + ## ![USB drive](image://usb_key.png?resize=100,100&class=inline) Flash the YunoHost image + {% endif %} Now that you downloaded the image of {{image_type}}, you should flash it on {% if arm %}a microSD card{% else %}a USB stick or a CD/DVD.{% endif %} @@ -457,6 +463,7 @@ Then run : # Replace /dev/mmcblk0 if the name of your device is different... dd if=/path/to/yunohost.img of=/dev/mmcblk0 ``` + [/ui-tab] {% if regular %} [ui-tab title="Burning a CD/DVD"] @@ -472,10 +479,11 @@ For older devices, you might want to burn a CD/DVD. The software to use depends Ventoy will be useful if you can't sucessfully boot the Yunohost image using the other methods. [Ventoy](https://www.ventoy.net/) is a nice tool that makes it really easy to put multiple linux images on a USB stick. When the computer refuses to boot from an image on a usb stick, Ventoy will usually be able to boot it anyway! + 1. Install [Ventoy](https://www.ventoy.net/) on the USB stick. Refer to the [install instructions](https://www.ventoy.net/en/doc_start.html). - - This will create 2 partitions on the stick. + * This will create 2 partitions on the stick. 3. Using your favorite file explorer app, copy the Yunohost image file on the big `Ventoy` partition (not "VTOYEFI") - - Don't use *Balena Etcher*, USBImager or `dd` for this! + * Don't use *Balena Etcher*, USBImager or `dd` for this! Later, when you'll boot the computer using this usb stick, Ventoy will appear and will list the images on the USB stick. Select the Yunohost image, then select GRUB2 launch option (or use whichever works for your computer 😉) [/ui-tab] @@ -504,19 +512,12 @@ Go to **Settings** > **Network**: {% endif %} - - - - - - - - {% if arm %} + ## [fa=plug /] Power up the board * Plug the ethernet cable (one side on your main router, the other on your board). - * For advanced users willing to configure the board to connect to WiFi instead, see for example [here](https://www.raspberrypi.com/documentation/computers/configuration.html#connect-to-a-wireless-network) ([or here prior to YunoHost12/bookworm](https://www.raspberryme.com/configurer-le-wifi-sur-un-pi-manuellement-a-laide-de-wpa_supplicant-conf/). + * For advanced users willing to configure the board to connect to WiFi instead, see for example [here](https://www.raspberrypi.com/documentation/computers/configuration.html#connect-to-a-wireless-network) ([or here prior to YunoHost12/bookworm](https://www.raspberryme.com/configurer-le-wifi-sur-un-pi-manuellement-a-laide-de-wpa_supplicant-conf/). * Plug the SD card in your board * (Optional) You can connect a screen+keyboard directly on your board if you want to troubleshoot the boot process or if you're more comfortable to "see what happens" or want a direct access to the board. * Power up the board @@ -524,6 +525,7 @@ Go to **Settings** > **Network**: * Make sure that your computer (desktop/laptop) is connected to the same local network (i.e. same internet box) as your server. {% elseif virtualbox %} + ## [fa=plug /] Boot up the virtual machine Start the virtual machine after selecting the YunoHost image. @@ -532,19 +534,20 @@ Start the virtual machine after selecting the YunoHost image. ! If you encounter the error "VT-x is not available", you probably need to enable Virtualization in the BIOS of your computer. - {% else %} + ## [fa=plug /] Boot the machine on your USB stick * Plug the ethernet cable (one side on your main router, the other on your server). * Boot up your server with the USB stick or a CD-ROM inserted, and select it as **bootable device**. Depending on your hardware, you will need to press one of the following keys: ``, ``, ``, ``, ``, `` or ``. - * N.B. : if the server was previously installed with a recent version of Windows (8+), you first need to tell Windows, to "actually reboot". This can be done somewhere in "Advanced startup options". + * N.B. : if the server was previously installed with a recent version of Windows (8+), you first need to tell Windows, to "actually reboot". This can be done somewhere in "Advanced startup options". !!! If you can't boot the Yunohost image, try using Ventoy (select "Ventoy" in the section "Flash the YunoHost image" above). {% endif %} {% if regular or virtualbox %} + ## [fa=rocket /] Launch the graphical install You should see a screen like this: @@ -567,9 +570,10 @@ You should see a screen like this: The YunoHost project simplified the classic installation as much as possible in order to avoid as many people as possible being lost with questions that are too technical or related to specific cases. -With the expert mode installation, you have more possibilities, especially concerning the exact partitioning of your storage media. You can also decide to use the classic mode and [add your disks afterwards](/external_storage). +With the expert mode installation, you have more possibilities, especially concerning the exact partitioning of your storage media. You can also decide to use the classic mode and [add your disks afterwards](/external_storage). + +### Summary of the steps in expert mode -### Summary of the steps in expert mode: 1. Select `Expert graphical install`. 2. Select your language, location, keyboard layout and possibly your timezone. 3. Partition your disks. This is where you can set up a RAID or encrypt all or part of the server. @@ -595,13 +599,16 @@ If you have one or more hard drives to store data, you can choose to mount it on If you want flexibility and don't want to (re)size partitions, you can also choose to mount on `/mnt/hdd` and follow this [tutorial to mount all these folders with `mount --bind`](/external_storage). ### About encryption + Be aware that if you encrypt all or part of your disks, you will have to type the passphrase every time you restart your server, which can be a problem if you are not on site. There are however solutions (quite difficult to implement) that allow you to type the passphrase via SSH or via a web page (search for "dropbear encrypted disk"). ### About RAID + Keep in mind that: - * the disks in your RAIDs must be of different brands, wear and tear or batches (especially if they are SSDs) - * a RAID 1 (even without a spare) is more reliable than a RAID 5 from a probability point of view - * hardware raids are dependent on the raid card, if the card fails you will need a replacement to read and rebuild the array + +* the disks in your RAIDs must be of different brands, wear and tear or batches (especially if they are SSDs) +* a RAID 1 (even without a spare) is more reliable than a RAID 5 from a probability point of view +* hardware raids are dependent on the raid card, if the card fails you will need a replacement to read and rebuild the array [/ui-tab] [/ui-tabs] @@ -609,20 +616,24 @@ Keep in mind that: !!! If the Yunohost installer fails and you can't solve the issue, know that it's also possible to install Debian and then install Yunohost on top. For instructions, at the top of this page, select "Remote server", then "VPS or dedicated server with Debian". {% endif %} - {% if rpi012 %} + ## [fa=bug /] Connect to the board and hotfix the image + Raspberry Pi 1 and 0 are not totally supported due to [compilation issues for this architecture](https://github.com/YunoHost/issues/issues/1423). However, it is possible to fix by yourself the image before to run the initial configuration. To achieve this, you need to connect on your raspberry pi as root user [via SSH](/ssh) with the temporary password `yunohost`: + ``` ssh root@yunohost.local ``` + (or `yunohost-2.local`, and so on if multiple YunoHost servers are on your network) Then run the following commands to work around the metronome issue: + ``` mv /usr/bin/metronome{,.bkp} mv /usr/bin/metronomectl{,.bkp} @@ -631,6 +642,7 @@ ln -s /usr/bin/true /usr/bin/metronomectl ``` And this one to work around the upnpc issue: + ``` sed -i 's/import miniupnpc/#import miniupnpc/g' /usr/lib/moulinette/yunohost/firewall.py ``` @@ -638,6 +650,7 @@ sed -i 's/import miniupnpc/#import miniupnpc/g' /usr/lib/moulinette/yunohost/fir ! This last command need to be run after each yunohost upgrade :/ {% elseif arm_unsup %} + ## [fa=terminal /] Connect to the board Next you need to [find the local IP address of your server](/finding_the_local_ip) to connect as root user [via SSH](/ssh) with the temporary password `1234`. @@ -650,13 +663,13 @@ ssh root@192.168.x.xxx {% endif %} - {% if vps_debian or arm_unsup %} + ## [fa=rocket /] Run the install script -- Open a command line prompt on your server (either directly or [through SSH](/ssh)) -- Make sure you are root (or type `sudo -i` to become root) -- Run the following command: +* Open a command line prompt on your server (either directly or [through SSH](/ssh)) +* Make sure you are root (or type `sudo -i` to become root) +* Run the following command: ```bash curl https://install.yunohost.org | bash @@ -744,7 +757,6 @@ If you want to create subdomains, do not forget to add them in the `hosts` file This user replaces the old `admin` user, which some old documentation page may still refer to. In which case : just replace `admin` with your username. - ## [fa=stethoscope /] Run the initial diagnosis Once the postinstall is done, you should be able to actually log in the web admin interface using the credentials of the first user you just created. @@ -772,10 +784,12 @@ To run a diagnosis, go on Web Admin in the Diagnosis section. Click Run initial [/ui-tab] [ui-tab title="From the command line"] + ``` yunohost diagnosis run yunohost diagnosis show --issues --human-readable ``` + [/ui-tab] [/ui-tabs] @@ -796,13 +810,15 @@ Go in Domains > Click on your domain > SSL Certificate [/ui-tab] [ui-tab title="From the command line"] + ``` yunohost domain cert install ``` + [/ui-tab] [/ui-tabs] -## ![](image://tada.png?resize=32&classes=inline) Congratz! +## ![](image://tada.png?resize=32&classes=inline) Congratz You now have a pretty well configured server. If you're new to YunoHost, we recommend to have a look at [the guided tour](/overview). You should also be able to [install your favourite applications](/apps). Don't forget to [plan backups](/backup) ! diff --git a/pages/02.administer/10.install/install.ru.md b/pages/02.administer/10.install/install.ru.md index 060545f1f..5a907e6fc 100644 --- a/pages/02.administer/10.install/install.ru.md +++ b/pages/02.administer/10.install/install.ru.md @@ -70,27 +70,27 @@ routes: [div class="flex-container"] [div class="flex-child hardware{%if virtualbox %} active{% endif %}"] -[[figure caption="VirtualBox"]![](image://virtualbox.png?height=75)[/figure]](/install/hardware:virtualbox) +[[figure caption="VirtualBox"]![][image://virtualbox.png?height=75](/figure)](/install/hardware:virtualbox) [/div] [div class="flex-child hardware{%if rpi012 or rpi34 %} active{% endif %}"] -[[figure caption="Raspberry Pi"]![](image://raspberrypi.png?height=75)[/figure]](/install/hardware:rpi34) +[[figure caption="Raspberry Pi"]![][image://raspberrypi.png?height=75](/figure)](/install/hardware:rpi34) [/div] [div class="flex-child hardware{%if arm_sup or (arm_unsup and not rpi012) or internetcube %} active{% endif %}"] -[[figure caption="ARM платы"]![](image://olinuxino.png?height=75)[/figure]](/install/hardware:arm) +[[figure caption="ARM платы"]![][image://olinuxino.png?height=75](/figure)](/install/hardware:arm) [/div] [div class="flex-child hardware{%if regular %} active{% endif %}"] -[[figure caption="Обычный компьютер"]![](image://computer.png?height=75)[/figure]](/install/hardware:regular) +[[figure caption="Обычный компьютер"]![][image://computer.png?height=75](/figure)](/install/hardware:regular) [/div] [div class="flex-child hardware{%if wsl %} active{% endif %}"] -[[figure caption="WSL"]![](image://wsl.png?height=75)[/figure]](/install/hardware:wsl) +[[figure caption="WSL"]![][image://wsl.png?height=75](/figure)](/install/hardware:wsl) [/div] [div class="flex-child hardware{%if vps_debian or vps_ynh %} active{% endif %}"] -[[figure caption="Удалённый сервер"]![](image://vps.png?height=75)[/figure]](/install/hardware:vps_debian) +[[figure caption="Удалённый сервер"]![][image://vps.png?height=75](/figure)](/install/hardware:vps_debian) [/div] [/div] @@ -98,56 +98,55 @@ routes: {% if rpi012 or rpi34 %} [div class="flex-child hardware{%if rpi34 %} active{% endif %}"] -[[figure caption="Raspberry Pi 3 или 4"]![](image://raspberrypi.png?height=50)[/figure]](/install/hardware:rpi34) +[[figure caption="Raspberry Pi 3 или 4"]![][image://raspberrypi.png?height=50](/figure)](/install/hardware:rpi34) [/div] [div class="flex-child hardware{%if rpi012 %} active{% endif %}"] -[[figure caption="Raspberry Pi 0, 1 или 2"]![](image://rpi1.png?height=50)[/figure]](/install/hardware:rpi012) +[[figure caption="Raspberry Pi 0, 1 или 2"]![][image://rpi1.png?height=50](/figure)](/install/hardware:rpi012) [/div] {% elseif show_legacy_arm_menu %} [div class="flex-child hardware{%if internetcube %} active{% endif %}"] -[[figure caption="Internet cube с VPN"]![](image://internetcube.png?height=50)[/figure]](/install/hardware:internetcube) +[[figure caption="Internet cube с VPN"]![][image://internetcube.png?height=50](/figure)](/install/hardware:internetcube) [/div] [div class="flex-child hardware{%if arm_sup and not internetcube %} active{% endif %}"] -[[figure caption="Olinuxino lime1&2 или Orange Pi PC+"]![](image://olinuxino.png?height=50)[/figure]](/install/hardware:arm_sup) +[[figure caption="Olinuxino lime1&2 или Orange Pi PC+"]![][image://olinuxino.png?height=50](/figure)](/install/hardware:arm_sup) [/div] [div class="flex-child hardware{%if arm_unsup %} active{% endif %}"] -[[figure caption="Другие платы"]![](image://odroidhc4.png?height=50)[/figure]](/install/hardware:arm_unsup) +[[figure caption="Другие платы"]![][image://odroidhc4.png?height=50](/figure)](/install/hardware:arm_unsup) [/div] {% elseif vps_debian or vps_ynh %} [div class="flex-child hardware{%if vps_debian %} active{% endif %}"] -[[figure caption="VPS или выделенный сервер с Debian 11"]![](image://debian-logo.png?height=50)[/figure]](/install/hardware:vps_debian) +[[figure caption="VPS или выделенный сервер с Debian 11"]![][image://debian-logo.png?height=50](/figure)](/install/hardware:vps_debian) [/div] [div class="flex-child hardware{%if vps_ynh %} active{% endif %}"] -[[figure caption="VPS или выделенный сервер с предустановленным YunoHost"]![](image://logo.png?height=50)[/figure]](/install/hardware:vps_ynh) +[[figure caption="VPS или выделенный сервер с предустановленным YunoHost"]![][image://logo.png?height=50](/figure)](/install/hardware:vps_ynh) [/div] {% endif %} [/div] - {% if hardware != '' %} {% if wsl %} !! Эта настройка в основном предназначена для локального тестирования продвинутыми пользователями. Из-за ограничений на стороне WSL (в частности, изменение IP-адреса) самостоятельный хостинг с него может быть сложным и здесь описываться не будет. {% endif %} - ## [fa=list-alt /] Предварительные условия {% if regular %} + * x86-совместимое оборудование, предназначенное для YunoHost: ноутбук, неттоп, нетбук, настольный компьютер с 512 МБ оперативной памяти и емкостью 16 ГБ (не менее) {% elseif rpi34 %} * Raspberry Pi 3 or 4 {% elseif rpi012 %} -* Raspberry Pi 0, 1 или 2 с ОЗУ не менее 512 МБ +* Raspberry Pi 0, 1 или 2 с ОЗУ не менее 512 МБ {% elseif internetcube %} * Orange Pi PC+ или Olinuxino Lime 1 или 2 * VPN с выделенным общедоступным IP-адресом и файлом `.cube` @@ -190,7 +189,9 @@ routes: {% endif %} {% if wsl %} + ## Вступление + WSL is a nice feature of Windows 10, making Linux pseudo-distributions available through command line. Let's say pseudo, because even though they are not really like virtual machines, they rely on virtualization capacities that make their integration with Windows almost seamless. Docker for Windows can now rely on WSL instead of Hyper-V, for example. @@ -216,7 +217,7 @@ rmdir .\debian -R You can now access it: run `wsl.exe -d YunoHost` -It is under Debian 9 Stretch, so let's upgrade it: +It is under Debian 9 Stretch, so let's upgrade it: ```bash # In WSL @@ -225,6 +226,7 @@ sudo apt update sudo apt upgrade sudo apt dist-upgrade ``` + ## Prevent WSL from tweaking configuration files Edit `/etc/wsl.conf` and put the following code in it: @@ -252,6 +254,7 @@ Debian on WSL does not have `systemd`, a service configuration software. This is a key element for YunoHost, and for any decent Debian distro (seriously MS, what the heck). Let's install it: 1. Install dotNET runtime: + ```bash # In WSL wget https://packages.microsoft.com/config/debian/11/packages-microsoft-prod.deb -O packages-microsoft-prod.deb @@ -263,6 +266,7 @@ sudo apt install -y dotnet-sdk-3.1 ``` 2. Install [Genie](https://github.com/arkane-systems/genie): + ```bash # In WSL # Add their repository @@ -291,8 +295,10 @@ Always call `genie -s` while starting your distro. `wsl -d YunoHost -e genie -s` -## Backup and restore the distro +## Backup and restore the distro + ### Make your first distro backup + As said before, there is no rollback capability. So let's export your fresh distro. In PowerShell: ``` @@ -307,10 +313,11 @@ cd ~ wsl --unregister YunoHost wsl --import YunoHost .\WSL\YunoHost .\WSL\YunoHost.tar.gz --version 2 ``` -{% endif %} +{% endif %} {% if vps_ynh %} + ## YunoHost VPS providers Here are some VPS providers supporting YunoHost natively : @@ -318,19 +325,19 @@ Here are some VPS providers supporting YunoHost natively : [div class="flex-container"] [div class="flex-child"] -[[figure caption="Alsace Réseau Neutre - FR"]![](image://vps_ynh_arn.png?height=50)[/figure]](https://vps.arn-fai.net) +[[figure caption="Alsace Réseau Neutre - FR"]![][image://vps_ynh_arn.png?height=50](/figure)]() [/div] [div class="flex-child"] -[[figure caption="FAImaison - FR"]![](image://vps_ynh_faimaison.svg?height=50)[/figure]](https://www.faimaison.net/services/vm.html) +[[figure caption="FAImaison - FR"]![][image://vps_ynh_faimaison.svg?height=50](/figure)]() [/div] [div class="flex-child"] -[[figure caption="ECOWAN - FR"]![](image://vps_ynh_ecowan.png?height=50)[/figure]](https://www.ecowan.fr/vps-linux) +[[figure caption="ECOWAN - FR"]![][image://vps_ynh_ecowan.png?height=50](/figure)]() [/div] [/div] {% endif %} - {% if at_home %} + ## [fa=download /] Download the {{image_type}} image {% if rpi012 %} @@ -396,7 +403,7 @@ $(document).ready(function () { .replace('%7Bimage%7D', infos.image) .replace('{image}', infos.image) .replace('{version}', infos.version); - + if (!infos.file.startsWith("http")) infos.file="https://build.yunohost.org/"+infos.file; html = html.replace(/%7Bfile%7D/g, infos.file).replace(/{file}/g, infos.file); @@ -413,17 +420,16 @@ $(document).ready(function () { }); - - - - - {% if not virtualbox %} {% if arm %} + ## ![microSD card with adapter](image://sdcard_with_adapter.png?resize=100,75&class=inline) Flash the {{image_type}} image + {% else %} + ## ![USB drive](image://usb_key.png?resize=100,100&class=inline) Flash the YunoHost image + {% endif %} Now that you downloaded the image of {{image_type}}, you should flash it on {% if arm %}a microSD card{% else %}a USB stick or a CD/DVD.{% endif %} @@ -457,6 +463,7 @@ Then run : # Replace /dev/mmcblk0 if the name of your device is different... dd if=/path/to/yunohost.img of=/dev/mmcblk0 ``` + [/ui-tab] {% if regular %} [ui-tab title="Burning a CD/DVD"] @@ -493,19 +500,12 @@ Go to **Settings** > **Network**: {% endif %} - - - - - - - - {% if arm %} + ## [fa=plug /] Power up the board * Plug the ethernet cable (one side on your main router, the other on your board). - * For advanced users willing to configure the board to connect to WiFi instead, see for example [here](https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md). + * For advanced users willing to configure the board to connect to WiFi instead, see for example [here](https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md). * Plug the SD card in your board * (Optional) You can connect a screen+keyboard directly on your board if you want to troubleshoot the boot process or if you're more comfortable to "see what happens" or want a direct access to the board. * Power up the board @@ -513,6 +513,7 @@ Go to **Settings** > **Network**: * Make sure that your computer (desktop/laptop) is connected to the same local network (i.e. same internet box) as your server. {% elseif virtualbox %} + ## [fa=plug /] Boot up the virtual machine Start the virtual machine after selecting the YunoHost image. @@ -521,17 +522,18 @@ Start the virtual machine after selecting the YunoHost image. ! If you encounter the error "VT-x is not available", you probably need to enable Virtualization in the BIOS of your computer. - {% else %} + ## [fa=plug /] Boot the machine on your USB stick * Plug the ethernet cable (one side on your main router, the other on your server). * Boot up your server with the USB stick or a CD-ROM inserted, and select it as **bootable device** by pressing one of the following keys (hardware specific): ``, ``, ``, ``, `` or ``. - * N.B. : if the server was previously installed with a recent version of Windows (8+), you first need to tell Windows, to "actually reboot". This can be done somewhere in "Advanced startup options". + * N.B. : if the server was previously installed with a recent version of Windows (8+), you first need to tell Windows, to "actually reboot". This can be done somewhere in "Advanced startup options". {% endif %} {% if regular or virtualbox %} + ## [fa=rocket /] Launch the graphical install You should see a screen like this: @@ -554,9 +556,10 @@ You should see a screen like this: The YunoHost project simplified the classic installation as much as possible in order to avoid as many people as possible being lost with questions that are too technical or related to specific cases. -With the expert mode installation, you have more possibilities, especially concerning the exact partitioning of your storage media. You can also decide to use the classic mode and [add your disks afterwards](/external_storage). +With the expert mode installation, you have more possibilities, especially concerning the exact partitioning of your storage media. You can also decide to use the classic mode and [add your disks afterwards](/external_storage). + +### Summary of the steps in expert mode -### Summary of the steps in expert mode: 1. Select `Expert graphical install`. 2. Select your language, location, keyboard layout and possibly your timezone. 3. Partition your disks. This is where you can set up a RAID or encrypt all or part of the server. @@ -582,32 +585,39 @@ If you have one or more hard drives to store data, you can choose to mount it on If you want flexibility and don't want to (re)size partitions, you can also choose to mount on `/mnt/hdd` and follow this [tutorial to mount all these folders with `mount --bind`](/external_storage). ### About encryption + Be aware that if you encrypt all or part of your disks, you will have to type the passphrase every time you restart your server, which can be a problem if you are not on site. There are however solutions (quite difficult to implement) that allow you to type the passphrase via SSH or via a web page (search for "dropbear encrypted disk"). ### About RAID + Keep in mind that: - * the disks in your RAIDs must be of different brands, wear and tear or batches (especially if they are SSDs) - * a RAID 1 (even without a spare) is more reliable than a RAID 5 from a probability point of view - * hardware raids are dependent on the raid card, if the card fails you will need a replacement to read and rebuild the array + +* the disks in your RAIDs must be of different brands, wear and tear or batches (especially if they are SSDs) +* a RAID 1 (even without a spare) is more reliable than a RAID 5 from a probability point of view +* hardware raids are dependent on the raid card, if the card fails you will need a replacement to read and rebuild the array [/ui-tab] [/ui-tabs] {% endif %} - {% if rpi012 %} + ## [fa=bug /] Connect to the board and hotfix the image + Raspberry Pi 1 and 0 are not totally supported due to [compilation issues for this architecture](https://github.com/YunoHost/issues/issues/1423). However, it is possible to fix by yourself the image before to run the initial configuration. To achieve this, you need to connect on your raspberry pi as root user [via SSH](/ssh) with the temporary password `yunohost`: + ``` ssh root@yunohost.local ``` + (or `yunohost-2.local`, and so on if multiple YunoHost servers are on your network) Then run the following commands to work around the metronome issue: + ``` mv /usr/bin/metronome{,.bkp} mv /usr/bin/metronomectl{,.bkp} @@ -616,6 +626,7 @@ ln -s /usr/bin/true /usr/bin/metronomectl ``` And this one to work around the upnpc issue: + ``` sed -i 's/import miniupnpc/#import miniupnpc/g' /usr/lib/moulinette/yunohost/firewall.py ``` @@ -623,6 +634,7 @@ sed -i 's/import miniupnpc/#import miniupnpc/g' /usr/lib/moulinette/yunohost/fir ! This last command need to be run after each yunohost upgrade :/ {% elseif arm_unsup %} + ## [fa=terminal /] Connect to the board Next you need to [find the local IP address of your server](/finding_the_local_ip) to connect as root user [via SSH](/ssh) with the temporary password `1234`. @@ -635,13 +647,13 @@ ssh root@192.168.x.xxx {% endif %} - {% if vps_debian or arm_unsup %} + ## [fa=rocket /] Run the install script -- Open a command line prompt on your server (either directly or [through SSH](/ssh)) -- Make sure you are root (or type `sudo -i` to become root) -- Run the following command: +* Open a command line prompt on your server (either directly or [through SSH](/ssh)) +* Make sure you are root (or type `sudo -i` to become root) +* Run the following command: ```bash curl https://install.yunohost.org | bash @@ -729,7 +741,6 @@ If you want to create subdomains, do not forget to add them in the `hosts` file This user replaces the old `admin` user, which some old documentation page may still refer to. In which case : just replace `admin` with your username. - ## [fa=stethoscope /] Run the initial diagnosis Once the postinstall is done, you should be able to actually log in the web admin interface using the credentials of the first user you just created. @@ -757,10 +768,12 @@ To run a diagnosis, go on Web Admin in the Diagnosis section. Click Run initial [/ui-tab] [ui-tab title="From the command line"] + ``` yunohost diagnosis run yunohost diagnosis show --issues --human-readable ``` + [/ui-tab] [/ui-tabs] @@ -781,13 +794,15 @@ Go in Domains > Click on your domain > SSL Certificate [/ui-tab] [ui-tab title="From the command line"] + ``` yunohost domain cert install ``` + [/ui-tab] [/ui-tabs] -## ![](image://tada.png?resize=32&classes=inline) Congratz! +## ![](image://tada.png?resize=32&classes=inline) Congratz You now have a pretty well configured server. If you're new to YunoHost, we recommend to have a look at [the guided tour](/overview). You should also be able to [install your favourite applications](/apps). Don't forget to [plan backups](/backup) ! diff --git a/pages/02.administer/15.admin_guide/05.guidelines/guidelines.de.md b/pages/02.administer/15.admin_guide/05.guidelines/guidelines.de.md index a8ec4025c..46346d12e 100644 --- a/pages/02.administer/15.admin_guide/05.guidelines/guidelines.de.md +++ b/pages/02.administer/15.admin_guide/05.guidelines/guidelines.de.md @@ -13,16 +13,18 @@ Diese Seite listet einige Tipps und Richtlinien auf, die jeder YunoHost-Administ Das heißt : Entweder ist der Server für den Betreib vorgesehen, oder ein Testserver, auf dem Sie sich erlauben, zu experimentieren. -Ist Ihr Ziel, einen Produktionserver zu benutzen, so beachten Sie folgendes : +Ist Ihr Ziel, einen Prsoduktionserver zu benutzen, so beachten Sie folgendes : + - ein Server ist ein empfindliches System : Seien Sie vorsichtig, methodisch und geduldig ; - experimentieren und Anpassen einschränken - insbesondere von Konfigurationsdateien ; - nicht Dutzende von Anwendungen installieren, bloß zum sehen, wie sie aussehen ; - Vorsicht mit inoffiziellen Anwendungen, und verzichten auf solche, die noch "in Bearbeitung" sind, oder einen Level 0 haben ; - wenn etwas kaputt geht, überlegen Sie richtig, bevor Sie versuchen, es selbst zu reparieren, wenn Sie nicht wissen, was Sie tun. (z. B., den Admin-Benutzer nicht selbst versuchen neu anzulegen, falls er komischerweise verschwunden ist.) -## Keep it simple ! +## Keep it simple YunoHost ist für allgemeine und einfache Anwendungsfälle konzipiert. Wenn Sie von diesen Bedingungen abweichen, wird es schwieriger, und Sie benötigen technisches Wissen, um sie zu erfüllen. Zum Beispiel: + - Versuchen Sie nicht, YunoHost in einem Kontext auszuführen, in dem Sie keine Kontrolle über die Ports 80 und 443 haben (oder überhaupt kein Internet); - Versuchen Sie nicht, fünf Server über dieselbe Internetverbindung zu hosten, wenn Sie nicht bereits ein fortgeschrittener Benutzer sind; - Reiben Sie sich nicht an dem Versuch auf, NGINX durch Apache zu ersetzen (oder beides gleichzeitig laufen zu lassen); @@ -45,7 +47,7 @@ Wenn Sie Dienste und Daten hosten, die für Ihre Benutzer wichtig sind, ist es w Als Administrator sollten Sie einen E-Mail-Client so einrichten, dass er E-Mails prüft, die an `root@your.domain.tld` (das muss ein Alias für den ersten von Ihnen hinzugefügten Benutzer sein) gesendet werden, oder sie an eine andere Adresse weiterleitet, die Sie aktiv prüfen. Diese E-Mails können Informationen darüber enthalten, was auf Ihrem Server passiert, wie z. B. periodische automatisierte Aufgaben. -## YunoHost ist freie Software, die von Freiwilligen instand gehalten wird. +## YunoHost ist freie Software, die von Freiwilligen instand gehalten wird Schließlich sollten Sie bedenken, dass YunoHost eine freie Software ist, die von Freiwilligen gepflegt wird - und dass das Ziel von YunoHost (die Demokratisierung des Selbst-Hostings) nicht einfach ist! Die Software wird ohne jegliche Garantie zur Verfügung gestellt. Das YunoHost Team tut sein Bestes, um das bestmögliche Erlebnis zu erhalten und zu bieten - dennoch sind die Funktionen, Anwendungen und YunoHost als Ganzes weit davon entfernt, perfekt zu sein, und Sie werden früher oder später auf kleine oder große Probleme stoßen. Wenn das passiert, kommen Sie bitte [in den Chat oder das Forum und bitten um Hilfe, oder melden das Problem](/help) :)! diff --git a/pages/02.administer/15.admin_guide/05.guidelines/guidelines.fr.md b/pages/02.administer/15.admin_guide/05.guidelines/guidelines.fr.md index f6e8c2b68..6714d9ca7 100644 --- a/pages/02.administer/15.admin_guide/05.guidelines/guidelines.fr.md +++ b/pages/02.administer/15.admin_guide/05.guidelines/guidelines.fr.md @@ -14,15 +14,17 @@ Cette page énumère quelques conseils et lignes directrices que tout administra En d'autres termes : votre serveur est soit un « serveur de production » (destiné à fonctionner), soit un serveur de test sur lequel vous vous permettez d'expérimenter. Si votre but est d'avoir un serveur de production : + - soyez conscient qu'un serveur est un système fragile : restez prudent, méthodique et patient ; - limitez les expérimentations et la personnalisation - notamment des fichiers de config ; - n'installez pas des douzaines d'applications juste pour voir de quoi elles ont l'air ; - utilisez les applications non-officielles avec prudence, et interdisez-vous d'utiliser celles marquées 'in progress', 'not working' ou qui sont en niveau 0 ; - si quelque chose casse, réfléchissez à deux fois avant de tenter de le réparer vous-même si vous ne savez pas ce que vous faites. (Par exemple, n'essayez pas de recréer vous-même l'utilisateur admin juste parce qu'il a mystérieusement disparu...) -## Keep it simple ! +## Keep it simple YunoHost est conçu pour fonctionner avec des cas d'utilisation généraux et simples. S'écarter de ces conditions rendra les choses plus difficiles et vous aurez besoin de connaissances techniques pour les faire fonctionner. Par exemple, + - n'essayez pas d'exécuter YunoHost dans un contexte où vous ne pouvez pas avoir le contrôle des ports 80 et 443 (ou pas d'Internet du tout) ; - n'essayez pas d'héberger cinq serveurs derrière la même connexion Internet si vous n'êtes pas déjà un utilisateur avancé ; - ne vous tourmentez pas à vouloir remplacer NGINX par Apache (ou faire tourner les deux à la fois) ; @@ -45,7 +47,7 @@ Si vous hébergez des services et des données qui sont importants pour vos util En tant qu'administrateur, vous devriez configurer un client de messagerie pour vérifier les e-mails envoyés à `root@votre.domaine.tld` (qui doit être un alias pour le premier utilisateur que vous avez ajouté) ou les transférer à une autre adresse que vous vérifiez activement. Ces courriels peuvent contenir des informations sur ce qui se passe sur votre serveur, comme les tâches périodiques automatisées. -## YunoHost est un logiciel gratuit, maintenu par des bénévoles. +## YunoHost est un logiciel gratuit, maintenu par des bénévoles Enfin, gardez à l'esprit que YunoHost est un logiciel libre maintenu par des volontaires - et que le but de YunoHost (démocratiser l'auto-hébergement) n'est pas simple ! Le logiciel est fourni sans aucune garantie. L'équipe de bénévoles fait de son mieux pour maintenir et fournir la meilleure expérience possible - pourtant les fonctionnalités, les applications et YunoHost dans son ensemble sont loin d'être parfaits et vous ferez face tôt ou tard à de petit ou gros problèmes. Lorsque cela se produit, venez gentiment [demander de l'aide sur le chat ou le forum, ou signaler le problème](/help) :) ! diff --git a/pages/02.administer/15.admin_guide/05.guidelines/guidelines.it.md b/pages/02.administer/15.admin_guide/05.guidelines/guidelines.it.md index bbce4194a..f0059b9bf 100644 --- a/pages/02.administer/15.admin_guide/05.guidelines/guidelines.it.md +++ b/pages/02.administer/15.admin_guide/05.guidelines/guidelines.it.md @@ -14,15 +14,17 @@ Questa pagina elenca qualche consiglio e delle linee guida che tutti gli amminis In altre parole: il tuo server può essere un "server in produzione" (destinato a funzionare), oppure un server di test che ti permette di sperimentare. Se il tuo obiettivo è avere un server in produzione: + - sii consapevole che i server sono sistemi fragili: sii prudente, metodico e paziente; - limita gli esperimenti e le personalizzazioni (per le istanze il file config) - non installare dozzine di installazioni solo per vedere come sono; - usa le applicazioni non ufficiali con prudenza, e evita di usare quelle 'in progress', 'not working' o che hanno un livello 0; - se qualcosa dovesse rompersi, pensate due volte prima di cercare di riparare da soli se non sapete quello che state facendo. (Per esempio, non tentate di ricreare da soli l'utente admin solo perché sembra che sia misteriosamente scomparso...) -## Keep it simple ! +## Keep it simple YunoHost è progettato per funzionare in casi d'uso generici e semplici. Deviare da queste condizioni renderà le cose più difficili e avrai bisogno di conoscenze tecniche perché tutto funzioni. Per esempio, + - non provare ad eseguire YunoHost in un contesto dove non puoi controllare le porte 80 e 443 (o senza Internet del tutto); - non provare a hostare cinque server dietro la stessa connessione Internet se non sei un utente esperto; - non cadere nei capricci dei nerd che vogliono sostituire NGINX con Apache (o farli girare tutti e due insieme); @@ -45,7 +47,7 @@ Se ospiti dei servizi e dei dati che sono importanti per i tuoi utenti, è impor Come amministratore, dovrai configurare un client di posta per controllare le mail inviate a `root@your.domani.tld` (che dovrà essere un alias per il primo utente che aggiungerai) o trasferitele ad un altro indirizzo mail che controlli attivamente. Queste mail possono contenere informazioni riguardo quello che avviene sul tuo server, come i compiti periodici automatici. -## YunoHost è software libero, mantenuto da volontari. +## YunoHost è software libero, mantenuto da volontari Infine, tieni presente che YunoHost è software libero mantenuto da volontari - e che l'obiettivo di YunoHost (democratizzare il self-hosting) non è semplice! Il software è fornito senza nessuna garanzia. Il team di volontari fa del suo meglio per mantenere e fornire la migliore esperienza possibile - quindi le funzionalità, le applicazioni e YunoHost nel suo insieme sono lontani dall'essere perfetti e presto o tardi incontrerai piccoli o grossi problemi. Quando accadrà potrai [chiedere aiuto sulla chat o nel forum, o segnalare il problema](/help) :)! diff --git a/pages/02.administer/15.admin_guide/05.guidelines/guidelines.md b/pages/02.administer/15.admin_guide/05.guidelines/guidelines.md index d4b3151fc..048c92223 100644 --- a/pages/02.administer/15.admin_guide/05.guidelines/guidelines.md +++ b/pages/02.administer/15.admin_guide/05.guidelines/guidelines.md @@ -13,19 +13,21 @@ This page lists some advice and guidelines which every YunoHost administrator sh To put it another way: your server is either a production server (meant to work) or a test server on which you allow yourself to experiment. -If your goal is to run a production server: +If your goal is to run a production server: + - be aware that servers are fragile system. Stay cautious, methodical and patient; - limit experimentations and customizations (for instance of config file); - do not install dozens of apps just to see how they look; - use non-official apps with caution, and do not use apps that are still 'in progress', 'not working' or level 0; - if something gets broken, think twice about fixing it by yourself if you don't know what you are doing. (For instance, do not attempt to recreate yourself the admin user just because it mysteriously disappeared...) -## Keep it simple! +## Keep it simple + +YunoHost is designed to work with general and simple use cases in mind. Deviating from those conditions will make things harder and you will need technical knowledge to make it work. For instance, -YunoHost is designed to work with general and simple use cases in mind. Deviating from those conditions will make things harder and you will need technical knowledge to make it work. For instance, -- do not try to run YunoHost in a context where you cannot have control over ports 80 and 443 (or no internet at all); -- do not try to host five servers behind the same internet connection if you are not already an advanced user; -- do not fall into nerd whims such as willing to replace NGINX with Apache (or run both at the same time); +- do not try to run YunoHost in a context where you cannot have control over ports 80 and 443 (or no internet at all); +- do not try to host five servers behind the same internet connection if you are not already an advanced user; +- do not fall into nerd whims such as willing to replace NGINX with Apache (or run both at the same time); - do not try to use custom SSL certificates if you don't really need them; - ... @@ -45,7 +47,7 @@ If you host services and data that are important for your users, it is important As an administrator, you should configure an email client to check emails sent to `root@your.domain.tld` (which should be an alias to the first user your added) or otherwise forward them to another address that you actively check. Those mails may contain information on what is happening on your server such as automated periodic tasks. -## YunoHost is free software, maintained by volunteers +## YunoHost is free software, maintained by volunteers Finally, keep in mind that YunoHost is a free software maintained by volunteers - and that the goal of YunoHost (to democratize self-hosting) is not an easy one! It is provided without any warranty. The team of volunteers does its best to maintain and provide the best possible experience - yet features, applications and YunoHost as a whole are far from being perfect and you will experience small and big shortcomings at some points. When this happens, kindly [reach for help on the chat or forum, or report the issue](/help)! :) diff --git a/pages/02.administer/15.admin_guide/10.admin/admin.de.md b/pages/02.administer/15.admin_guide/10.admin/admin.de.md index 84c362845..e2bbe2d5a 100644 --- a/pages/02.administer/15.admin_guide/10.admin/admin.de.md +++ b/pages/02.administer/15.admin_guide/10.admin/admin.de.md @@ -11,6 +11,6 @@ YunoHost hat ein Administrator-Webinterface. Die andere Möglichkeit, Ihre YunoH ### Zugang -Sie können auf Ihr Administrator-Webinterface unter folgender Adresse zugreifen: https://example.org/yunohost/admin (ersetzen Sie 'example.org' durch Ihren eigenen Domainnamen) +Sie können auf Ihr Administrator-Webinterface unter folgender Adresse zugreifen: (ersetzen Sie 'example.org' durch Ihren eigenen Domainnamen) ![](image://webadmin.png) diff --git a/pages/02.administer/15.admin_guide/10.admin/admin.es.md b/pages/02.administer/15.admin_guide/10.admin/admin.es.md index c95fa8805..f2668751f 100644 --- a/pages/02.administer/15.admin_guide/10.admin/admin.es.md +++ b/pages/02.administer/15.admin_guide/10.admin/admin.es.md @@ -11,6 +11,6 @@ YunoHost tiene una interfaz gráfica de administración. El otro método consist ### Acceso -La interfaz admin está accesible desde tu instancia YunoHost en esta dirección : https://ejemplo.org/yunohost/admin (reemplaza ejemplo.org por tu nombre de dominio) +La interfaz admin está accesible desde tu instancia YunoHost en esta dirección : (reemplaza ejemplo.org por tu nombre de dominio) ![](image://webadmin.png) diff --git a/pages/02.administer/15.admin_guide/10.admin/admin.fr.md b/pages/02.administer/15.admin_guide/10.admin/admin.fr.md index c8d0b2853..3d3f6d0e9 100644 --- a/pages/02.administer/15.admin_guide/10.admin/admin.fr.md +++ b/pages/02.administer/15.admin_guide/10.admin/admin.fr.md @@ -11,7 +11,6 @@ YunoHost est fourni avec une interface graphique d’administration (aussi appel ### Accès -L’interface d'administration web est accessible depuis votre instance YunoHost à l’adresse https://exemple.org/yunohost/admin (remplacez exemple.org par la bonne valeur) +L’interface d'administration web est accessible depuis votre instance YunoHost à l’adresse (remplacez exemple.org par la bonne valeur) ![](image://webadmin_fr.png) - diff --git a/pages/02.administer/15.admin_guide/10.admin/admin.it.md b/pages/02.administer/15.admin_guide/10.admin/admin.it.md index 035821445..93901cbb1 100644 --- a/pages/02.administer/15.admin_guide/10.admin/admin.it.md +++ b/pages/02.administer/15.admin_guide/10.admin/admin.it.md @@ -11,7 +11,6 @@ YunoHost ha un'interfaccia web di amministrazione. L'altro metodo è quello di u ### Accesso -L'interfaccia di amministrazione è accessibile all'indirizzo https://example.org/yunohost/admin (sostituisci 'example.org' con il tuo dominio) +L'interfaccia di amministrazione è accessibile all'indirizzo (sostituisci 'example.org' con il tuo dominio) ![](image://webadmin.png) - diff --git a/pages/02.administer/15.admin_guide/10.admin/admin.md b/pages/02.administer/15.admin_guide/10.admin/admin.md index 4b2f60042..5e917ba8c 100644 --- a/pages/02.administer/15.admin_guide/10.admin/admin.md +++ b/pages/02.administer/15.admin_guide/10.admin/admin.md @@ -11,6 +11,6 @@ YunoHost has an administrator web interface. The other way to administrate your ### Access -You can access your administrator web interface at this address: https://example.org/yunohost/admin (replace 'example.org' with your own domain name) +You can access your administrator web interface at this address: (replace 'example.org' with your own domain name) ![](image://webadmin.png) diff --git a/pages/02.administer/15.admin_guide/15.command_line/command_line.de.md b/pages/02.administer/15.admin_guide/15.command_line/command_line.de.md index 432597fc1..c018ee067 100644 --- a/pages/02.administer/15.admin_guide/15.command_line/command_line.de.md +++ b/pages/02.administer/15.admin_guide/15.command_line/command_line.de.md @@ -19,9 +19,10 @@ page-toc: #### Finde deine IP -Solltest du auf einem VPS installieren, dann hat der VPS Provider die IP-Adresse, die du bei ihm erfragen solltest. +Solltest du auf einem VPS installieren, dann hat der VPS Provider die IP-Adresse, die du bei ihm erfragen solltest. Wenn du Zuhause installierst (z.B. auf einem Raspberry Pi oder OLinuXino), dann musst du herausfinden, welche IP-Adresse dein Router dem System zugewiesen hat. Hierfür existieren mehrere Wege: + - Öffne ein Terminal und tippe `sudo arp-scan --local` ein, um eine Liste der aktiven IP-Adressen deines lokalen Netzwerks anzuzeigen; - wenn dir der arp-scan eine zu unübersichtliche Zahl an Adressen anzeigt, versuche mit `nmap -p 22 192.168.**x**.0/24` nur die anzuzeigen, deren SSH-Port 22 offen ist. (passe das **x** deinem Netzwerk an); - Prüfe die angezeigten Geräte in der Benutzeroberfläche deines Routers, ob du das Gerät findest; @@ -39,11 +40,11 @@ Es wird nach einem Passwort gefragt. Handelt es sich um einen VPS, sollte der VP ! Seit YunoHost 3.4 kann man sich nach dem Ausführen der Postinstallation nicht mehr als `root` anmelden. **Stattdessen sollte man sich mit dem `admin` Benutzer anmelden!** Für den Fall, dass der LDAP-Server defekt und der `admin` Benutzer nicht verwendbar ist, kann man sich eventuell trotzdem noch mit `root` über das lokale Netzwerk anmelden. -#### Ändere das Passwort! +#### Ändere das Passwort Nach dem allerersten Login sollte man das root Passwort ändern. Der Server könnte dazu automatisch auffordern. Falls nicht, ist der Befehl `passwd` zu benutzen. Es ist wichtig, ein einigermaßen starkes Passwort zu wählen. Beachte, dass das root Passwort durch das admin Passwort überschrieben wird, wenn man die Postinstallation durchführt. -#### Auf ans Konfigurieren! +#### Auf ans Konfigurieren Wir sind nun bereit, mit der [Postinstallation](/postinstall) zu beginnen. @@ -103,14 +104,13 @@ N.B.: `fail2ban` sperrt deine IP für 10 Minuten, wenn du 5 fehlgeschlagene Logi Eine ausführlichere Diskussion über Sicherheit & SSH findest du auf der [dedicated page](/security). - ## YunoHost Kommandozeile !!! Ein vollständiges Tutorial über die Kommandozeile würde den Rahmen der YunoHost-Dokumentation sprengen: Lies dazu am besten ein spezielles Tutorial wie [dieses](https://ryanstutorials.net/linuxtutorial/) oder [dieses](http://linuxcommand.org/). Aber sei versichert, dass du kein CLI-Experte sein musst, um es zu benutzen! Der Befehl "yunohost" kann zur Verwaltung deines Servers verwendet werden und führt verschiedene Aktionen aus, die denen des Webadmin ähneln. Der Befehl muss entweder vom `root`-Benutzer oder vom `admin`-Benutzer durch Voranstellen von `sudo` gestartet werden. (ProTip™ : Du kannst `root` mit dem Befehl `sudo su` als `admin` werden). -YunoHost-Befehle haben normalerweise diese Art von Struktur: +YunoHost-Befehle haben normalerweise diese Art von Struktur: ```bash yunohost app install wordpress --label Webmail @@ -119,7 +119,7 @@ yunohost app install wordpress --label Webmail category action argument options ``` -Zögere nicht, nach weiteren Informationen zu einer bestimmten Kategorie oder Aktion zu fragen, indem du die Option `--help` verwendest. Zum Beispiel listen diese Befehle : +Zögere nicht, nach weiteren Informationen zu einer bestimmten Kategorie oder Aktion zu fragen, indem du die Option `--help` verwendest. Zum Beispiel listen diese Befehle : ```bash yunohost --help diff --git a/pages/02.administer/15.admin_guide/15.command_line/command_line.es.md b/pages/02.administer/15.admin_guide/15.command_line/command_line.es.md index 5ed7c26f8..0b66dd8cc 100644 --- a/pages/02.administer/15.admin_guide/15.command_line/command_line.es.md +++ b/pages/02.administer/15.admin_guide/15.command_line/command_line.es.md @@ -21,7 +21,7 @@ La interfaz de línea de comandos (CLI) es, en informática, la manera original #### Encontrar su IP -Si instalas YunoHost en un VPS, tu proveedor debería haberte comunicado la dirección IP de tu servidor. +Si instalas YunoHost en un VPS, tu proveedor debería haberte comunicado la dirección IP de tu servidor. Si instalas un servidor en tu casa (por ejemplo en Raspberry Pi u OLinuXino), tienes que encontrar el IP que fue atribuido a tu tarjeta cuando la conectaste a tu router / caja Internet. Hay varias maneras de hacerlo : @@ -41,11 +41,10 @@ Ahora te piden una contraseña. Si es un VPS, tu proveedor ya te hará comunicad ! Desde YunoHost 3.4, después de la post-instalación ya no es posible conectarse con el usuario `root`. En lugar de eso, hace falta **conectarse con el usuario `admin`**. Incluso si el servidor LDAP fuera quebrado (haciendo que el usuario `admin` ya no fuera utilizable) todavía deberías poder conectarte con el usuario `root` desde la red local. -#### ¡ Cambiar la contraseña root ! +#### ¡ Cambiar la contraseña root Después de haberte conectado por primera vez, tienes que cambiar la contraseña `root`. Tal vez el servidor te pida automáticamente que lo hagas. Si no es el caso, hay que utilizar el comando `passwd`. Es muy importante que elijas una contraseña bastante complicada. Nota que esta contraseña luego estará reemplazada por la contraseña admin elegida durante la post-instalación. - ## En una instancia que ya está instalada Si instalaste tu servidor en casa y que quieres conectarte desde fuera de la red local, asegúrate que hayas previamente redirigido el puerto 22 de tu router / caja hacia tu servidor (con el usuario `admin` !) @@ -77,16 +76,19 @@ ssh -p 2244 admin@tu.dominio.tld Por defecto, sólo el usuario `admin` puede conectarse en SSH en una instancia YunoHost. Los usuarios YunoHost creados vea la interfaz de administración están administrados por la base de datos LDAP. Por defecto, no pueden conectarse en SSH por razones de seguridad. Si necesitas absolutamente que uno de estos usuarios disponga de un acceso SSH, puedes utilizar el comando : + ```bash yunohost user permission add ssh.main ``` Del mismo modo, es posible cancelar el acceso SSH de un usuario con el comando : + ```bash yunohost user permission remove ssh.main ``` Finalmente, es posible añadir, suprimir y listar llaves SSH, para mejorar la seguridad del acceso SSH, con estos comandos : + ```bash yunohost user ssh add-key yunohost user ssh remove-key diff --git a/pages/02.administer/15.admin_guide/15.command_line/command_line.fr.md b/pages/02.administer/15.admin_guide/15.command_line/command_line.fr.md index 19632c765..187fbf7ff 100644 --- a/pages/02.administer/15.admin_guide/15.command_line/command_line.fr.md +++ b/pages/02.administer/15.admin_guide/15.command_line/command_line.fr.md @@ -18,6 +18,7 @@ page-toc: L'interface en ligne de commande (CLI) est, en informatique, la manière originale (et plus technique) d'interagir avec un ordinateur, comparée aux interfaces graphiques. La ligne de commande est généralement considérée comme plus complète, puissante et efficace que les interfaces graphiques, bien que plus difficile à apprendre. ## Comment se connecter ? + ### Identifiant à utiliser [ui-tabs position="top-left" active="0" theme="lite"] @@ -38,9 +39,10 @@ Durant la post-installation, vous avez défini un mot de passe d'administration. ### Adresse à utiliser Si vous hébergez votre serveur **à la maison** (par ex. Raspberry Pi ou OLinuXino ou vieil ordinateur) - - vous devriez pouvoir vous connecter à la machine en utilisant `yunohost.local` (ou `yunohost-2.local`, selon le nombre de serveurs sur le réseau). - - si `yunohost.local` et consorts ne fonctionnent pas, il vous faut [trouver l'IP locale de votre serveur](/finding_the_local_ip). - - si vous avez installé votre serveur à la maison mais essayez d'y accéder depuis l'extérieur du réseau local, assurez-vous d'avoir bien configuré une redirection de port pour le port 22. + +- vous devriez pouvoir vous connecter à la machine en utilisant `yunohost.local` (ou `yunohost-2.local`, selon le nombre de serveurs sur le réseau). +- si `yunohost.local` et consorts ne fonctionnent pas, il vous faut [trouver l'IP locale de votre serveur](/finding_the_local_ip). +- si vous avez installé votre serveur à la maison mais essayez d'y accéder depuis l'extérieur du réseau local, assurez-vous d'avoir bien configuré une redirection de port pour le port 22. S'il s'agit d'une machine distante (VPS), votre fournisseur devrait vous avoir communiqué l'IP de votre machine. @@ -87,6 +89,7 @@ Si vous souhaitez ajouter une clé publique SSH à l'utilisateur, vous devez le [/ui-tab] [ui-tab title="À partir de la ligne de commande"] Pour autoriser un utilisateur ou un groupe à accéder en SFTP ou en SSH : + ```bash # SFTP yunohost user permission add sftp @@ -95,6 +98,7 @@ yunohost user permission add ssh ``` Pour enlever la permission : + ```bash # SFTP yunohost user permission remove sftp @@ -103,11 +107,13 @@ yunohost user permission remove ssh ``` Enfin, il est possible d'ajouter, de supprimer et de lister des clés SSH, pour améliorer la sécurité de l'accès SSH, avec les commandes : + ```bash yunohost user ssh add-key yunohost user ssh remove-key yunohost user ssh list-keys ``` + [/ui-tab] [/ui-tabs] @@ -143,25 +149,31 @@ yunohost user create --help vont successivement lister toutes les catégories disponibles, puis les actions de la catégorie `user`, puis expliquer comment utiliser l'action `user create`. Vous devriez remarquer que l'arbre des commandes YunoHost suit une structure similaire aux pages de la webadmin. ### La commande `yunopaste` + Cette commande est utile lorsque vous voulez communiquer à une autre personne le retour d'une commande. Exemple : + ```bash yunohost tools diagnosis | yunopaste ``` + ### Quelques commandes utiles Si votre interface web d'administration indique que l'API est injoignable, essayez de démarrer `yunohost-api` : + ```bash systemctl start yunohost-api ``` Si vous ne parvenez plus à vous connecter avec l'utilisateur `admin` via SSH et via l'interface web, le service `slapd` est peut-être éteint, essayez de le redémarrer : + ```bash systemctl restart slapd ``` Si vous avez des configurations modifiées manuellement et souhaitez connaître les modifications : + ```bash yunohost tools regen-conf --with-diff --dry-run ``` diff --git a/pages/02.administer/15.admin_guide/15.command_line/command_line.it.md b/pages/02.administer/15.admin_guide/15.command_line/command_line.it.md index 104f43ff8..c1bbc3313 100644 --- a/pages/02.administer/15.admin_guide/15.command_line/command_line.it.md +++ b/pages/02.administer/15.admin_guide/15.command_line/command_line.it.md @@ -22,6 +22,7 @@ page-toc: Se stai installando su un VPS allora il provider dovrebbe averti indicato il tuo indirizzo IP. Se stai installando su un computer casalingo (ad esempio un Raspberry Pi o un OLinuXino) devi individuare l'indirizzo IP che è stato attribuito al computer dopo averlo collegato al router. Questi sono alcuni sistemi: + - avvia un terminale e dai il comando `sudo arp-scan --local` per elencare gli indirizzi IP sulla rete locale; - usa l'interfaccia del router per vedere la lista dei computer collegati o controllane i log; - collega un monitor al tuo server YunoHost, fai login e digita `hostname --all-ip-address`. @@ -104,7 +105,7 @@ Una discussione più approfondita relativa a sicurezza & SSH è su [questa pagin The `yunohost` command can be used to administrate your server and perform the various actions similarly to what you do on the webadmin. The command must be launched either from the `root` user or from the `admin` user by preceeding them with `sudo`. (ProTip™ : you can become `root` with the command `sudo su` as `admin`). -YunoHost commands usually have this kind of structure : +YunoHost commands usually have this kind of structure : ```bash yunohost app install wordpress --label Webmail @@ -113,7 +114,7 @@ yunohost app install wordpress --label Webmail category action argument options ``` -Don't hesitate to browse and ask for more information about a given category or action using the the `--help` option. For instance, those commands : +Don't hesitate to browse and ask for more information about a given category or action using the the `--help` option. For instance, those commands : ```bash yunohost --help diff --git a/pages/02.administer/15.admin_guide/15.command_line/command_line.md b/pages/02.administer/15.admin_guide/15.command_line/command_line.md index 99f6de1b4..23ec08b8c 100644 --- a/pages/02.administer/15.admin_guide/15.command_line/command_line.md +++ b/pages/02.administer/15.admin_guide/15.command_line/command_line.md @@ -18,8 +18,8 @@ page-toc: The command line interface (CLI) is, in the computer world, the original (and more technical) way of interacting with a computer compared to graphical interface. Command line interfaces are generally said to be more complete, powerful or efficient than a graphical interface, though also more difficult to learn. ## How to connect -### Login credentials +### Login credentials [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="Before running the initial configuration (post-installation)"] @@ -39,19 +39,18 @@ During the postinstall, you've been asked to choose an administration password. ### Address to use If you are **installing at home** (e.g. on a Raspberry Pi or OLinuXino or old computer): - - you should be able to connect to your server using `yunohost.local` (or `yunohost-2.local`, depending on how many servers are on your network). - - if `yunohost.local` and the like do not work, your need to [find out the local IP of the server](/finding_the_local_ip). - - if you installed a server at home but are attempting to connect from outside your local network, make sure port 22 is correctly forwarded to your server. +- you should be able to connect to your server using `yunohost.local` (or `yunohost-2.local`, depending on how many servers are on your network). +- if `yunohost.local` and the like do not work, your need to [find out the local IP of the server](/finding_the_local_ip). +- if you installed a server at home but are attempting to connect from outside your local network, make sure port 22 is correctly forwarded to your server. If your server is a remote server (VPS), your provider should have communicated you the IP address of the machine In any cases, if you already configured a domain name pointing to the appropriate IP, it's much better to use `yourdomain.tld` instead of the IP address. - ### Connecting -The SSH command typically looks like: +The SSH command typically looks like: ```bash # before the postinstall: @@ -76,7 +75,7 @@ N.B. : `fail2ban` will ban your IP for 10 minutes if you perform 10 failed login By default, only the `admin` user can log in to YunoHost SSH server. -YunoHost's users created via the administration interface are managed by the LDAP directory. By default, they can't connect via SSH for security reasons. Via the permissions system it is possible to allow the connection in SFTP or if it is really necessary in SSH. +YunoHost's users created via the administration interface are managed by the LDAP directory. By default, they can't connect via SSH for security reasons. Via the permissions system it is possible to allow the connection in SFTP or if it is really necessary in SSH. ! Be careful who you give SSH access to. This increases even more the attack surface available to a malicious user. @@ -90,6 +89,7 @@ If you want to add an SSH public key to the user, you have to do it from the com [/ui-tab] [ui-tab title="From the command line"] To allow a user or group to access via SFTP or SSH: + ```bash # SFTP yunohost user permission add sftp @@ -98,6 +98,7 @@ yunohost user permission add ssh ``` To remove permission: + ```bash # SFTP yunohost user permission remove sftp @@ -106,15 +107,16 @@ yunohost user permission remove ssh ``` Finally, it is possible to add, delete and list SSH keys, to improve SSH access security, using the commands: + ```bash yunohost user ssh add-key yunohost user ssh remove-key yunohost user ssh list-keys ``` + [/ui-tab] [/ui-tabs] - ## Security and SSH A more extensive discussion about security & SSH can be found on the [dedicated page](/security). @@ -127,7 +129,7 @@ A more extensive discussion about security & SSH can be found on the [dedicated The `yunohost` command can be used to administer your server and perform the various actions similarly to what you do on the webadmin. The command must be launched either from the `root` user or from the `admin` user by preceeding them with `sudo`. (ProTip™ : you can become `root` with the command `sudo su` as `admin`). -YunoHost commands usually have this kind of structure : +YunoHost commands usually have this kind of structure : ```bash yunohost app install wordpress --label Webmail @@ -136,7 +138,7 @@ yunohost app install wordpress --label Webmail category action argument options ``` -Don't hesitate to browse and ask for more information about a given category or action using the the `--help` option. For instance, those commands : +Don't hesitate to browse and ask for more information about a given category or action using the the `--help` option. For instance, those commands : ```bash yunohost --help @@ -147,16 +149,18 @@ yunohost user create --help will successively list all the categories available, then the actions available in the `user` category, then the usage of the action `user create`. You might notice that the YunoHost command tree is built with a structure similar to the YunoHost admin pages. ### The `yunopaste` command + This command allow you to share with an other person the output of a command. Example: + ```bash yunohost tools diagnosis | yunopaste ``` ### The `ynh-vpnclient-loadcubefile.sh` command -This command is only available if you have the `VPN Client` application installed. You can use it to load a new .cube in case you can't get to the VPN Client interface to do so. +This command is only available if you have the `VPN Client` application installed. You can use it to load a new .cube in case you can't get to the VPN Client interface to do so. ```bash ynh-vpnclient-loadcubefile.sh -u -p -c .cube @@ -165,16 +169,19 @@ ynh-vpnclient-loadcubefile.sh -u -p -c .cube ### Some useful commands If your administration web interface indicates that the API is unreachable, try starting `yunohost-api`: + ```bash systemctl start yunohost-api ``` If you can no longer connect with the user `admin` via SSH and via the web interface, the `slapd` service may be down, try restarting it: + ```bash systemctl restart slapd ``` If you have manually modified configurations and want to know the changes: + ```bash yunohost tools regen-conf --with-diff --dry-run ``` diff --git a/pages/02.administer/15.admin_guide/20.users/05.groups_and_permissions/groups_and_permissions.fr.md b/pages/02.administer/15.admin_guide/20.users/05.groups_and_permissions/groups_and_permissions.fr.md index e907cc917..bbf357750 100644 --- a/pages/02.administer/15.admin_guide/20.users/05.groups_and_permissions/groups_and_permissions.fr.md +++ b/pages/02.administer/15.admin_guide/20.users/05.groups_and_permissions/groups_and_permissions.fr.md @@ -19,17 +19,18 @@ L'utilisation de groupes est cependant utile pour la sémantique, par exemple si Il est également possible de définir des alias mail pour un groupe, afin que les mails envoyés à `groupe@domain.tld` soient redirigés vers tous les membres du groupe. - ### Groupes par défaut + Par défaut, deux groupes spéciaux sont créés : + - `all_users`, qui contient tous les utilisateurs enregistrés sur YunoHost, -- `visitors`, c'est-à-dire les personnes qui consultent le serveur sans être connectées. +- `visitors`, c'est-à-dire les personnes qui consultent le serveur sans être connectées. - `admins`, apparut depuis Yunohost 11.1, ce groupe permet de gérer les administrateurs de la machine, chaque utilisateur aura alors (selon la configuration du serveur) accès en SSH ainsi que la webadmin. Vous ne pouvez pas changer le contenu de ces groupes, seulement les permissions qui leur sont accordées. - ### Lister les groupes existants + [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="À partir de l'interface web"] Les groupes existants sont listés en haut de la page *groupes et autorisations*. @@ -40,7 +41,6 @@ Les groupes existants sont listés en haut de la page *groupes et autorisations* [ui-tab title="À partir de la ligne de commande"] Pour obtenir la liste des groupes existants en ligne de commande : - ```shell $ yunohost user group list groups: @@ -51,10 +51,12 @@ groups: - charlie - delphine ``` + [/ui-tab] [/ui-tabs] ### Créer un nouveau groupe + [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="À partir de l'interface web"] Pour créer un nouveau groupe, il suffit de cliquer sur le bouton "Nouveau groupe" en haut de la page. Vous ne pouvez choisir qu'un nom formé de lettres (majuscules et minuscules) et d'espaces. Le groupe est créé vide et sans aucune permission. @@ -66,12 +68,14 @@ Pour créer un nouveau groupe, il suffit de cliquer sur le bouton "Nouveau group Dans la ligne de commande, pour créer un nouveau groupe appelé `yolo_crew`, il faut utiliser ```shell -$ yunohost user group create yolo_crew +yunohost user group create yolo_crew ``` + [/ui-tab] [/ui-tabs] ### Mettre à jour un groupe + [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="À partir de l'interface web"] Ajoutons un premier utilisateur à ce groupe : dans le panneau du groupe, cliquez sur le bouton "Ajouter un utilisateur" et faites défiler jusqu'à l'utilisateur souhaité, puis cliquez dessus. @@ -87,7 +91,7 @@ Pour supprimer un utilisateur, cliquez sur la croix à côté de son nom d'utili En ligne de commande, utilisez la commande suivante pour ajouter `charlie` et `delphine` au groupe `yolo_crew` : ```shell -$ yunohost user group add yolo_crew charlie delphine +yunohost user group add yolo_crew charlie delphine ``` (De même, `remove` peut être utilisé pour retirer des membres d'un groupe.) @@ -108,6 +112,7 @@ groups: - charlie - delphine ``` + [/ui-tab] [/ui-tabs] @@ -125,8 +130,9 @@ Pour supprimer un groupe, cliquez sur la croix rouge en haut à droite du pannea Pour supprimer le groupe `yolo_crew` en ligne de commande, vous pouvez exécuter : ```shell -$ yunohost user group delete yolo_crew +yunohost user group delete yolo_crew ``` + [/ui-tab] [/ui-tabs] @@ -145,6 +151,7 @@ La page des groupes liste les permissions données à chaque groupe, y compris l [/ui-tab] [ui-tab title="À partir de la ligne de commande"] Pour répertorier les permissions et les accès correspondants en ligne de commande : + ```shell $ yunohost user permission list permissions: @@ -157,6 +164,7 @@ permissions: xmpp.main: allowed: all_users ``` + Ici, nous constatons que tous les utilisateurs enregistrés peuvent utiliser le mail, 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 adresses web associées à une permission (pertinent pour les applications web). @@ -182,13 +190,13 @@ Notez que, par exemple, si nous voulons restreindre la permission pour le mail a Pour permettre à un groupe d'accéder à l'interface d'administration de WordPress via la ligne de commande : ```shell -$ yunohost user permission update wordpress.admin --add yolo_crew +yunohost user permission update wordpress.admin --add yolo_crew ``` Vous pouvez également autoriser un seul utilisateur : ```shell -$ yunohost user permission update wordpress.admin --add alice +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 : @@ -206,7 +214,7 @@ $ yunohost user permission list Pour permettre seulement à Bob d'accéder aux emails en ligne de commande : ```shell -$ yunohost user permission update mail --remove all_users --add bob +yunohost user permission update mail --remove all_users --add bob ``` [/ui-tab] @@ -235,12 +243,13 @@ En ligne de commande, le même genre de chose peut être fait avec : # Activer la tuile pour l'interface d'admin de WordPress $ yunohost user permission update wordpress.admin --show_tile True ``` + [/ui-tab] [/ui-tabs] - ### Gérer les alias des groupes -Chaque groupe peut utiliser des alias de mail, bien que leur configuration se fasse actuellement uniquement depuis la CLI. Par défaut, le groupe `admins` dispose ainsi de `admins@domain.tld`, `root@domain.tld` ... : les messages envoyés à ces adresses sont redirigés vers tous les membres du groupe `admins`. + +Chaque groupe peut utiliser des alias de mail, bien que leur configuration se fasse actuellement uniquement depuis la CLI. Par défaut, le groupe `admins` dispose ainsi de `admins@domain.tld`, `root@domain.tld` ... : les messages envoyés à ces adresses sont redirigés vers tous les membres du groupe `admins`. L'utilisation de la commande `yunohost user group info` permet de lister tous les alias pour le groupe renseigné. @@ -258,6 +267,7 @@ $ yunohost user group info admins ``` Il est possible de les ajouter avec l'action `add-mailalias` ou de les enlever avec `remove-mailalias`. + ```shell -$ yunohost user group add-mailalias +yunohost user group add-mailalias ``` diff --git a/pages/02.administer/15.admin_guide/20.users/05.groups_and_permissions/groups_and_permissions.md b/pages/02.administer/15.admin_guide/20.users/05.groups_and_permissions/groups_and_permissions.md index 587d25ac3..e5b53f18f 100644 --- a/pages/02.administer/15.admin_guide/20.users/05.groups_and_permissions/groups_and_permissions.md +++ b/pages/02.administer/15.admin_guide/20.users/05.groups_and_permissions/groups_and_permissions.md @@ -20,12 +20,12 @@ Using groups is however useful for semantics, for example if you host multiple g It's also possible to define mail aliases for a group, such that mails sent to `groupe@domain.tld` will be dispatched to all members of the group. - ### Default groups By default, two special groups are created: + - `all_users`, that contain all users registered on YunoHost, -- `visitors`, that applies to people viewing the server while not logged in. +- `visitors`, that applies to people viewing the server while not logged in. The content of those groups cannot be changed, only the permissions given to them. @@ -52,6 +52,7 @@ groups: - charlie - delphine ``` + [/ui-tab] [/ui-tabs] @@ -68,8 +69,9 @@ To create a new group, simply click on the "New Group" button at the top of the In CLI, to create a new group called `yolo_crew` ```shell -$ yunohost user group create yolo_crew +yunohost user group create yolo_crew ``` + [/ui-tab] [/ui-tabs] @@ -90,7 +92,7 @@ To remove a user, click on the cross next to their username, in the group panel. In CLI, use the following command to add `charlie` and `delphine`to the `yolo_crew` group: ```shell -$ yunohost user group add yolo_crew charlie delphine +yunohost user group add yolo_crew charlie delphine ``` (similarly, `remove` can be used to remove members from a group) @@ -111,6 +113,7 @@ groups: - charlie - delphine ``` + [/ui-tab] [/ui-tabs] @@ -127,8 +130,9 @@ To delete a group, click on the red cross on the top right of the group panel. Y To delete the group `yolo_crew` in CLI, you may run ```shell -$ yunohost user group delete yolo_crew +yunohost user group delete yolo_crew ``` + [/ui-tab] [/ui-tabs] @@ -184,13 +188,13 @@ Note that you can also allow a single user, by using the specific panel at the b To allow a group to access the WordPress admin interface in CLI: ```shell -$ yunohost user permission update wordpress.admin --add yolo_crew +yunohost user permission update wordpress.admin --add yolo_crew ``` Note that you can also allow a single user, by using the specific panel at the bottom of the page. ```shell -$ yunohost user permission update wordpress.admin --add alice +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: @@ -208,8 +212,9 @@ $ 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: ```shell -$ yunohost user permission update mail --remove all_users --add bob +yunohost user permission update mail --remove all_users --add bob ``` + [/ui-tab] [/ui-tabs] @@ -224,7 +229,7 @@ The webadmin will issue a warning if you set a permission that is superseded by Since YunoHost 4.1, you can choose to hide/display specific tiles in the SSO. [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="From the web interface"] -In the webadmin, you can do so by going in the corresponding app view, go in `Manage label and tiles` and check/uncheck the option `Display the tile in the user portal` for the corresponding permission. +In the webadmin, you can do so by going in the corresponding app view, go in `Manage label and tiles` and check/uncheck the option `Display the tile in the user portal` for the corresponding permission. [/ui-tab] [ui-tab title="From the command line"] @@ -235,11 +240,12 @@ In command line, this may be done with: # Enable the tile for the WordPress admin interface $ yunohost user permission update wordpress.admin --show_tile True ``` + [/ui-tab] [/ui-tabs] - ### Config alias group + Each group can use mail aliases, but their configuration is only available from the CLI so far. For example, the `admins` group is configured with aliases such as `admins@domain.tld`, `root@domain.tld` ... : mail sent to these addresses will be dispatched to all members of the `admins` group. The command `yunohost user group info` will list them. @@ -258,6 +264,7 @@ $ yunohost user group info admins ``` To add a new mail, use the action `add-mailalias` or `remove-mailalias` to delete it. + ```shell -$ yunohost user group add-mailalias +yunohost user group add-mailalias ``` diff --git a/pages/02.administer/15.admin_guide/20.users/users.fr.md b/pages/02.administer/15.admin_guide/20.users/users.fr.md index 64696fe8b..e24b3813d 100644 --- a/pages/02.administer/15.admin_guide/20.users/users.fr.md +++ b/pages/02.administer/15.admin_guide/20.users/users.fr.md @@ -34,4 +34,3 @@ Voir [cette page de documentation dédiée](/groups_and_permissions). ## Accès SSH Voir [cette page de documentation dédiée](/ssh). - diff --git a/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.de.md b/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.de.md index acca9712f..55a8e7481 100644 --- a/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.de.md +++ b/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.de.md @@ -37,7 +37,7 @@ Wurde der Domain-Name vor kurzem hinzugefügt, so steht ein selbst-signiertes Ze ![](image://certificate-before-LE.png) -Wenn die Domain korrekt konfiguriert ist, dann ist es möglich +Wenn die Domain korrekt konfiguriert ist, dann ist es möglich mit dem grünen Knopf ein Let's Encrypt-Zertifikat einzusetzen. ![](image://certificate-after-LE.png) @@ -52,7 +52,7 @@ von Let's Encrypt zu überprüfen. Das digitale Zertifikat wird automatisch etwa SSH-Zugang auf Ihrem Server herstellen. -So können Sie den aktuellen Status des digitalen Zertifikats überprüfen +So können Sie den aktuellen Status des digitalen Zertifikats überprüfen ```bash yunohost domain cert-status Ihre.domain.tld @@ -91,5 +91,3 @@ manschmal die Einstellungen verweigern. In diesem Fall ist es notwendig : - die Parameter `127.0.0.1 Ihre.domain.tld` auf der Datei `/etc/hosts` des Webserver hinzufügen. Wenn es immer noch nicht funktionsfähig ist, also die Überprüfungen deaktivieren mit `--no-checks` nach dem Befehl `cert-install`. - - diff --git a/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.es.md b/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.es.md index 3d1b2d80d..bc887a5d1 100644 --- a/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.es.md +++ b/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.es.md @@ -47,7 +47,7 @@ Una vez la instalación terminada, puedes ir a tu dominio vía tu navegador, en Conectate en tu servidor en SSH. -Puedes comprobar el estatus corriente de tu certificado vía +Puedes comprobar el estatus corriente de tu certificado vía ```bash yunohost domain cert-status tu.dominio.tld diff --git a/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.it.md b/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.it.md index 04a6894e6..b8719133e 100644 --- a/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.it.md +++ b/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.it.md @@ -19,7 +19,7 @@ Il browser fondamentalmente ci chiede **«Potete fidarvi del server che ospita q Per evitare questa situazione è possibile ottenere un certificato riconosciuto dai browser e firmato da un'autorità conosciuta come **Let's Encrypt**, **Gandi**, **RapidSSL**, **StartSSL**, **Cacert**. -In particolare **Let's Encrypt** offre i certificati gratuitamente. Dalla versione 2.5 YunoHost permette di installare il certificato direttamente dall'interfaccia di amministrazione web o da linea di comando. Di seguito troverete la documentazione per l'installazione e la gestione di un certificato. È comunque possibile [installare ugualmente un certificato di un'autorità diversa da Let's Encrypt](/certificate_custom). +In particolare **Let's Encrypt** offre i certificati gratuitamente. Dalla versione 2.5 YunoHost permette di installare il certificato direttamente dall'interfaccia di amministrazione web o da linea di comando. Di seguito troverete la documentazione per l'installazione e la gestione di un certificato. È comunque possibile [installare ugualmente un certificato di un'autorità diversa da Let's Encrypt](/certificate_custom). ### Installare un certificato Let's Encrypt @@ -35,7 +35,6 @@ Recatevi nella sezione 'Domini' dell'interfaccia di amministrazione, scegliete l ![](image://domain-certificate-button.png) - Nella sezione 'Certificati SSL' potere visualizzare lo stato attuale del certificato. Se avete appena creato il dominio, esso disporrà di un certificato auto firmato. diff --git a/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.md b/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.md index 2c6144cdd..fe8b57fec 100644 --- a/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.md +++ b/pages/02.administer/15.admin_guide/25.domains/01.certificate/certificate.md @@ -83,4 +83,3 @@ If YunoHost thinks that your domain is badly configured despite the fact that yo - add a line `127.0.0.1 your.domain.tld` to the file `/etc/hosts` on your server; - if the certificate installation still doesn't work, you can disable the checks with `--no-checks` after the `cert-install` command. - diff --git a/pages/02.administer/15.admin_guide/25.domains/domains.de.md b/pages/02.administer/15.admin_guide/25.domains/domains.de.md index 905fc39a4..955b4893b 100644 --- a/pages/02.administer/15.admin_guide/25.domains/domains.de.md +++ b/pages/02.administer/15.admin_guide/25.domains/domains.de.md @@ -19,7 +19,7 @@ Beachten Sie abschließend, dass es im Kontext von YunoHost keine Hierarchie zwi ## Nicht-lateinische Zeichen -Wenn Ihre Domain spezielle, nicht-lateinische Zeichen enthält, müssen Sie ihre [internationalisierte Version](https://de.wikipedia.org/wiki/Internationalisierter_Domainname) über [Punycode](https://de.wikipedia.org/wiki/Punycode) verwenden. Sie können [diesen Konverter](https://www.charset.org/punycode) verwenden und den konvertierten Domainnamen in Ihrer YunoHost-Konfiguration verwenden. +Wenn Ihre Domain spezielle, nicht-lateinische Zeichen enthält, müssen Sie ihre [internationalisierte Version](https://de.wikipedia.org/wiki/Internationalisierter_Domainname) über [Punycode](https://de.wikipedia.org/wiki/Punycode) verwenden. Sie können [diesen Konverter](https://www.charset.org/punycode) verwenden und den konvertierten Domainnamen in Ihrer YunoHost-Konfiguration verwenden. ## Subdomains @@ -28,7 +28,7 @@ Wenn Ihre Domain spezielle, nicht-lateinische Zeichen enthält, müssen Sie ihre ## DNS-Konfiguration -DNS (Domain Name System) ist ein System, das es Computern auf der ganzen Welt ermöglicht, von Menschen lesbare Domain-Namen (wie z.B. `yolo.com`) in maschinenverständliche Adressen, sogenannte IP-Adressen (wie z.B. `11.22.33.44`), zu übersetzen. Damit diese Übersetzung (und andere Funktionen) funktioniert, müssen Sie DNS-Einträge sorgfältig konfigurieren. +DNS (Domain Name System) ist ein System, das es Computern auf der ganzen Welt ermöglicht, von Menschen lesbare Domain-Namen (wie z.B. `yolo.com`) in maschinenverständliche Adressen, sogenannte IP-Adressen (wie z.B. `11.22.33.44`), zu übersetzen. Damit diese Übersetzung (und andere Funktionen) funktioniert, müssen Sie DNS-Einträge sorgfältig konfigurieren. YunoHost kann eine empfohlene DNS-Konfiguration für jede Domain generieren, einschließlich der für Mail und XMPP benötigten Elemente. Die empfohlene DNS-Konfiguration ist im Webadmin über Domain > (die Domain) > DNS-Konfiguration oder mit dem Befehl `yunohost domain dns-conf the.domain.tld` verfügbar. @@ -40,7 +40,7 @@ Ein weiterer wichtiger Aspekt der Domain-Konfiguration ist das SSL/HTTPS-Zertifi !!!! Section to be moved to a translated /apps_overview page -Im Zusammenhang mit YunoHost ist es durchaus üblich, eine einzige (oder einige wenige) Domains zu haben, auf denen mehrere Anwendungen in "Unterpfaden" installiert sind, so dass man am Ende etwas wie dieses erhält: +Im Zusammenhang mit YunoHost ist es durchaus üblich, eine einzige (oder einige wenige) Domains zu haben, auf denen mehrere Anwendungen in "Unterpfaden" installiert sind, so dass man am Ende etwas wie dieses erhält: ```bash yolo.com diff --git a/pages/02.administer/15.admin_guide/25.domains/domains.fr.md b/pages/02.administer/15.admin_guide/25.domains/domains.fr.md index 3706d12e2..3527d1b54 100644 --- a/pages/02.administer/15.admin_guide/25.domains/domains.fr.md +++ b/pages/02.administer/15.admin_guide/25.domains/domains.fr.md @@ -42,7 +42,7 @@ Le chiffre risque de changer selon quel serveur démarre en premier, donc ne com ## 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. +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 Domaines > (le domaine) > configuration DNS, ou avec la commande `yunohost domain dns-conf the.domain.tld`. diff --git a/pages/02.administer/15.admin_guide/25.domains/domains.it.md b/pages/02.administer/15.admin_guide/25.domains/domains.it.md index c5b5f3409..3402e1b10 100644 --- a/pages/02.administer/15.admin_guide/25.domains/domains.it.md +++ b/pages/02.administer/15.admin_guide/25.domains/domains.it.md @@ -9,7 +9,7 @@ routes: Yunohost permette l'installazione e la gestione di più domini sullo stesso server. Potrete quindi ospitare, ad esempio, un blog e una istanza Nextcloud sul dominio primario yolo.com, e un altro servizio su un secondo dominio swag.nohost.me. Ogni dominio viene automaticamente configurato affinché possa gestire i servizi web, le mail, e un servizio di chat XMPP. -I domini possono essere configurati a partire dalla sezione 'Domini' della pagina di amministrazione web, o attraverso la sezione `yunohost domain` da linea di comando. +I domini possono essere configurati a partire dalla sezione 'Domini' della pagina di amministrazione web, o attraverso la sezione `yunohost domain` da linea di comando. Ogni volta che aggiungete un dominio, sia esso vostro o del quale abbiate facoltà di gestione, dovete averne il pieno controllo per la poter effettuare la sua [configurazione DNS](/dns_config). Fanno eccezione i [domini in .nohost.me, .noho.st et ynh.fr](/dns_nohost_me) offerti dal progetto YunoHost, che possono essere direttamente integrati nel vostro server YunoHost grazie alla configurazione automatica di un servizio DynDns. Al fine di impedire abusi e limitare i costi, una instanza YunoHost può essere configurata con un solo dominio offerto, tuttavia potete aggiungere tutti i suoi sotto domini che desiderate. Ad esempio, se scegliete il dominio `exemple.ynh.fr` potrete in un secondo tempo aggiungere i domini `video.exemple.ynh.fr` o `www.exemple.ynh.fr` o qualsiasi altro sottodominio che possa servirvi. @@ -49,10 +49,3 @@ YunoHost può generare una configurazione DNS raccomandata per ogni dominio che ## Certificati SSL/HTTPS Un altro importante aspetto della configurazione dei domini è quello riguardante il certificato SSL/HTTPS. YuhoHost integra Let's Encrypt, potete installare il certificato e impostare il rinnovo automatico. La documentazione relativa e altre informazioni si trovano alla pagina [certificati](/certificate). - - - - - - - diff --git a/pages/02.administer/15.admin_guide/25.domains/domains.md b/pages/02.administer/15.admin_guide/25.domains/domains.md index 359f4b5dd..7cd41d236 100644 --- a/pages/02.administer/15.admin_guide/25.domains/domains.md +++ b/pages/02.administer/15.admin_guide/25.domains/domains.md @@ -26,6 +26,7 @@ Domains can be managed in the 'Domain' section of the webadmin, or through the ` In order to make self-hosting as accessible as possible, the YunoHost Project provides a *free* and *automatically configured* domain name service. By using this service, you won't have to [configure DNS records](/dns_config) yourself, which can be tedious and technical. The following (sub)domains are offered: + - `whateveryouwant.nohost.me`; - `whateveryouwant.noho.st`; - `whateveryouwant.ynh.fr`. @@ -46,19 +47,17 @@ To get one of this domain you simply need to choose `I don't have a domaine name [ui-tab title="Your own domains"] Having your own domain brings several advantages: - * more control and autonomy - * simpler domain name (for example directly in .net or .org) +- more control and autonomy +- simpler domain name (for example directly in .net or .org) However, you have to pay for it each year (about 15€/year) and you have to do some extra configuration to [setup a correct DNS zone](/dns_config). Our diagnosis tool can trigger alert to help you to do this configuration. -If you already have your own domain, you can simply click "I already have a domain name…". If you don't, in order to simplify and automate the DNS configuration, we suggest you to buy it from a [registrar whose API is supported by YunoHost](/providers/registrar). +If you already have your own domain, you can simply click "I already have a domain name…". If you don't, in order to simplify and automate the DNS configuration, we suggest you to buy it from a [registrar whose API is supported by YunoHost](/providers/registrar). ![Here a screenshot of the "Add domain" page where you can choose "I already have a domain name"](image://webadmin_domain_owndomain.png) - [Know more on DNS zone configuration](/dns_config) - [/ui-tab] [ui-tab title="Local domains (only reachable in your local network)"] @@ -80,11 +79,11 @@ The number may change depending on which server starts first, so do not rely on ! Unfortunately, Android devices before version 12 (released in 2021) do not seem to be listening to mDNS protocol. ! To be able to reach `.local` domains on your Android devices, you will have to add in their DNS settings your YunoHost server's local IP address. - [/ui-tab] [/ui-tabs] ## The main domain + The domain chosen during the initial configuration (post-install) is defined as the main (or default) domain of the server : this is where [the user portal (SSO)](/users) will be available. The main domain can later be changed through the web admin in Domains > (the domain) > Set default, or with the command line `yunohost tools maindomain`. More technically, the main domain is also used as hostname by SMTP protocol to send email (EHLO) and determine which value should be configured in the reverse DNS bind to your public IP. If this 2 values are mis-configured, the diagnosis tool will trigger you an alert. @@ -98,7 +97,6 @@ More technically, the main domain is also used as hostname by SMTP protocol to s If your domain has special, non-latin characters, it will be transformed by YunoHost into its [internationalized version](https://en.wikipedia.org/wiki/Internationalized_domain_name) through [Punycode](https://en.wikipedia.org/wiki/Punycode). So when you use the command line, you have to use the punycode format return for example by `yunohost domain list`. - ## 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. diff --git a/pages/02.administer/15.admin_guide/30.apps/apps.fr.md b/pages/02.administer/15.admin_guide/30.apps/apps.fr.md index 72d7d4bc7..b4ecf56b1 100644 --- a/pages/02.administer/15.admin_guide/30.apps/apps.fr.md +++ b/pages/02.administer/15.admin_guide/30.apps/apps.fr.md @@ -47,6 +47,7 @@ L'accès aux applications peut être limité à certains utilisateurs seulement. À partir de YunoHost v11.1.21.4, si vous avez besoin d'exécuter des commandes avec le binaire de l'application, ou des commandes PHP, etc., vous pouvez exécuter la commande `yunohost app shell `. Cela aura pour effet de : + - ouvrir un nouveau shell Bash en tant qu'utilisateur système de l'application - ouvrir le répertoire de travail de l'application (par exemple `/var/www/`) - précharger l'environnement avec des variables provenant du service de l'application, s'il existe @@ -58,7 +59,7 @@ Si vous voulez apprendre ou contribuer à l'empaquetage des applications, veuill ## 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 : +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 : ```bash yolo.com diff --git a/pages/02.administer/15.admin_guide/30.apps/apps.it.md b/pages/02.administer/15.admin_guide/30.apps/apps.it.md index 8e38f1a46..71a62292e 100644 --- a/pages/02.administer/15.admin_guide/30.apps/apps.it.md +++ b/pages/02.administer/15.admin_guide/30.apps/apps.it.md @@ -11,7 +11,7 @@ routes: Una delle caratteristiche principali di YunoHost è la possibilità di installare facilmente applicazioni che saranno immediatamente utilizzabili. Ad esempio possiamo installare un blog, un "cloud" (per salvare e sincronizzare file), un sito web, un lettore RSS... -Le applicazioni possono essere installate e gestite tramite l'interfaccia di amministrazione web nella sezione `[fa=cubes /] Applicazioni`, oppure utilizzando i comandi della categoria `yunohost app`. +Le applicazioni possono essere installate e gestite tramite l'interfaccia di amministrazione web nella sezione `[fa=cubes /] Applicazioni`, oppure utilizzando i comandi della categoria `yunohost app`. [center] ![Apps list](image://apps_list.png?resize=512&classes=caption "Lista di applicazioni nella pagina webadmin con il relativo bottone Installa.") @@ -21,7 +21,6 @@ Le applicazioni possono essere installate e gestite tramite l'interfaccia di amm
Lista applicazioni
- ! Siate ragionevoli sul numero di programmi che installate. Ogni programma aumenta le possibilità di errori e attacchi dall'esterno. È preferibile, se desiderate effettuare dei test, utilizzare una [macchina virtuale](https://yunohost.org/en/install/hardware:virtualbox) con un'altra istanza. @@ -72,7 +71,6 @@ rss.yolo.com : TinyTiny RSS (a RSS reader) wiki.yolo.com : DokuWiki (a wiki) ``` - !!! Molte applicazioni integrano una caratteristica che permette di cambiare l'URL dell'applicazione. La scelta fra sotto-directory e sotto-dominio in alcuni casi può essere cambiata con una semplice modifica nell'interfaccia di amministrazione. ### Gestione accessi utente e applicazioni pubbliche @@ -141,7 +139,7 @@ Alcune applicazioni includono un *pannello di configurazione* che contiene azion Dalla riga di comando è possibile elencare le impostazione del pannello di configurazione con il comando `yunohost app config get ` -``` +```bash $ yunohost app config get my_webapp main.php_fpm_config.phpversion: ask: PHP version @@ -165,14 +163,15 @@ La parola `` è il nome dell'impostazione come nell'esempio sopra `main.sft Dalla versione di YunoHost v11.1.21.4 è possibile eseguire un comando con il binario dell'applicazione o comandi PHP con il comando `yunohost app shell `. In questo modo: -- verrà avviata una shell Bash come l'utente di sistema dell'applicazione -- verrà aperta la directory di lavoro dell'applicazione (ad esempio `/var/www/`) -- carico di tutte le variabili d'ambiente come da file service dell'applicazione se queste esistono -- verrà il usata la versione di `php` usata dall'applicazione + +* verrà avviata una shell Bash come l'utente di sistema dell'applicazione +* verrà aperta la directory di lavoro dell'applicazione (ad esempio `/var/www/`) +* carico di tutte le variabili d'ambiente come da file service dell'applicazione se queste esistono +* verrà il usata la versione di `php` usata dall'applicazione ## Packaging delle applicazioni -Le applicazioni devono essere preparate (packaging) manualmente dai programmatori (packagers)/manutentori. Le applicazioni possono essere integrate con YunoHost perché supportino gli upgrade, i backup e restore e l'integrazione con LDAP/SSO fra le altre cose. +Le applicazioni devono essere preparate (packaging) manualmente dai programmatori (packagers)/manutentori. Le applicazioni possono essere integrate con YunoHost perché supportino gli upgrade, i backup e restore e l'integrazione con LDAP/SSO fra le altre cose. ## Integrazione e qualità @@ -180,6 +179,4 @@ Test automatici sono regolarmente eseguiti per controllare l'integrazione e la q Alcuni risultati sono disponibili su [questa pagina](https://dash.yunohost.org/appci/branch/stable). - Solo i programmi con una qualità sufficiente sono inseriti nell'elenco delle applicazioni installabili. Nel caso i test dovessero segnalare una diminuzione dell'indice di qualità, gli aggiornamenti saranno sospesi e le nuove installazioni non saranno possibili fino alla soluzione del problema che ha causato l'abbassamento dell'indice. - diff --git a/pages/02.administer/15.admin_guide/30.apps/apps.md b/pages/02.administer/15.admin_guide/30.apps/apps.md index a8b12cde8..8be50b761 100644 --- a/pages/02.administer/15.admin_guide/30.apps/apps.md +++ b/pages/02.administer/15.admin_guide/30.apps/apps.md @@ -21,10 +21,8 @@ The application catalog and its categories can be browsed directly from the weba
Applications catalog
- ! Be careful and stay reasonable on the number of installed applications. Each additional installation increases the attack surface and the risk of failure. Ideally, if you want to test, do it with another instance for example in [a virtual machine](/install/hardware:virtualbox). - ## Installing an app Let's say you want to install a *Custom Webapp*. Before actually running the installation steps, YunoHost will usually have you fill in a form to properly set it up for you. @@ -46,7 +44,7 @@ Let's say you want to install a *Custom Webapp*. Before actually running the ins Among specific questions, forms usually ask you to choose a domain and a path onto which the app will be accessible. -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: +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: ```bash yolo.com @@ -137,7 +135,7 @@ The configuration panels are accessible in the webadmin in their operations page From the command line, you can list the configuration panel settings with the following command: `yunohost app config get ` -``` +```bash $ yunohost app config get my_webapp main.php_fpm_config.phpversion: ask: PHP version @@ -161,20 +159,20 @@ The `` is the setting name, for example `main.sftp.with_sftp` from above. Starting YunoHost v11.1.21.4, if you need to execute commands with the app's binary, or PHP commands, etc., you can execute the command `yunohost app shell `. It will: -- open a new Bash shell as the app's system user -- open the app's working directory (e.g. `/var/www/`) -- preload the environment with variables taken from the app's service, if it exists -- override `php`, so that it points to the PHP version used by the app + +* open a new Bash shell as the app's system user +* open the app's working directory (e.g. `/var/www/`) +* preload the environment with variables taken from the app's service, if it exists +* override `php`, so that it points to the PHP version used by the app ## Applications packaging 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. -If you want to learn or contribute to app packaging, please check the [contributor documentation](/contributordoc). +If you want to learn or contribute to app packaging, please check the [contributor documentation](/contributordoc). ### Integration and quality levels Automated tests are being run regularly to test the integration and quality of all apps who were declared to be `working` by packagers. The result is a level between 0 and 8, 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). By default, only applications of sufficient quality are offered. When the quality of an application drops and until the problem is reolved, the app is hidden from the catalog to prevent its installation and its upgrades are put on hold. - diff --git a/pages/02.administer/15.admin_guide/35.nginx/nginx.md b/pages/02.administer/15.admin_guide/35.nginx/nginx.md index 256591bc8..e1891fc5e 100644 --- a/pages/02.administer/15.admin_guide/35.nginx/nginx.md +++ b/pages/02.administer/15.admin_guide/35.nginx/nginx.md @@ -16,11 +16,9 @@ Most of the web applications installed with YunoHost will automatically have the Generally, you should refrain from manually tinkering and installing apps, except if you are sure they will not interfere with your server. YunoHost proposes two generic apps to help you out: - If you already have a website ready to be deployed, consider using a **Custom Webapp**. It allows you to easily setup a directory into which you can upload your HTML, PHP, CSS, JS files with SFTP, and a database if needed. - - If you want to use YunoHost as a reverse proxy, i.e. serve an app from another server or an internal web server (think NodeJS, Ruby, Python, ...), you can use the **Redirect app** in proxy mode. - - The **Redirect app** can also simply run in redirect mode, for example to create shortcuts for your users in their SSO page, or redirect `www.yourdomain.tld` to `yourdomain.tld`. For more information on these apps, and for more application use cases, have a look to the [Tutorials](/tutorials) section. -!! Do not try to install Apache or other public web servers. This will break your system. \ No newline at end of file +!! Do not try to install Apache or other public web servers. This will break your system. diff --git a/pages/02.administer/15.admin_guide/40.xmpp/xmpp.es.md b/pages/02.administer/15.admin_guide/40.xmpp/xmpp.es.md index 2cfd454eb..32c61d109 100644 --- a/pages/02.administer/15.admin_guide/40.xmpp/xmpp.es.md +++ b/pages/02.administer/15.admin_guide/40.xmpp/xmpp.es.md @@ -11,9 +11,9 @@ routes: YunoHost está instalado con un servidor de mensajería instantánea Metronome que implementa el [protocolo XMPP](https://es.wikipedia.org/wiki/Extensible_Messaging_and_Presence_Protocol). -XMPP es un protocolo abierto y extensible que también permite crear salones de discusión, compartir status y datos, echar llamadas en VoIP y hacer videoconferencias. +XMPP es un protocolo abierto y extensible que también permite crear salones de discusión, compartir status y datos, echar llamadas en VoIP y hacer videoconferencias. -Todas las aplicaciones basadas en XMPP son compatibles entre ellas : cuando utilizas un cliente XMPP puedes discutir con cualquier persona que tenga una cuenta XMPP/Jabber. Este protocolo ya es utilizado por millones de personas en el mundo. +Todas las aplicaciones basadas en XMPP son compatibles entre ellas : cuando utilizas un cliente XMPP puedes discutir con cualquier persona que tenga una cuenta XMPP/Jabber. Este protocolo ya es utilizado por millones de personas en el mundo. ## Cuenta XMPP/Jabber @@ -27,4 +27,4 @@ Prosody, un servidor XMPP alternativo, está empaquetado para YunoHost. En particular, lo utilizan el plugin de chat Peertube y Jitsi para las videoconferencias. Estas aplicaciones instalará Prosody, que requiere que Metronome esté desactivado para funcionar. -! En pocas palabras, la instalación de Prosody o de una aplicación que dependa de ella desactivará el servidor XMPP. \ No newline at end of file +! En pocas palabras, la instalación de Prosody o de una aplicación que dependa de ella desactivará el servidor XMPP. diff --git a/pages/02.administer/15.admin_guide/40.xmpp/xmpp.fr.md b/pages/02.administer/15.admin_guide/40.xmpp/xmpp.fr.md index c5ca9de5f..509fb5616 100644 --- a/pages/02.administer/15.admin_guide/40.xmpp/xmpp.fr.md +++ b/pages/02.administer/15.admin_guide/40.xmpp/xmpp.fr.md @@ -29,4 +29,4 @@ Prosody, un serveur XMPP alternatif, est packagé pour YunoHost. Il est notamment utilisé par le plugin de chat de Peertube, et Jitsi pour des vidéoconférences. Installer ces apps installera Prosody, qui nécessite de désactiver Metronome pour fonctionner. -! En résumé, installer Prosody ou une app en dépendant désactivera le serveur XMPP. \ No newline at end of file +! En résumé, installer Prosody ou une app en dépendant désactivera le serveur XMPP. diff --git a/pages/02.administer/15.admin_guide/40.xmpp/xmpp.md b/pages/02.administer/15.admin_guide/40.xmpp/xmpp.md index 9256b279e..3da63c2e4 100644 --- a/pages/02.administer/15.admin_guide/40.xmpp/xmpp.md +++ b/pages/02.administer/15.admin_guide/40.xmpp/xmpp.md @@ -31,4 +31,4 @@ Prosody, an alternative XMPP server, is packaged for YunoHost. It is notably used by Peertube's chat feature, and Jitsi for video conferences. Installing these apps will install Prosody, which needs to disable Metronome to work properly. -! In summary, installing Prosody or an app relying on it will disable the XMPP server. \ No newline at end of file +! In summary, installing Prosody or an app relying on it will disable the XMPP server. diff --git a/pages/02.administer/15.admin_guide/45.emails/email.de.md b/pages/02.administer/15.admin_guide/45.emails/email.de.md index c6cd979f0..51580c617 100644 --- a/pages/02.administer/15.admin_guide/45.emails/email.de.md +++ b/pages/02.administer/15.admin_guide/45.emails/email.de.md @@ -17,7 +17,7 @@ E-Mail ist ein kompliziertes Ökosystem und eine ganze Reihe von Details können Um Ihre Einstellungen zu validieren: -- Wenn Sie zu Hause selbst hosten und kein VPN verwenden, stellen Sie sicher das [Ihr ISP den Port 25 nicht blockiert](https://yunohost.org/#/isp); +- Wenn Sie zu Hause selbst hosten und kein VPN verwenden, stellen Sie sicher das [Ihr ISP den Port 25 nicht blockiert](https://yunohost.org/#/isp); - leiten Sie Ports weiter, wie in [dieser Dokumentation](https://yunohost.org/#/isp_box_config) beschrieben; - Mail-DNS-Einträge nach [dieser Dokumentation](https://yunohost.org/#/dns_config) sorgfältig konfigurieren; - testen Sie Ihre Konfiguration mit [Mail-tester.com](https://mail-tester.com/) (Vorsicht : nur 3 Tests pro Domain und Tag sind erlaubt) ; @@ -47,4 +47,3 @@ Es ist möglich, dass die von Ihrer YunoHost-Instanz gesendeten E-Mails von den ## Eine Migration von E-Mails von einem E-Mail-Provider zu einer YunoHost-Instanz Siehe [diese Seite](https://yunohost.org/#/email_migration). - diff --git a/pages/02.administer/15.admin_guide/45.emails/email.es.md b/pages/02.administer/15.admin_guide/45.emails/email.es.md index 7bbcc224b..fdc38fe14 100644 --- a/pages/02.administer/15.admin_guide/45.emails/email.es.md +++ b/pages/02.administer/15.admin_guide/45.emails/email.es.md @@ -16,6 +16,7 @@ Este ecosistema comprende un servidor SMTP (postfix), un servidor IMAP (Dovecot) Los emails son un ecosistema complicado y una multitud de detalles puedes impedir que funcionen correctamente. Para validar que tu configuración es correcta : + - si te alojas en casa y que no tienes VPN, asegúrate de que [tu proveedor de Internet no esté bloqueando el puerto 25](/isp) ; - redirige los puertos siguiendo [esta documentación](/isp_box_config) ; - configura con cuidado los registros DNS del correo electrónico siguiendo [esta documentación](/dns_config) ; @@ -23,13 +24,13 @@ Para validar que tu configuración es correcta : Una nota de al menos 8~9/10 es un objetivo razonable. -## Clientes de mensajería +## Clientes de mensajería Para interactuar con el servidor de mail, o sea leer y mandar emails, puedes instalar un cliente web como Roundcube o Rainloop en tu servidor - o configurar un cliente de Desktop o móvil como descrito en [esta página][cette page](/email_configure_client). Los clientes Desktop o móvil tienen la ventaja de copiar tu emails en el equipo, así permitiendo la consulta desconectada de tus mensajes, y cierta protección frente a la posibilidad de un servidor averiado. -## Configuration de los aliases de mensajeras y de las redirecciones automáticas +## Configuration de los aliases de mensajeras y de las redirecciones automáticas Aliases de mensajeras y redirecciones pueden ser configurados por cada usuario. Por ejemplo, el primer usuario creado en el servidor automáticamente dispone de un alias `root@tu.dominio.tld` - lo que significa que un email mandado hacia esta dirección se encontrará en el buzón de entrada de este usuario. Las redirecciones automáticas pueden ser configuradas, por ejemplo si un usuario no quiere configurar una cuenta de correo adicional y simplemente desea recibir correos del servidor en - por ejemplo - su dirección gmail. @@ -37,7 +38,7 @@ Otra función desconocida es el uso del sufijo "+". Por ejemplo, email mandados ## ¿ Qué ocurre si mi servidor se pone indisponible ? -Si tu servidor se pone indisponible, los correos electrónicos mandados a tu servir se quedarán en una fila de espera por el lado del expedidor durante aproximadamente 5 días. El proveedor de hosting del expedidor intentará mandarte regularmente el correo, hasta que lo tire si no lo puede enviar. +Si tu servidor se pone indisponible, los correos electrónicos mandados a tu servir se quedarán en una fila de espera por el lado del expedidor durante aproximadamente 5 días. El proveedor de hosting del expedidor intentará mandarte regularmente el correo, hasta que lo tire si no lo puede enviar. ## Más información diff --git a/pages/02.administer/15.admin_guide/45.emails/email.fr.md b/pages/02.administer/15.admin_guide/45.emails/email.fr.md index 3a9dd3c3c..0a635fe26 100644 --- a/pages/02.administer/15.admin_guide/45.emails/email.fr.md +++ b/pages/02.administer/15.admin_guide/45.emails/email.fr.md @@ -16,6 +16,7 @@ Cet écosystème comprend un serveur SMTP (postfix), un serveur IMAP (Dovecot), Les emails sont un écosystème compliqué et un grand nombre de détails peuvent les empêcher de fonctionner correctement. Pour valider que votre configuration est correcte : + - si vous vous hébergez chez vous et n'utilisez pas de VPN, assurez-vous que [votre FAI ne bloque pas le port 25](/isp) ; - routez les ports selon [cette documentation](/isp_box_config) ; - configurez soigneusement les enregistrements DNS du courrier électronique selon [cette documentation](/dns_config) ; diff --git a/pages/02.administer/15.admin_guide/45.emails/email.md b/pages/02.administer/15.admin_guide/45.emails/email.md index 5a9bea263..cb61758ff 100644 --- a/pages/02.administer/15.admin_guide/45.emails/email.md +++ b/pages/02.administer/15.admin_guide/45.emails/email.md @@ -16,10 +16,11 @@ The mail stack includes a SMTP server (postfix), an IMAP server (Dovecot), an an Email is a complicated ecosystem and quite a few details can prevent it from working properly. To validate your setup: + - if you are self-hosting at home and not using a VPN, ensure [your ISP won't block port 25](/isp) ; - route ports according to [this documentation](/isp_box_config) ; - carefully configure mail DNS records according to [this documentation](/dns_config) ; -- test your configuration using the diagnostic features (`Webadmin > Diagnosis > Email`). You can also use [mail-tester.com](https://mail-tester.com), a score of at least 8~9/10 is a reasonnable goal (be careful : only 3 tests per domain per day are allowed) +- test your configuration using the diagnostic features (`Webadmin > Diagnosis > Email`). You can also use [mail-tester.com](https://mail-tester.com), a score of at least 8~9/10 is a reasonnable goal (be careful : only 3 tests per domain per day are allowed) ## Email clients @@ -40,6 +41,7 @@ Groups also can use alias features, by default the group `admins` have `root@ Archives locales` et en cliquant sur `Nouvelle sauvegarde`. Vous pourrez ensuite sélectionner les éléments à sauvegarder (configuration, données "système", applications). - ![Image de l'écran de sauvegarde de YunoHost dans la webadmin](image://backup.png) [/ui-tab] @@ -38,26 +37,31 @@ Vous pouvez facilement créer des archives depuis la webadmin en allant dans `Sa Vous pouvez créer de nouvelles archives depuis la ligne de commande. Voici quelques exemples de commandes et leur comportement correspondant : - Tout sauvegarder (système et apps) : + ```bash yunohost backup create ``` - Sauvegarder seulement les apps : + ```bash yunohost backup create --apps ``` - Sauvegarder seulement deux apps (WordPress et Shaarli) : + ```bash yunohost backup create --apps wordpress shaarli ``` - Sauvegarder seulement les mails : + ```bash yunohost backup create --system data_mail ``` - Sauvegarder les mails et WordPress : + ```bash yunohost backup create --system data_mail --apps wordpress ``` @@ -68,6 +72,7 @@ Pour plus d'informations et d'options sur la création d'archives, consultez `yu [/ui-tabs] #### Télécharger la sauvegarde + [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="À partir de l'interface web"] Après avoir créé des sauvegardes, il est possible de les lister et de les inspecter grâce aux vues correspondantes dans l'interface d'administration web. Un bouton propose de télécharger l'archive. Si l'archive fait plus de 3Go, il peut être préférable de procéder via SFTP. @@ -101,14 +106,12 @@ scp -P port_ssh admin@votre.domaine.tld:/home/yunohost.backup/archives/ Archives locales` et sélectionnez l'archive. Vous pou ![](image://restore.png) - [/ui-tab] [ui-tab title="À partir de la ligne de commande"] @@ -147,6 +150,7 @@ Vous pouvez ensuite exécuter `yunohost backup restore ` (donc sans Pour restaurer une application, le domaine sur laquelle elle est installée doit déjà être configuré (ou il vous faut restaurer en même temps la configuration correspondante). Aussi, il n'est pas possible de restaurer une application déjà installée... ce qui veut dire que pour restaurer une sauvegarde d'une app, il vous faut déjà la désinstaller. #### Téléverser une archive + Dans de nombreux cas, l'archive n'est pas sur le serveur sur lequel on souhaite la restaurer. Il faut donc la téléverser, ce qui selon son poids peut prend plus ou moins de temps. [ui-tabs position="top-left" active="0" theme="lite"] @@ -175,15 +179,15 @@ scp -P port_ssh /path/to/your/.tar admin@your.domain.tld:/home/yu Il existe 3 applications YunoHost qui proposent d'étendre YunoHost avec une méthode de sauvegarde automatisées. - * [BorgBackup](/backup/borgbackup) - * [Restic](/backup/restic) - * [Archivist](/backup/archivist) +- [BorgBackup](/backup/borgbackup) +- [Restic](/backup/restic) +- [Archivist](/backup/archivist) ## Aller plus loin - * [Évaluer la qualité de sa sauvegarde](/backup/strategies) - * [Cloner son système de fichier](/backup/clone_filesystem) - * [Éviter une panne matérielle](/backup/avoid_hardware_failure) - * [Inclure/exclure des fichiers](/backup/include_exclude_files) - * [Méthodes personnalisées](/backup/custom_backup_methods) - * [Migrer ou fusionner des serveurs](/backup/migrate_or_merge_servers) +- [Évaluer la qualité de sa sauvegarde](/backup/strategies) +- [Cloner son système de fichier](/backup/clone_filesystem) +- [Éviter une panne matérielle](/backup/avoid_hardware_failure) +- [Inclure/exclure des fichiers](/backup/include_exclude_files) +- [Méthodes personnalisées](/backup/custom_backup_methods) +- [Migrer ou fusionner des serveurs](/backup/migrate_or_merge_servers) diff --git a/pages/02.administer/15.admin_guide/50.backups/backup.it.md b/pages/02.administer/15.admin_guide/50.backups/backup.it.md index 1b9fa5c12..90bf638b3 100644 --- a/pages/02.administer/15.admin_guide/50.backups/backup.it.md +++ b/pages/02.administer/15.admin_guide/50.backups/backup.it.md @@ -29,7 +29,6 @@ Potete creare gli archivi di backup dalla pagina web di amministrazione andando Potete fare un nuovo archivio di backup dalla riga di comando. Questi sono alcuni esempi di comandi e i relativi risultati: - - Esecuzione di un backup completo (tutti i componenti del sistema e delle app): ```bash @@ -62,7 +61,6 @@ Potete fare un nuovo archivio di backup dalla riga di comando. Questi sono alcun Per maggiori informazioni e opzioni sulla creazione di backup leggete `yunohost backup create --help`. Potrete anche elencare le parti del sistema delle quali si può farne il backup con `yunohost hook list backup`. - ### Configurazioni specifiche per le app Alcune app come ad esempio Nextcloud possono contenere grandi quantità di dati. È possibile in questi casi eseguire il backup dell'app senza i dati degli utenti, modalità che viene indicata come "backing up only the core" (delle app). @@ -70,7 +68,6 @@ Eseguendo un aggiornamento, delle app con grandi quantità di dati normalmente v Per disabilitare esplicitamente il backup di grandi quantità di dati, per le applicazioni che implementano questa possibilità, dovete impostare la variabile `BACKUP_CORE_ONLY` prima di eseguire il comando di backup: `sudo BACKUP_CORE_ONLY=1 yunohost backup create --apps nextcloud`. Fate attenzione però perché dovrete fare il backup di questi dati autonomamente: è possibile eseguire questi backup, di tipo incrementale o differenziale, opzione che però non è ancora provvista da YunoHost. - ## Download e upload dei backup Dopo aver creato gli archivi di backup è possibile elencarli e ispezionarli sia dalla pagina web di amministrazione relativa sia dalla riga di comando con i comandi `yunohost backup list` e `yunohost backup info `. Di default i backup sono copiati nella directory `/home/yunohost.backup/archives/`. @@ -79,7 +76,6 @@ Attualmente il modo più semplice per scaricare gli archivi è usando il program Una soluzione alternativa è quella di installare Nextcloud o un'applicazione simile e configurarle per accedere ai file contenuti in `/home/yunohost.backup/archives/` da un browser. - Un'altra soluzione è quella di usare `scp` (un programma che si basa su [`ssh`](/ssh)) per copiare i file fra due computer usando la riga di comando. In questo modo usando un computer con GNU/Linux potete copiare uno specifico backup con questo comando: ```bash @@ -110,34 +106,29 @@ scp -P porta_ssh /path/to/your/.tar admin@your.domain.tld:/home/yun Dovete andare in Backup > Archivi locali e selezionare il vostro archivio. È possibile selezionare ciò che volete ripristinare e poi cliccare su 'Ripristina'. - ![picture of YunoHost's restore pannel](image://restore.png) ### Dalla riga di comando Dalla riga di comando date il comando `yunohost backup restore ` (senza il `.tar.gz`) per ripristinare un archivio. Così come `yunohost backup create`, questo comando ripristinerà di default tutto il contenuto dell'archivio; se invece volete ripristinare solo alcuni file potete usare ad esempio il comando `yunohost backup restore --apps wordpress` per ripristinare esclusivamente wordpress. - ### Limiti Per ripristinare una app, il dominio sul quale era stata installata dovrà essere già stato configurato oppure dovrete avere già ripristinato la configurazione di sistema relativa. Inoltre non è possibile ripristinare una app che è già installata ... il che comporta che se volete ripristinare una versione passata della app dovrete prima disinstallarla. - ### Ripristino durante il postinstall È possibile ripristinare un archivio completo *invece* di eseguire il passaggio di postinstall. Questo è utile se volete reinstallare un sistema interamente da un backup preesistente. Per fare questo dovrete copiare l'archivio sul server nella directory `/home/yunohost.backup/archives` e poi, **invece di dare il comando** `yunohost tools postinstall` darete il comando: - ```bash yunohost backup restore ``` Nota: se il vostro archivio non si trova in `/home/yunohost.backup/archives` potete specificare il path giusto con: - ```bash yunohost backup restore /path/to/ -``` +``` ## Ulteriori possibilità @@ -145,7 +136,6 @@ yunohost backup restore /path/to/ Potete connettere e montare un disco esterno per tenerci gli archivi di backup (oltre a tutto il resto): per fare questo prima spostate gli archivi e poi aggiungete un link simbolico. - ```bash PATH_TO_DRIVE="/media/my_external_drive" # Come esempio, dipende da dove monterete il vostro disco mv /home/yunohost.backup/archives $PATH_TO_DRIVE/yunohost_backup_archives @@ -169,7 +159,6 @@ chmod +x /etc/cron.weekly/backup-wordpress Prestate attenzione a ciò di cui fate il backup e quando perché altrimenti è possibile esaurire lo spazio del vostro disco eseguendo, ad esempio, 30 Gb di backup ogni giorno. - #### Backup del server su un server remoto Potete seguire questo tutorial sul forum per impostare Borg fra due server: @@ -181,9 +170,10 @@ Alternativamente, la app Archivist permette di impostare un sistema simile: .tar admin@your.domain.tld:/home/yun There are 3 YunoHost applications that offer to extend YunoHost with an automated backup method. - * [BorgBackup](/backup/borgbackup) - * [Restic](/backup/restic) - * [Archivist](/backup/archivist) +- [BorgBackup](/backup/borgbackup) +- [Restic](/backup/restic) +- [Archivist](/backup/archivist) ## Go further - * [Evaluate the quality of your backup](/backup/strategies) - * [Clone your file system](/backup/clone_filesystem) - * [Avoid a hardware failure](/backup/avoid_hardware_failure) - * [Include/exclude files](/backup/include_exclude_files) - * [Custom methods](/backup/custom_backup_methods) - * [Migrate or merge servers](/backup/migrate_or_merge_servers) - - +- [Evaluate the quality of your backup](/backup/strategies) +- [Clone your file system](/backup/clone_filesystem) +- [Avoid a hardware failure](/backup/avoid_hardware_failure) +- [Include/exclude files](/backup/include_exclude_files) +- [Custom methods](/backup/custom_backup_methods) +- [Migrate or merge servers](/backup/migrate_or_merge_servers) diff --git a/pages/02.administer/15.admin_guide/55.upgrade/10.stretch_buster_migration/stretch_buster_migration.fr.md b/pages/02.administer/15.admin_guide/55.upgrade/10.stretch_buster_migration/stretch_buster_migration.fr.md index 317d37464..b308c36c7 100644 --- a/pages/02.administer/15.admin_guide/55.upgrade/10.stretch_buster_migration/stretch_buster_migration.fr.md +++ b/pages/02.administer/15.admin_guide/55.upgrade/10.stretch_buster_migration/stretch_buster_migration.fr.md @@ -19,13 +19,13 @@ L'objectif cette page est de décrire le processus de migration d'une instance e ## Procédure de migration -#### Depuis la webadmin +### Depuis la webadmin Après avoir mis à jour vers la version en 3.8.5.x, allez dans Outils > Migrations pour accéder à l'interface de migration. Il vous faudra ensuite lire l'avertissement attentivement et l'accepter pour lancer la migration. -#### Depuis la ligne de commande +### Depuis la ligne de commande -Après avoir mis à jour vers la version 3.8.5.x, lancez : +Après avoir mis à jour vers la version 3.8.5.x, lancez : ```bash sudo yunohost tools migrations migrate @@ -37,25 +37,25 @@ puis lisez attentivement l'avertissement et les instructions. En fonction de votre matériel et des paquets installés, la migration peut prendre jusqu'à une ou deux heures. -Les logs seront affichés dans la barre de message en haut (vous pouvez approcher la souris dessus pour voir l'historique en entier). Ils seront également consultable après coup (comme les autres opérations) dans Outils > Journaux. +Les logs seront affichés dans la barre de message en haut (vous pouvez approcher la souris dessus pour voir l'historique en entier). Ils seront également consultable après coup (comme les autres opérations) dans Outils > Journaux. Notez que même si vous fermez la page d'admin, la migration continuera (par contre l'interface d'admin sera partiellement indisponible). -#### Si la migration a crashé / échoué à un moment. +### Si la migration a crashé / échoué à un moment Si la migration a échoué a un moment donné, la première chose à faire est de tenter de la relancer. Si cela ne fonctionne toujours pas, il vous faut [trouver de l'aide](/help) (prière de fournir le/les messages correspondants ou tout élément qui vous fait penser que ça n'a pas marché). ## Choses à vérifier après la migration -#### Vérifiez que vous êtes véritablement sous Debian Buster / YunoHost 4.x +### Vérifiez que vous êtes véritablement sous Debian Buster / YunoHost 4.x Pour cela, vous pouvez aller dans la partie Diagnostic (section Système de base). (Vous pouvez aussi regarder ce qui est affiché à droite dans le pied de page de la webadmin). En ligne de commande, vous pouvez aussi utiliser `lsb_release -a` et `yunohost --version`. -#### Vérifiez que le diagnostic ne rapporte pas de problème particulier +### Vérifiez que le diagnostic ne rapporte pas de problème particulier Également dans la section Diagnostic de la webadmin, vérifiez qu'il n'y a pas de problème apparu suite à la migration (par exemple un service qui ne tournerais plus...) -#### Vérifiez que les applications fonctionnent +### Vérifiez que les applications fonctionnent Vérifiez que vos applications installées fonctionnent... Si elles ne fonctionnent pas, il est recommandé de tenter de les mettre à jour. (ou bien de manière générale, il est recommandé de les mettre à jour même si elles fonctionnent !). diff --git a/pages/02.administer/15.admin_guide/55.upgrade/10.stretch_buster_migration/stretch_buster_migration.md b/pages/02.administer/15.admin_guide/55.upgrade/10.stretch_buster_migration/stretch_buster_migration.md index 138bbdc01..42366a5bf 100644 --- a/pages/02.administer/15.admin_guide/55.upgrade/10.stretch_buster_migration/stretch_buster_migration.md +++ b/pages/02.administer/15.admin_guide/55.upgrade/10.stretch_buster_migration/stretch_buster_migration.md @@ -19,13 +19,13 @@ This page is dedicated to help you migrating an instance from YunoHost 3.8.x (ru ## Migration procedure -#### From the webadmin +### From the webadmin -After upgrading to 3.8.5.x, go to Tools > Migrations to access the migrations interface. You will have to read carefully and accept the disclaimer then launch the migration. +After upgrading to 3.8.5.x, go to Tools > Migrations to access the migrations interface. You will have to read carefully and accept the disclaimer then launch the migration. -#### From the command line +### From the command line -After upgrading to 3.8.5.x, run : +After upgrading to 3.8.5.x, run : ```bash sudo yunohost tools migrations migrate @@ -35,33 +35,33 @@ then read carefully and accept the disclaimer. ## During the migration -Depending on your hardware and packages installed, the migration might take up to a few hours. +Depending on your hardware and packages installed, the migration might take up to a few hours. The logs will be shown in the message bar (you can hover it to see the whole history). They will also be available after the migration (like any other operations) in Tools > Logs. Note that even if you close the webadmin page for some reason, the migration will continue in the background (but the webadmin will be partially unavailable). -#### If the migration crashed / failed at some point. +### If the migration crashed / failed at some point If the migration failed at some point, it should be possible to relaunch it. If it still doesn't work, you can try to [get help](/help) (please provide the corresponding messages or whatever makes you tell that it's not working). ## What to do after the upgrade -#### Check that you actually are on Debian Buster and YunoHost 4.x +### Check that you actually are on Debian Buster and YunoHost 4.x For this, go in Diagnosis (category Base system) or look at the footer of the webadmin. In the command line, you can use `lsb_release -a` and `yunohost --version`. -#### Check that no issue appeared in the diagnosis +### Check that no issue appeared in the diagnosis Also in the Diagnosis in the webadmin, make sure that no specific issue appeared after running the migration (for example a service that crashed for some reason). -#### Check that your applications are working +### Check that your applications are working Test that your applications are working. If they aren't, you should try to upgrade them (it is also a good idea to upgrade them even if they are working anyway). ## Current known (minor) issues after the migration -- Some file (`/etc/nsswitch.conf` and `/etc/nslcd.conf`) will appear as manually modified after the migration. You can safely apply the regen-conf with: +- Some file (`/etc/nsswitch.conf` and `/etc/nslcd.conf`) will appear as manually modified after the migration. You can safely apply the regen-conf with: ```bash yunohost tools regen-conf nsswitch nslcd --force diff --git a/pages/02.administer/15.admin_guide/55.upgrade/15.buster_bullseye/buster_bullseye_migration.fr.md b/pages/02.administer/15.admin_guide/55.upgrade/15.buster_bullseye/buster_bullseye_migration.fr.md index 7bfda98fc..6a6165b6a 100644 --- a/pages/02.administer/15.admin_guide/55.upgrade/15.buster_bullseye/buster_bullseye_migration.fr.md +++ b/pages/02.administer/15.admin_guide/55.upgrade/15.buster_bullseye/buster_bullseye_migration.fr.md @@ -19,13 +19,13 @@ L'objectif cette page est de décrire le processus de migration d'une instance e ## Procédure de migration -#### Depuis la webadmin +### Depuis la webadmin Après avoir mis à jour vers la version en 4.4.x, allez dans Outils > Migrations pour accéder à l'interface de migration. Il vous faudra ensuite lire l'avertissement attentivement et l'accepter pour lancer la migration. -#### Depuis la ligne de commande +### Depuis la ligne de commande -Après avoir mis à jour vers la version 4.4.x, lancez : +Après avoir mis à jour vers la version 4.4.x, lancez : ```bash sudo yunohost tools migrations migrate @@ -37,57 +37,57 @@ puis lisez attentivement l'avertissement et les instructions. En fonction de votre matériel et des paquets installés, la migration peut prendre jusqu'à une ou deux heures. -Les logs seront affichés dans la barre de message au centre de la page (vous pouvez approcher la souris dessus pour voir l'historique en entier). Ils seront également consultable après coup (comme les autres opérations) dans Outils > Journaux. +Les logs seront affichés dans la barre de message au centre de la page (vous pouvez approcher la souris dessus pour voir l'historique en entier). Ils seront également consultable après coup (comme les autres opérations) dans Outils > Journaux. Notez que même si vous fermez la page d'admin, la migration continuera (par contre l'interface d'admin sera partiellement indisponible). -#### Si la migration a crashé / échoué à un moment. +### Si la migration a crashé / échoué à un moment Si la migration a échoué a un moment donné, la première chose à faire est de tenter de la relancer. Si cela ne fonctionne toujours pas, il vous faut [trouver de l'aide](/help) (prière de fournir le/les messages correspondants ou tout élément qui vous fait penser que ça n'a pas marché). ## Choses à vérifier après la migration -#### Exécuter la migration pour réparer votre application python +### Exécuter la migration pour réparer votre application python + Après la mise à jour, vos applications python devraient être indisponibles car leur environnement virtuel doit être reconstruit. Pour ce faire, vous pouvez exécuter les migrations en cours dans `Webadmin > Mises à jour`. Les applications ci-dessous ne seront pas réparées automatiquement, vous devez les mettre à jour manuellement avec `yunohost app upgrade -F APP`. Les applications qui ne seront pas réparées automatiquement et nécessitent une mise à jour forcée : - * calibreweb - * django-for-runners - * ffsync (cette application est en python2 et n'est plus maintenue, aucune garantie) - * jupiterlab - * librephotos - * mautrix - * mediadrop - * mopidy - * pgadmin - * tracim - * synapse - * weblate +- calibreweb +- django-for-runners +- ffsync (cette application est en python2 et n'est plus maintenue, aucune garantie) +- jupiterlab +- librephotos +- mautrix +- mediadrop +- mopidy +- pgadmin +- tracim +- synapse +- weblate ! !! Si nécessaire, vous pouvez désactiver la reconstruction automatique pour une application python spécifique, en supprimant le fichier dédié terminé par `.requirements_backup_for_bullseye_upgrade.txt` avant d'appliquer la migration. Vous pouvez trouver ce fichier près du venv de votre application dans `/opt` ou `/var/www`. -#### Vérifiez que vous êtes véritablement sous Debian Bullseye et YunoHost 11.x +### Vérifiez que vous êtes véritablement sous Debian Bullseye et YunoHost 11.x Pour cela, vous pouvez aller dans la partie Diagnostic (section Système de base). (Vous pouvez aussi regarder ce qui est affiché à droite dans le pied de page de la webadmin). En ligne de commande, vous pouvez aussi utiliser `lsb_release -a` et `yunohost --version`. -#### Vérifiez que le diagnostic ne rapporte pas de problème particulier +### Vérifiez que le diagnostic ne rapporte pas de problème particulier Également dans la section Diagnostic de la webadmin, vérifiez qu'il n'y a pas de problème apparu suite à la migration (par exemple un service qui ne tournerais plus...) -#### Vérifiez que les applications fonctionnent +### Vérifiez que les applications fonctionnent Vérifiez que vos applications installées fonctionnent... Si elles ne fonctionnent pas, il est recommandé de tenter de les mettre à jour. (ou bien de manière générale, il est recommandé de les mettre à jour même si elles fonctionnent !). - Si votre app est cassée et que vous étiez déjà sur la dernière version d'une application, vous pouvez relancer la mise à jour grâce à l'option `--force`: -``` + +```bash yunohost app upgrade --force NOM_APP ``` ## Soucis (mineurs) connus après la migration Voir la [page anglaise](https://yunohost.org/en/buster_bullseye_migration#current-known-minor-issues-after-the-migration) - diff --git a/pages/02.administer/15.admin_guide/55.upgrade/15.buster_bullseye/buster_bullseye_migration.md b/pages/02.administer/15.admin_guide/55.upgrade/15.buster_bullseye/buster_bullseye_migration.md index b62cbd934..4becc37be 100644 --- a/pages/02.administer/15.admin_guide/55.upgrade/15.buster_bullseye/buster_bullseye_migration.md +++ b/pages/02.administer/15.admin_guide/55.upgrade/15.buster_bullseye/buster_bullseye_migration.md @@ -21,13 +21,13 @@ This page is dedicated to help you migrating an instance from YunoHost 4.4.x (ru ## Migration procedure -#### From the webadmin +### From the webadmin -After upgrading to 4.4.x, go to Tools > Migrations to access the migrations interface. You will have to read carefully and accept the disclaimer then launch the migration. +After upgrading to 4.4.x, go to Tools > Migrations to access the migrations interface. You will have to read carefully and accept the disclaimer then launch the migration. -#### From the command line +### From the command line -After upgrading to 4.4.x, run : +After upgrading to 4.4.x, run : ```bash sudo yunohost tools migrations run @@ -37,62 +37,65 @@ then read carefully and accept the disclaimer. ## During the migration -Depending on your hardware and packages installed, the migration might take up to a few hours. +Depending on your hardware and packages installed, the migration might take up to a few hours. The logs will be shown in the message bar (you can hover it to see the whole history). They will also be available after the migration (like any other operations) in Tools > Logs. Note that even if you close the webadmin page for some reason, the migration will continue in the background (but the webadmin will be partially unavailable). -#### If the migration crashed / failed at some point. +### If the migration crashed / failed at some point If the migration failed at some point, it should be possible to relaunch it. If it still doesn't work, you can try to [get help](/help) (please provide the corresponding messages or whatever makes you say that it's not working). ## What to do after the upgrade -#### Check that you actually are on Debian Bullseye and YunoHost 11.x +### Check that you actually are on Debian Bullseye and YunoHost 11.x For this, go to Diagnosis (category Base system) or look at the footer of the webadmin. In the command line, you can use `lsb_release -a` and `yunohost --version`. -#### Run the migration to repair your python app +### Run the migration to repair your python app + After upgrading, your python apps should be unavailable because their virtual environment (venv) needs to be rebuilt. To do that you can run the pending migrations in `Webadmin > Update`. The apps below won't be automatically repaired, you need to force-upgrade them manually instead with `yunohost app upgrade -F APP`. Apps which won't be automatically repaired and need a force upgrade: - * calibreweb - * django-for-runners - * ffsync (this app is in python2 and no longer maintained, no guarantee) - * jupiterlab - * librephotos - * mautrix - * mediadrop - * mopidy - * pgadmin - * tracim - * synapse - * weblate +- calibreweb +- django-for-runners +- ffsync (this app is in python2 and no longer maintained, no guarantee) +- jupiterlab +- librephotos +- mautrix +- mediadrop +- mopidy +- pgadmin +- tracim +- synapse +- weblate !!! If needed, you can disable the automatic rebuild for a specific python app, by removing the dedicated file ending with `.requirements_backup_for_bullseye_upgrade.txt` before applying the migration. You can find this file near the venv (Python virtual environment) of your app inside `/opt` or `/var/www`. -#### Check that no issue appeared in the diagnosis +### Check that no issue appeared in the diagnosis Also in the webadmin Diagnosis section, make sure that no specific issue appeared after running the migration (for example a service that crashed for some reason). If the service `php7.3-fpm` appears to be dead, you should upgrade your PHP apps like the custom web app. Next, you can run `apt autoremove`. -#### Check that your applications are working +### Check that your applications are working Test that your applications are working. If they aren't, you should try to upgrade them (it is also a good idea to upgrade them even if they are working anyway). If your app is broken and you were already with the latest version, you can rerun the upgrade thanks to the `-F|--force` option: -``` + +```bash yunohost app upgrade --force APP_NAME ``` ## Current known issues after the migration -### Can't run the migration due to `libc6-dev : Breaks: libgcc-8-dev issue`. +### Can't run the migration due to `libc6-dev : Breaks: libgcc-8-dev issue` + Note: This issue should be resolved in yunohost_version: 4.4.2.13 You have an app that depends on the `build-essential` package. @@ -107,7 +110,8 @@ We haven't yet found solution for this issue. ! If you have not yet rebooted your server, don't do it (we are looking for a solution). This will avoid you the use of a keyboard and screen. We found this in the Raspberry Pi documentation -``` + +```text when the dhcpcd5 package is updated to the latest version (1:8.1.2-1+rpt1 -> 1:8.1.2-1+rpt2), the Raspberry Pi will fail to obtain a DHCP IP address following the next reboot or startup. This problem can be avoided by disabling and re-enabling the "System Options -> Network at Boot" option using the latest raspi-config after the dhcpcd5 package has been updated and prior to the system being shutdown or rebooted ``` @@ -116,9 +120,9 @@ If you are using a Raspberry Pi 4 (or maybe 3), see this [solution](https://foru ### Restore ynh4 backup onto a fresh ynh11 If you can't restore your app but your system has been restored, you probably should use the regen conf to fix the nginx issues: -``` + +```bash yunohost tools regenconf nginx --force ``` After that you should be able to restore your apps. Don't forget to force upgrade them if you have 502 errors. - diff --git a/pages/02.administer/15.admin_guide/55.upgrade/5.jessie_stretch_migration/jessie_stretch_migration.fr.md b/pages/02.administer/15.admin_guide/55.upgrade/5.jessie_stretch_migration/jessie_stretch_migration.fr.md index 537e0c928..dbc6cada0 100644 --- a/pages/02.administer/15.admin_guide/55.upgrade/5.jessie_stretch_migration/jessie_stretch_migration.fr.md +++ b/pages/02.administer/15.admin_guide/55.upgrade/5.jessie_stretch_migration/jessie_stretch_migration.fr.md @@ -23,13 +23,13 @@ L'objectif cette page est de décrire le processus de migration d'une instance e ## Procédure de migration -#### Depuis la webadmin +### Depuis la webadmin Après avoir mis à jour vers la version 2.7.14, allez dans Outils > Migrations pour accéder à l'interface de migration. Il vous faudra ensuite lire l'avertissement attentivement et l'accepter pour lancer la migration. Les logs seront affichés dans la barre de message en haut (vous pouvez approcher la souris dessus pour voir l'historique en entier). -#### Depuis la ligne de commande +### Depuis la ligne de commande -Après avoir mis à jour vers la version 2.7.14, lancez : +Après avoir mis à jour vers la version 2.7.14, lancez : ```bash sudo yunohost tools migrations migrate @@ -43,24 +43,24 @@ En fonction de votre matériel et des paquets installés, la migration peut pren Notez qu'il est attendu de voir certaines erreurs (en particulier à propos de Fail2Ban) pendant la migration - ne vous en inquiétez pas trop. -#### Si la migration a crashé / échoué à un moment. +### Si la migration a crashé / échoué à un moment Si la migration a échoué a un moment donné, la première chose à faire est de tenter de la relancer. Si cela ne fonctionne toujours pas, il vous faut [trouver de l'aide](/help) (prière de fournir le/les messages correspondants ou tout élément qui vous fait penser que ça n'a pas marché). ## Choses à vérifier après la migration -#### Vérifiez que vous êtes véritablement sous Debian Stretch / YunoHost 3.0 +### Vérifiez que vous êtes véritablement sous Debian Stretch / YunoHost 3.0 Pour cela, allez dans Outils > Diagnostique. (Vous pouvez aussi regarder ce qui est affiché dans le pied de page). En ligne de commande, vous pouvez aussi utiliser `lsb_release -a` et `yunohost --version`. -#### Vérifiez que Fail2Ban et le pare-feu sont actifs. +### Vérifiez que Fail2Ban et le pare-feu sont actifs Vous devriez voir que Fail2Ban et le firewall sont actifs. Depuis la webadmin, dans Services (chercher 'fail2ban' et 'yunohost-firewall'). Depuis la ligne de commande, faites `yunohost service status fail2ban yunohost-firewall` : les deux devraient être en `active: active`. -#### Vérifiez que les applications fonctionnent +### Vérifiez que les applications fonctionnent Vérifiez que vos applications installées fonctionnent... Si elles ne fonctionnent pas, il est recommandé de tenter de les mettre à jour. (ou bien de manière générale, il est recommandé de les mettre à jour même si elles fonctionnent !). -#### Si vous utilisez les mails : vérifiez votre score +### Si vous utilisez les mails : vérifiez votre score Si vous utilisez les emails (en particulier les envois), vérifiez que votre score est toujours bon via [mail-tester](https://www.mail-tester.com/) par exemple. diff --git a/pages/02.administer/15.admin_guide/55.upgrade/5.jessie_stretch_migration/jessie_stretch_migration.md b/pages/02.administer/15.admin_guide/55.upgrade/5.jessie_stretch_migration/jessie_stretch_migration.md index 8896e8455..23d6e430b 100644 --- a/pages/02.administer/15.admin_guide/55.upgrade/5.jessie_stretch_migration/jessie_stretch_migration.md +++ b/pages/02.administer/15.admin_guide/55.upgrade/5.jessie_stretch_migration/jessie_stretch_migration.md @@ -23,13 +23,13 @@ This page is dedicated to help you migrating an instance from YunoHost 2.7.x (ru ## Migration procedure -#### From the webadmin +### From the webadmin After upgrading to 2.7.14, go to Tools > Migrations to access the migrations interface. You will have to read carefully and accept the disclaimer then launch the migration. The logs will be shown in the message bar (you can hover it to see the whole history). -#### From the command line +### From the command line -After upgrading to 2.7.14, run: +After upgrading to 2.7.14, run: ```bash sudo yunohost tools migrations migrate @@ -39,28 +39,28 @@ then read carefully and accept the disclaimer. ## During the migration -Depending on your hardware and packages installed, the migration might take up to a few hours. +Depending on your hardware and packages installed, the migration might take up to a few hours. Note that it is expected to see some errors (in particular about Fail2Ban) during the migration, so don't worry too much about them. -#### If the migration crashed / failed at some point. +### If the migration crashed / failed at some point If the migration failed at some point, it should be possible to relaunch it. If it still doesn't work, you can try to [get help](/help) (please provide the corresponding messages or whatever makes you tell that it's not working). ## What to do after the upgrade -#### Check that you actually are on Debian Stretch and YunoHost 3.0 +### Check that you actually are on Debian Stretch and YunoHost 3.0 You should be able to see this from the webadmin Tools > Diagnosis, and also in the footer of the page. On the command line, you can use `lsb_release -a` and `yunohost --version`. -#### Check that Fail2Ban and the firewall are active +### Check that Fail2Ban and the firewall are active You should be able to see that Fail2Ban and the firewall are active. From the webadmin in Services (look for 'fail2ban' and 'yunohost-firewall'). From the command line, run `yunohost service status fail2ban yunohost-firewall`. They should both have `active: active`. -#### Check that your applications are working +### Check that your applications are working Test that your applications are working. If they aren't, you should try to upgrade them (it is also a good idea to upgrade them even if they are working anyway). -#### Mail users: check your mail score +### Mail users: check your mail score If you are using mails (especially sending them), check that your score is still good by using [mail-tester](https://www.mail-tester.com/) for example. diff --git a/pages/02.administer/15.admin_guide/admin_guide.de.md b/pages/02.administer/15.admin_guide/admin_guide.de.md index a62af6f67..9b216a8ef 100644 --- a/pages/02.administer/15.admin_guide/admin_guide.de.md +++ b/pages/02.administer/15.admin_guide/admin_guide.de.md @@ -10,11 +10,10 @@ routes: Diese Seite bietet eine Übersicht über das Ökosystem eines YunoHost-Servers. Diese Übersicht macht mehrere Vereinfachungen und zielt wesentlich darauf ab, ein globales Bild zu vermitteln, bevor tiefer auf die verschiedenen Aspekte eingegangen wird. - ![](image://ecosystem.png) Alles beginnt mit dem speziellen **admin** Benutzer. Dies ist der Administrator des Computers, der Dinge auf dem Server über die Webverwaltungsoberfläche oder über SSH und die Befehlszeilenschnittstelle installieren, konfigurieren und verwalten kann. *(Wenn du bereits mit GNU / Linux vertraut bist, ist dies root ziemlich ähnlich. YunoHost hat diesen zusätzlichen 'Admin'-Benutzer aus verschiedenen technischen Gründen.)* Der Administrator kann unter anderem Benutzer erstellen und Anwendungen installieren. Benutzer haben, wenn sie erstellt werden, automatisch eine eigene E-Mail-Adresse sowie ein XMPP-Konto. Benutzer können auch eine Verbindung zum Benutzerportal (SSO) herstellen, um auf Anwendungen zuzugreifen. Einige Anwendungen können normalerweise entweder öffentlich zugänglich oder privat installiert werden. Letzteres bedeutes, dass nur einige Benutzer Zugriff darauf haben. -Anwendungen und andere Funktionen des Servers hängen von verschiedenen Diensten ab, damit sie ordnungsgemäß funktionieren. Dienste (manchmal auch als Daemons bezeichnet) sind Programme, die ständig auf dem Server ausgeführt werden. Sie stellen sicher, dass verschiedene Aufgaben, z.B. das Beantworten von Webanfragen von Webbrowsern oder das Weiterleiten von E-Mails, ausgeführt werden. +Anwendungen und andere Funktionen des Servers hängen von verschiedenen Diensten ab, damit sie ordnungsgemäß funktionieren. Dienste (manchmal auch als Daemons bezeichnet) sind Programme, die ständig auf dem Server ausgeführt werden. Sie stellen sicher, dass verschiedene Aufgaben, z.B. das Beantworten von Webanfragen von Webbrowsern oder das Weiterleiten von E-Mails, ausgeführt werden. diff --git a/pages/02.administer/15.admin_guide/admin_guide.md b/pages/02.administer/15.admin_guide/admin_guide.md index 6268f320b..8379ec1cc 100644 --- a/pages/02.administer/15.admin_guide/admin_guide.md +++ b/pages/02.administer/15.admin_guide/admin_guide.md @@ -17,5 +17,3 @@ Everything starts with the special user **admin**. This is the administrator of The administrator can create users and install applications, among other admin actions. Users automatically have their own email address as well as an XMPP account when they get created. Users will also be able to connect to the user portal (SSO) to access applications. Some applications can typically be installed either as publicly-accessible, or as private, i.e. only some users will have access to it. Applications and their features of the server rely on different services to work properly. Services (sometimes also called daemons) are programs that are constantly running on the server to ensure various tasks are done, such as answering to web requests from web browsers, or relaying emails. - - diff --git a/pages/02.administer/20.backups/05.evaluate/evaluate.fr.md b/pages/02.administer/20.backups/05.evaluate/evaluate.fr.md index 29a677044..30ca8f73e 100644 --- a/pages/02.administer/20.backups/05.evaluate/evaluate.fr.md +++ b/pages/02.administer/20.backups/05.evaluate/evaluate.fr.md @@ -13,6 +13,7 @@ page-toc: 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 montrer beaucoup plus de prudence 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 ou des endroits différents*. ## Qu'est-ce qu'une bonne sauvegarde ? + Une bonne sauvegarde est constituée d'au moins **3 copies des données** (en comptant les données originales), sur au moins **2 stockages distincts**, dans au moins **2 lieux distincts** (suffisamment éloignés) et idéalement avec 2 méthodes distinctes. Si vos sauvegardes sont chiffrées **ces règles s'appliquent aussi à la phrase/clé de déchiffrement**. Une bonne sauvegarde est aussi dans de nombreux cas, une sauvegarde récente, il faut donc soit beaucoup de rigueur, soit **automatiser** le processus. @@ -22,43 +23,43 @@ Une bonne sauvegarde est vérifiée régulièrement afin de s'assurer de l'effec Enfin, une bonne sauvegarde est une sauvegarde **restaurable dans des délais acceptables** pour vous. Pensez notamment à documenter votre méthode de restauration et à estimer le temps de transfert d'une copie notamment si les connexions internet en jeu ne sont pas symétriques. !!! Exemple d'**une combinaison** robuste et comfortable: -* une sauvegarde distante et automatique avec borg -* une sauvegarde sur disque externe et automatique avec borg -* un snapshot/image régulier (et avant les mises à jour) -* une grappe RAID 1 monitorée (ou un VPS du commerce qui sera aussi sur une grappe) -* une passphrase de déchiffrement stockée sur 3 supports dans 2 lieux +- une sauvegarde distante et automatique avec borg +- une sauvegarde sur disque externe et automatique avec borg +- un snapshot/image régulier (et avant les mises à jour) +- une grappe RAID 1 monitorée (ou un VPS du commerce qui sera aussi sur une grappe) +- une passphrase de déchiffrement stockée sur 3 supports dans 2 lieux ## Quelques méthodes possibles -* [générer une archive et la télécharger manuellement (méthode par défaut de YunoHost)](/backup#sauvegarde-manuelle) -* [sauvegarder automatiquement (méthode conseillée)](/backup#sauvegarde-automatique-ou-distante) -* [générer une archive directement sur un autre disque](/external_storage) -* [faire une image du disque ou un snapshot](/backup/clone_filesystem) -* [sauvegarder les données utiles via une méthode personnalisée](/backup/custom_backup_methods) +- [générer une archive et la télécharger manuellement (méthode par défaut de YunoHost)](/backup#sauvegarde-manuelle) +- [sauvegarder automatiquement (méthode conseillée)](/backup#sauvegarde-automatique-ou-distante) +- [générer une archive directement sur un autre disque](/external_storage) +- [faire une image du disque ou un snapshot](/backup/clone_filesystem) +- [sauvegarder les données utiles via une méthode personnalisée](/backup/custom_backup_methods) ## Risques -Ci-dessous, une liste de risques triés du plus au moins probable, dont la probabilité reste à adapter selon votre situation (lieu du serveur, qualité des installations, profils d'usagers, etc.). À vous de mettre le curseur là où il faut, notamment en considérant les conséquences d'une perte de données. - -!!! Gardez en tête que les vrais accidents sont liés à la survenue de 2 événements de façon simultanée. - -* **Manque de rigueur**: les stratégies à base de sauvegardes manuelles nécessitent beaucoup de rigueur dans la régularité -* **Mauvaise manipulation**: il peut arriver d'effacer une sauvegarde par erreur lors d'une restauration ou si vous comptez sur un système de synchronisation, vous pourriez supprimer un fichier et que la suppression soit synchronisée de façon instantanée -* **Cryptolocker**: il s'agit de virus qui chiffrent les fichiers et réclament une rançon. Si vos utilisateurs ou utilisatrices utilisent nextcloud et windows, un windows infecté pourrait synchroniser des fichiers chiffrés et ainsi vous perdriez votre copie. -* **Panne matérielle**: les cartes SD sont les supports les moins fiables dans le temps (~2ans de vie dans un serveur), viennent ensuite les disques SSD (environ 3 ans de vie) et les disques durs (3 ans). À noter qu'un équipement neuf a aussi une probabilité non nulle de tomber en panne lors des 6 premiers mois. Dans tous les cas, vos copies ne devraient pas être sur le même support physique. -* **Panne logicielle/bug**: un bug logiciel peut aboutir à la suppression de données ou vous pourriez ne pas savoir réparer un problème et souhaiter restaurer votre système. -* **Panne d'électricité ou d'internet**: avez-vous un plan si ça arrive ? Quid si vous êtes en vacances ? -* **Catastrophe ou événement naturel ou non**: un petit enfant, un chat, la foudre ou une simple fuite peuvent détruire votre matériel. Les incendies ou inondations peuvent aussi mettre à mal votre copie de sauvegarde à l'autre bout de votre logement... -* **Compromission du serveur**: une personne malveillante ou un robot pourrait attaquer votre serveur et supprimer vos données. -* **Vol de machine**: un cambriolage ou le vol d'un ordinateur sur lequel se trouve votre gestionnaire de mots de passe pour déchiffrer vos sauvegardes. -* **Perquisition**: que vous soyez coupable ou non, une perquisition peut aboutir à la saisie entière du matériel informatique d'un lieu (voir de plusieurs lieux). -* **Décès/problème de santé**: vous pourriez ne plus être en mesure de taper votre phrase de passe. + +Ci-dessous, une liste de risques triés du plus au moins probable, dont la probabilité reste à adapter selon votre situation (lieu du serveur, qualité des installations, profils d'usagers, etc.). À vous de mettre le curseur là où il faut, notamment en considérant les conséquences d'une perte de données. + +!!! Gardez en tête que les vrais accidents sont liés à la survenue de 2 événements de façon simultanée. + +- **Manque de rigueur**: les stratégies à base de sauvegardes manuelles nécessitent beaucoup de rigueur dans la régularité +- **Mauvaise manipulation**: il peut arriver d'effacer une sauvegarde par erreur lors d'une restauration ou si vous comptez sur un système de synchronisation, vous pourriez supprimer un fichier et que la suppression soit synchronisée de façon instantanée +- **Cryptolocker**: il s'agit de virus qui chiffrent les fichiers et réclament une rançon. Si vos utilisateurs ou utilisatrices utilisent nextcloud et windows, un windows infecté pourrait synchroniser des fichiers chiffrés et ainsi vous perdriez votre copie. +- **Panne matérielle**: les cartes SD sont les supports les moins fiables dans le temps (~2ans de vie dans un serveur), viennent ensuite les disques SSD (environ 3 ans de vie) et les disques durs (3 ans). À noter qu'un équipement neuf a aussi une probabilité non nulle de tomber en panne lors des 6 premiers mois. Dans tous les cas, vos copies ne devraient pas être sur le même support physique. +- **Panne logicielle/bug**: un bug logiciel peut aboutir à la suppression de données ou vous pourriez ne pas savoir réparer un problème et souhaiter restaurer votre système. +- **Panne d'électricité ou d'internet**: avez-vous un plan si ça arrive ? Quid si vous êtes en vacances ? +- **Catastrophe ou événement naturel ou non**: un petit enfant, un chat, la foudre ou une simple fuite peuvent détruire votre matériel. Les incendies ou inondations peuvent aussi mettre à mal votre copie de sauvegarde à l'autre bout de votre logement... +- **Compromission du serveur**: une personne malveillante ou un robot pourrait attaquer votre serveur et supprimer vos données. +- **Vol de machine**: un cambriolage ou le vol d'un ordinateur sur lequel se trouve votre gestionnaire de mots de passe pour déchiffrer vos sauvegardes. +- **Perquisition**: que vous soyez coupable ou non, une perquisition peut aboutir à la saisie entière du matériel informatique d'un lieu (voir de plusieurs lieux). +- **Décès/problème de santé**: vous pourriez ne plus être en mesure de taper votre phrase de passe. ## À propos de la synchronisation Nextcloud ou Thunderbird (IMAP) -Une méthode qui permet une sauvegarde partielle consiste à sauvegarder les fichiers et les emails via des logiciels de synchronisation comme Nextcloud client ou ThunderBird. De cette façon, vous évitez le risque de panne matérielle. + +Une méthode qui permet une sauvegarde partielle consiste à sauvegarder les fichiers et les emails via des logiciels de synchronisation comme Nextcloud client ou ThunderBird. De cette façon, vous évitez le risque de panne matérielle. Si cette méthode est simple à mettre en place, elle n'est pas sans risque du fait de la synchronisation elle-même. Par exemple, si vous êtes sur windows ou mac, vous augmentez de façon non négligeable le risque de perte de données suite au chiffrement des fichiers par un virus de type [cryptolocker](https://fr.wikipedia.org/wiki/Ran%C3%A7ongiciel). Sur tout type de système, une fausse manipulation peut supprimer l'ensemble de vos copies sur le serveur et sur les équipements qui synchronisent. Ce souci est aggravé par le fait que la synchronisation de suppression est en général plutôt instantanée. Si le risque de fausse manipulation peut être atténué via des logiciels de sauvegarde pour PC de bureau comme TimeShift, seule une sauvegarde sur un disque dur externe déconnecté vous protège vraiment des rançongiciels. - - diff --git a/pages/02.administer/20.backups/05.evaluate/evaluate.it.md b/pages/02.administer/20.backups/05.evaluate/evaluate.it.md index 26b518c2c..8059a1b3d 100644 --- a/pages/02.administer/20.backups/05.evaluate/evaluate.it.md +++ b/pages/02.administer/20.backups/05.evaluate/evaluate.it.md @@ -1,4 +1,4 @@ -# --- +--- title: Strategie di backup template: docs taxonomy: @@ -10,10 +10,10 @@ page-toc: depth: 3 --- - In un contesto di self hosting le strategie di backup sono un fattore chiave per sopperire ad eventi inattesi (incendio, corruzione del database, impossibilità di accedere al server, compromissione del server...). La tipologia di backup da adottare dipende dalla importanza dei dati e dei servizi che vogliamo proteggere. Ad esempio, nel contesto di un server di test possiamo evitare un backup integrale (dati e sistema operativo), al contrario, dovremo porre molta più attenzione nel caso di un server in produzione che contenga dati importanti. In questo caso è necessario conservare più copie di backup *in posti diversi*. ## Ottimizzare il backup + Un buon backuo consiste in almeno **tre copie dei dati** (compreso l'originale), salvate su almeno **due supporti distinti** che si trovano a loro volta **in due luoghi distinti** (sufficientemente lontani tra loro) e con due diversi sistemi di stoccaggio. Se il vostro backup è cifrato **questa regola aurea si applica anche alla password o frase di decifrazione**. Un buon backup deve anche essere recente, dovrete quindi essere molto precisi e quando possibile **automatizzare il processo**. @@ -22,46 +22,44 @@ Controllate sempre l'integrità del file di backup. Per ultimo, un buon backup **deve essere facilmente e velocemente accessibile**. Ricorda di documentare il metodo di recupero e di controllare la velocità delle connessioni in download specialmente se la connessione Internet non è simmetrica. - !! Esempi di **backup sicuro e facilmente recuperabile**. -* backup remoto e automatizzato con borg -* backup automatizzato su unità locale esterna con borg -* snapshot o immagine (eseguiti prima di ogni aggiornamento) -* server monitorato con RAID 1 (o una VPS commerciale che può essere su un array) -* password di decifratura salvata su (tre supporti e due luoghi diversi) -## Alcuni esempi di esecuzione del backup +- backup remoto e automatizzato con borg +- backup automatizzato su unità locale esterna con borg +- snapshot o immagine (eseguiti prima di ogni aggiornamento) +- server monitorato con RAID 1 (o una VPS commerciale che può essere su un array) +- password di decifratura salvata su (tre supporti e due luoghi diversi) -* [creare un file di backup e salvarlo manualmente (scelta di default per YunoHost)](/backup#manual-backup) -* [backup automatizzato (scelta consigliata)](/backup#automatic-or-remote-backup) -* [backup su disco esterno](/external_storage) -* [creazione di un'immagine o snapshot](/backup/clone_filesystem) -* [salvataggio dei dati con metodo personalizzato](/backup/custom_backup_methods) +## Alcuni esempi di esecuzione del backup +- [creare un file di backup e salvarlo manualmente (scelta di default per YunoHost)](/backup#manual-backup) +- [backup automatizzato (scelta consigliata)](/backup#automatic-or-remote-backup) +- [backup su disco esterno](/external_storage) +- [creazione di un'immagine o snapshot](/backup/clone_filesystem) +- [salvataggio dei dati con metodo personalizzato](/backup/custom_backup_methods) ## Rischi + Di seguito un elenco di errori in ordine crescente di pericolosità. L'ordine proposto varia in base alla vostra situazione (tipo di server, complessità dell'installazione, permessi degli utenti), ponete attenzione alla vostra configurazione, avendo ben presenti le conseguenze di una possibile perdita dei dati. !!! Tenete presente che i rischi reali sono collegati all'evenienza di 2 eventi contemporanei -* **Imprecisione**: i backup manuali richiedono rigore e regolarità -* **Errata gestione**: cancellazione involontaria di un file di backup in un sistema di sincronizzazione client server di backup, cancellazione che si propaga instantaneamente -* **Cryptolocker**: si tratta di virus che cifrano i file e chiedono un riscatto. Se i vostri utenti usano nextcloud e windows un sistema windows infetto può sincronizzare file cifrati perdendo così le copie di backup. -* **Guasto hardware**: le schede SD sono i supporti meno affidabili nel tempo (si stima meno di 2 anni di vita in un server), seguite dai dischi SSD (circa 3 anni di vita) e i dischi HD (3 anni). Ricordate che neppure un'infrastruttura nuova è esente al 100% da guasti nei primi sei mesi di vita. In ogni caso le copie non devono stare sugli stessi supporti fisici. -* **Bug software**: il malfunzionamento del software può portare alla perdita dei dati oppure potreste non sapere come risolvere un problema e quindi vorrete recuperare il vostro sistema. -* **Assenza di energia elettrica o connessione**: prevedete un piano di azione se dovesse succedere...quando siete in vacanza. -* **Catastrofi naturali e non**: un bambino o di un gatto, un fulmine o una perdita di acqua, incendio e inondazioni possono rovinare il vostro backup custodito nella stanza adiacente. -* **Compromissione del server**: un attacco informatico diretto al vostro server potrebbe cancellarne i dati -* **Furto**: nel caso di furto potreste perdere il software di gestione della password per decriptare il backup. -* **Problemi legali**: per poter dimostrare la vostra innocenza i vostri pc potrebbero essere sequestrati, a casa vostra e altrove -* **Decesso o malattia**: potreste non essere più in grado di digitare la vostra password +- **Imprecisione**: i backup manuali richiedono rigore e regolarità +- **Errata gestione**: cancellazione involontaria di un file di backup in un sistema di sincronizzazione client server di backup, cancellazione che si propaga instantaneamente +- **Cryptolocker**: si tratta di virus che cifrano i file e chiedono un riscatto. Se i vostri utenti usano nextcloud e windows un sistema windows infetto può sincronizzare file cifrati perdendo così le copie di backup. +- **Guasto hardware**: le schede SD sono i supporti meno affidabili nel tempo (si stima meno di 2 anni di vita in un server), seguite dai dischi SSD (circa 3 anni di vita) e i dischi HD (3 anni). Ricordate che neppure un'infrastruttura nuova è esente al 100% da guasti nei primi sei mesi di vita. In ogni caso le copie non devono stare sugli stessi supporti fisici. +- **Bug software**: il malfunzionamento del software può portare alla perdita dei dati oppure potreste non sapere come risolvere un problema e quindi vorrete recuperare il vostro sistema. +- **Assenza di energia elettrica o connessione**: prevedete un piano di azione se dovesse succedere...quando siete in vacanza. +- **Catastrofi naturali e non**: un bambino o di un gatto, un fulmine o una perdita di acqua, incendio e inondazioni possono rovinare il vostro backup custodito nella stanza adiacente. +- **Compromissione del server**: un attacco informatico diretto al vostro server potrebbe cancellarne i dati +- **Furto**: nel caso di furto potreste perdere il software di gestione della password per decriptare il backup. +- **Problemi legali**: per poter dimostrare la vostra innocenza i vostri pc potrebbero essere sequestrati, a casa vostra e altrove +- **Decesso o malattia**: potreste non essere più in grado di digitare la vostra password ## Qualche info sulla sincronizzazione Nextcloud o Thunderbird (IMAP) + Un metodo per un parziale backup consiste nello salvare i file e le mail tramite dei programmi di sincronizzazione quali Nextcloud o Thunderbird. In questo modo eviterete le perdite dovute ad un guasto fisico. La semplicità di tale operazione comporta qualche rischio intrinseco nella natura stessa del metodo, sopratutto se usato in ambiente mac o windows. Un [crytolocker](https://en.wikipedia.org/wiki/Ransomware) sul vostro pc porterebbe come conseguenza la perdita dei file sul server nextcloud, così come una involontaria cancellazione del file sul pc. Normalmente la sincronizzazione tra il pc e il server nextcloud è istantanea e quindi i danni sono irreparabili. Anche se il rischio di evento del genere può essere attenuato con programmi quali Timeshift, solo il backup su un supporto non connesso vi proteggerà dai crytolocker. - - - diff --git a/pages/02.administer/20.backups/05.evaluate/evaluate.md b/pages/02.administer/20.backups/05.evaluate/evaluate.md index 00e6023fd..57d67d98c 100644 --- a/pages/02.administer/20.backups/05.evaluate/evaluate.md +++ b/pages/02.administer/20.backups/05.evaluate/evaluate.md @@ -10,54 +10,55 @@ page-toc: depth: 3 --- - In the context of self-hosting, backups are an important element to compensate for unexpected events (fire, database corruption, loss of access to the server, compromised server...). The backup policy to implement depends on the importance of the services and data you manage. For example, backing up a test server will be of little interest, while you will want to be very careful if you are managing critical data for an association or a company - and in such cases, you will want to store the backups *in a different location or locations*. ## What is a good backup ? -A good backup consists of at least **3 copies of the data** (including the original data), on at least **2 separate storages**, in at least **2 separate locations** (far enough apart) and ideally with 2 separate methods. If your backups are encrypted **these rules also apply to the decryption phrase/key**. -A good backup is also in many cases, a recent backup, so it takes either a lot of rigor or to **automate** the process. +A good backup consists of at least **3 copies of the data**- (including the original data), on at least **2 separate storages**, in at least **2 separate locations** - (far enough apart) and ideally with 2 separate methods. If your backups are encrypted **these rules also apply to the decryption phrase/key**. -A good backup is checked regularly to ensure the effectiveness and integrity of the data. +A good backup is also in many cases, a recent backup, so it takes either a lot of rigor or to **automate*- the process. -Finally, a good backup is one that is **restorable within an acceptable timeframe** for you. Remember to document your restoration method and to estimate the transfer time of a copy, especially if the Internet connections involved are not symmetrical. +A good backup is checked regularly to ensure the effectiveness and integrity of the data. +Finally, a good backup is one that is **restorable within an acceptable timeframe*- for you. Remember to document your restoration method and to estimate the transfer time of a copy, especially if the Internet connections involved are not symmetrical. !!! Example of **a robust and comfortable combination**: -* a remote and automatic backup with borg -* a backup on external disk and automatic with borg -* a regular snapshot/image (and before updates) -* a monitored RAID 1 array (or a commercial VPS that will also be on an array) -* a decryption passphrase stored on 3 media in 2 locations -## Some possible methods +- a remote and automatic backup with borg +- a backup on external disk and automatic with borg +- a regular snapshot/image (and before updates) +- a monitored RAID 1 array (or a commercial VPS that will also be on an array) +- a decryption passphrase stored on 3 media in 2 locations -* [generate an archive and download it manually (default method of YunoHost)](/backup#manual-backup) -* [backup automatically (recommended method)](/backup#automatic-or-remote-backup) -* [generate an archive directly on another disk](/external_storage) -* [make a disk image or snapshot](/backup/clone_filesystem) -* [save useful data via a custom method](/backup/custom_backup_methods) +## Some possible methods +- [generate an archive and download it manually (default method of YunoHost)](/backup#manual-backup) +- [backup automatically (recommended method)](/backup#automatic-or-remote-backup) +- [generate an archive directly on another disk](/external_storage) +- [make a disk image or snapshot](/backup/clone_filesystem) +- [save useful data via a custom method](/backup/custom_backup_methods) ## Risks -Below, a list of risks sorted from the most to the least probable, whose probability remains to be adapted according to your situation (location of the server, quality of the installations, user profiles, etc.). It is up to you to put the cursor where it should be, especially considering the consequences of a data loss. - -!!! Keep in mind that real accidents are linked to the occurrence of 2 events simultaneously. - -* **Lack of rigor**: strategies based on manual backups require a lot of rigor in the regularity -* **Bad handling**: it can happen that a backup is erased by mistake during a restoration or if you rely on a synchronization system, you could delete a file and the deletion would be synchronized instantly -* **Cryptolocker**: this is a virus that encrypts files and demands a ransomware. If your users are using nextcloud and windows, an infected windows could synchronize encrypted files and thus you lose your copy. -* **Hardware failure**: SD cards are the least reliable media over time (~2 years of life in a server), followed by SSD disks (about 3 years of life) and hard drives (3 years). Note that a new equipment has also probability to break down during the first 6 months. In all cases, your copies should not be on the same physical media. -* **Software failure/bug**: a software bug may result in data deletion or you may not know how to fix a problem and want to restore your system. -* **Electricity or internet failure**: do you have a plan if this happens? What if you are on vacation? -* **Disaster or natural or unnatural event**: a small child, a cat, lightning or a simple leak can destroy your equipment. Fires or floods can also destroy your backup copy at the other end of your home... -* **Server compromise**: a malicious person or a robot could attack your server and delete your data -* **Machine theft**: a burglary or theft of a computer on which your password manager is located to decrypt your backups -* **Search**: whether you are guilty or not, a search can result in the seizure of the entire computer equipment of a place (or even several) -* **Death/health problem**: you may not be able to type your passphrase anymore + +Below, a list of risks sorted from the most to the least probable, whose probability remains to be adapted according to your situation (location of the server, quality of the installations, user profiles, etc.). It is up to you to put the cursor where it should be, especially considering the consequences of a data loss. + +!!! Keep in mind that real accidents are linked to the occurrence of 2 events simultaneously. + +- **Lack of rigor**: strategies based on manual backups require a lot of rigor in the regularity +- **Bad handling**: it can happen that a backup is erased by mistake during a restoration or if you rely on a synchronization system, you could delete a file and the deletion would be synchronized instantly +- **Cryptolocker**: this is a virus that encrypts files and demands a ransomware. If your users are using nextcloud and windows, an infected windows could synchronize encrypted files and thus you lose your copy. +- **Hardware failure**: SD cards are the least reliable media over time (~2 years of life in a server), followed by SSD disks (about 3 years of life) and hard drives (3 years). Note that a new equipment has also probability to break down during the first 6 months. In all cases, your copies should not be on the same physical media. +- **Software failure/bug**: a software bug may result in data deletion or you may not know how to fix a problem and want to restore your system. +- **Electricity or internet failure**: do you have a plan if this happens? What if you are on vacation? +- **Disaster or natural or unnatural event**: a small child, a cat, lightning or a simple leak can destroy your equipment. Fires or floods can also destroy your backup copy at the other end of your home... +- **Server compromise**: a malicious person or a robot could attack your server and delete your data +- **Machine theft**: a burglary or theft of a computer on which your password manager is located to decrypt your backups +- **Search**: whether you are guilty or not, a search can result in the seizure of the entire computer equipment of a place (or even several) +- **Death/health problem**: you may not be able to type your passphrase anymore ## About Nextcloud or Thunderbird (IMAP) synchronization -A method that allows a partial backup is to backup files and emails via synchronization software like Nextcloud client or ThunderBird. This way, you avoid the risk of hardware failure. + +A method that allows a partial backup is to backup files and emails via synchronization software like Nextcloud client or ThunderBird. This way, you avoid the risk of hardware failure. If this method is easy to set up, it is not without risk because of the synchronization itself. For example, if you are on Windows or Mac, you increase the risk of data loss following the encryption of files by a [cryptolocker](https://en.wikipedia.org/wiki/Ransomware) type virus. On any type of system, a false manipulation can delete all your copies on the server and on the equipment that synchronizes. This concern is aggravated by the fact that the deletion synchronization is usually rather instantaneous. diff --git a/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.fr.md b/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.fr.md index a0d505ada..2ec15e893 100644 --- a/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.fr.md +++ b/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.fr.md @@ -10,27 +10,28 @@ page-toc: depth: 3 --- - YunoHost propose un couple d'applications pour [BorgBackup](https://www.borgbackup.org/). ## Fonctionnalité + Cette application propose: -* la sauvegarde des données sur un disque externe ou sur un dépôt borg distant -* la déduplication et la compression des fichiers ce qui permet de conserver de nombreuses copies antérieures -* le chiffrement des données, ce qui permet de pouvoir stocker chez un tiers -* de définir finement la fréquence et le type de données à sauvegarder -* un système d'alerte mail en cas de défaut de sauvegarde. + +- la sauvegarde des données sur un disque externe ou sur un dépôt borg distant +- la déduplication et la compression des fichiers ce qui permet de conserver de nombreuses copies antérieures +- le chiffrement des données, ce qui permet de pouvoir stocker chez un tiers +- de définir finement la fréquence et le type de données à sauvegarder +- un système d'alerte mail en cas de défaut de sauvegarde. Il existe des [fournisseurs de dépôts borg distants](https://www.borgbackup.org/support/commercial.html), il est également possible de créer son propre dépôt sur un autre YunoHost avec l'[application borgserver](https://github.com/YunoHost-Apps/borgserver_ynh). La future méthode de sauvegarde intégrée par défaut dans YunoHost sera basée sur ce logiciel. ## Mise en place de la sauvegarde -!!! Pour la mise en place, il faut d'abord installer l'[application borg](https://github.com/YunoHost-Apps/borg_ynh), puis éventuellement l'[application borgserver](https://github.com/YunoHost-Apps/borgserver_ynh). - +!!! Pour la mise en place, il faut d'abord installer l'[application borg](https://github.com/YunoHost-Apps/borg_ynh), puis éventuellement l'[application borgserver](https://github.com/YunoHost-Apps/borgserver_ynh). ## Tester + Avec les apps borg un email est envoyé pour dire si la sauvegarde échoue ou si le repo distant n'a rien reçu. On peut toutefois analyser manuellement pour s'assurer que tout va bien de façon plus complète. ```bash @@ -55,27 +56,32 @@ app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ss Si on est dans le cas d'une migration ou d'une réinstallation, il faut réinstaller borg de la même façon. Si le repo est distant il faut changer la clé publique. Lister les archives disponibles -``` + +```bash app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg list "$(yunohost app setting $app repository)" ``` Créer les archives tar (une archive par app et partie de système) -``` + +```bash app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg export-tar "$(yunohost app setting $app repository)::ARCHIVE" /home/yunohost.backup/archives/ARCHIVE.tar ``` Puis restaurer l'archive de façon classique. ### Restaurer des grosses archives + Si l'espace disponible est inférieur au poids de votre archive, des données décompressées et des dépendances, vous devrez restaurer partie par partie, app par app. Si restaurer app par app ne suffit pas OU si une archive est trop grosse, il peut être judicieux de générer une archive tar sans les "grosses" données d'une app comme si elle avait été générée avec l'[option BACKUP_CORE_ONLY](/backup/include_exclude_files#ne-pas-sauvegarder-les-grosses-quantites-de-donnees). Exemple avec Nextcloud: -``` + +```bash app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg export-tar -e apps/nextcloud/backup/home/yunohost.app "$(yunohost app setting $app repository)::ARCHIVE" /home/yunohost/archives/ARCHIVE.tar ``` Il faudra ensuite extraire ces données directement avec borg -``` + +```bash cd /home/yunohost.app/ app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg extract "$(yunohost app setting $app repository)::ARCHIVE" apps/nextcloud/backup/home/yunohost.app/ mv apps/nextcloud/backup/home/yunohost.app/nextcloud ./ diff --git a/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.it.md b/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.it.md index c9ff5c296..0b6e35274 100644 --- a/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.it.md +++ b/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.it.md @@ -13,12 +13,14 @@ page-toc: YunoHost propone due programmi per [BorgBackup](https://www.borgbackup.org/). ## Funzionalità + con BorgBackup potrete: -* effettuare il backup dei dati in un HD esterno o in un repository borg remoto -* deduplicare e comprimere i file, che permette di mantenere molte versioni precedenti -* la cifratura dei dati, permettendo così di conservare in modo sicuro i file presso soggetti terzi -* definire i tipi di dati da copiare e la frequenza di backup -* ricevere una mail di allerta in caso di fallimento del backup + +- effettuare il backup dei dati in un HD esterno o in un repository borg remoto +- deduplicare e comprimere i file, che permette di mantenere molte versioni precedenti +- la cifratura dei dati, permettendo così di conservare in modo sicuro i file presso soggetti terzi +- definire i tipi di dati da copiare e la frequenza di backup +- ricevere una mail di allerta in caso di fallimento del backup Oltre ai [fornitori terzi di repository](https://www.borgbackup.org/support/commercial.html), vi è la possibilità di hostare il proprio repository su una differente installazione yunohost con installata l'[applicazione borgserver](https://github.com/YunoHost-Apps/borgserver_ynh). @@ -28,10 +30,9 @@ Il futuro metodo di backup integrato in YunoHost sarà basato su BorgBackup !!!Installate l'[applicazione borg](https://github.com/YunoHost-Apps/borg_ynh), ed eventualmente l'[applicazione borgserver](https://github.com/YunoHost-Apps/borgserver_ynh). - ## Test -Con il programma borg una mail viene inviata nel caso la sessione di backup fallisca o nel caso il repository di destinazione non riceva nessun dato. Da terminale possiamo controllare nei minimi dettagli, che tutto funzioni. +Con il programma borg una mail viene inviata nel caso la sessione di backup fallisca o nel caso il repository di destinazione non riceva nessun dato. Da terminale possiamo controllare nei minimi dettagli, che tutto funzioni. ```bash # Elencare i files @@ -55,31 +56,36 @@ app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ss Se effettuiamo il ripristino dopo una migrazione o una reinstallazione dobbiamo reinstallare borg nello stessa maniera. Se il repository si trova in un server remoto bisogna cambiare la chiave pubblica. Elencare gli archivi disponibili -``` + +```bash app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg list "$(yunohost app setting $app repository)" ``` Creare gli archivi tar (uno per ogni applicazione e componente del sistema) -``` + +```bash app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg export-tar "$(yunohost app setting $app repository)::ARCHIVE" /home/yunohost/archives/ARCHIVE.tar ``` In seguito ripristinare l'archivio come di consueto. ### Ripristino di archivi di grandi dimensioni + Se lo spazio disponibile è inferiore alla dimensione del vostro archivio, dei dati scompattati e delle dipendenze, dovrete ripristinare un'applicazione alla volta. Se il ripristino non riesce o se un archivio è troppo grande, è più prudente creare un archivio tar senza la parte più grande dei dati, cioè come se l'archivio fosse stato creato con l'[opzione BACKUP_CORE_ONLY](/backup/include_exclude_files#don't-save-large-quantities-of-data). Di seguito un esempio con Nextcloud: -``` + +```bash app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg export-tar -e apps/nextcloud/backup/home/yunohost.app "$(yunohost app setting $app repository)::ARCHIVE" /home/yunohost/archives/ARCHIVE.tar ``` In seguito si estrarranno questi dati direttamente con borg -``` + +```bash cd /home/yunohost.app/ app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg extract "$(yunohost app setting $app repository)::ARCHIVE" apps/nextcloud/backup/home/yunohost.app/ mv apps/nextcloud/backup/home/yunohost.app/nextcloud ./ rm -r apps ``` - Procedere poi con il consueto metodo di ripristino + Procedere poi con il consueto metodo di ripristino diff --git a/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.md b/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.md index 11584f08c..f12648e05 100644 --- a/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.md +++ b/pages/02.administer/20.backups/10.backup_methods/01.borgbackup/borgbackup.md @@ -10,28 +10,29 @@ page-toc: depth: 3 --- - YunoHost offers a couple of applications for [BorgBackup](https://www.borgbackup.org/). ## Functionality + This application offers: -* backup of data on an external disk or on a remote Borg repository -* deduplication and compression of files, which allows to keep many previous copies -* data encryption, which allows you to store data with a third party -* to define the frequency and type of data to be backed up -* a mail alert system in case of backup failure. + +- backup of data on an external disk or on a remote Borg repository +- deduplication and compression of files, which allows to keep many previous copies +- data encryption, which allows you to store data with a third party +- to define the frequency and type of data to be backed up +- a mail alert system in case of backup failure. There are [remote borg repository providers](https://www.borgbackup.org/support/commercial.html), it is also possible to create your own repository on another YunoHost with the [borgserver application](https://github.com/YunoHost-Apps/borgserver_ynh). The future default backup method integrated in YunoHost will be based on this software. ## Setting up the backup -!!! To set up, first install the [borg application](https://github.com/YunoHost-Apps/borg_ynh), then optionally the [borgserver application](https://github.com/YunoHost-Apps/borgserver_ynh). +!!! To set up, first install the [borg application](https://github.com/YunoHost-Apps/borg_ynh), then optionally the [borgserver application](https://github.com/YunoHost-Apps/borgserver_ynh). ## Test -With the borg apps an email is sent to say if the backup fails or if the remote repo has received nothing. However, you can manually test to make sure everything is fine in a more complete way. +With the borg apps an email is sent to say if the backup fails or if the remote repo has received nothing. However, you can manually test to make sure everything is fine in a more complete way. ```bash # List files @@ -55,27 +56,32 @@ app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ss If we are in the case of a migration or a reinstallation, we must reinstall borg in the same way. If the repo is remote you have to change the public key. List the available archives -``` + +```bash app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg list "$(yunohost app setting $app repository)" ``` Create tar archives (one archive per app and system part) -``` + +```bash app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg export-tar "$(yunohost app setting $app repository)::ARCHIVE" /home/yunohost/archives/ARCHIVE.tar ``` Then restore the archive in the usual way. ### Restore large archives + If the available space is less than the weight of your archive, decompressed data and dependencies, you will have to restore part by part, app by app. If restoring app by app is not enough OR if an archive is too big, it may be a good idea to generate a tarball without the "big" data of an app as if it had been generated with the [BACKUP_CORE_ONLY option](/backup/include_exclude_files#don't-save-large-quantities-of-data). Example with Nextcloud: -``` + +```bash app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg export-tar -e apps/nextcloud/backup/home/yunohost.app "$(yunohost app setting $app repository)::ARCHIVE" /home/yunohost.backup/archives/ARCHIVE.tar ``` You will then have to extract these data directly with borg -``` + +```bash cd /home/yunohost.app/ app=borg; BORG_PASSPHRASE="$(yunohost app setting $app passphrase)" BORG_RSH="ssh -i /root/.ssh/id_${app}_ed25519 -oStrictHostKeyChecking=yes " borg extract "$(yunohost app setting $app repository)::ARCHIVE" apps/nextcloud/backup/home/yunohost.app/ mv apps/nextcloud/backup/home/yunohost.app/nextcloud ./ diff --git a/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.fr.md b/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.fr.md index 6f4aa03a4..d096cc158 100644 --- a/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.fr.md +++ b/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.fr.md @@ -10,13 +10,12 @@ page-toc: depth: 3 --- - ## Fonctionnalité Cette application propose: -* la sauvegarde des données sur un stockage distant (support de différents types de stockage) -* la déduplication et la compression des fichiers ce qui permet de conserver de nombreuses copies antérieures -* le chiffrement des données, ce qui permet de pouvoir stocker chez un tiers -Le paquet permet aussi de définir finement la fréquence et le type de données à sauvegarder et intègre un système d'alerte mail en cas de défaut de sauvegarde. +- la sauvegarde des données sur un stockage distant (support de différents types de stockage) +- la déduplication et la compression des fichiers ce qui permet de conserver de nombreuses copies antérieures +- le chiffrement des données, ce qui permet de pouvoir stocker chez un tiers +Le paquet permet aussi de définir finement la fréquence et le type de données à sauvegarder et intègre un système d'alerte mail en cas de défaut de sauvegarde. diff --git a/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.it.md b/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.it.md index 638e618af..9108e0bc3 100644 --- a/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.it.md +++ b/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.it.md @@ -14,8 +14,8 @@ page-toc: Questa applicazione permette: -* il backup dei dati in rete (compatibile con diverse modalità di stoccaggio dei dati) -* deduplicare e comprimere i file, permettendo di mantenere molte copie precedenti -* la cifratura dei dati, permettendo così di conservare in modo sicuro i file presso soggetti terzi +- il backup dei dati in rete (compatibile con diverse modalità di stoccaggio dei dati) +- deduplicare e comprimere i file, permettendo di mantenere molte copie precedenti +- la cifratura dei dati, permettendo così di conservare in modo sicuro i file presso soggetti terzi Il programma permette di configurare con precisione i dati che devono essere salvati e la frequenza dei backup, e comprende un sistema di allerta via mail nel caso di fallimento nell'esecuzione del backup diff --git a/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.md b/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.md index 30ba422cf..97fe4df4c 100644 --- a/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.md +++ b/pages/02.administer/20.backups/10.backup_methods/02.restic/restic.md @@ -10,12 +10,12 @@ page-toc: depth: 3 --- - ## Functionality This application offers: -* backup of data to remote storage (support for different types of storage) -* deduplication and compression of files, which makes it possible to keep many previous copies -* data encryption, which allows to store data at a third party + +- backup of data to remote storage (support for different types of storage) +- deduplication and compression of files, which makes it possible to keep many previous copies +- data encryption, which allows to store data at a third party The package also allows you to finely define the frequency and type of data to be backed up and integrates an email alert system in case of backup failure. diff --git a/pages/02.administer/20.backups/10.backup_methods/03.archivist/archivist.fr.md b/pages/02.administer/20.backups/10.backup_methods/03.archivist/archivist.fr.md index 0e8c9fcb9..74a4d0699 100644 --- a/pages/02.administer/20.backups/10.backup_methods/03.archivist/archivist.fr.md +++ b/pages/02.administer/20.backups/10.backup_methods/03.archivist/archivist.fr.md @@ -10,13 +10,13 @@ page-toc: depth: 3 --- - ## Fonctionnalité + Cette application se base sur rsync et GPG, elle propose: -* la sauvegarde des données sur un stockage distant (support de différents types de stockage) -* le chiffrement des données, ce qui permet de pouvoir stocker chez un tiers + +- la sauvegarde des données sur un stockage distant (support de différents types de stockage) +- le chiffrement des données, ce qui permet de pouvoir stocker chez un tiers Le paquet permet aussi de définir finement la fréquence et le type de données à sauvegarder et intègre un système d'alerte mail en cas de défaut de sauvegarde. Pour plus d'information : [https://forum.yunohost.org/t/new-app-archivist/3747](https://forum.yunohost.org/t/new-app-archivist/3747) - diff --git a/pages/02.administer/20.backups/10.backup_methods/03.archivist/archivist.md b/pages/02.administer/20.backups/10.backup_methods/03.archivist/archivist.md index 4debd2052..3aff4324e 100644 --- a/pages/02.administer/20.backups/10.backup_methods/03.archivist/archivist.md +++ b/pages/02.administer/20.backups/10.backup_methods/03.archivist/archivist.md @@ -10,14 +10,13 @@ page-toc: depth: 3 --- -!! This application is currently broken! To help fix this application please checkout [https://github.com/YunoHost-Apps/archivist_ynh](https://github.com/YunoHost-Apps/archivist_ynh) - ## Functionality + This application is based on rsync and GPG, it offers: -* backup of data on a remote storage (support for different types of storage) -* data encryption, which allows to store data at a third party + +- backup of data on a remote storage (support for different types of storage) +- data encryption, which allows to store data at a third party The package also allows you to finely define the frequency and type of data to be backed up and integrates an email alert system in case of backup failure. For more information: [https://forum.yunohost.org/t/new-app-archivist/3747](https://forum.yunohost.org/t/new-app-archivist/3747) - diff --git a/pages/02.administer/20.backups/10.backup_methods/backup_methods.md b/pages/02.administer/20.backups/10.backup_methods/backup_methods.md index 37f283b45..daed09c25 100644 --- a/pages/02.administer/20.backups/10.backup_methods/backup_methods.md +++ b/pages/02.administer/20.backups/10.backup_methods/backup_methods.md @@ -11,21 +11,27 @@ page-toc: --- ## [BorgBackup](/borgbackup) + This application offers: -* backup of data on an external disk or on a remote Borg repository -* deduplication and compression of files, which allows to keep many previous copies -* data encryption, which allows you to store data with a third party -* to define the frequency and type of data to be backed up -* a mail alert system in case of backup failure. + +- backup of data on an external disk or on a remote Borg repository +- deduplication and compression of files, which allows to keep many previous copies +- data encryption, which allows you to store data with a third party +- to define the frequency and type of data to be backed up +- a mail alert system in case of backup failure. ## [Restic](/restic) + This application offers: -* backup of data to remote storage (support for different types of storage) -* deduplication and compression of files, which makes it possible to keep many previous copies -* data encryption, which allows to store data at a third party + +- backup of data to remote storage (support for different types of storage) +- deduplication and compression of files, which makes it possible to keep many previous copies +- data encryption, which allows to store data at a third party ## [Archivist](/archivist) + !! This application is currently broken! This application is based on rsync and GPG, it offers: -* backup of data on a remote storage (support for different types of storage) -* data encryption, which allows to store data at a third party + +- backup of data on a remote storage (support for different types of storage) +- data encryption, which allows to store data at a third party diff --git a/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.fr.md b/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.fr.md index 0f17dd911..85475ffae 100644 --- a/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.fr.md +++ b/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.fr.md @@ -19,6 +19,7 @@ Réaliser des images complètes du système peut être un moyen complémentaire Selon votre type d'installation, vous pouvez soit créer un snapshot, soit cloner le support de stockage en le retirant de votre serveur (éteint). ## Déclencher un snapshot + Un snapshot permet de figer une image du système de fichiers. Les snapshots sont très pratiques lorsque l'on fait une mise à jour ou des essais, car ils vous permettent de revenir facilement en arrière en cas de pépin. En revanche, en dehors de quelques clusters de très haute disponibilité, les snapshots ne vous protègent pas vraiment face à des pannes matérielles ou des catastrophes (cf. incendie d'OVH à Strasbourg en 2021). En général, les snapshots sont assez économes en espace disque, le principe est que votre système de fichier va stocker les différences survenues depuis votre snapshot. Ainsi, seules les modifications consomment de l'espace. @@ -30,10 +31,11 @@ Vous pouvez utiliser cette méthode avec la plupart des VPS (souvent payant), de [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="VPS"] Ci-dessous, quelques documentations pour les fournisseurs les plus connus: - * [DigitalOcean (EN)](https://docs.digitalocean.com/products/images/snapshots/) - * [Gandi](https://docs.gandi.net/fr/simple_hosting/operations_courantes/snapshots.html) - * [OVH](https://docs.ovh.com/fr/vps/snapshot-vps/) - * [Scaleway (EN)](https://www.scaleway.com/en/docs/backup-your-data-with-snapshots/) + +- [DigitalOcean (EN)](https://docs.digitalocean.com/products/images/snapshots/) +- [Gandi](https://docs.gandi.net/fr/simple_hosting/operations_courantes/snapshots.html) +- [OVH](https://docs.ovh.com/fr/vps/snapshot-vps/) +- [Scaleway (EN)](https://www.scaleway.com/en/docs/backup-your-data-with-snapshots/) [/ui-tab] [ui-tab title="VirtualBox"] Sélectionner la machine virtuelle et cliquer sur `Snapshots`, puis spécifier le nom du snapshot et cliquer sur `OK`. @@ -47,26 +49,29 @@ Ensuite cliquer sur `Restore Snapshot`. [/ui-tab] [ui-tab title="Proxmox"] - * Sélectionner la machine virtuelle - * Aller dans l'onglet `Backup` - * Cliquer sur `Backup now` - * Choisir le mode `Snapshot` - * Valider +- Sélectionner la machine virtuelle +- Aller dans l'onglet `Backup` +- Cliquer sur `Backup now` +- Choisir le mode `Snapshot` +- Valider [/ui-tab] [ui-tab title="BTRFS"] Ci-dessous on considère que `/pool/volume` est le volume à snapshoter. Créer un snapshot en lecture seule + ``` btrfs subvolume snapshot /pool/volume /pool/volume/$(date +"%Y-%m-%d_%H:%M") ``` Lister les snapshots + ``` btrfs subvolume show /pool/volume ``` Restaurer un snapshot + ``` btrfs sub del /pool/volume btrfs sub snap /pool/volume/2021-07-22_16:12 /pool/volume @@ -74,9 +79,11 @@ btrfs sub del /pool/volume/2021-07-22_16:12 ``` Supprimer un snapshot + ``` btrfs subvolume delete /pool/volume/2021-07-22_16:12 ``` + !! Attention de ne pas supprimer le volume original !!! Voir [ce tutoriel](https://www.linux.com/training-tutorials/how-create-and-manage-btrfs-snapshots-and-rollbacks-linux-part-2/) pour plus d'info @@ -85,44 +92,53 @@ btrfs subvolume delete /pool/volume/2021-07-22_16:12 Ci-dessous on considère que `pool/volume` est le volume à snapshoter. Créer un snapshot + ``` rbd snap create pool/volume@$(date +"%Y-%m-%d_%H:%M") ``` Lister les snapshots + ``` rbd snap ls pool/volume ``` Restaurer un snapshot + ``` rbd snap rollback pool/volume@2021-07-22_16:22 ``` Supprimer un snapshot + ``` rbd snap rm pool/volume@2021-07-22_16:12 ``` + [/ui-tab] [ui-tab title="ZFS"] Ci-dessous on considère que `pool/volume` est le volume à snapshoter. Créer un snapshot + ``` zfs snapshot pool/volume@$(date +"%Y-%m-%d_%H:%M") ``` Lister les snapshots + ``` zfs list -t snapshot -o name,creation ``` Restaurer un snapshot + ``` zfs rollback pool/volume@2021-07-22_16:22 ``` Supprimer un snapshot + ``` zfs destroy pool/volume@2021-07-22_16:12 ``` @@ -130,7 +146,6 @@ zfs destroy pool/volume@2021-07-22_16:12 [/ui-tab] [/ui-tabs] - ## Créer une image du système de fichier à froid Vous pouvez cloner votre support (carte SD, disque ssd, volume de VPS...) pour créer une image disque. Cette image avant compression sera de la taille exacte de votre support, c'est pourquoi cette méthode s'applique plutôt aux machines de moins de 64Go. @@ -140,6 +155,7 @@ Vous pouvez cloner votre support (carte SD, disque ssd, volume de VPS...) pour c [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="Avec USBimager"] Ceci peut être effectué avec [USBimager](https://bztsrc.gitlab.io/usbimager/) (N.B. : assurez-vous de télécharger la version 'Read-write' ! Pas la version 'Write-only' !). Le processus consiste ensuite à "l'inverse" du processus de flashage de la carte SD: + - Éteignez votre serveur - Récupérez la carte SD et branchez-la dans votre ordinateur - Dans USBimager, cliquez sur "Read" pour créer une image ("photographie") de la carte SD. Vous pouvez utiliser le fichier obtenu pour plus tard restaurer le système en entier. @@ -158,4 +174,3 @@ dd if=/dev/mmcblk0 | gzip > ./my_snapshot.gz [/ui-tab] [/ui-tabs] - diff --git a/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.it.md b/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.it.md index 3e8ea2c18..5cddae088 100644 --- a/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.it.md +++ b/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.it.md @@ -19,6 +19,7 @@ Realizzare un'immagine completa può essere un metodo, complementare o alternati In base a quale tipo di installazione avete, potrete creare uno snapshot oppure clonare il supporto che ospita il sistema (mentre è spento). ## Eseguire uno snapshot + Lo snapshot permette di congelare l'immagine del file system. Gli snapshot sono molto comodi in caso di aggiornamenti frequenti o di prove, perché vi permettono di tornare facilmente sui vostri passi in caso di problemi. Purtroppo, a meno di non avere un cluster ad altissima affidabilità, gli snapshot non vi proteggono efficacemente contro i guasti hardware o catastrofi (come l'incendio di OVH a Strasburgo nel 2021). Generalmente gli snapshot non occupano molto spazio sull'hard disk, si basano sul principio del backup differenziale, salvano cioè solo le variazioni dei file avvenute dopo la creazione del primo snapshot. Di conseguenza solo le modifiche prendono spazio. @@ -30,10 +31,11 @@ Potete usare questo sistema con la maggior parte dei fornitori VPS (quasi sempre [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="VPS"] Sotto la documentazione per i provider più conosciuti: - * [DigitalOcean (EN)](https://docs.digitalocean.com/products/images/snapshots/) - * [Gandi](https://docs.gandi.net/fr/simple_hosting/operations_courantes/snapshots.html) - * [OVH](https://docs.ovh.com/fr/vps/snapshot-vps/) - * [Scaleway (EN)](https://www.scaleway.com/en/docs/backup-your-data-with-snapshots/) + +- [DigitalOcean (EN)](https://docs.digitalocean.com/products/images/snapshots/) +- [Gandi](https://docs.gandi.net/fr/simple_hosting/operations_courantes/snapshots.html) +- [OVH](https://docs.ovh.com/fr/vps/snapshot-vps/) +- [Scaleway (EN)](https://www.scaleway.com/en/docs/backup-your-data-with-snapshots/) [/ui-tab] [ui-tab title="VirtualBox"] Seleziona la macchina virtuale e clicca su `Snapshot`, poi indica il nome dello snapshot e clicca `OK`. @@ -47,26 +49,29 @@ Infine cliccate su `Restore Snapshot`. [/ui-tab] [ui-tab title="Proxmox"] -* Selezionate la macchina virtuale -* Andate al tab `Backup` -* Cliccate su `Backup now` -* Scegliete `Snapshot` -* Confermate +- Selezionate la macchina virtuale +- Andate al tab `Backup` +- Cliccate su `Backup now` +- Scegliete `Snapshot` +- Confermate [/ui-tab] [ui-tab title="BTRFS"] Nell'esempio seguente `/pool/volume` è il volume da salvare. Creare uno snapshot in sola lettura + ``` btrfs subvolume snapshot /pool/volume /pool/volume/$(date +"%Y-%m-%d_%H:%M") ``` Elencare gli snapshots + ``` btrfs subvolume show /pool/volume ``` Ripristinare uno snapshots + ``` btrfs sub del /pool/volume btrfs sub snap /pool/volume/2021-07-22_16:12 /pool/volume @@ -74,9 +79,11 @@ btrfs sub del /pool/volume/2021-07-22_16:12 ``` Cancellare uno snapshot + ``` btrfs subvolume delete /pool/volume/2021-07-22_16:12 ``` + !! Attenzione a non cancellate il volume originale !!! Seguite [questo tutorial](https://www.linux.com/training-tutorials/how-create-and-manage-btrfs-snapshots-and-rollbacks-linux-part-2/) per maggiori informazioni @@ -85,43 +92,53 @@ btrfs subvolume delete /pool/volume/2021-07-22_16:12 Nell'esempio seguente `pool/volume` è il volume che vogliamo salvare Creare uno snapshots + ``` rbd snap create pool/volume@$(date +"%Y-%m-%d_%H:%M") ``` Elencare gli snapshot + ``` rbd snap ls pool/volume ``` Ripristinare uno snapshot + ``` rbd snap rollback pool/volume@2021-07-22_16:22 ``` Cancellare uno snapshot + ``` rbd snap rm pool/volume@2021-07-22_16:12 ``` + [/ui-tab] [ui-tab title="ZFS"] Nell'esempio seguente `pool/volume` è il volume che vogliamo salvare. Creare uno snapshot + ``` zfs snapshot pool/volume@$(date +"%Y-%m-%d_%H:%M") ``` Elencare gli snapshots + ``` zfs list -t snapshot -o name,creation ``` + Ripristinare uno snapshot + ``` zfs rollback pool/volume@2021-07-22_16:22 ``` Cancellare uno snapshot + ``` zfs destroy pool/volume@2021-07-22_16:12 ``` @@ -129,7 +146,6 @@ zfs destroy pool/volume@2021-07-22_16:12 [/ui-tab] [/ui-tabs] - ## Creare una immagine a freddo del server Potete clonare il supporto del vostro server (scheda SD, disco SSD, volume di un VPS...) al fine di creare una immagine del disco. L'immagine creata, prima che venga compressa, sarà della stessa dimensione del vostro supporto e di conseguenza questa procedura è consigliata per supporti di capacità inferiore a 64GB. @@ -139,6 +155,7 @@ Questo metodo comporta lo spegnimento del server per il tempo necessario alla cr [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="Usando USBimager"] Questo può essere fatto con il programma [USBimager](https://bztsrc.gitlab.io/usbimager/) (N.B.: assicuratevi di scaricare la versione 'Read-write'! Non la versione 'Write-only'!). Il processo poi prosegue "all'opposto" della copia sulla scheda SD: + - Spegnete il vostro server - Estraete la scheda SD e inseritela nel pc - Nel programma USBimage cliccate su "Read" per creare l'immagine ("photograph") della scheda SD. Il file ottenuto verrà utilizzato per il ripristino del sistema. @@ -157,4 +174,3 @@ dove `/dev/mmcblk0` sarà il vostro supporto (scheda SD o disco). [/ui-tab] [/ui-tabs] - diff --git a/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.md b/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.md index f58727ab9..b6a7780c6 100644 --- a/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.md +++ b/pages/02.administer/20.backups/15.clone_filesystem/clone_filesystem.md @@ -19,6 +19,7 @@ Making full system images can be a complementary or alternative way to backup yo Depending on your type of installation, you can either create a snapshot or clone the storage medium by removing it from your server (turned off). ## Trigger a snapshot + A snapshot allows you to freeze an image of the file system. Snapshots are very useful when doing an update or testing, because they allow you to easily go back in case of a glitch. On the other hand, apart from some very high availability clusters, snapshots do not really protect you against hardware failures or disasters (cf. OVH fire in Strasbourg in 2021). In general, snapshots are quite disk space saving, the principle is that your file system will store the differences that occurred since your snapshot. Thus, only the modifications consume space. @@ -30,10 +31,11 @@ You can use this method with most VPS (often paying), virtual machine managers o [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="VPS"] Below, some documentation for the most known suppliers: - * [DigitalOcean (EN)](https://docs.digitalocean.com/products/images/snapshots/) - * [Gandi](https://docs.gandi.net/fr/simple_hosting/operations_courantes/snapshots.html) - * [OVH](https://docs.ovh.com/fr/vps/snapshot-vps/) - * [Scaleway (EN)](https://www.scaleway.com/en/docs/backup-your-data-with-snapshots/) + +- [DigitalOcean (EN)](https://docs.digitalocean.com/products/images/snapshots/) +- [Gandi](https://docs.gandi.net/fr/simple_hosting/operations_courantes/snapshots.html) +- [OVH](https://docs.ovh.com/fr/vps/snapshot-vps/) +- [Scaleway (EN)](https://www.scaleway.com/en/docs/backup-your-data-with-snapshots/) [/ui-tab] [ui-tab title="VirtualBox"] Select the virtual machine and click `Snapshots`, then specify the snapshot name and click `OK`. @@ -47,26 +49,29 @@ Then click on `Restore Snapshot`. [/ui-tab] [ui-tab title="Proxmox"] - * Select the virtual machine - * Go to the `Backup` tab - * Click on `Backup now`. - * Choose `Snapshot` mode - * Validate +- Select the virtual machine +- Go to the `Backup` tab +- Click on `Backup now`. +- Choose `Snapshot` mode +- Validate [/ui-tab] [ui-tab title="BTRFS"] Below we consider that `/pool/volume` is the volume to snapshot. Create a read-only snapshot + ``` btrfs subvolume snapshot /pool/volume /pool/volume/$(date +"%Y-%m-%d_%H:%M") ``` List snapshots + ``` btrfs subvolume show /pool/volume ``` Restore a snapshot + ``` btrfs sub del /pool/volume btrfs sub snap /pool/volume/2021-07-22_16:12 /pool/volume @@ -74,9 +79,11 @@ btrfs sub del /pool/volume/2021-07-22_16:12 ``` Delete a snapshot + ``` btrfs subvolume delete /pool/volume/2021-07-22_16:12 ``` + !! Be careful not to delete the original volume !!! See [this tutorial](https://www.linux.com/training-tutorials/how-create-and-manage-btrfs-snapshots-and-rollbacks-linux-part-2/) for more info @@ -85,43 +92,53 @@ btrfs subvolume delete /pool/volume/2021-07-22_16:12 Below we consider that `pool/volume` is the volume to snapshot. Create a snapshot + ``` rbd snap create pool/volume@$(date +"%Y-%m-%d_%H:%M") ``` List snapshots + ``` rbd snap ls pool/volume ``` Restore a snapshot + ``` rbd snap rollback pool/volume@2021-07-22_16:22 ``` Delete a snapshot + ``` rbd snap rm pool/volume@2021-07-22_16:12 ``` + [/ui-tab] [ui-tab title="ZFS"] Below we consider that `pool/volume` is the volume to snapshot. Create a snapshot + ``` zfs snapshot pool/volume@$(date +"%Y-%m-%d_%H:%M") ``` List snapshots + ``` zfs list -t snapshot -o name,creation ``` + Restore a snapshot + ``` zfs rollback pool/volume@2021-07-22_16:22 ``` Delete a snapshot + ``` zfs destroy pool/volume@2021-07-22_16:12 ``` @@ -129,8 +146,7 @@ zfs destroy pool/volume@2021-07-22_16:12 [/ui-tab] [/ui-tabs] - -## Create a cold image of the file system +## Create a cold image of the file system You can clone your media (SD card, ssd disk, VPS volume...) to create a disk image. This image before compression will be the exact size of your media, that's why this method applies rather to machines of less than 64GB. @@ -139,6 +155,7 @@ Unless you can read a snapshot, this method requires you to stop the server whil [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="With USBimager"] This can be done with [USBimager](https://bztsrc.gitlab.io/usbimager/) (Note: make sure you download the 'Read-write' version! Not the 'Write-only' version!). The process then consists of the "reverse" of the SD card flashing process: + - Turn off your server - Retrieve the SD card and plug it into your computer - In USBimager, click on "Read" to create an image ("photograph") of the SD card. You can use the resulting file to restore the whole system later. @@ -157,4 +174,3 @@ dd if=/dev/mmcblk0 | gzip > ./my_snapshot.gz [/ui-tab] [/ui-tabs] - diff --git a/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.fr.md b/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.fr.md index 4d32160cb..d0c4c975e 100644 --- a/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.fr.md +++ b/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.fr.md @@ -11,29 +11,38 @@ page-toc: --- ## Sécuriser physiquement votre serveur + Très souvent les personnes qui s'autohébergent n'ont pas de rangement correct pour leur système. Laisser le serveur en plusieurs parties, dans un lieu de passage, accessible à des enfants ou des animaux, ou dans un endroit peu aéré peut vite tourner à la catastrophe. ## Fixer vos disques durs + Idéalement, vos disques durs doivent être fixés pour éviter les vibrations qui peuvent accélérer l'usure du matériel voire atténuer ses performances, notamment s'il y a un autre disque à côté. ## Réduire la swapiness pour les cartes SD et disques SSD + Si vous utilisez un fichier de swap avec un SSD ou une carte SD avec une swapiness trop élevée, votre support de stockage pourrait rendre l'âme prématurément en raison d'un trop grand nombre d'écritures. Pour éviter ça: -``` + +```bash cat /proc/sys/vm/swappiness ``` + Si elle est au-dessus de 10: -``` + +```bash sysctl vm.swappiness=10 nano /etc/sysctl.conf ``` + Si la ligne est présente, changez la valeur vm.swappiness à 10.Sinon, ajoutez la ligne: -``` + +```text vm.swappiness = 10 ``` ## Redondance de stockage + Afin de limiter les pannes matérielles des supports de stockage, il peut être pertinent de mettre en place une grappe de disques en miroir (RAID, ZFS). L'idée ici est que tout ce qui est écrit sur un disque le sera sur l'autre. Ainsi, si l'un tombe en panne, l'autre continue de fonctionner et le serveur est toujours pleinement fonctionnel. Il existe aussi des grappes plus évoluées qui maximisent la tolérance de panne (panne de 2 disques comme le RAID6) ou le stockage (voir RAID 5). @@ -41,6 +50,7 @@ Il existe aussi des grappes plus évoluées qui maximisent la tolérance de pann Toutefois, ces techniques de grappes de disques ne devraient pas être considérées comme des copies de sauvegarde. Une grappe RAID devrait être considérée comme un seul support de stockage. En effet, si cette technique permet d'éviter de devoir réinstaller en cas de crash probable d'un disque, on est loin du risque zéro. Quelques exemples de situations connues des administrateurs systèmes professionnels: + * les disques d'une grappe montée avec des disques de la même marque peuvent tomber en panne quasiment en même temps en moins de quelques heures * sans monitoring de la santé des disques, il y a de fortes chances que l'on ne remarque la panne d'un disque de la grappe que lorsqu'un deuxième tombe en panne (><) * si on n'a pas de disque de rechange, le délai d'achat peut aboutir à un crash de l'autre disque diff --git a/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.it.md b/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.it.md index 75e3858a3..81f11fbac 100644 --- a/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.it.md +++ b/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.it.md @@ -12,29 +12,38 @@ page-toc: ## Rendere sicuro fisicamente il tuo server + Frequentemente la persone che fanno selfhosting non dispongono di spazi adatti per posizionare il proprio server. Posizionare il server, o parti di esso, in un luogo di passaggio, accessibile a bambini o animali, o in un luogo poco ventilato, può avere conseguenze catastrofiche. ## Fissate i vostri HD + Sarebbe opportuno fissare saldamente i propri hard disk al fine di evitare vibrazioni che provocano usura prematura del disco, o ne pregiudicano le performance, in particolar modo se si trovano vicini ad altri dischi. ## Ridurre lo swapiness nelle schede SD e nei dischi SSD + Se utilizzate un file di swap, in un disco SSD o in una scheda SD, con uno swapiness troppo elevato correte il serio rischio di usurare prematuramente il vostro supporto a causa di un numero eccessivo di scritture sul disco. Per evitare il problema -``` + +```bash cat /proc/sys/vm/swappiness ``` + Se il comando restituisce un valore superiore a 10: -``` + +```bash sysctl vm.swappiness=10 nano /etc/sysctl.conf ``` + Se la riga è presente, cambiate il valore vm.swappiness con 10. In caso contrario aggiungete la riga: -``` + +```text vm.swappiness = 10: ``` ## Ridondanza dei supporti + Al fine di limitare i guasti dei supporti si dovrebbe ricorrere ad un cluster di dischi in modalità mirror (RAID, ZFS). Il concetto è che tutto quello che verrà scritto su un disco verrà scritto anche negli altri. In questo modo se un disco subisce un guasto, gli altri garantiranno la funzionalità del server. Altre configurazioni più evolute, migliorano la tolleranza ai guasti (guasto di 2 dischi nel RAID6) o la suddivisione dei dati (RAID 5). @@ -42,6 +51,7 @@ Altre configurazioni più evolute, migliorano la tolleranza ai guasti (guasto di Comunque i sistemi RAID non vanno considerati come metodi di backup. Un RAID deve essere considerato un normale supporto dei dati. Se questo sistema permette di evitare reinstallazioni in caso di guasto ad un disco, esso non ci garantisce che i nostri dati non correranno nessun rischio. Alcune situazioni ben conosciute dagli amministratori di sistema. + * i dischi di un cluster creato con dischi della stessa marca possono guastarsi quasi contemporaneamente nel giro di poche ore * se non monitoriamo lo stato di salute dei nostri dischi, probabilmente ci accorgeremo di un problema ai dischi della configurazione RAID solo quando si guasterà un secondo disco (><) * se non abbiamo un HD di scorta, nell'attesa che arrivi il disco nuovo per sostituire quello danneggiato, si guasterà anche l'altro diff --git a/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.md b/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.md index 1d8e88651..bd80c79d0 100644 --- a/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.md +++ b/pages/02.administer/20.backups/20.avoid_hardware_failure/avoid_hardware_failure.md @@ -12,29 +12,38 @@ page-toc: ## Physically secure your server + Very often people who self-host don't have proper storage for their system. Leaving the server in several parts, in a high traffic area, accessible to children or pets, or in a poorly ventilated area can quickly turn into a disaster. ## Secure your hard drives + Ideally, your hard disks should be fixed to avoid vibrations which can accelerate the wear of the equipment or even reduce its performance, especially if there is another disk next to it. ## Reduce swapiness for SD cards and SSDs + If you use a swap file with an SSD or SD card with too much swapiness, your storage media could give up the ghost prematurely due to too many writes. To avoid this: -``` + +```bash cat /proc/sys/vm/swappiness ``` + If it is above 10: -``` + +```bash sysctl vm.swappiness=10 nano /etc/sysctl.conf ``` + If present, change the vm.swappiness value to 10. Otherwise add the line: -``` + +```text vm.swappiness = 10 ``` ## Storage redundancy + In order to limit hardware failures of storage media, it can be relevant to set up a cluster of mirrored disks (RAID, ZFS). The idea here is that everything that is written to one disk will be written to the other. This way, if one fails, the other continues to work and the server is still fully functional. There are also more advanced clusters that maximize fault tolerance (failure of 2 disks like RAID6) or storage (see RAID 5). @@ -42,6 +51,7 @@ There are also more advanced clusters that maximize fault tolerance (failure of However, these disk clustering techniques should not be considered as backups. A RAID array should be considered as a single storage medium. Indeed, if this technique avoids having to reinstall in case of a probable disk crash, it is far from zero risk. Some examples of situations known to professional system administrators: + * the disks of a cluster mounted with disks of the same brand can fail almost at the same time within a few hours * without monitoring the health of the disks, there is a good chance that the failure of one disk in the cluster will only be noticed when a second one fails (><) * if you don't have a spare disk, the delay in purchasing one may result in the other disk crashing diff --git a/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.fr.md b/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.fr.md index d36f84294..0c29a2f04 100644 --- a/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.fr.md +++ b/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.fr.md @@ -18,7 +18,8 @@ Par défaut, si des configurations suivies par YunoHost sont modifiées, elles s Vous pouvez créer un hook de sauvegarde et un hook de restauration pour ajouter des données à sauvegarder. Ci-dessous un exemple: -/etc/yunohost/hooks.d/backup/99-conf_custom +`/etc/yunohost/hooks.d/backup/99-conf_custom` + ```bash #!/bin/bash @@ -58,7 +59,8 @@ ynh_backup "/etc/yunohost/hooks.d/backup/99-conf_custom" ynh_backup "/etc/yunohost/hooks.d/restore/99-conf_custom" ``` -/etc/yunohost/hooks.d/restore/99-conf_custom +`/etc/yunohost/hooks.d/restore/99-conf_custom` + ```bash #!/bin/bash @@ -105,9 +107,11 @@ ynh_restore_file "/etc/yunohost/hooks.d/restore/99-conf_custom" ``` ## Exclure des fichiers + Il n'existe pas de mécanisme pour exclure d'une sauvegarde au format YunoHost des fichiers spécifiques, en dehors des 2 options présentées ci-dessous: ### Éviter de sauvegarder certains dossiers du `/home` + Si besoin, vous pouvez spécifier que certains dossiers `home` d'utilisateurs ou utilisatrices ne soient pas sauvegardés par la commande `yunohost backup`, en créant un fichier vide nommé `.nobackup` à l'intérieur. Attention ce mécanisme ne fonctionne que pour les **sous-dossiers de premier niveau** du `/home`, comme par exemple `/home/user1` ou `/home/yunohost.multimedia` . Cela ne fonctionne pas pour les autres dossiers ou sous-dossiers, comme par exemple `/home/user1/grosdossier`. @@ -117,7 +121,8 @@ Attention ce mécanisme ne fonctionne que pour les **sous-dossiers de premier ni Certaines apps comme Nextcloud sont potentiellement rattachées à des quantités importantes de données. Il est possible de ne pas les sauvegarder par défaut. Dans ce cas, on dit que l'app "sauvegarde uniquement le core" (de l'app). Lors d'une mise à jour, les apps contenant une grande quantité de données effectuent généralement une sauvegarde sans ces données. -Pour désactiver temporairement 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 : +Pour désactiver temporairement 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 : + ```bash BACKUP_CORE_ONLY=1 yunohost backup create --apps nextcloud ``` @@ -125,7 +130,7 @@ BACKUP_CORE_ONLY=1 yunohost backup create --apps nextcloud Faites montre de prudence : il vous faudra alors sauvegarder vous-même les données des utilisateurs et utilisatrices de Nextcloud. Si vous souhaitez que ce comportement soit permanent: + ```bash yunohost app setting nextcloud do_not_backup_data -v 1 ``` - diff --git a/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.it.md b/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.it.md index a275c742e..d50b4199a 100644 --- a/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.it.md +++ b/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.it.md @@ -18,8 +18,8 @@ YunoHost tiene traccia delle modifiche effettuate utilizzando gli strumenti di d Potete creare un hook di backup e un hook di ripristino per aggiungere i file da salvare. Esempio: +`/etc/yunohost/hooks.d/backup/99-conf_custom` -/etc/yunohost/hooks.d/backup/99-conf_custom ```bash #!/bin/bash @@ -59,7 +59,8 @@ ynh_backup "/etc/yunohost/hooks.d/backup/99-conf_custom" ynh_backup "/etc/yunohost/hooks.d/restore/99-conf_custom" ``` -/etc/yunohost/hooks.d/restore/99-conf_custom +`/etc/yunohost/hooks.d/restore/99-conf_custom` + ```bash #!/bin/bash @@ -105,12 +106,12 @@ ynh_restore_file "/etc/yunohost/hooks.d/backup/99-conf_custom" ynh_restore_file "/etc/yunohost/hooks.d/restore/99-conf_custom" ``` - - ## Escludere file + Esistono solo due metodi per escludere file dal backup di YunoHost: ### Escludere alcune cartelle presenti in `/home` + Se necessario potete specificare quali cartelle nella `home` di un utente non siano da includere nel comando `yunohost backup`, creando al loro interno un file vuoto con l'estensione `.nobackup`. Attenzione: questo metodo funziona solo con la **prima sottodirectory di `/home`** ad esempio `/home/user1` o `/home/yunohost.multimedia`. Al contrario non funzionerà per altre sottodirectory come `/home/user1/miacartella`. @@ -120,8 +121,8 @@ Attenzione: questo metodo funziona solo con la **prima sottodirectory di `/home` Alcuni programmi come Nextcloud sono potenzialmente accompagnati da grandi quantità di dati. In questi casi viene fatto il backup solo del programma stesso (il "core"). Generalmente negli aggiornamenti dei programmi che contengono grandi quantità di dati, questi vengono esclusi dal backup. - Per disattivare temporaneamente, nei programmi che supportano tale procedura, il backup di file di grandi dimensioni potete definire la variabile `BACKUP_CORE_ONLY`. La variabile deve essere definita prima di eseguire il comando di backup: + ```bash BACKUP_CORE_ONLY=1 yunohost backup create --apps nextcloud ``` @@ -129,6 +130,7 @@ BACKUP_CORE_ONLY=1 yunohost backup create --apps nextcloud Attenzione: dovrete procedere fare backup dei dati degli utenti Nextcloud separatamente. Se volete rendere permanente l'impostazione: + ```bash yunohost app setting nextcloud do_not_backup_data -v 1 ``` diff --git a/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.md b/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.md index a99ed2ac7..57d51818b 100644 --- a/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.md +++ b/pages/02.administer/20.backups/25.include_exclude_files/include_exclude_files.md @@ -18,8 +18,8 @@ By default, if configurations tracked by YunoHost are changed, they will be back You can create a backup hook and a restore hook to add data to backup. Here is an example: +`/etc/yunohost/hooks.d/backup/99-conf_custom` -/etc/yunohost/hooks.d/backup/99-conf_custom ```bash #!/bin/bash @@ -59,7 +59,8 @@ ynh_backup "/etc/yunohost/hooks.d/backup/99-conf_custom" ynh_backup "/etc/yunohost/hooks.d/restore/99-conf_custom" ``` -/etc/yunohost/hooks.d/restore/99-conf_custom +`/etc/yunohost/hooks.d/restore/99-conf_custom` + ```bash #!/bin/bash @@ -105,12 +106,12 @@ ynh_restore_file "/etc/yunohost/hooks.d/backup/99-conf_custom" ynh_restore_file "/etc/yunohost/hooks.d/restore/99-conf_custom" ``` - - ## Exclude files + There is no mechanism to exclude specific files from a YunoHost backup, other than the 2 options presented below: ### Avoid backing up certain `/home` folders + If needed, you can specify that certain user `home` folders not be backed up by the `yunohost backup` command, by creating an empty file named `.nobackup` inside. Caution: this setup only works with **first-level subfolders of `/home`**, such as `/home/user1` or `/home/yunohost.multimedia`. It does not work for other levels of subfolders, like `/home/user1/bigfolder/`. @@ -120,8 +121,8 @@ Caution: this setup only works with **first-level subfolders of `/home`**, such Some apps like Nextcloud are potentially attached to large amounts of data. It is possible to not backup them by default. In this case, the app is said to "backup only the core" (of the app). During an update, apps containing a large amount of data usually make a backup without these data. +To temporarily disable backup of large data, for applications that implement this feature, you can set the `BACKUP_CORE_ONLY` variable. To do this, the variable must be set before the backup command: -To temporarily disable backup of large data, for applications that implement this feature, you can set the `BACKUP_CORE_ONLY` variable. To do this, the variable must be set before the backup command: ```bash BACKUP_CORE_ONLY=1 yunohost backup create --apps nextcloud ``` @@ -129,7 +130,7 @@ BACKUP_CORE_ONLY=1 yunohost backup create --apps nextcloud Be careful: you will have to backup Nextcloud users' data yourself. If you want this behavior to be permanent: + ```bash yunohost app setting nextcloud do_not_backup_data -v 1 ``` - diff --git a/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.fr.md b/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.fr.md index 31570cc1e..78319e613 100644 --- a/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.fr.md +++ b/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.fr.md @@ -13,6 +13,7 @@ page-toc: Il est possible de créer votre propre méthode de sauvegarde et de la lier au système de collecte de fichiers à sauvegarder de YunoHost. Ceci peut être utile si vous souhaitez utiliser votre propre logiciel de sauvegarde ou mener des opérations de montages démontages de disques par exemple. Cette opération se fait à l'aide d'un hook et vous permettra de lancer une sauvegarde de cette façon: + ``` yunohost backup create --method custom ``` @@ -20,6 +21,7 @@ yunohost backup create --method custom Ci-dessous, un exemple simpliste qui peut permettre de mettre en place un backup rotationnel avec différents disques que l'on change toutes les semaines: /etc/yunohost/hooks.d/backup_method/05-custom + ```bash #!/bin/bash set -euo pipefail diff --git a/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.it.md b/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.it.md index de2e2cb99..3b1b4b1eb 100644 --- a/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.it.md +++ b/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.it.md @@ -14,6 +14,7 @@ page-toc: È possibile creare un proprio metodo di backup e includerlo nel sistema di raccolta file di backup di YunoHost. Questo può essere utilizzato ad esempio, nel caso utilizziate un particolare programma di backup o vogliate effettuare delle operazioni di montaggio o smontaggio sui vostri HD. Dovrete creare un hook che lancerà il backup utilizzando il metodo personalizzato con questo comando: + ``` yunohost backup create --method custom ``` @@ -21,6 +22,7 @@ yunohost backup create --method custom Di seguito un esempio, semplificato, che esegue il backup con rotazione dei dischi, che vengono sostituiti ogni settimana. /etc/yunohost/hooks.d/backup_method/05-custom + ```bash #!/bin/bash set -euo pipefail diff --git a/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.md b/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.md index 5f27a37bd..a92144adf 100644 --- a/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.md +++ b/pages/02.administer/20.backups/30.custom_backup_methods/custom_backup_methods.md @@ -14,6 +14,7 @@ page-toc: It is possible to create your own backup method and link it to YunoHost's backup file collection system. This can be useful if you want to use your own backup software or conduct disk mount/dismount operations for example. This operation is done with a hook and will allow you to launch a backup this way: + ``` yunohost backup create --method custom ``` @@ -21,6 +22,7 @@ yunohost backup create --method custom Below is a simplistic example that can be used to set up a rotational backup with different disks that are changed every week: /etc/yunohost/hooks.d/backup_method/05-custom + ```bash #!/bin/bash set -euo pipefail diff --git a/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.fr.md b/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.fr.md index c6f1aa8f8..531d4dc08 100644 --- a/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.fr.md +++ b/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.fr.md @@ -15,6 +15,7 @@ page-toc: Si le système d'archive de YunoHost est assez pratique pour migrer un serveur, on peut aussi [migrer de serveur à serveur avec rsync](https://www.man42.net/blog/2017/07/how-to-migrate-a-debian-server/). ## Fusionner 2 serveurs YunoHost -Si vous fusionnez 2 serveurs ensemble, vous devrez recréer les utilisateurs et utilisatrices, ainsi que les domaines et les permissions du premier serveur sur le serveur de destination. Puis vous pourrez restaurer app par app. + +Si vous fusionnez 2 serveurs ensemble, vous devrez recréer les utilisateurs et utilisatrices, ainsi que les domaines et les permissions du premier serveur sur le serveur de destination. Puis vous pourrez restaurer app par app. !! Il existe tout de même une limite concernant les apps qui ont le même ID. Il ne sera pas possible de les restaurer facilement. Attention également à ne pas supprimer l'app éponyme du serveur de destination :/ diff --git a/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.it.md b/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.it.md index 4fe9cb8b8..93a8aa09f 100644 --- a/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.it.md +++ b/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.it.md @@ -16,6 +16,7 @@ page-toc: Il sistema di archiviazione di YunoHost permette di migrare facilmente un server ma potete anche seguire [questo link per migrare un server ad un altro con rsync](https://www.man42.net/blog/2017/07/how-to-migrate-a-debian-server/). ## Aggregare 2 server YunoHost + Se volete aggregare 2 server dovrete ricreare i domini, gli account utenti e i relativi permessi dal primo al server di destinazione. In seguito potrete ripristinare i programmi uno alla volta. !! Esiste però un limite che riguarda i programmi che hanno lo stesso ID che saranno difficilmente ripristinabili. Abbiate cura di non cancellare il programma eponymous del server di destinazione :/ diff --git a/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.md b/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.md index 64daf853d..f5a19ea65 100644 --- a/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.md +++ b/pages/02.administer/20.backups/35.migrate_or_merge_servers/migrate_or_merge_servers.md @@ -16,6 +16,7 @@ page-toc: If YunoHost's archive system is not convenient enough to migrate a server, you can also [migrate from server to server with rsync](https://www.man42.net/blog/2017/07/how-to-migrate-a-debian-server/). ## Merge 2 YunoHost servers -If you merge 2 servers together, you will need to recreate the users, domains and permissions of the first server on the destination server. Then you can restore app by app. + +If you merge 2 servers together, you will need to recreate the users, domains and permissions of the first server on the destination server. Then you can restore app by app. !! There is a limitation concerning apps that have the same ID. It will not be possible to restore them easily. Also be careful not to delete the eponymous app from the destination server :/ diff --git a/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.es.md b/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.es.md index a3aa87237..6449a5cfa 100644 --- a/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.es.md +++ b/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.es.md @@ -10,6 +10,7 @@ routes: Para hacer que el auto-alojamiento esté lo más accesible posible, el Proyecto YunoHost provee un servicio de nombres de dominio *ofertos* y *automáticamente configurados*. Cuando utilizas este servicio, no tienes que configurar tú mismo la [configuración de los registros DNS](/dns_config) que es bastante técnica. Los subdominios siguientes están propuestos : + - `loquequieras.nohost.me` ; - `loquequieras.noho.st` ; - `loquequieras.ynh.fr`. @@ -55,8 +56,9 @@ Si reinstalas tu servidor y quieres utilizar un dominio automático que ya utili ### Cambiar un dominio nohost.me, noho.st o ynh.fr Si quieres utilizar otro dominio automático en tu servidor, primero tienes que cancelar el que ya está configurado, siguiendo estas instrucciones : + 1. Suprimir el dominio de tu instancia (vía webadmin o `yunohost domain remove`). **Cuidado : esto suprimirá todas las aplicaciones instaladas en este dominio así como sus datos**. 2. Pedir la supresión de tu suscripción [en el hilo de discusión dedicado del foro](https://forum.yunohost.org/t/nohost-domain-recovery/442). 3. Suprimir los archivos de configuración automática de tu instancia (únicamente desde la linea de comando por ahora) : `sudo rm /etc/cron.d/yunohost-dyndns && sudo rm -r /etc/yunohost/dyndns` -Luego podrás registrar un nuevo dominio automático. +Luego podrás registrar un nuevo dominio automático. diff --git a/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.fr.md b/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.fr.md index 0a0897a3a..270c9570f 100644 --- a/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.fr.md +++ b/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.fr.md @@ -10,6 +10,7 @@ routes: Afin de rendre l'auto-hébergement le plus accessible possible, le Projet YunoHost fournit un service de noms de domaine *offerts* et *automatiquement configurés*. En utilisant ce service, vous n'avez donc pas à réaliser vous-même la [configuration des enregistrements DNS](/dns_config) qui est assez technique. Les (sous-)domaines suivants sont proposés : + - `cequevousvoulez.nohost.me` ; - `cequevousvoulez.noho.st` ; - `cequevousvoulez.ynh.fr`. @@ -24,7 +25,7 @@ Le service de domaines `nohost.me`, `noho.st` et `ynh.fr` autorise la création YunoHost permet l'installation d'applications sur des sous-domaines (par exemple avoir l'application ownCloud accessible depuis l'adresse `cloud.mondomaine.org`), cette fonctionnalité est aussi permise avec les domaines `nohost.me`, `noho.st` et `ynh.fr` et il est donc possible d’avoir un sous-sous-domaine tel `monapplication.mondomaine.nohost.me`. -Pour créer un sous domaine à un domaine `nohost.me`, `noho.st` et `ynh.fr` il suffit d'ajouter celui-ci à YunoHost de la même manière que n'importe quel autre nom de domaine. +Pour créer un sous domaine à un domaine `nohost.me`, `noho.st` et `ynh.fr` il suffit d'ajouter celui-ci à YunoHost de la même manière que n'importe quel autre nom de domaine. ### Ajouter un domaine nohost.me, noho.st ou ynh.fr après la post-installation @@ -57,6 +58,7 @@ Si vous réinstallez votre serveur et voulez utiliser un domaine automatique dé ### Changer un domaine nohost.me, noho.st ou ynh.fr Si vous voulez utiliser un autre domaine automatique sur votre serveur, vous devez d'abord supprimer celui qui est déjà configuré, selon les instructions suivantes : + 1. Supprimer le domaine de votre instance (par webadmin ou `yunohost domain remove`). **Attention : cela supprimera toute application installée sur ce domaine, ainsi que ses données**. 2. Demander la suppression de votre souscription [dans le fil de discussion dédié du forum](https://forum.yunohost.org/t/nohost-domain-recovery/442). 3. Enlever les fichiers de configuration automatique sur votre instance (uniquement depuis la ligne de commande pour le moment) : `sudo rm /etc/cron.d/yunohost-dyndns && sudo rm -r /etc/yunohost/dyndns` diff --git a/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.it.md b/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.it.md index 299f3174d..2869d1b46 100644 --- a/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.it.md +++ b/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.it.md @@ -8,8 +8,9 @@ routes: --- Al fine di rendere il self-hosting accessibile al maggior numero di persone, il progetto YunoHost fornisce un servizio *gratuito* di nomi di dominio *configurati automaticamente*. Utilizzando questo servizio non dovrete [configurare i record DNS](/dns_config), in generale un'operazione abbastanza complessa. - + Potete scegliere tra i (sotto-) domini seguenti: + - `miosito.nohost.me`; - `miosito.noho.st`; - `miosito.ynh.fr`. @@ -24,9 +25,9 @@ Il servizio di domini `nohost.me`, `noho.st` e `ynh.fr` permette la creazione di YunoHost permette l'installazione di applicazioni in sotto domini (ad esempio avere l'applicazione NextCloud accessibile dall'indirizzo `cloud.miosito.org`), e questa funzionalità è permessa anche con i domini `nohost.me`, `noho.st` e `ynh.fr.` e quindi è possibile avere un sotto-sotto dominio com ad esempio `cloud.miosito.nohost.me`. Per creare un sotto dominio in un dominio `nohost.me`, `noho.st` e `ynh.fr` è sufficiente aggiungere quest'ultimo a YunoHost, con la stessa procedura di un qualsiasi altro nome di dominio. -### Aggiungere un dominio nohost.me, noho.st e ynh.fr dopo la post-installazione. +### Aggiungere un dominio nohost.me, noho.st e ynh.fr dopo la post-installazione -Se avete già effettuato la post-installazione e desiderate aggiungere un dominio del tipo nohost.me, potere utilizzare la sezione "Domini" dall'interfaccia web di amministrazione, +Se avete già effettuato la post-installazione e desiderate aggiungere un dominio del tipo nohost.me, potere utilizzare la sezione "Domini" dall'interfaccia web di amministrazione, scegliendo l'opzione "Non ho un nome di dominio.." Potete compiere la stessa operazione da shell con i seguenti comandi. @@ -51,7 +52,6 @@ yunohost domain main-domain -n miosito.nohost.me Se dovete reinstallare il vostro server e volete utilizzare un dominio offerto da YunoHost ma già utilizzato precedentemente, dovete chiedere la reinizializzazione del dominio [nella specifica sezione del forum](https://forum.yunohost.org/t/nohost-domain-recovery/442). - ### Cambiare uno dominio nohost.me, noho.st, ynh.fr Se volete cambiare il dominio automatico, dovete inizialmente cancellare quello già configurato seguendo le istruzioni seguenti: diff --git a/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.md b/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.md index 0ad0fe9ae..720e4c9d2 100644 --- a/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.md +++ b/pages/02.administer/45.tutorials/05.domains/01.dns_nohost_me/dns_nohost_me.md @@ -10,6 +10,7 @@ routes: In order to make self-hosting as accessible as possible, the YunoHost Project provides a *free* and *automatically configured* domain name service. By using this service, you won't have to [configure DNS records](/dns_config) yourself, which can be tedious and technical. The following (sub)domains are offered: + - `whateveryouwant.nohost.me`; - `whateveryouwant.noho.st`; - `whateveryouwant.ynh.fr`. @@ -24,7 +25,6 @@ The `nohost.me`, `noho.st` and `ynh.fr` domain service allows the creation of su YunoHost allows the installation of applications on subdomains (for example, having the Nextcloud application accessible from the `cloud.mydomain.org` address), this feature is also allowed with the `nohost.me`, `noho.st` and `ynh.fr` domains and so it is possible to have a subdomain such as `my.application.mydomain.nohost.me`. To create a subdomain on `nohost.me`, `noho.st` and `ynh.fr`, you just have to add the subdomain to yunohost like any other domains. - ### Adding a nohost.me, noho.st or ynh.fr domain after the post-installation If you already did the postinstall and want to add an automatic domain, you may do so from the "Domains" web interface, selecting the option "I don't have a domain name..." @@ -51,12 +51,11 @@ yunohost domain main-domain -n whateveryouwant.nohost.me If you reinstall your server and want to use a domain already used previously, you must request a domain reset on the forum [in the dedicated thread](https://forum.yunohost.org/t/nohost-domain-recovery/442). - ### Change a nohost.me, noho.st or ynh.fr domain If you wish to use a different automatic domain, you first have to remove your present domain registration. This is done in 3 steps: -1. Remove the domain from your instance (via webadmin or the `yunohost domain remove` in the CLI). +1. Remove the domain from your instance (via webadmin or the `yunohost domain remove` in the CLI). 2. Ask for registration removal [in the dedicated forum thread](https://forum.yunohost.org/t/nohost-domain-recovery/442). 3. Remove automatic domain configuration files on your server, via CLI only: `sudo rm /etc/cron.d/yunohost-dyndns && sudo rm -r /etc/yunohost/dyndns` diff --git a/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.fr.md b/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.fr.md index 252a63b5c..8d9b35794 100644 --- a/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.fr.md +++ b/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.fr.md @@ -16,43 +16,50 @@ Après avoir mis en place la solution proposée dans ce tutoriel, la redirection La méthode qui sera mise en place consiste à rendre automatique le fait que la box annonce au DNS dynamique qu’elle a changé d’adresse IP publique, et qu’ensuite la zone DNS soit automatiquement changée. ### Bureaux d'enregistrement + Voici quelques bureaux d'enregistrement, qui permettent d'acheter des noms de domaine : -* [OVH](http://ovh.com/) -* [GoDaddy](https://godaddy.com/) -* [Gandi](http://gandi.net/) -* [Namecheap](https://www.namecheap.com/) -* [BookMyName](https://www.bookmyname.com/) + +- [OVH](http://ovh.com/) +- [GoDaddy](https://godaddy.com/) +- [Gandi](http://gandi.net/) +- [Namecheap](https://www.namecheap.com/) +- [BookMyName](https://www.bookmyname.com/) Si vous possédez un nom de domaine chez **OVH**, vous pouvez aller à l’étape 4 et suivre ce [tutoriel](/OVH) étant donné qu’OVH propose un service de DynDNS. #### 1. Créer un compte pour un service de DNS dynamique Voici des sites qui proposent un service de DynDNS gratuitement : -* [DNSexit](https://www.dnsexit.com/Direct.sv?cmd=dynDns) -* [No-IP](https://www.noip.com/remote-access) -* [ChangeIP](https://changeip.com) -* [DynDNS.it (en italien, payant)](https://dyndns.it) -* [DynDNS avec votre propre nom de domaine](https://github.com/opi/DynDNS-with-HE.NET) -* [Duck DNS](https://www.duckdns.org/) -* [ydns.io](https://ydns.io/) + +- [DNSexit](https://www.dnsexit.com/Direct.sv?cmd=dynDns) +- [No-IP](https://www.noip.com/remote-access) +- [ChangeIP](https://changeip.com) +- [DynDNS.it (en italien, payant)](https://dyndns.it) +- [DynDNS avec votre propre nom de domaine](https://github.com/opi/DynDNS-with-HE.NET) +- [Duck DNS](https://www.duckdns.org/) +- [ydns.io](https://ydns.io/) Créer un compte chez l’un d’eux. #### 2. Déplacer les zones DNS + Déplacer les [zones DNS](/dns_config), à l’exception des champs NS, du [bureau d’enregistrement](#registrar) où vous avez acheté votre nom de domaine vers le DNS dynamique où vous avez créé un compte à l’étape 1. #### 3. Basculer la gestion de votre nom de domaine vers le serveur DNS dynamique + Cette étape consiste à faire savoir au [bureau d’enregistrement](#registrar) que le service de DNS sera assuré par le service de DynDNS. Redirigez le champ NS vers l’adresse IP donnée par le service de DynDNS. Ensuite, supprimez les [zones DNS](/dns_config), à l’exception des champs NS, du [bureau d’enregistrement](#registrar). #### 4. Créer un identifiant de DNS dynamique + Sur le service de DNS dynamique créer un identifiant qui sera entré dans un client de DNS dynamique. Ce client peut être votre box ou un paquet installé sur votre serveur comme `ddclient`. Nous allons utiliser le client de la box qui est plus simple à mettre en place. #### 5. Configurer la box + Mettez l’identifiant du DNS dynamique et l’[adresse IP publique](http://ip.yunohost.org/) dans votre box. ![](image://dns_dynamic-ip_box_conf.png?resize=600) diff --git a/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.it.md b/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.it.md index 30e1a2c3d..8aadd30b0 100644 --- a/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.it.md +++ b/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.it.md @@ -9,7 +9,7 @@ routes: ! Prima di continuare, assicuratevi che il vostro indirizzo IP pubblico sia dinamico utilizzando: [ip.yunohost.org](http://ip.yunohost.org/). L'indirizzo IP del vostro router cambia quasi ogni giorno. -Questo tutorial cerca di risolvere il problema con gli IP dinamici: quando l'IP pubblico del vostro router cambia, la zona DNS non viene aggiornata per riflettere il nuovo indirizzo IP e di conseguenza il vostro server non è più raggiungibile con il nome di dominio. +Questo tutorial cerca di risolvere il problema con gli IP dinamici: quando l'IP pubblico del vostro router cambia, la zona DNS non viene aggiornata per riflettere il nuovo indirizzo IP e di conseguenza il vostro server non è più raggiungibile con il nome di dominio. Dopo aver applicato le configurazioni proposte in questo tutorial la redirezione dal vostro nome di dominio del vostro server all'IP reale non verrà più persa. @@ -18,32 +18,37 @@ La configurazione che adotteremo consiste nel rendere automatica la comunicazion ### Registrars Di seguito un elenco, non esaustivo, dei registrar. Qui potere acquistare il vostro dominio: -* [OVH](http://ovh.com/) -* [GoDaddy](https://godaddy.com) -* [Gandi](http://gandi.net) -* [Namecheap](https://www.namecheap.com) -* [BookMyName](https://www.bookmyname.com) -* [Ionos](https://ionos.com) -* [Infomaniak](https://infomaniak.com) + +- [OVH](http://ovh.com/) +- [GoDaddy](https://godaddy.com) +- [Gandi](http://gandi.net) +- [Namecheap](https://www.namecheap.com) +- [BookMyName](https://www.bookmyname.com) +- [Ionos](https://ionos.com) +- [Infomaniak](https://infomaniak.com) Se siete in possesso di un dominio presso **OVH**, saltate al punto 4 e proseguite con il [tutorial](/OVH) considerando che OVH propone un servizio DynDNS. #### 1. Create un account per il servizio DynDNS + Di seguito un elenco, non esaustivo, di offerte dei servizi DynDNS: -* [DNSexit](https://www.dnsexit.com/Direct.sv?cmd=dynDns) -* [No-IP](https://www.noip.com/remote-access) -* [ChangeIP](https://changeip.com/) -* [DynDNS.it (in italiano, a pagamento)](https://dyndns.it/) -* [DynDNS con il suo nome di dominio](https://github.com/opi/DynDNS-with-HE.NET) -* [Duck DNS](https://www.duckdns.org/) -* [ydns.io](https://ydns.io/) -Create un account presso il fornitore scelto. Dovrebbe comunicarvi uno (o più) indirizzi IP per raggiungere il servizio e un login (che dovreste poter configurare da soli). +- [DNSexit](https://www.dnsexit.com/Direct.sv?cmd=dynDns) +- [No-IP](https://www.noip.com/remote-access) +- [ChangeIP](https://changeip.com/) +- [DynDNS.it (in italiano, a pagamento)](https://dyndns.it/) +- [DynDNS con il suo nome di dominio](https://github.com/opi/DynDNS-with-HE.NET) +- [Duck DNS](https://www.duckdns.org/) +- [ydns.io](https://ydns.io/) + +Create un account presso il fornitore scelto. Dovrebbe comunicarvi uno (o più) indirizzi IP per raggiungere il servizio e un login (che dovreste poter configurare da soli). #### 2. Configurate la zona DNS + Copiate la [zona DNS](/dns_config), tranne il record NS, del vostro [registrar](#registrar) verso il DNS dinamico del servizio DynDNS che avete scelto al punto 1 del tutorial. #### 3. Reindirizzate la gestione del vostro dominio verso il server DNS dinamico + In questo passaggio informeremo il [registrar](#registrar) che il servizio DNS sarà affidato al servizio DyDNS. Reindirizzate il campo NS verso l'indirizzo IP fornito dal servizio DyDNS. @@ -51,28 +56,10 @@ Reindirizzate il campo NS verso l'indirizzo IP fornito dal servizio DyDNS. In seguito cancellate la [zona DNS](/dns_config) (eccetto il precedente campo NS) nel vostro [registrar](#registrar). ## 4. Configurazione del router/client + Configurate il vostro router o un client specifico installato sul vostro server come ad esempio `ddclient` con i dati del vostro account DNS dinamico. Qui useremo il client fornito dal router che è il sistema sicuramente più facile. -Inserite il login del servizio di DNS dinamico e l'indirizzo IP pubblico nel vostro router (l'interfaccia varierà sicuramente a seconda dell'ISP che state usando). +Inserite il login del servizio di DNS dinamico e l'indirizzo IP pubblico nel vostro router (l'interfaccia varierà sicuramente a seconda dell'ISP che state usando). ![](image://dns_dynamic-ip_box_conf.png?resize=600) - - - - - - - - - - - - - - - - - - - diff --git a/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.md b/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.md index 9e9a06d29..87550416c 100644 --- a/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.md +++ b/pages/02.administer/45.tutorials/05.domains/02.dns_dynamic_ip/dns_dynamicip.md @@ -18,30 +18,35 @@ The method proposed here consists of automatizing the fact the box announces its ### Registrars Here are some examples of registrars, companies where you can buy domain names: -* [OVH](http://ovh.com/) -* [GoDaddy](https://godaddy.com/) -* [Gandi](http://gandi.net/) -* [Namecheap](https://www.namecheap.com/) -* [BookMyName](https://www.bookmyname.com/) + +- [OVH](http://ovh.com/) +- [GoDaddy](https://godaddy.com/) +- [Gandi](http://gandi.net/) +- [Namecheap](https://www.namecheap.com/) +- [BookMyName](https://www.bookmyname.com/) If you own a domain name at **OVH**, you may go to step 4 and follow this [tutorial](/OVH), given that OVH proposes a DynDNS service. #### 1. Create an account to a Dynamic DNS service + Here are sites which offer a DynDNS service free of charge: -* [DNSexit](https://www.dnsexit.com/Direct.sv?cmd=dynDns) -* [No-IP](https://www.noip.com/remote-access) -* [ChangeIP](https://changeip.com) -* [DynDNS.it (in italian, paid plan)](https://dyndns.it) -* [DynDNS with your own domain](https://github.com/opi/DynDNS-with-HE.NET) -* [Duck DNS](https://www.duckdns.org/) -* [ydns.io](https://ydns.io/) + +- [DNSexit](https://www.dnsexit.com/Direct.sv?cmd=dynDns) +- [No-IP](https://www.noip.com/remote-access) +- [ChangeIP](https://changeip.com) +- [DynDNS.it (in italian, paid plan)](https://dyndns.it) +- [DynDNS with your own domain](https://github.com/opi/DynDNS-with-HE.NET) +- [Duck DNS](https://www.duckdns.org/) +- [ydns.io](https://ydns.io/) Register to one of them. It should provide you with one (or more) IP address to reach the service, and a login (that you may be able to self-define). #### 2. Move the DNS zones + Copy the [DNS zones](/dns_config), except for the NS fields, from the [registrar](#registrar) where you bought your domain name from to the dynamic DNS service you registrer at in step 1. #### 3. Switch the management of your domain name to the dynamic DNS server + This step consists in declaring to your [registrar](#registrar) that the DNS service will now be managed by the DynDNS service provider. For this, first declare in the NS field(s) the IP address provided by the DynDNS service. @@ -49,6 +54,7 @@ For this, first declare in the NS field(s) the IP address provided by the DynDNS Then, remove any other item in the [DNS zones](/dns_config) (except the previous NS fields), from the [registrar](#registrar). #### 4. Configure the client + This client could be your ISP-box, or a package installed on your server, such as `ddclient`. Here, we will use the client provided by the box, which is the more easy way. diff --git a/pages/02.administer/45.tutorials/05.domains/03.dns_subdomains/dns_subdomains.fr.md b/pages/02.administer/45.tutorials/05.domains/03.dns_subdomains/dns_subdomains.fr.md index 37b2b14d4..57806f43c 100644 --- a/pages/02.administer/45.tutorials/05.domains/03.dns_subdomains/dns_subdomains.fr.md +++ b/pages/02.administer/45.tutorials/05.domains/03.dns_subdomains/dns_subdomains.fr.md @@ -15,7 +15,8 @@ YunoHost permet l’usage de sous-domaine. Il faut avoir un nom de domaine par e Dans la configuration de son DNS, on aura donc une entrée A avec l’adresse IPv4, une entrée AAAA avec l’adresse IPv6 et ensuite différents CNAME pour les sous-domaines que l’on souhaite créer. Nom Type Valeur -```bash + +```text @ A XYZ.XYZ.XYZ.XYZ @ AAAA 1234:1234:1234:FFAA:FFAA:FFAA:FFAA:AAFF * CNAME mondomaine.fr. @@ -23,6 +24,7 @@ agenda CNAME mondomaine.fr. blog CNAME mondomaine.fr. rss CNAME mondomaine.fr. ``` + permet d’avoir un `agenda.mondomaine.fr`, un `blog.mondomaine.fr` etc. ### Installer une application sur un sous-domaine diff --git a/pages/02.administer/45.tutorials/05.domains/03.dns_subdomains/dns_subdomains.md b/pages/02.administer/45.tutorials/05.domains/03.dns_subdomains/dns_subdomains.md index c70a0291e..8b14d87b7 100644 --- a/pages/02.administer/45.tutorials/05.domains/03.dns_subdomains/dns_subdomains.md +++ b/pages/02.administer/45.tutorials/05.domains/03.dns_subdomains/dns_subdomains.md @@ -16,7 +16,8 @@ YunoHost allows the use of subdomains. If one owns a domain name `mydomain.com`, The DNS configuration needs an A record with an IPv4 address, an AAAA record with an IPv6 address, and various CNAME records, one for each desired subdomain. If your DNS configuration looks like: -```bash + +```text @ A XYZ.XYZ.XYZ.XYZ @ AAAA 1234:1234:1234:FFAA:FFAA:FFAA:FFAA:AAFF * CNAME mydomain.com. @@ -24,6 +25,7 @@ agenda CNAME mydomain.com. blog CNAME mydomain.com. rss CNAME mydomain.com. ``` + then you can access `agenda.mydomain.com`, `blog.mydomain.com` and `rss.mydomain.com` subdomains. ### Install an application on a subdomain @@ -37,8 +39,8 @@ The application is then available at `blog.mydomain.com` (and not `mydomain.com/ ### Moving an application to a subdomain What happens if the application is already installed? For example, one wants to move `mydomain.com/wordpress` to `blog.mydomain.com`. -It depends on the application. -Some applications allow the change of domain. In that case, one can proceed to the change through the administration panel Applications>the_app>change URL. +It depends on the application. +Some applications allow the change of domain. In that case, one can proceed to the change through the administration panel Applications>the_app>change URL. If the application doesn't allow URL change, then there is no easy way to do it. The best solution is to reinstall the application. ### Reinstalling an application diff --git a/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.es.md b/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.es.md index dcb362d77..b08bab1e1 100644 --- a/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.es.md +++ b/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.es.md @@ -10,12 +10,14 @@ routes: After completing your server installation, it is possible that your domain will not be accessible through the local network. This is an issue known as [hairpinning](http://en.wikipedia.org/wiki/Hairpinning) - a feature that is not well supported by some internet routers. To solve this issue you can: + - configure your router's DNS - or alternatively - your /etc/hosts files on your clients workstation ### Find the local IP address of your server First you need to find out the local IP of your server + - either using the tricks lister [here](/finding_the_local_ip) - or if in the webadmin, in the Diagnosis section, under Internet Connectivity, IPv4, click on 'Details' and you should find an entry for 'Local IP' - or using the command line on the server : `hostname -I` @@ -25,6 +27,7 @@ First you need to find out the local IP of your server Vas a crear una redirección que estará activa en toda tu red local. El objetivo es crear una redirección DNS hacia el IP de tu servidor en tu caja Internet. Hay que acceder a la interfaz de configuración de tu caja y a los parámetros DNS, y luego crear una redirección local (por ejemplo, `yunohost.local` puede redigir hacia `192.168.1.21`). ## Configurar el archivo [hosts](https://es.wikipedia.org/wiki/Archivo_hosts) del ordenador cliente + Sólo deberías modificar el archivo hosts si no puedes modificar el DNS de tu caja Internet / router, porque el archivo hosts únicamente afectará el ordenador en el cual el archivo esté modificado. - En Windows, encontrarás el archivo hosts aquí : @@ -37,5 +40,5 @@ Sólo deberías modificar el archivo hosts si no puedes modificar el DNS de tu c Simplemente añade al final del archivo hosts una linea conteniendo la dirección IP privada del servidor y tu nombre de dominio ```bash -192.168.1.62 domain.tld +192.168.1.62 domain.tld ``` diff --git a/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.fr.md b/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.fr.md index cfbf0e32d..fa7b9a67e 100644 --- a/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.fr.md +++ b/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.fr.md @@ -10,12 +10,14 @@ routes: Après installation de votre serveur, il est possible que votre nom de domaine ne soit pas accessible depuis le réseau local où se trouve le serveur. Ceci est un problème connu sous le nom de [hairpinning](http://fr.wikipedia.org/wiki/Hairpinning) - une fonctionnalité mal supportée par certaines box internet. Pour résoudre ce problème: -- il est nécessaire de configurer le DNS de votre routeur + +- il est nécessaire de configurer le DNS de votre routeur - à défaut, il est possible de modifier le ou les fichiers /etc/hosts de vos ordinateurs clients. ### Trouver l’adresse IP locale du serveur Tout d'abord il vous faut trouver l'adresse IP locale du serveur + - soit en utilisant l'une de astuces expliquées [ici](/finding_the_local_ip) - ou en utilisant la webadmin, dans l'écran Diagnostic, section Connexion Internet, IPv4, cliquer sur 'Détails' et vous devriez trouver une entrée pour 'IP locale'. - ou en ligne de commande sur le serveur: `hostname -I` @@ -31,6 +33,7 @@ Si vous ne disposez toujours pas de l’adresse IP privée de votre serveur, vou #### Configurer le DNS de la box SFR + Rendez-vous dans l’onglet Réseau puis DNS pour ajouter votre nom de domaine au DNS de la box. @@ -48,5 +51,5 @@ La modification du fichier hosts devrait être effectuée seulement si vous ne p Ajoutez simplement à la fin du fichier hosts une ligne contenant l’adresse IP privée du serveur suivi de votre nom de domaine ```bash -192.168.1.62 domain.tld +192.168.1.62 domain.tld ``` diff --git a/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.it.md b/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.it.md index 0487c54be..8bb10b7ae 100644 --- a/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.it.md +++ b/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.it.md @@ -10,21 +10,24 @@ routes: Dopo aver concluso l'installazione del server, è possibile che il vostro dominio non sia accessibile dalla rete locale del server. Questo problema è noto con il nome di [hairpinning](http://en.wikipedia.org/wiki/Hairpinning) ed è una caratteristica non supportata da alcuni router. Per risolvere questo problema dobbiamo: + - configurare i DNS del nostro router -- o in alternativa modificare il file /etc/hosts dei client dai quali vogliamo raggiungere il server +- o in alternativa modificare il file /etc/hosts dei client dai quali vogliamo raggiungere il server ### Trovare l'indirizzo IP del server nella rete locale Dobbiamo innanzitutto conoscere l'IP locale del server + - utilizziamo uno di questi [metodi](https://yunohost.org/en/finding_the_local_ip) - dalla pagina di amministrazione, sezione Diagnostica > Connessione Internet > IPv4 cliccando su 'Dettagli' dovrebbe apparire il valore di 'IP locale' - dal terminale con il comando: `hostname -I` - + ## Configurare il DNS del router Andremo a creare un reindirizzamento attivo su tutta la LAN. Lo scopo è di creare, nel router, un reindirizzamento DNS verso l'IP del server YunoHost. Dobbiamo accedere all'interfaccia di configurazione del router, nella sezione DNS e creare il reindirizzamento nella LAN (ad esempio, `yunohost.local` invia a `192.168.1.21`). ### Box SFR + Se non trovate l'indirizzo IP privato lo potete trovare nel pannello di amministrazione: Andate su Etichetta Network > Generale @@ -38,7 +41,7 @@ Andate all'etichetta Network > DNS e aggiungete il vostro nome a dominio al DNS L'opzione di modificare il file /etc/hosts deve essere presa in considerazione solo se non è possibile configurare il DNS del router, perché tale modifica avrà effetto solo sul pc specifico. -- In windows trovate il file qui: +- In windows trovate il file qui: `%SystemRoot%\system32\drivers\etc\` > È necessario abilitare la visualizzazione dei file nascosti e di sistema per rendere visibile il file hosts. - In sistemi UNIX (GNU/Linux, macOS), trovate il file qui: @@ -48,5 +51,5 @@ L'opzione di modificare il file /etc/hosts deve essere presa in considerazione s Aggiungete alla fine del file una riga contenente l'indirizzo IP del server seguito dal dominio ```bash -192.168.1.62 domain.tld +192.168.1.62 domain.tld ``` diff --git a/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.md b/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.md index 10b777ca0..c8ef01d4e 100644 --- a/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.md +++ b/pages/02.administer/45.tutorials/05.domains/04.dns_local_network/dns_local_network.md @@ -10,12 +10,14 @@ routes: After completing your server installation, it is possible that your domain will not be accessible through the local network. This is an issue known as [hairpinning](http://en.wikipedia.org/wiki/Hairpinning) - a feature that is not well supported by some internet routers. To solve this issue you can: + - configure your router's DNS - or alternatively - your /etc/hosts files on your clients workstation ### Find the local IP address of your server First you need to find out the local IP of your server + - either using the tricks lister [here](/finding_the_local_ip) - or if in the webadmin, in the Diagnosis section, under Internet Connectivity, IPv4, click on 'Details' and you should find an entry for 'Local IP' - or using the command line on the server : `hostname -I` @@ -25,6 +27,7 @@ First you need to find out the local IP of your server The goal here is to create a network wide redirection handled by your router. The idea is to create a DNS redirection to your server's IP. You should access your router's configuration and look for DNS configuration, then add a redirection to your server's IP (e.g. redirect `yunohost.local` to `192.168.1.21`). ### SFR Box + If you haven't found your server private IP, you may find it using the SFR box admin panel: Go to Network tab > General @@ -48,5 +51,5 @@ Modifying hosts file should be done only if you cannot alter your box's DNS or r Add a line at the end of the file containing your server private IP followed by a space and your domain name ```bash -192.168.1.62 domain.tld +192.168.1.62 domain.tld ``` diff --git a/pages/02.administer/45.tutorials/15.filezilla/filezilla.it.md b/pages/02.administer/45.tutorials/15.filezilla/filezilla.it.md index 1c610aac9..7e7c5d2c4 100644 --- a/pages/02.administer/45.tutorials/15.filezilla/filezilla.it.md +++ b/pages/02.administer/45.tutorials/15.filezilla/filezilla.it.md @@ -18,8 +18,8 @@ Potete scaricare FileZilla [da questa pagina](https://filezilla-project.org/down Installate e lanciate *FileZilla* ## Configurazione - -1. Cliccate sull'icona in alto a sinistra *Site Manager*. + +1. Cliccate sull'icona in alto a sinistra *Site Manager*. ![Pagina principale di Filezilla](image://filezilla_1.png) @@ -27,7 +27,7 @@ Installate e lanciate *FileZilla* ![Schermata del site manager](image://filezilla_2.png) -3. Apparirà un avviso poiché vi state collegando per la prima volta al server. *Se è la prima connessione, potete ignorarlo* +3. Apparirà un avviso poiché vi state collegando per la prima volta al server. *Se è la prima connessione, potete ignorarlo* ![Avviso per la fingerprint del server sconosciuta](image://filezilla_3.png) @@ -35,9 +35,9 @@ Installate e lanciate *FileZilla* ![schermata per la richiesta della password](image://filezilla_4.png) -5. Una volta salvato nei segnalibri, il server verrà salvato e vedrete questa schermata. +5. Una volta salvato nei segnalibri, il server verrà salvato e vedrete questa schermata. - ![Schermata del "site manager" con il server appena aggiunto](image://filezilla_5.png) + ![Schermata del "site manager" con il server appena aggiunto](image://filezilla_5.png) ## Utilizzo @@ -79,4 +79,4 @@ Nautilus di Gnome3 integra delle funzionalità simili a FileZilla: ### MacOS -* [Cyberduck](https://cyberduck.io/) un programma libero per macOS +* [Cyberduck](https://cyberduck.io/) un programma libero per macOS diff --git a/pages/02.administer/45.tutorials/25.external_storage/external_storage.fr.md b/pages/02.administer/45.tutorials/25.external_storage/external_storage.fr.md index 07f7e07d3..cb450f707 100644 --- a/pages/02.administer/45.tutorials/25.external_storage/external_storage.fr.md +++ b/pages/02.administer/45.tutorials/25.external_storage/external_storage.fr.md @@ -35,7 +35,7 @@ Ci-dessous, vous trouverez des explications pour parvenir à déplacer vos donn ## 1. Identifier les dossiers à déplacer -La commande `ncdu /` vous permet de naviguer dans les dossiers de votre serveur afin de constater leurs tailles. +La commande `ncdu /` vous permet de naviguer dans les dossiers de votre serveur afin de constater leurs tailles. Ci-dessous, une explication de certains chemins qui peuvent prendre du poids avec quelques commentaires pour vous aider à réduire leur poids ou à choisir de les déplacer. @@ -107,13 +107,14 @@ mkfs.ext4 /dev/VOTRE_DISQUE1 Remplacez `VOTRE_DISQUE1` par le nom de la première partition sur le disque par exemple `sda1`. -!!! Il est possible d'adapter cette étape, pour par exemple créer un volume raid 1 (disques en miroir) ou chiffrer le dossier. +!!! Il est possible d'adapter cette étape, pour par exemple créer un volume raid 1 (disques en miroir) ou chiffrer le dossier. ## 4. Monter le disque Contrairement à Windows où les disques sont accessibles avec des lettres (C:/), sous linux, les disques sont rendus accessibles via l'arborescence. "Monter" un disque signifie le rendre effectivement accessible dans l'arborescence des fichiers. Nous allons choisir arbitrairement de monter le disque dans `/mnt/hdd` mais vous pouvez le nommer différemment (par exemple `/mnt/disque` ...). Commençons par créer le répertoire : + ```bash mkdir /mnt/hdd ``` @@ -126,12 +127,12 @@ mount /dev/VOTRE_DISQUE1 /mnt/hdd (Ici, `/dev/VOTRE_DISQUE1` correspond à la première partition sur le disque) - ## 5. Monter un dossier de /mnt/hdd sur un des dossiers dont on veut déplacer les données Ici on va considérer que vous souhaitez déplacer les grosses données des applications qui se trouvent dans `/home/yunohost.app` ainsi que les mails sur votre disque dur. ### 5.1 Création des sous-dossiers sur le disque + Pour commencer, on crée un dossier dans le disque dur ```bash @@ -140,6 +141,7 @@ mkdir -p /mnt/hdd/var/mail ``` ### 5.2 Passage en mode maintenance + Puis, idéalement on passe en maintenance les applications qui pourraient être en train d'écrire des données. Exemple, pour nextcloud: @@ -205,7 +207,6 @@ A partir de cette étape, vos services tournent avec leurs données sur le disqu ## 6. Monter automatiquement au démarrage - Jusqu'ici, nous avons monté manuellement le disque et les sous-dossiers. Cependant, il est nécessaire de configurer le système pour qu'il monte automatiquement le disque après un démarrage. Si vos tests sont concluants, il faut pérenniser les points de montages, sinon dépêchez-vous de faire machine arrière en commençant par remettre en maintenance. @@ -239,6 +240,7 @@ Utiliser Ctrl+X puis `o` pour sauvegarder. Vous pouvez ensuite tester de redémarrer le système pour vérifier si le disque et les sous-dossiers sont montés automatiquement. ## 7. Nettoyer les anciennes données + Dès que votre nouveau setup est validé, vous pouvez procéder à la suppression des anciennes données issues de l'étape 6.3: ```bash @@ -246,6 +248,6 @@ rm -Rf /home/yunohost.app.bkp rm -Rf /var/mail.bkp ``` -## ![](image://tada.png?resize=32&classes=inline) Félicitations ! +## ![](image://tada.png?resize=32&classes=inline) Félicitations Si vous êtes arrivé jusqu'ici sans dommage, vous avez désormais un serveur qui tire parti d'un ou de plusieurs disques de stockage. diff --git a/pages/02.administer/45.tutorials/25.external_storage/external_storage.it.md b/pages/02.administer/45.tutorials/25.external_storage/external_storage.it.md index 01ed4d7a5..fec751467 100644 --- a/pages/02.administer/45.tutorials/25.external_storage/external_storage.it.md +++ b/pages/02.administer/45.tutorials/25.external_storage/external_storage.it.md @@ -11,13 +11,12 @@ routes: ## Introduzione - Oltre al monitoraggio delle dimensioni delle partizioni (che controlla che non siano troppo piccole), YunoHost non si occupa, al momento, dell'organizzazione delle partizioni dei vostri dischi. Se la vostra configurazione è basata su una board ARM con scheda SD, oppure il server dispone di un disco SSD di piccole dimensioni, potreste, per motivi di spazio o di sicurezza, voler aggiungere uno o più dischi al vostro server. ! Se avete esaurito lo spazio sul disco del vostro server, potete provare con il comando `apt clean` per tentare di recuperarne un po' e avere modo di seguire le istruzioni di seguito riportate. - + Troverete qui le istruzioni per riuscire a spostare i vostri dati su un disco esterno in modo corretto e con un impatto minimo sul funzionamento di YunoHost. Potete eseguire lo spostamento durante l'installazione o in un secondo momento, quando si presenterà la necessità di più spazio o temete per l'affidabilità della scheda SD. !!! Il procedimento presentato qui inizia montando l'unica partizione del disco, in seguito utilizza una o più sotto-cartelle per creare diversi punti di montaggio sull'albero del file system del pc. Questo metodo è preferibile rispetto al utilizzo di link simbolici poiché questi possono entrare in conflitto con alcune applicazioni, tra le quali il sistema di backup di YunoHost. Potreste scegliere di montare le partizioni invece che le sotto-cartelle, ma sorge la difficoltà di prevedere la stima della dimensione della cartella. @@ -29,7 +28,7 @@ Troverete qui le istruzioni per riuscire a spostare i vostri dati su un disco es * Conoscenza della connessione come root sul server anche via [SSH](/ssh). (Nota bene: se siete connessi come utente `admin`, potete passare root con il comando `sudo su`) * Conoscere i comandi `cd`, `ls`, `mkdir`, `rm`. - + * Disporre di un backup nel caso le cose non vadano come previsto * Disporre di un disco aggiuntivo (SSD, hard disk, chiavetta USB) collegato al server via USB o SATA @@ -54,7 +53,6 @@ Di seguito, alcuni esempi di percorsi che possono essere di notevoli dimensioni | `/opt` | Programmi e dipendenze di alcune applicazioni YunoHost | Per motivi di velocità è consigliato lasciare sul disco principale. Per le applicazioni nodejs è possibile recuperare dello spazio cancellando le versioni non in uso | | `/boot` | Kernel e file di avvio | Non spostare se non perfettamente a conoscenza delle possibili conseguenze. Si possono eliminare vecchi kernel non in uso | - ## 2. Collegare e identificare il disco Collegate il disco al server e identificate il nome assegnato dal sistema. @@ -116,6 +114,7 @@ Sostituite `miodisco` con il nome della prima partizione del disco di destinazio Contrariamente a Windows, dove i dischi sono contraddistinti da lette (C:/), in linux i dischi sono accessibili dall'albero del gestore dei file. "Montare" un disco significa renderlo accessibile nell'albero dei file. Sceglieremo di montare il disco in `/mnt/hdd` ma possiamo anche assegnare un nome di fantasia. (Ad esempio `/mnt/disco` ...). Iniziamo creando la directory: + ```bash mkdir /mnt/hdd ``` @@ -133,6 +132,7 @@ mount /dev/miodisco /mnt/hdd Ipotizzeremo, di seguito, lo spostamento delle mail e di una notevole quantità di dati delle applicazioni, che si trovano in `/home/yunohost.app`. ### 5.1 Creazione delle sotto cartelle sul disco + Iniziamo creando due cartelle nel disco di destinazione. ```bash @@ -141,6 +141,7 @@ mkdir -p /mnt/hdd/var/mail ``` ### 5.2 Passaggio alla modalità manutenzione + Precauzionalmente portiamo nello stato di manutenzione le applicazioni che potrebbero scrivere dei dati nella cartella che vogliamo spostare. Ad esempio, per nextcloud: @@ -206,10 +207,9 @@ Dopo aver impartito i comandi di avvio, le applicazioni e i servizi sfrutteranno ## 6. Automatizzare il montaggio all'avvio - Fino ad ora, abbiamo montato manualmente il disco e le sotto cartelle. È però necessario configurare il sistema affinché il disco esterno venga montato in automatico ad ogni avvio. -Se i test di velocità sono soddisfacenti, bisogna rendere definitivo il punto di montaggio. In caso contrario affrettatevi a fare dietro front iniziando a ripristinare la modalità di manutenzione. +Se i test di velocità sono soddisfacenti, bisogna rendere definitivo il punto di montaggio. In caso contrario affrettatevi a fare dietro front iniziando a ripristinare la modalità di manutenzione. Iniziamo cercando l'UUID (universal identifier, identificatore universale) del nostro disco: @@ -240,6 +240,7 @@ Salvate le modifiche con CTRL+x e `o`. Riavviate il server per assicurarvi che il disco e le sotto cartelle vengano montate in automatico. ## 7. Cancellare i dati precedenti + Quando siete sicuri che la configurazione sia corretta, potete procedere alla cancellazione della configurazione creata nel punto 5.3: ```bash @@ -247,7 +248,6 @@ rm -Rf /home/yunohost.app.bkp rm -Rf /var/mail.bkp ``` -### ![](image://tada.png?resize=32&classes=inline) Complimenti!!! +### ![](image://tada.png?resize=32&classes=inline) Complimenti Se siete giunti fino qui senza incidenti, avete configurato un server che sfrutta uno o più dischi per il salvataggio dei dati. - diff --git a/pages/02.administer/45.tutorials/25.external_storage/external_storage.md b/pages/02.administer/45.tutorials/25.external_storage/external_storage.md index d5bec860c..a75aaa910 100644 --- a/pages/02.administer/45.tutorials/25.external_storage/external_storage.md +++ b/pages/02.administer/45.tutorials/25.external_storage/external_storage.md @@ -10,7 +10,6 @@ routes: --- ## Introduction - Apart from the monitoring system that ensures that your system's partitions are not too small, YunoHost does not currently deal with the organisation of your partitions and disks. @@ -36,7 +35,7 @@ Below you will find explanations on how to move your data to a hard disk in a co ## 1. Identify directories to be moved -The `ncdu /` command allows you to browse the folders on your server to see how big they are. +The `ncdu /` command allows you to browse the folders on your server to see how big they are. Below is an explanation of some of the paths that can take up weight with some comments to help you reduce their weight or choose to move them. @@ -54,7 +53,6 @@ Below is an explanation of some of the paths that can take up weight with some c | `/opt` | Program and dependency of some YunoHost applications. | Ideally leave it on the SSD for performance reasons. For nodejs applications it is possible to do some cleanup of unused versions. | `/boot` | Kernels and boot files | Do not move unless you know what you are doing. It can happen that too many kernels are kept, it is possible to do some cleanup. - ## 2. Connect and identify the disk Start by connecting your disk to your system. You must then identify the name under which the disk is designated by the system. @@ -109,13 +107,14 @@ mkfs.ext4 /dev/YOUR_DISK1 Replace `YOUR_DISK1` with the name of the first partition on the disk e.g. `sda1`. -!!! It is possible to adapt this step, for example to create a raid 1 volume (mirrored disks) or encrypt the folder. +!!! It is possible to adapt this step, for example to create a raid 1 volume (mirrored disks) or encrypt the folder. ## 4. Mount the disk Unlike Windows where disks are accessed with letters (C:/), under Linux, disks are made accessible via the file tree. "Mounting" a disk means making it effectively accessible in the file tree. We will arbitrarily choose to mount the disk in `/mnt/hdd` but you can name it differently (e.g. `/mnt/disk` ...). Let's start by creating the directory : + ```bash mkdir /mnt/hdd ``` @@ -133,6 +132,7 @@ mount /dev/YOUR_DISK1 /mnt/hdd Here we will consider that you want to move the big data of the applications which are in /home/yunohost.app and the mails on your hard disk. ### 5.1 Creating subfolders on the disk + To begin with, we create a folder on the hard drive ```bash @@ -141,6 +141,7 @@ mkdir -p /mnt/hdd/var/mail ``` ### 5.2 Switching to maintenance mode + Then, ideally, we switch to maintenance mode the applications that might be writing data. Example, for nextcloud: @@ -206,7 +207,6 @@ From this point on, your services are running with their data on disk, so it's t ## 6. Automatically mount on boot - So far we have manually mounted the disk and subfolders. However, it is necessary to configure the system to automatically mount the disk after a boot. If your tests are successful, you should keep the mount points, otherwise you should hurry up and go back to maintenance first. @@ -238,6 +238,7 @@ Use Ctrl+X then `y` to save. You can then try rebooting the system to check if the disk and subfolders are mounted automatically. ## 7. Clean up old data + Once your new setup is validated, you can proceed to delete the old data from step 5.3: ```bash @@ -245,6 +246,6 @@ rm -Rf /home/yunohost.app.bkp rm -Rf /var/mail.bkp ``` -## ![](image://tada.png?resize=32&classes=inline) Congratulations! +## ![](image://tada.png?resize=32&classes=inline) Congratulations If you have made it this far without damage, you now have a server that takes advantage of one or more storage disks. diff --git a/pages/02.administer/45.tutorials/35.email_relay/email_configure_relay.fr.md b/pages/02.administer/45.tutorials/35.email_relay/email_configure_relay.fr.md index 006c0bfb4..765d27f2c 100644 --- a/pages/02.administer/45.tutorials/35.email_relay/email_configure_relay.fr.md +++ b/pages/02.administer/45.tutorials/35.email_relay/email_configure_relay.fr.md @@ -39,12 +39,14 @@ Habituellement les fournisseurs ont une documentation à ce sujet. ! [fa=exclamation-triangle /] Attention une fois la zone DNS enregistrée, le relais SMTP peut envoyer des e-mails à votre nom sans que vous ne le sachiez ## Étape 3 :Configurer YunoHost correctement + Il est possible de configurer soit via la webadmin ou en ligne de commande. -[ui-tabs position="top-left" active="0" theme="lite"] +[ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="Depuis la webadmin"] Depuis l'interface d'administration, dans la section `Outils` > `Paramètres de YunoHost`, et l'onglet `Email`. Il suffit d'activer l'option, et de renseigner les champs nécessaires : + - **Adresse du relais SMTP** : L'url pour le serveur SMTP. - **Port du relais SMTP** : Le port utilisé sur le serveur renseigné. - **Utilisateur du relais SMTP** : Login ou mail d'identification pour le serveur. @@ -54,11 +56,12 @@ Il suffit d'activer l'option, et de renseigner les champs nécessaires : ![Option-Relais-Smtp](image://relay_smtp_option_webadmin_en.png?resize=800) -[/ui-tab] +[/ui-tab] [ui-tab title="En ligne de commande"] Pour que YunoHost soit capable d'utiliser le relais, il faut paramétrer 4 choses. + 1. Votre url de relais SMTP (on utilisera `smtprelay.tld`). -2. Le port sur lequel on accède au relais (on utilisera le port 2525 ci-dessous) +2. Le port sur lequel on accède au relais (on utilisera le port 2525 ci-dessous) 3. Votre nom d'utilisateur SMTP (on utilisera `username`). 4. Votre mot de passe SMTP (on utilisera `password`). @@ -66,13 +69,13 @@ Pour que YunoHost soit capable d'utiliser le relais, il faut paramétrer 4 chose Le fournisseur SMTP vous fournit ces trois informations. -Premièrement se connecter sur son serveur en SSH avec la commande : +Premièrement se connecter sur son serveur en SSH avec la commande : ```bash ssh admin@domain.tld ``` -Ensuite, mettre à jour les informations suivantes : +Ensuite, mettre à jour les informations suivantes : ```bash sudo yunohost settings set email.smtp.smtp_relay_enabled -v yes diff --git a/pages/02.administer/45.tutorials/35.email_relay/email_configure_relay.md b/pages/02.administer/45.tutorials/35.email_relay/email_configure_relay.md index 2a09fa014..340b01745 100644 --- a/pages/02.administer/45.tutorials/35.email_relay/email_configure_relay.md +++ b/pages/02.administer/45.tutorials/35.email_relay/email_configure_relay.md @@ -36,31 +36,35 @@ Once registered, the SMTP relay provider will usually ask you to modify your DNS Standard procedure is to add a DKIM key and a SPF key to your DNS records. The way to modify these records and the value of the keys you'll have to add depend both on your domain name provider and SMTP relay provider. -Usually, the SMTP relay provider will provide you with a guide on how to modify these records, together with an automatic check tool that will tell you when your DNS have been setup correctly. That step is mandatory to prove "the world" that you, owner of your domain name, did explicitly authorize your SMTP relay provider to send emails on your behalf. +Usually, the SMTP relay provider will provide you with a guide on how to modify these records, together with an automatic check tool that will tell you when your DNS have been setup correctly. That step is mandatory to prove "the world" that you, owner of your domain name, did explicitly authorize your SMTP relay provider to send emails on your behalf. Please note that modifying your DNS records could sometimes take over 24h to take effect, so be patient! ! [fa=exclamation-triangle /] From now on, a non trusty SMTP relay provider could send emails from your main domain without telling you. ### Step 3: Setup YunoHost correctly + It can be configured either from the webadmin or the command line. -[ui-tabs position="top-left" active="0" theme="lite"] +[ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="From the webadmin"] Go to your web admin, in `Tools` > `Yunohost Settings` and `Email`. Now set all options requests : + - **SMTP relay host** : SMTP server url. - **SMTP relay port** : Port use with the distant server. - **SMTP relay user** : Login or identification mail server. - **SMTP relay password** : Your SMTP relay password. -- +- + ! [fa=exclamation-triangle /] Password with `#` char won't works properly due to postfix limitation (it's possible other chars are forbidden, don't hesitate to report it to update this doc). ![Option-Relais-Smtp](image://relay_smtp_option_webadmin_en.png?resize=800) -[/ui-tab] +[/ui-tab] [ui-tab title="From the command line"] In order to setup your YunoHost to use your SMTP relay, you will have to configure four things: + 1. Your SMTP relay URL (for this tutorial we will use `smtprelay.tld`) 2. The port on which you access the relay (for this tutorial we will use port 2525 below) 3. Your SMTP relay username (for this tutorial we will use `username`) @@ -71,6 +75,7 @@ In order to setup your YunoHost to use your SMTP relay, you will have to configu Your SMTP relay will obviously provide you with these four things, that should be available in your control panel or whatsoever. You can log into your YunoHost server using SSH: + ```bash ssh admin@yourdomain.tld ``` diff --git a/pages/02.administer/45.tutorials/40.tor/torhiddenservice.fr.md b/pages/02.administer/45.tutorials/40.tor/torhiddenservice.fr.md index a84093354..17b667ead 100644 --- a/pages/02.administer/45.tutorials/40.tor/torhiddenservice.fr.md +++ b/pages/02.administer/45.tutorials/40.tor/torhiddenservice.fr.md @@ -7,14 +7,16 @@ routes: default: '/torhiddenservice' --- -! Ce tuto n'est pas complet ! Des données peuvent être récupérées avec cette installation comme le nom de domaine principal de votre yunohost, donc ce n'est pas un "service caché". Voir https://www.torproject.org/docs/tor-hidden-service.html.en (anglais) +! Ce tuto n'est pas complet ! Des données peuvent être récupérées avec cette installation comme le nom de domaine principal de votre yunohost, donc ce n'est pas un "service caché". Voir (anglais) ### Installer Tor + ```bash apt install tor ``` -### Configurer notre service caché +###  Configurer notre service caché + Éditer le fichier `/etc/tor/torrc`, et ajouter ces lignes : ```bash @@ -24,11 +26,13 @@ HiddenServicePort 443 127.0.0.1:443 ``` ### Redémarrer Tor + ```bash systemctl restart tor ``` ### Obtenir l’adresse du service caché + ```bash cat /var/lib/tor/hidden_service/hostname ``` @@ -36,11 +40,13 @@ cat /var/lib/tor/hidden_service/hostname Le nom de domaine ressemble à *random123456789.onion* ### Ajouter le domaine .onion à YunoHost + ```bash yunohost domain add random123456789.onion ``` ### Éviter la redirection vers le SSO (optionnel) + Si vous voulez éviter d’être redirigé vers le portail à la connexion pour des raisons de traçabilité, vous pouvez désactiver SSOwat pour le domaine, en éditant le fichier `/etc/nginx/conf.d/random123456789.onion.conf` et en commentant la ligne suivante (elle apparaît deux fois dans le fichier) : ```bash @@ -48,11 +54,13 @@ Si vous voulez éviter d’être redirigé vers le portail à la connexion pour ``` ### Vérifier que l'on a pas fait d'erreurs dans la configuration de NGINX + ```bash nginx -t ``` ### Si tout est OK on applique les modifications de la configuration + ```bash systemctl reload nginx ``` diff --git a/pages/02.administer/45.tutorials/40.tor/torhiddenservice.it.md b/pages/02.administer/45.tutorials/40.tor/torhiddenservice.it.md index 406e2fa32..e747df37d 100644 --- a/pages/02.administer/45.tutorials/40.tor/torhiddenservice.it.md +++ b/pages/02.administer/45.tutorials/40.tor/torhiddenservice.it.md @@ -7,14 +7,16 @@ routes: default: '/torhiddenservice' --- -! Questo tutorial non è completo! Con queste impostazioni alcuni dati possono essere rivelati come ad esempio il dominio principale del tuo yunohost, di conseguenza non può essere considerato un reale "Hidden service". Vedi https://www.torproject.org/docs/tor-hidden-service.html +! Questo tutorial non è completo! Con queste impostazioni alcuni dati possono essere rivelati come ad esempio il dominio principale del tuo yunohost, di conseguenza non può essere considerato un reale "Hidden service". Vedi ### Installare Tor + ```bash apt install tor ``` ### Configurazione dell'hidden service + Modifica `/etc/tor/torrc` aggiungendo queste righe: ```bash @@ -24,11 +26,13 @@ HiddenServicePort 443 127.0.0.1:443 ``` ### Riavvia Tor + ```bash service tor restart ``` ### Copia l'hostname del tuo Hidden Service + ```bash cat /var/lib/tor/hidden_service/hostname ``` @@ -36,11 +40,13 @@ cat /var/lib/tor/hidden_service/hostname Il dominio dell'hidden service sarà una cosa tipo *random123456789.onion* ### Aggiungi il dominio .onion a YunoHost + ```bash yunohost domain add random123456789.onion ``` ### Disabilita la redirezione SSO (opzionale) + Se non vuoi essere rediretto al portale SSO al login puoi disattivare SSOwat specificatamente per questo dominio modificando il file `/etc/nginx/conf.d/random123456789.onion.conf` commentando le seguenti linee (due volte): ```bash @@ -48,7 +54,7 @@ Se non vuoi essere rediretto al portale SSO al login puoi disattivare SSOwat spe ``` ### Riavvia NGINX + ```bash service nginx restart ``` - diff --git a/pages/02.administer/45.tutorials/40.tor/torhiddenservice.md b/pages/02.administer/45.tutorials/40.tor/torhiddenservice.md index 71dadd676..f4656e185 100644 --- a/pages/02.administer/45.tutorials/40.tor/torhiddenservice.md +++ b/pages/02.administer/45.tutorials/40.tor/torhiddenservice.md @@ -7,14 +7,16 @@ routes: default: '/torhiddenservice' --- -! This tuto is not finished ! Some data could leak with this setup like the main domain of your yunohost, so it's not a "Hidden Service". See https://www.torproject.org/docs/tor-hidden-service.html.en +! This tuto is not finished ! Some data could leak with this setup like the main domain of your yunohost, so it's not a "Hidden Service". See + +###  Installing Tor -### Installing Tor ```bash apt install tor ``` -### Configuring our hidden service +###  Configuring our hidden service + Edit `/etc/tor/torrc`, and add these lines: ```bash @@ -23,12 +25,14 @@ HiddenServicePort 80 127.0.0.1:80 HiddenServicePort 443 127.0.0.1:443 ``` -### Restart Tor +###  Restart Tor + ```bash service tor restart ``` ### Get your Tor Hidden Service hostname + ```bash cat /var/lib/tor/hidden_service/hostname ``` @@ -36,11 +40,13 @@ cat /var/lib/tor/hidden_service/hostname Your domain looks like *random123456789.onion* ### Add the .onion domain to YunoHost + ```bash yunohost domain add random123456789.onion ``` ### Avoid SSO redirection (optional) + If you want to avoid being redirected to the SSO portal at login, you can deactivate SSOwat for this specific tor domain, by editing the file `/etc/nginx/conf.d/random123456789.onion.conf` and commenting the following line (two times): ```bash @@ -48,6 +54,7 @@ If you want to avoid being redirected to the SSO portal at login, you can deacti ``` ### Restart NGINX + ```bash service nginx restart ``` diff --git a/pages/02.administer/45.tutorials/45.certificate_custom/certificate_custom.fr.md b/pages/02.administer/45.tutorials/45.certificate_custom/certificate_custom.fr.md index 2ff450ab0..d21e95384 100644 --- a/pages/02.administer/45.tutorials/45.certificate_custom/certificate_custom.fr.md +++ b/pages/02.administer/45.tutorials/45.certificate_custom/certificate_custom.fr.md @@ -58,22 +58,26 @@ sudo mv *.pem *.cnf yunohost_self_signed/ En fonction de l’autorité d’enregistrement, des certificats intermédiaires et racines doivent être obtenus. > **StartSSL** +> > ```bash > sudo wget http://www.startssl.com/certs/ca.pem -O ae_certs/ca.pem > sudo wget http://www.startssl.com/certs/sub.class1.server.ca.pem -O ae_certs/intermediate_ca.pem >``` > **Gandi** +> > ```bash > sudo wget https://www.gandi.net/static/CAs/GandiStandardSSLCA2.pem -O ae_certs/intermediate_ca.pem >``` > **RapidSSL** +> > ```bash > sudo wget https://knowledge.rapidssl.com/library/VERISIGN/INTERNATIONAL_AFFILIATES/RapidSSL/AR1548/RapidSSLCABundle.txt -O ae_certs/intermediate_ca.pem >``` > **Cacert** +> > ```bash > sudo wget http://www.cacert.org/certs/root.crt -O ae_certs/ca.pem > sudo wget http://www.cacert.org/certs/class3.crt -O ae_certs/intermediate_ca.pem @@ -138,4 +142,4 @@ Rechargez la configuration de NGINX pour prendre en compte le nouveau certificat sudo service nginx reload ``` -Votre certificat est prêt à servir. Vous pouvez toutefois vous assurer de sa mise en place en testant le certificat à l’aide du service de geocerts. +Votre certificat est prêt à servir. Vous pouvez toutefois vous assurer de sa mise en place en testant le certificat à l’aide du service de geocerts. diff --git a/pages/02.administer/45.tutorials/45.certificate_custom/certificate_custom.md b/pages/02.administer/45.tutorials/45.certificate_custom/certificate_custom.md index ee6eeb545..7f5a707ed 100644 --- a/pages/02.administer/45.tutorials/45.certificate_custom/certificate_custom.md +++ b/pages/02.administer/45.tutorials/45.certificate_custom/certificate_custom.md @@ -57,22 +57,26 @@ sudo mv *.pem *.cnf yunohost_self_signed/ Depending on the registration authority, intermediate and root certificates must be obtained. > **StartSSL** +> > ```bash > sudo wget http://www.startssl.com/certs/ca.pem -O ae_certs/ca.pem > sudo wget http://www.startssl.com/certs/sub.class1.server.ca.pem -O ae_certs/intermediate_ca.pem >``` > **Gandi** +> > ```bash > sudo wget https://www.gandi.net/static/CAs/GandiStandardSSLCA2.pem -O ae_certs/intermediate_ca.pem >``` > **RapidSSL** +> > ```bash > sudo wget https://knowledge.rapidssl.com/library/VERISIGN/INTERNATIONAL_AFFILIATES/RapidSSL/AR1548/RapidSSLCABundle.txt -O ae_certs/intermediate_ca.pem >``` > **Cacert** +> > ```bash > sudo wget http://www.cacert.org/certs/root.crt -O ae_certs/ca.pem > sudo wget http://www.cacert.org/certs/class3.crt -O ae_certs/intermediate_ca.pem @@ -137,5 +141,4 @@ Reload NGINX configuration to take into account the new certificate. sudo service nginx reload ``` -Your certificate is ready. However, you can ensure that it is in place by testing the certificate using the geocerts. - +Your certificate is ready. However, you can ensure that it is in place by testing the certificate using the geocerts. diff --git a/pages/02.administer/45.tutorials/55.moving_app_folder/moving_app_folder.fr.md b/pages/02.administer/45.tutorials/55.moving_app_folder/moving_app_folder.fr.md index 6f3f3c321..c73b77917 100644 --- a/pages/02.administer/45.tutorials/55.moving_app_folder/moving_app_folder.fr.md +++ b/pages/02.administer/45.tutorials/55.moving_app_folder/moving_app_folder.fr.md @@ -13,28 +13,25 @@ Lorsqu'un dossier d'application devient trop volumineux il peut être intéressa Partant du principe que [le stockage externe est déjà monté](/external_storage), voici un guide pour déplacer le dossier de l'application wordpress : - #### 1. Déplacer le dossier wordpress et tout son contenu vers le stockage externe -```shell +```bash mv /var/www/wordpress /media/externalharddrive/ ``` -___ -#### 2. Créer un lien symbolique +#### 2. Créer un lien symbolique Le programme qui va chercher des informations dans le dossier /var/www/wordpress sera redirigé vers le stockage externe. -```shell +```bash ln -s /media/externalharddrive/wordpress /var/www/wordpress ``` -___ #### 3. (peut être) bidouiller les permissions Après tout ça, il est possible que vous ayez à modifier les permissions de `/media/externalharddrive` pour que `www-data` (ou l'utilisateur de l'app) puisse y accéder. Quelque chose comme : - -```shell + +```bash chgrp www-data /media/externalharddrive chmod g+rx /media/externalharddrive diff --git a/pages/02.administer/45.tutorials/55.moving_app_folder/moving_app_folder.md b/pages/02.administer/45.tutorials/55.moving_app_folder/moving_app_folder.md index e0802f0eb..1fef76c70 100644 --- a/pages/02.administer/45.tutorials/55.moving_app_folder/moving_app_folder.md +++ b/pages/02.administer/45.tutorials/55.moving_app_folder/moving_app_folder.md @@ -16,23 +16,23 @@ Here's a summary of how to do this the application wordpress. Here, is is assume #### 1. Move the entire wordpress folder to an external hard drive -```shell +```bash mv /var/www/wordpress /media/externalharddrive/ ``` -#### 2. Create a symbolic link +#### 2. Create a symbolic link So that programs looking for files in /var/www/wordpress will actually take them from the harddrive -```shell +```bash ln -s /media/externalharddrive/wordpress /var/www/wordpress ``` #### 3. Tweak permissions (maybe?) After this, note that you may need to tweak the permissions of `/media/externalharddrive` so that `www-data` (or the user corresponding to the app) is able to read through the folder... Something like : - -```shell + +```bash chgrp www-data /media/externalharddrive chmod g+rx /media/externalharddrive @@ -42,4 +42,3 @@ chmod g+rx /media/externalharddrive out what to do exactly) !!! If you want to do it with *NextCloud*, see [this Tutorial](/app_nextcloud). - diff --git a/pages/02.administer/45.tutorials/60.security/security.it.md b/pages/02.administer/45.tutorials/60.security/security.it.md index 17a7cd85f..4c7e81f62 100644 --- a/pages/02.administer/45.tutorials/60.security/security.it.md +++ b/pages/02.administer/45.tutorials/60.security/security.it.md @@ -15,7 +15,7 @@ Rimangono due punti importanti da notare: * Poiché YunoHost è un software molto conosciuto ed usato aumenta le possibilità di un attacco. Se viene scoperto un problema potrebbe essere usato contemporaneamente contro tutte le istanze. Mantenete **aggiornato** il vostro sistema per aumentare la sicurezza. Gli aggiornamenti possono essere automatizzati installando l'[applicazione "Unattended_upgrades"](https://install-app.yunohost.org/?app=unattended_upgrades). -!!!! Se avete bisogno di aiuto non esitate a [chiedere](/help). +!!!! Se avete bisogno di aiuto non esitate a [chiedere](/help). !! [fa=shield /] Per discutere di problemi di sicurezza contattate il [team YunoHost security](/security_team). @@ -27,11 +27,11 @@ Se il vostro server YunoHost è usato in situazioni critiche di produzione oppur ! **ATTENZIONE:** Per seguire queste istruzioni è necessario essere in possesso di conoscenze avanzate di amministrazione di sistema. -!!!! **SUGGERIMENTO** Non chiudete mai la connessione SSH in uso prima di aver controllato che le modifiche fatte siano corrette. Provate la nuova configurazione aprendo un nuovo terminale o una nuova finestra cosicché possiate eliminare le modifiche se c'è qualcosa di sbagliato. +!!!! **SUGGERIMENTO** Non chiudete mai la connessione SSH in uso prima di aver controllato che le modifiche fatte siano corrette. Provate la nuova configurazione aprendo un nuovo terminale o una nuova finestra cosicché possiate eliminare le modifiche se c'è qualcosa di sbagliato. ### Autenticazione SSH con la chiave -Di default l'autenticazione SSH chiede la password dell'amministratore. È consigliato disattivare questo tipo di autenticazione per sostituirlo con il sistema basato sulle chiavi. +Di default l'autenticazione SSH chiede la password dell'amministratore. È consigliato disattivare questo tipo di autenticazione per sostituirlo con il sistema basato sulle chiavi. **Sul client**: @@ -40,7 +40,7 @@ ssh-keygen ssh-copy-id -i ~/.ssh/id_rsa.pub ``` -!!! Se incontrate problemi di permessi impostate `username` come proprietario della directory `~/.ssh` con il comando `chown`. Fate attenzione al fatto che, per ragiorni di sicurezza questa directory deve essere con il modo `700`. +!!! Se incontrate problemi di permessi impostate `username` come proprietario della directory `~/.ssh` con il comando `chown`. Fate attenzione al fatto che, per ragiorni di sicurezza questa directory deve essere con il modo `700`. !!! Se state usando Ubuntu 16.04 dovete avviare `ssh-add` per avviare l'agente SSH. @@ -51,6 +51,7 @@ Digitate la password di amministrazione e la chiave verrà copiata nel vostro se ```bash sudo yunohost settings set security.ssh.password_authentication -v no ``` + --- ### Modificare la porta SSH @@ -58,7 +59,7 @@ sudo yunohost settings set security.ssh.password_authentication -v no Per prevenire i tentativi di connessione dei robot che fanno scan di internet alla ricerca di server con SSH attivato è possibile cambiare la porta SSH. Questa impostazione è gestita da un'impostazione di sistema che aggiorna le configurazioni di SSH e di fail2ban. -! Se modificate una qualsiasi impostazione nel file `/etc/ssh/sshd_config`, anche solo la porta di ascolto, YunoHost non gestirà più il file. Per questa ragione è necessario usare sempre gli strumenti di amministrazione per fare modifiche ai file di configurazione del sistema. +! Se modificate una qualsiasi impostazione nel file `/etc/ssh/sshd_config`, anche solo la porta di ascolto, YunoHost non gestirà più il file. Per questa ragione è necessario usare sempre gli strumenti di amministrazione per fare modifiche ai file di configurazione del sistema. ```bash sudo yunohost settings set security.ssh.port -v @@ -81,11 +82,13 @@ La configurazione TLS di default per i servizi è pensata per offrire una buona Il cambio di livello di compatibilità non è definitivo e può essere ripristinato nel caso in cui non si adatti alle vostre necessità. **Sul vostro server**, cambio della policy per NGINX + ```bash sudo yunohost settings set security.nginx.compatibility -v modern ``` **Sul vostro server**, cambio della policy per SSH + ```bash sudo yunohost settings set security.ssh.compatibility -v modern ``` diff --git a/pages/02.administer/45.tutorials/65.sftp_on_apps/sftp_on_apps.it.md b/pages/02.administer/45.tutorials/65.sftp_on_apps/sftp_on_apps.it.md index 06c05747c..02d6a6db4 100644 --- a/pages/02.administer/45.tutorials/65.sftp_on_apps/sftp_on_apps.it.md +++ b/pages/02.administer/45.tutorials/65.sftp_on_apps/sftp_on_apps.it.md @@ -29,6 +29,3 @@ setfacl -m u:wordpress:r-- /var/www/wordpress/wp-config.php setfacl -R -m u:USER:rwX /var/www/wordpress setfacl -R -d -m u:USER:rwX /var/www/wordpress ``` - - - diff --git a/pages/02.administer/45.tutorials/65.sftp_on_apps/sftp_on_apps.md b/pages/02.administer/45.tutorials/65.sftp_on_apps/sftp_on_apps.md index d90aced59..22cde23a7 100644 --- a/pages/02.administer/45.tutorials/65.sftp_on_apps/sftp_on_apps.md +++ b/pages/02.administer/45.tutorials/65.sftp_on_apps/sftp_on_apps.md @@ -29,5 +29,3 @@ setfacl -m u:wordpress:r-- /var/www/wordpress/wp-config.php setfacl -R -m u:USER:rwX /var/www/wordpress setfacl -R -d -m u:USER:rwX /var/www/wordpress ``` - - diff --git a/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.fr.md b/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.fr.md index 925aa9b18..e60bd036a 100644 --- a/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.fr.md +++ b/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.fr.md @@ -18,11 +18,8 @@ SSH (à partir de votre réseau local ! ou en utilisant un mode rescure si vous 1. Connectez-vous à l'interface web d'administration. 2. Allez dans la section Outis > Changer le mot de passe d’administration. - ## En ligne de commande - ```bash -yunohost tools adminpw +yunohost tools rootpw ``` - diff --git a/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.it.md b/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.it.md index efadb5687..cde0d4fa8 100644 --- a/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.it.md +++ b/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.it.md @@ -17,10 +17,8 @@ Innanzitutto collegati all'interfaccia web d'amministrazione. Poi vai su Strumenti > Cambia password amministrazione. - ## Usando l'interfaccia a linea di comando - ```bash yunohost tools rootpw ``` diff --git a/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.md b/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.md index d01d6eb66..d249c898b 100644 --- a/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.md +++ b/pages/02.administer/50.troubleshooting/10.admin_password/change_admin_password.md @@ -19,10 +19,8 @@ First, connect to your web administration. Then go to Tools > Change administration password. - ## Using the command line interface - ```bash yunohost tools rootpw ``` diff --git a/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.fr.md b/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.fr.md index 3102fc7bd..e8b919322 100644 --- a/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.fr.md +++ b/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.fr.md @@ -11,26 +11,25 @@ Il existe de nombreuses causes pouvant empêcher totalement ou partiellement d'a Cette page va vous aider à diagnostiquer, obtenir un accès et si besoin réparer votre système. Les pannes les plus courantes sont priorisées de haut en bas. Il vous suffit de tester chaque hypothèse. - ## Vous avez accès au serveur via l'adresse IP, mais pas avec le nom de domaine ? #### Si vous êtes auto-hébergé à la maison : il faut configurer les redirection de ports -Vérifier que vous arrivez à accéder au serveur en utilisant son IP globale (que vous pouvez trouver sur https://ip.yunohost.org). Si cela ne fonctionne pas: - - Assurez-vous d'avoir [configuré les redirections de ports](/isp_box_config) - - Certaines box de FAI ne supportent pas le hairpinning et vous ne pouvez pas accéder à votre serveur depuis l'intérieur du réseau local (sauf à passer par l'IP locale). Pour contourner le problème, vous pouvez utiliser un des moyens suivants: - - utiliser une connexion cellulaire (4/5G) - - modifier le fichier /etc/hosts sur vos équipements - - déclarer l'ip locale de yunohost comme resolveur DNS dans votre routeur (partie DHCP) et ouvrir le port 53 UDP sur votre yunohost en faisant attention de ne pas activer l'upnp sur le port 53. Surtout, n'ouvrez pas le port 53 de votre routeur. +Vérifier que vous arrivez à accéder au serveur en utilisant son IP globale (que vous pouvez trouver sur ). Si cela ne fonctionne pas: + +- Assurez-vous d'avoir [configuré les redirections de ports](/isp_box_config) +- Certaines box de FAI ne supportent pas le hairpinning et vous ne pouvez pas accéder à votre serveur depuis l'intérieur du réseau local (sauf à passer par l'IP locale). Pour contourner le problème, vous pouvez utiliser un des moyens suivants: + - utiliser une connexion cellulaire (4/5G) + - modifier le fichier /etc/hosts sur vos équipements + - déclarer l'ip locale de yunohost comme resolveur DNS dans votre routeur (partie DHCP) et ouvrir le port 53 UDP sur votre yunohost en faisant attention de ne pas activer l'upnp sur le port 53. Surtout, n'ouvrez pas le port 53 de votre routeur. #### Il faut configurer vos enregistrement DNS (N.B.: ce n'est pas nécessaire si vous utilisez un domaine de type nohost.me, noho.st ou ynh.fr) -Il vous faut configurer vos enregistrement DNS comme expliqué sur [cette page](/dns_config) (à minima l'enregistrement A, et AAAA si vous avez de l'IPv6). - -Vous pouvez valider que les enregistrements DNS sont corrects en comparant le résultat de https://www.whatsmydns.net/ avec l'IP globale de votre serveur (si vous êtes hébergé à la maison, vous pouvez obtenir cette IP sur https://ip.yunohost.org) +Il vous faut configurer vos enregistrement DNS comme expliqué sur [cette page](/dns_config) (à minima l'enregistrement A, et AAAA si vous avez de l'IPv6). +Vous pouvez valider que les enregistrements DNS sont corrects en comparant le résultat de avec l'IP globale de votre serveur (si vous êtes hébergé à la maison, vous pouvez obtenir cette IP sur ) #### Autres causes possibles @@ -38,14 +37,12 @@ Vous pouvez valider que les enregistrements DNS sont corrects en comparant le r - Votre nom de domaine est peut-être expiré. Vous pouvez vérifier que votre nom de domaine a expiré en vous connectant sur l'interface de votre registrar ou en utilisant le whois par exemple via la commande `whois NOM_DE_DOMAINE`. - Vous avez une IP dynamique. Dans ce cas, il faut mettre en place un script qui se charge de mettre à jour régulièrement votre IP (ou d'utiliser un nom de domaine en nohost.me, noho.st ou ynh.fr qui inclue un tel mécanisme) - ## Vous êtes face à une erreur de certificat qui vous empêche d’accéder à la webadmin Si vous venez d'installer votre serveur ou d'ajouter un nouveau domaine, il utilise pour le moment un certificat auto-signé. Dans ce cas, il devrait être possible et légitime d'ajouter *exceptionnellement* une exception de sécurité le temps d'[installer un certificat Let's Encrypt](/certificate) à condition d'être sur une connexion internet sûre (pas avec Tor Browser par exemple). Une erreur de certificat peut également être affichée dans certain cas où vous avez fait une faute de frappe dans la barre d'adresse de votre navigateur. - ## Vous avez accès en SSH mais pas à la Web admin ou inversement #### Vous essayez de vous connecter en SSH avec `root` plutôt qu'avec `admin` @@ -66,12 +63,12 @@ Voir aussi : [débannir une IP sur Fail2Ban](/fail2ban) NB : le bannissement dure en général 10 à 12 minutes. Le bannissement n'est actif qu'en IPv4. - #### Le serveur web NGINX est cassé Peut-être que le serveur web NGINX est en panne. Vous pouvez vérifier cela [en ssh](/ssh) avec `yunohost service status nginx`. Si il est en panne, vérifiez que la configuration ne comporte pas d'erreur avec `nginx -t`. Si la configuration est cassée, ceci est peut-être du à une l'installation ou désinstallation d'une application de mauvaise qualité... Si vous êtes perdu, [demandez de l'aide](/help). Il se peut également que le serveur web (NGINX) ou le serveur ssh aient été tués suite à un manque d'espace disque ou de RAM / swap. + - Tentez de relancer le service avec `systemctl restart nginx`. - Vous pouvez contrôler l'espace disque utilisé avec `df -h`. Si une de vos partitions est remplie à 100%, il faut identifier ce qui prend de la place sur votre système et faire de la place. Il est possible d'installer l'utilitaire `ncdu` avec `apt install ncdu` puis de faire `ncdu /` pour analyser la taille des dossiers de toute l'arborescence. - Vous pouvez contrôler l'utilisation de la RAM / swap avec `free -h`. En fonction des résultats, il peut être nécessaire d'optimiser votre serveur pour qu'il utilise moins de RAM (suppression d'app lourdes et inutiles...), d'ajouter de la RAM ou d'ajouter un fichier de swap. @@ -86,26 +83,24 @@ Dans ce cas il faut résoudre votre problème de connectivité. Dans certains, cas une mise à jour de votre box a activé l'IPv6, entraînant des problèmes de configuration au niveau de votre nom de domaine. - -## La webadmin fonctionne, mais certaines applications web me renvoient une erreur 502. +## La webadmin fonctionne, mais certaines applications web me renvoient une erreur 502 Il est fort probablement que le service correspondant à ces applications soit en panne (typiquement pour les applications PHP, il s'agit de php7.0-fpm ou php7.3-fpm). Vous pouvez alors tenter de relancer le service, et si cela ne fonctionne pas, regarder les logs du service correspondant et/ou [demander de l'aide](/help). - ## Vous avez perdu votre mot de passe administrateur ? (ou bien le mot de passe est refusé) Si vous arrivez à afficher la page web d'administration (forcez le rafraîchissement avec CTRL + F5 pour être sur) et que vous n'arrivez pas à vous connectez, vous avez probablement un mot de passe erroné. Si vous êtes certain du mot de passe, il est possible que le service SLAPD qui gère l'authentification soit en panne. Si c'est le cas, il vous faut vous connecter en `root`. + - Si votre serveur est chez vous, vous avez sans doute accès au réseau local du serveur. Depuis ce réseau, vous pouvez vous connecter [en SSH](/ssh) avec l'utilisateur `root`. -- Si vous êtes sur un VPS, votre hébergeur vous fournit peut-être la possibilité d'avoir une console sur votre serveur depuis le navigateur web. +- Si vous êtes sur un VPS, votre hébergeur vous fournit peut-être la possibilité d'avoir une console sur votre serveur depuis le navigateur web. Une fois connecté, il vous faut regarder l'état du service avec la commande `yunohost service status slapd` et/ou tenter de réinitialiser votre mot de passe avec la commande `yunohost tools adminpw`. Si vous ne pouvez pas ou ne réussissez pas non plus à vous connecter en `root`, vous allez devoir opérer en mode rescue. TODO: à compléter - ## Votre VPN a expiré ou ne se monte plus Si vous utilisez un VPN a IP fixe, peut être que celui-ci est arrivé à expiration ou que l'infrastructure de votre fournisseur est en difficulté. @@ -113,6 +108,7 @@ Si vous utilisez un VPN a IP fixe, peut être que celui-ci est arrivé à expira Dans ce cas, vous pouvez peut être accéder à votre serveur avec son IP locale s'agissant probablement d'un serveur auto-hébergé chez-vous. Pour connaître votre IP locale, certaines BOX proposent une cartographie du réseau en cours avec les équipements connectés. Sinon, en ligne de commande avec linux: + ```bash sudo arp-scan --local ``` @@ -135,7 +131,6 @@ Si les disques sont corrompus et difficiles à monter, il faut sauvegarder les d Sinon, relancer `grub-update` et `grub-install` en `chroot` ou avec `systemd-nspawn`. - ## L’accès en VNC ou via écran ne fonctionne pas Dans ce cas il peut s'agir d'un problème matériel sur votre serveur physique ou d'un problème d'hyperviseur si c'est un VPS. diff --git a/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.it.md b/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.it.md index bef33fc9a..b7c679427 100644 --- a/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.it.md +++ b/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.it.md @@ -11,14 +11,15 @@ Ci possono essere diverse ragioni che possono portare al blocco parziale o total Questa pagina cercherà di trovare il problema, riottenere l'accesso ed eventualmente riparare il vostro sistema. Le cause più comuni sono all'inizio per cui siete invitati a seguire questo tutorial dall'inizio. -## Hai l'accesso al server usando l'indirizzo IP locale ma non dal nome di dominio. +## Hai l'accesso al server usando l'indirizzo IP locale ma non dal nome di dominio #### Se il server è self-hosted a casa: controlla il port forwarding Controlla di riuscire ad accedere al server usando l'IP pubblico (lo puoi trovare su [https://ip.yunohost.org](https://ip.yunohost.org)). Se questo non funziona: - - Assicurati di aver [impostato il forwarding](/isp_box_config). - - Alcuni ISP non supportano l'*hairpinning*, cosa che ti impedirà di raggiungere il tuo server dal nome di dominio dalla rete locale. Nel caso puoi usare una connessione cellulare o modificare il file `hosts` del tuo computer in modo da associare il nome di dominio all'indirizzo IP locale invece che a quello pubblico. - + +- Assicurati di aver [impostato il forwarding](/isp_box_config). +- Alcuni ISP non supportano l'*hairpinning*, cosa che ti impedirà di raggiungere il tuo server dal nome di dominio dalla rete locale. Nel caso puoi usare una connessione cellulare o modificare il file `hosts` del tuo computer in modo da associare il nome di dominio all'indirizzo IP locale invece che a quello pubblico. + #### Configura i record DNS ! Questo non è un problema se stai usando un dominio fornito da `nohost.me`, `noho.st` or `ynh.fr` @@ -84,7 +85,7 @@ If one of the two is working, use it to connect by SSH or the webadmin. If none are working, you need to resolv your connection issue. In some cases, an update of your router may have enabled IPv6 and DNS configuration may be disrupted. -## Webadmin is working, but some web apps are returning 502 errors. +## Webadmin is working, but some web apps are returning 502 errors It is highly probable that the underlying service for these apps is failing (e.g. PHP apps requiring `php7.0-fpm` or `php7.3-fpm`). You can then try to restart the services, and/or ask for [help](/help) @@ -93,6 +94,7 @@ It is highly probable that the underlying service for these apps is failing (e.g If you can reach the webadmin login page (force reload with `CTRL + F5` to be sure), and you cannot log in, your password is probably wrong. If yoy are sure of your passord, it may be due to the `slapd` service failing. If that's the case, log into the server by SSH as `root`. + - If your server is at home, you most likely have access to the local network. From this network, you can follow the [SSH instructions](/ssh)`. - If your server is a VPS, your provider may offer a web console. @@ -109,6 +111,7 @@ If you have a VPN with fixed IP, maybe it has expired, or the provider's infrast In that case, contact your VPN provider to renew it and update the parameters of the VPN Client app. Meanwhile, try reaching your server if it is at home, by: + - its local IP, retrievable from your router configuration panel or `sudo arp-scan --local` - reaching it at `yunohost.local`, if it is at home and that you have only one YunoHost server in your network. diff --git a/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.md b/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.md index 1e283e0d7..9b05505fe 100644 --- a/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.md +++ b/pages/02.administer/50.troubleshooting/15.noaccess/noaccess.md @@ -11,19 +11,20 @@ There are several reasons that could lead to one administrator's access being pa This page will help you diagnose the issue, get back access, and if needed repair your system. Most common causes are listed first, so follow the tutorial from top to bottom. -## You have access to the server with its local IP address, but not its domain name. +## You have access to the server with its local IP address, but not its domain name #### If you are self-hosted at home: fix ports forwarding Check that you are getting access to the server by using its public IP (you can find at [https://ip.yunohost.org](https://ip.yunohost.org). If this does not work: - - Make sure you have [set up forwarding](/isp_box_config) - - Some ISP routers do not support *hairpinning*, which prevents you from reaching your server by its domain name from within your local network. If so, you can use a cellular connection, or tweak your `hosts` file on your computer to make it bind your domain name to the local IP address instead of the public one. + +- Make sure you have [set up forwarding](/isp_box_config) +- Some ISP routers do not support *hairpinning*, which prevents you from reaching your server by its domain name from within your local network. If so, you can use a cellular connection, or tweak your `hosts` file on your computer to make it bind your domain name to the local IP address instead of the public one. #### Configure DNS records ! This is not a problem if you are using a domain from `nohost.me`, `noho.st` or `ynh.fr`) -You have to configure your [DNS records](/dns_config) (at least `A` records, and `AAAA` if you have an IPv6 connection). +You have to configure your [DNS records](/dns_config) (at least `A` records, and `AAAA` if you have an IPv6 connection). You can check that the DNS records are correct by comparing the results given by [this service](https://www.whatsmydns.net/) with the [IP given by our service](https://ip.yunohost.org). @@ -41,7 +42,7 @@ You can check that the DNS records are correct by comparing the results given by ## You have access via SSH but not via the webadmin, or inversely -#### You are trying to log in with SSH as `root` instead of `admin` user. +#### You are trying to log in with SSH as `root` instead of `admin` user By default, SSH connection has to be made as `admin`. It possible to log into the server as `root` *only from the local network of the server*. If your server is a VPS, the web console or VNC provided by VPS providers may work. @@ -82,7 +83,7 @@ If one of the two is working, use it to connect by SSH or the webadmin. If none are working, you need to resolv your connection issue. In some cases, an update of your router may have enabled IPv6 and DNS configuration may be disrupted. -## Webadmin is working, but some web apps are returning 502 errors. +## Webadmin is working, but some web apps are returning 502 errors It is highly probable that the underlying service for these apps is failing (e.g. PHP apps requiring `php7.0-fpm` or `php7.3-fpm`). You can then try to restart the services, and/or ask for [help](/help) @@ -91,6 +92,7 @@ It is highly probable that the underlying service for these apps is failing (e.g If you can reach the webadmin login page (force reload with `CTRL + F5` to be sure), and you cannot log in, your password is probably wrong. If yoy are sure of your passord, it may be due to the `slapd` service failing. If that's the case, log into the server by SSH as `root`. + - If your server is at home, you most likely have access to the local network. From this network, you can follow the [SSH instructions](/ssh)`. - If your server is a VPS, your provider may offer a web console. @@ -107,6 +109,7 @@ If you have a VPN with fixed IP, maybe it has expired, or the provider's infrast In that case, contact your VPN provider to renew it and update the parameters of the VPN Client app. Meanwhile, try reaching your server if it is at home, by: + - its local IP, retrievable from your router configuration panel or `sudo arp-scan --local` - reaching it at `yunohost.local`, or `yunohost-2.local`, etc. depending on how many YunoHost servers are on your network. diff --git a/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.fr.md b/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.fr.md index f1700a1b2..b74c60d6f 100644 --- a/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.fr.md +++ b/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.fr.md @@ -12,26 +12,27 @@ L'IPv6 peut fonctionner directement dans certains cas. Mais dans d'autres, ou ch ## Avec un VPS chez OVH OVH donne une adresse IPv4 et une IPv6 pour ses VPS, mais par défaut, seule l'IPv4 fonctionne. -La documentation d'OVH à ce sujet est ici : https://docs.ovh.com/fr/vps/configurer-ipv6/ +La documentation d'OVH à ce sujet est ici : ### Configurer le serveur DNS -Ici : https://yunohost.org/#/dns_subdomains +Ici : ### Configurer le serveur Sur le panneau de gestion d'OVH, vous aller récupérer 3 informations : + - l'adresse IPv6 du serveur -- l'adresse passerelle IPv6 +- l'adresse passerelle IPv6 - le préfixe IPv6. Les offres VPS SSD d'OVH ne fournissent qu'**une** seule adresse IPV6, le préfixe est donc `/128` Sur votre VPS, vous allez créer une sauvegarde de votre fichier de configuration des interfaces réseau dans votre répertoire home avec la commande : `cp /etc/network/interfaces ~/interfaces`. 2 possibilités pour inscrire vos données ipv6 : -1/ vous pouvez modifier le fichier de configuration `/etc/network/interfaces` +1/ vous pouvez modifier le fichier de configuration `/etc/network/interfaces` 2/ vous pouvez créer un autre fichier "à part" par la commande `sudo nano /etc/network/interfaces.d/ovh-ipv6.cfg` (ce dernier fichier est pris en compte car appartenant au dossier) -! Découvrir et vérifier avec la commande `ip a` l'interface utilisée sur votre VPS ( généralement du type ENS3 chez OVH) +! Découvrir et vérifier avec la commande `ip a` l'interface utilisée sur votre VPS ( généralement du type ENS3 chez OVH) ! Dans cet exemple, nous considérons que votre interface réseau est `eth0`. Vous devez adapter l'exemple pour correspondre à votre situation. ```plaintext @@ -47,6 +48,7 @@ pre-down /sbin/ip -6 route del dev eth0 Maintenant, enregistrez le fichier et redémarrez les services réseau avec : `service networking restart`. (TODO : ideally we should find a way to validate the content of the configuration, otherwise it could fuck up the network stack and get disconnected from the VPS ?) Vérifiez votre configuration avec les commandes : + - `ip a` pour afficher les adresses IP des interfaces - `hostname -I` pour afficher les adresses IP du système - essayez de faire un test de `ping` sur un serveur IPv6 (vous pouvez utiliser `ping6 ipv6.yunohost.org`) diff --git a/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.it.md b/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.it.md index a83d0c3da..a323f94d7 100644 --- a/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.it.md +++ b/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.it.md @@ -12,15 +12,16 @@ IPv6 dovrebbe funzionare automaticamente in molti casi ma in alcune situzioni o ## Usando una VPS di OVH OVH fornisce un indirizzo IPv4 e uno IPv6 ma di default funziona solo il primo. -La documentazione di OVH la puoi trovare qui: https://docs.ovh.com/gb/en/vps/configuring-ipv6/ +La documentazione di OVH la puoi trovare qui: ### Configurare il server DNS -Qui : https://yunohost.org/#/dns_subdomains +Qui : ### Configurare il server Nella pagina di configurazione di OVH dovrai copiare questi 3 elementi: + - l'indirizzo IPv6 - l'indirizzo del gateway IPv6 - il prefisso IPv6. Nelle VPS SSD di OVH i prefissi sono `/128` perché hai a disposizione solo *uno* indirizzo IPv6. @@ -43,6 +44,7 @@ pre-down /sbin/ip -6 route del dev eth0 Now, save the file and restart the network service with : `service networking restart`. (TODO : ideally we should find a way to validate the content of the configuration, otherwise it could fuck up the network stack and get disconnected from the VPS ?) Check your configuration with these commands : + - `ip a` to display network interfaces and addresses - `hostname -I` to display the system IP addresses - try to ping an IPv6 server (for example you can use `ping6 ip6.yunohost.org`) diff --git a/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.md b/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.md index 8cc8efc88..c0e3c6557 100644 --- a/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.md +++ b/pages/02.administer/50.troubleshooting/20.ipv6/ipv6.md @@ -12,21 +12,22 @@ IPv6 may work out of the box in many cases. But in some cases or some specific p ## With a VPS from OVH OVH gives one IPv4 address and one IPv6 address for VPS but by default, only IPv4 is OK. -The OVH's documentation is here : https://docs.ovh.com/gb/en/vps/configuring-ipv6/ +The OVH's documentation is here : ### Configure the DNS server -Here : https://yunohost.org/#/dns_subdomains +Here : ### Configure the server On the OVH panel, you will copy 3 elements: + - the IPv6 address - the IPv6 gateway address - the IPv6 prefix. On OVH's VPS SSD, prefixes are `/128` because you have only *one* IPv6 address. On your VPS, create a backup of the network configuration with : `cp /etc/network/interfaces ~/interfaces` in home directory. -Then, you can edit the configuration file (`/etc/network/interfaces`) with the following. +Then, you can edit the configuration file (`/etc/network/interfaces`) with the following. ! In this example, it is assumed that your network interface is `eth0`. If it's different (check with `ip a`) you need to adapt the example below. @@ -43,6 +44,7 @@ pre-down /sbin/ip -6 route del dev eth0 Now, save the file and restart the network service with : `service networking restart`. (TODO : ideally we should find a way to validate the content of the configuration, otherwise it could fuck up the network stack and get disconnected from the VPS ?) Check your configuration with these commands : + - `ip a` to display network interfaces and addresses - `hostname -I` to display the system IP addresses - try to ping an IPv6 server (for example you can use `ping6 ip6.yunohost.org`) diff --git a/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.fr.md b/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.fr.md index d45f637e4..3ef3e22a0 100644 --- a/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.fr.md +++ b/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.fr.md @@ -10,7 +10,9 @@ routes: Il peut arriver que votre serveur (son adresse IP) soit ajouté à la liste noire de certains fournisseurs d’adresse de courrier électronique ou de services anti-spam. Les courriels envoyés à ces adresses sont alors filtrés et n’arrivent pas à destination. #### Testez votre serveur + Pour tester si votre serveur est sur une liste noire, vous pouvez utiliser les outils suivants : + * [Test en envoyant un email](https://www.mail-tester.com) * [Test à partir de l’adresse IP](http://whatismyipaddress.com/blacklist-check) @@ -21,10 +23,8 @@ Le cas échéant, voici certains des formulaires vous permettant de retirer votr * [Microsoft](https://support.microsoft.com/en-us/getsupport?oaspworkflow=start_1.0.0.0&wfname=capsub&productkey=edfsmsbl3&locale=en-us) * [GMail](https://support.google.com/mail/contact/msgdelivery) -##### Services anti-spam +##### Services anti-spam * [SpamHaus](http://www.spamhaus.org/lookup) Si le fournisseur vous concernant n’apparaît pas dans la liste, cherchez le formulaire adéquat, il existe probablement. - - diff --git a/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.it.md b/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.it.md index a47867aac..dcec10985 100644 --- a/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.it.md +++ b/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.it.md @@ -12,6 +12,7 @@ Può succedere talvolta che il tuo IP venga inserito nelle blacklist da parte di ## Prova il tuo server * [Prova mandando un email](https://www.mail-tester.com) + - [Prova da un indirizzo IP](http://whatismyipaddress.com/blacklist-check) Di seguito vengono elencati alcuni form che possono aiutarti a far rimuovere il tuo indirizzo IP da queste liste @@ -21,7 +22,7 @@ Di seguito vengono elencati alcuni form che possono aiutarti a far rimuovere il * [Microsoft](https://support.microsoft.com/en-us/getsupport?oaspworkflow=start_1.0.0.0&wfname=capsub&productkey=edfsmsbl3&locale=en-us) * [GMail](https://support.google.com/mail/contact/msgdelivery) -## Servizi anti-spam +## Servizi anti-spam * [SpamHaus](http://www.spamhaus.org/lookup) -* http://whatismyipaddress.com/blacklist-check +* diff --git a/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.md b/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.md index 3670bcf6f..1eaaeec2c 100644 --- a/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.md +++ b/pages/02.administer/50.troubleshooting/25.unblacklisting/blacklist_forms.md @@ -15,6 +15,7 @@ To check your Email deliverability, YunoHost provide some tests avilables in the all the points evaluated by [the well known mail-tester.com](https://www.mail-tester.com) except for mail content (usefull if you prepare a newsletter). However, if you have a doubt on the internal diagnosis results, you could check on external tools: + - by sending an emails : [Mail tester](https://www.mail-tester.com) - by providing the public ip : [MultiRBL Valli](https://multirbl.valli.org/) or [Whatismyip](https://whatismyipaddress.com/blacklist-check) @@ -22,45 +23,52 @@ However, if you have a doubt on the internal diagnosis results, you could check This command can help you to summarize which emails has been refused by other SMTP server and why. -``` +```bash cat /var/log/mail.log | grep "deferred" | sed -E "s/(:[0-9][0-9]).+.+dsn/\terror/g" | sed -E "s/, status=deferred \(/ /g" | sed -E "s/\)$//g" ``` See [the list of SMTP return code](https://en.wikipedia.org/wiki/List_of_SMTP_server_return_codes) from wikipedia. ## Untestable email providers + YunoHost is only able to test generic blacklist using the DNS RBL mechanism. However, Gmail, Microsoft, Yahoo or Free maintains their own blacklisting mechanism, so in some situation you may need to contact their teams through dedicated forms or use dedicated tools. ### Microsoft -* No way to test easily IP reputation -* [Microsoft guide for postmaster](https://sendersupport.olc.protection.outlook.com/pm/) -* [Information about SMTP return code from Microsoft](https://sendersupport.olc.protection.outlook.com/pm/troubleshooting.aspx#Codes) -* Reputation Management tools : - * [Junk Email Reporting Program (JMRP)](https://postmaster.live.com/snds/JMRP.aspx) - * [Smart Network Data Services (SNDS)](https://postmaster.live.com/snds/index.aspx) -* [Get support form for deliverability issues](https://support.microsoft.com/supportrequestform/8ad563e3-288e-2a61-8122-3ba03d6b8d75) (Sadly you need a Microsoft account :/ ) +- No way to test easily IP reputation +- [Microsoft guide for postmaster](https://sendersupport.olc.protection.outlook.com/pm/) +- [Information about SMTP return code from Microsoft](https://sendersupport.olc.protection.outlook.com/pm/troubleshooting.aspx#Codes) +- Reputation Management tools : + - [Junk Email Reporting Program (JMRP)](https://postmaster.live.com/snds/JMRP.aspx) + - [Smart Network Data Services (SNDS)](https://postmaster.live.com/snds/index.aspx) +- [Get support form for deliverability issues](https://support.microsoft.com/supportrequestform/8ad563e3-288e-2a61-8122-3ba03d6b8d75) (Sadly you need a Microsoft account :/ ) ### Gmail -* No way to test easily IP reputation -* [Google guide for postmaster](https://support.google.com/a/topic/1354753) -* [Information about SMTP return code from Google](https://support.google.com/a/answer/3726730) -* Reputation Management tools : [Google Postmaster Tools](https://postmaster.google.com) -* [Get support form for deliverability issues](https://support.google.com/mail/contact/bulk_send_new) + +- No way to test easily IP reputation + +- [Google guide for postmaster](https://support.google.com/a/topic/1354753) +- [Information about SMTP return code from Google](https://support.google.com/a/answer/3726730) +- Reputation Management tools : [Google Postmaster Tools](https://postmaster.google.com) +- [Get support form for deliverability issues](https://support.google.com/mail/contact/bulk_send_new) ### Yahoo -* No way to test easily IP reputation -* [Yahoo guide for postmaster](https://senders.yahooinc.com/best-practices) -* [Information about SMTP return code from Yahoo](https://senders.yahooinc.com/smtp-error-codes) -* Reputation Management tools : [Complaint Feedback Loop](https://io.help.yahoo.com/contact/index?page=contactform&locale=en_US&token=Zh%2FBBVqXzLHlIbokbUqVWTUbuuQeXGkGnZzhKR2JQ4O6mMQdy9JSWdtWFXvjthcYCRj9bUIFfycOfG%2B4GOHPHoOGa8HwDO2%2B0kYRtTcdR8Nja5P9HWkKh3VWfS3pyu4UdjhvwG%2BBCvnYFl5dToDK%2Fw%3D%3D&selectedChannel=email-icon) -* [Get support form for deliverability issues](https://senders.yahooinc.com/contact) + +- No way to test easily IP reputation + +- [Yahoo guide for postmaster](https://senders.yahooinc.com/best-practices) +- [Information about SMTP return code from Yahoo](https://senders.yahooinc.com/smtp-error-codes) +- Reputation Management tools : [Complaint Feedback Loop](https://io.help.yahoo.com/contact/index?page=contactform&locale=en_US&token=Zh%2FBBVqXzLHlIbokbUqVWTUbuuQeXGkGnZzhKR2JQ4O6mMQdy9JSWdtWFXvjthcYCRj9bUIFfycOfG%2B4GOHPHoOGa8HwDO2%2B0kYRtTcdR8Nja5P9HWkKh3VWfS3pyu4UdjhvwG%2BBCvnYFl5dToDK%2Fw%3D%3D&selectedChannel=email-icon) +- [Get support form for deliverability issues](https://senders.yahooinc.com/contact) ### Free + You can find a tool to test your IP, advices, explanation of error code and a way to contact Free on [this page](https://postmaster.free.fr/) ## Get alert about emails sent without SPF or DKIM + If you use your own domains and think that some mails are sent by unauthorized servers (so without SPF/DKIM), you get report about this mail with. -``` + +```dns _dmarc.DOMAIN 3600 IN TXT "v=DMARC1; p=none; fo=1; rua=mailto:example@domain.tld!10m" ``` - diff --git a/pages/02.administer/50.troubleshooting/troubleshooting.fr.md b/pages/02.administer/50.troubleshooting/troubleshooting.fr.md index f933f2004..3634e5c03 100644 --- a/pages/02.administer/50.troubleshooting/troubleshooting.fr.md +++ b/pages/02.administer/50.troubleshooting/troubleshooting.fr.md @@ -13,7 +13,7 @@ Voici quelques conseils généraux à suivre lorsque vous rencontrez des problè Restez calme. La plupart des problèmes sont moins grave que ce que les débutants pensent. Pour l'amour de Dieu (ou de votre déité, animal, nourriture préférée), ne sautez pas à pieds joint dans la "spirate de réinstallation" en pensant que réinstaller à partir de zéro va magiquement résoudre vos problèmes. Réinstaller est une opération lourde et n'est pas une bonne stratégie sur le long-terme pour résoudre les problèmes. Vous finirez par vous lasser et n'apprendrez rien. -## 1. Regardez sur le forum ou bugtrackers si quelqu'un a eu un problème similaire. +## 1. Regardez sur le forum ou bugtrackers si quelqu'un a eu un problème similaire Cherchez dans [le forum](https://forum.yunohost.org) des fils de discussions qui discutent de choses similaire aux problème que vous rencontrez. Si vous avez un soucis lié à une application en particulier, vous pouvez également tenter de chercher un ticket similaire sur le bugtracker de l'application, par exemple [ici se trouve le bugtracker de l'app wordpress](https://github.com/YunoHost-Apps/wordpress_ynh/issues). @@ -22,5 +22,3 @@ Cherchez dans [le forum](https://forum.yunohost.org) des fils de discussions qui Soit sur [le forum](https://forum.yunohost.org) ou bien le chat : c.f. [cette page](/help) !!! POUR L'AMOUR DE DIEU, PRIÈRE DE fournir du contexte ! Les bénévoles ne peuvent PAS vous aider si vous ne prenez pas *cinq* petites minutes pour décrire votre contexte : quel type de hardware, quelle version de YunoHost, qu'est-ce que vous essayez de faire, ce qui s'est passé, et **les journaux (logs) correspondants**. - - diff --git a/pages/02.administer/50.troubleshooting/troubleshooting.it.md b/pages/02.administer/50.troubleshooting/troubleshooting.it.md index 3d8f11868..fce8652dc 100644 --- a/pages/02.administer/50.troubleshooting/troubleshooting.it.md +++ b/pages/02.administer/50.troubleshooting/troubleshooting.it.md @@ -9,11 +9,11 @@ routes: Di seguito alcuni consigli generali per risolvere problemi con il vostro server. -## 0. Don't panic. +## 0. Don't panic Mantenete la calma. La maggior parte dei problemi sono meno gravi di quanto pensa chi è alle prime armi. Per amor di Dio (o le vostre divinità preferite / animali / cibo), non cadete nella "spirale della reinstallazione" presupponendo che reinstallare il vostro server da capo possa risolvere magicamente i problemi. La reinstallazione è un'operazione gravosa e non è una buona strategia per risolvere i problemi. Ti stancherai e non imparerai niente. -## 1. Cerca problemi simili nel forum o nei bugtrackers. +## 1. Cerca problemi simili nel forum o nei bugtrackers Cerca [nel forum](https://forum.yunohost.org) per argomenti simili al problema che stai trovando. Se hai problemi con una app specifica puoi consultare il bugtracker relativo, ad esempio [questo è il bugtracker per l'app Wordpress app](https://github.com/YunoHost-Apps/wordpress_ynh/issues). @@ -22,5 +22,3 @@ Cerca [nel forum](https://forum.yunohost.org) per argomenti simili al problema c Sia [sul forum](https://forum.yunohost.org) siaa nella chat : vedi [questa pagina](/help) !!! PER AMOR DI DIO, PER FAVORE fornisci un minimo di contesto! I volontari non possono aiutarti se non ti prendi *cinque* minuti per descrivere il contesto: il tipo di hardware, la versione di YunoHost, cosa stai cercando di fare e cos'hai provato a fare, cos'è successo e **i log relativi**. - - diff --git a/pages/02.administer/50.troubleshooting/troubleshooting.md b/pages/02.administer/50.troubleshooting/troubleshooting.md index 72370d487..de5c6f8e2 100644 --- a/pages/02.administer/50.troubleshooting/troubleshooting.md +++ b/pages/02.administer/50.troubleshooting/troubleshooting.md @@ -9,11 +9,11 @@ routes: Here are some general advices when encountering issues with your server. -## 0. Don't panic. +## 0. Don't panic Stay calm. Most issues are less worse than newcomers usually think. For the love of God (or your favourite deity / animal / food), please don't jump into the "reinstallation spiral" thinking reinstalling your server from scratch will magically fix stuff. Reinstalling is a heavy operation and is not a good long-term strategy for fixing problems. You will get tired and won't learn anything. -## 1. Look for similar issues on the forum or bugtrackers. +## 1. Look for similar issues on the forum or bugtrackers Search [the forum](https://forum.yunohost.org) for topics similar to the issue you're encountering. If you have issues with a specific app, you may also want to check the corresponding bugtracker of the app, for example [here is the bugtracker for the Wordpress app](https://github.com/YunoHost-Apps/wordpress_ynh/issues). @@ -22,5 +22,3 @@ Search [the forum](https://forum.yunohost.org) for topics similar to the issue y Either on [the forum](https://forum.yunohost.org) or the chat: c.f. [this page](/help) !!! FOR THE LOVE OF GOD, PLEASE provide basic context! Volunteers can NOT help you if you do not take *five* minutes to describe your context: which kind of hardware, which YunoHost version, what you are trying to do, what you tried, what happened and **the corresponding logs**. - - diff --git a/pages/02.administer/55.providers/05.registrar/gandi/autodns.it.md b/pages/02.administer/55.providers/05.registrar/gandi/autodns.it.md index d59cb98eb..b09e69572 100644 --- a/pages/02.administer/55.providers/05.registrar/gandi/autodns.it.md +++ b/pages/02.administer/55.providers/05.registrar/gandi/autodns.it.md @@ -13,12 +13,8 @@ Questa pagina indica come ottenere una chiave API con Gandi di modo da configura ! NB. : **NON comunicare a nessuno il token API!** Un attaccante malizioso con il tuo token potrebbe prendere il controllo del tuo dominio e quindi anche del tuo server! -1. Connettiti a https://account.gandi.net/ - +1. Connettiti a 2. Dovresti vedere questa pagina e quindi clicca su 'Security' - -![](image://registrar_api_gandi_1.png?resize=800) - + ![](image://registrar_api_gandi_1.png?resize=800) 3. Nella pagina successiva clicca su '(re)Generate the API key'. - -![](image://registrar_api_gandi_2.png?resize=800) + ![](image://registrar_api_gandi_2.png?resize=800) diff --git a/pages/02.administer/55.providers/05.registrar/gandi/autodns.md b/pages/02.administer/55.providers/05.registrar/gandi/autodns.md index 2cad29ebb..63c210efd 100644 --- a/pages/02.administer/55.providers/05.registrar/gandi/autodns.md +++ b/pages/02.administer/55.providers/05.registrar/gandi/autodns.md @@ -14,11 +14,7 @@ This page is meant to guide you in obtaining an API key from Gandi in order to c ! NB. : **DO NOT share your API tokens with anybody!** A malicious attacker obtaining your tokens could take over your domain, and possibly your server! 1. Go to [https://account.gandi.net/](https://account.gandi.net/) - 2. You should land on this page. Then click on 'Security' - -![](image://registrar_api_gandi_1.png?resize=800) - + ![](image://registrar_api_gandi_1.png?resize=800) 3. In the next page, click on '(re)Generate the API key'. - -![](image://registrar_api_gandi_2.png?resize=800) + ![](image://registrar_api_gandi_2.png?resize=800) diff --git a/pages/02.administer/55.providers/05.registrar/namecheap/autodns.md b/pages/02.administer/55.providers/05.registrar/namecheap/autodns.md index 09b9c478a..066a9d538 100644 --- a/pages/02.administer/55.providers/05.registrar/namecheap/autodns.md +++ b/pages/02.administer/55.providers/05.registrar/namecheap/autodns.md @@ -1,11 +1,11 @@ -[API Documentation](https://www.namecheap.com/support/api/intro/) +[API Documentation](https://www.namecheap.com/support/api/intro/) > 1. Login to your Namecheap account. > > 2. Go to the Profile > Tools menu. -> +> > 3. Scroll down to the Business & Dev Tools section. Click on MANAGE next to Namecheap API Access. -> +> > 4. Toggle ON/OFF, read our Terms of Service, enter your account password. -> +> > 5. After enabling API access, you will be allotted an APIKey. Your Namecheap account username will act as API username. Your access to the API is authenticated using these elements. diff --git a/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.fr.md b/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.fr.md index 040c4ccaa..03bcfc6b7 100644 --- a/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.fr.md +++ b/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.fr.md @@ -13,7 +13,7 @@ Cette page a pour but de vous guider dans l'obtention d'une clé API d'OVH afin ! NB. : **Ne partagez PAS vos tokens API avec qui que ce soit !** Un attaquant malveillant obtenant vos tokens pourrait prendre le contrôle de votre domaine, et éventuellement de votre serveur ! -1. Allez sur https://eu.api.ovh.com/createToken/ +1. Allez sur 2. Remplissez le formulaire avec les informations requises comme indiqué ci-dessous : @@ -23,10 +23,10 @@ Cette page a pour but de vous guider dans l'obtention d'une clé API d'OVH afin - Description du script : par exemple `YunoHost Auto DNS` - Validité : `Unlimited` - Droits : utilisez le bouton `+` pour ajouter les lignes suivantes - - `GET` : `/domain/zone/*` - - `POST` : `/domain/zone/*` - - `PUT` : `/domain/zone/*` - - `DELETE` : `/domain/zone/*` + - `GET` : `/domain/zone/*` + - `POST` : `/domain/zone/*` + - `PUT` : `/domain/zone/*` + - `DELETE` : `/domain/zone/*` ![](image://registrar_api_ovh_1.png?resize=800) diff --git a/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.it.md b/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.it.md index c6262ee78..74b835552 100644 --- a/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.it.md +++ b/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.it.md @@ -7,13 +7,13 @@ routes: default: '/providers/registrar/ovh/autodns' aliases: - '/registar_api_ovh' --- +--- Questa parte ha lo scopo di guidarvi nella procedura necessaria all'ottenimento di una chiave API di OVH, necessaria per impostare la procedura di configurazione automatica dei DNS di YunoHost. ! NB. : **Non divulgate MAI i vostri token API !** Un attaccante maligno con i vostri token potrebbe prendere il controllo del vostro dominio ed anche eventualmente del vostro server! -1. Recatevi su https://eu.api.ovh.com/createToken/ +1. Recatevi su 2. Compilate il formulario con le informazioni richieste, come nell'esempio seguente: @@ -23,12 +23,11 @@ Questa parte ha lo scopo di guidarvi nella procedura necessaria all'ottenimento - Date una sommaria descrizione: es. `YunoHost Auto DNS` - Validità: `Unlimited` - Rights: utilizzate il pulsante `+` per aggiungere le seguenti linee - - `GET` : `/domain/zone/*` - - `POST` : `/domain/zone/*` - - `PUT` : `/domain/zone/*` - - `DELETE` : `/domain/zone/*` + - `GET` : `/domain/zone/*` + - `POST` : `/domain/zone/*` + - `PUT` : `/domain/zone/*` + - `DELETE` : `/domain/zone/*` ![](image://registrar_api_ovh_1.png?resize=800) - 3. Otterrete tre tokens (una chiave segreta, una chiave pubblica, e una chiave consumer) che dovranno essere utilizzate nella configurazione di YunoHost diff --git a/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.md b/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.md index 588310a28..31f1ad35b 100644 --- a/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.md +++ b/pages/02.administer/55.providers/05.registrar/ovh/autodns/autodns.md @@ -13,7 +13,7 @@ This page is meant to guide you in obtaining an API key from OVH in order to con ! NB. : **DO NOT share your API tokens with anybody!** A malicious attacker obtaining your tokens could take over your domain, and possibly your server! -1. Go to https://eu.api.ovh.com/createToken/ +1. Go to 2. Fill the form with the required informations as shown below: @@ -23,10 +23,10 @@ This page is meant to guide you in obtaining an API key from OVH in order to con - Script description: for example `YunoHost Auto DNS` - Validity: `Unlimited` - Rights: use the `+` button to add the following lines - - `GET` : `/domain/zone/*` - - `POST` : `/domain/zone/*` - - `PUT` : `/domain/zone/*` - - `DELETE` : `/domain/zone/*` + - `GET` : `/domain/zone/*` + - `POST` : `/domain/zone/*` + - `PUT` : `/domain/zone/*` + - `DELETE` : `/domain/zone/*` ![](image://registrar_api_ovh_1.png?resize=800) diff --git a/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.fr.md b/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.fr.md index fd4f390e5..5d23886b0 100644 --- a/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.fr.md +++ b/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.fr.md @@ -20,14 +20,15 @@ Cliquez sur l'onglet **Zone DNS**, puis sur **Ajouter une entrée** : ![](image://ovh_dns_zone.png?resize=800) Cliquer sur "Modifier en mode textuel", garder les 4 premières lignes : + ```bash $TTL 3600 -@ IN SOA dns104.ovh.net. tech.ovh.net. (2020083101 86400 3600 3600000 60) +@ IN SOA dns104.ovh.net. tech.ovh.net. (2020083101 86400 3600 3600000 60) IN NS dns104.ovh.net. IN NS ns104.ovh.net. ``` -puis effacer tout ce qu'il y a en-dessous, et le remplacer par la configuration donnée par votre serveur, comme indiqué dans la [configuration DNS standard](/dns_config). +puis effacer tout ce qu'il y a en-dessous, et le remplacer par la configuration donnée par votre serveur, comme indiqué dans la [configuration DNS standard](/dns_config). ### IP dynamique @@ -43,6 +44,7 @@ Suivez [ce tutoriel](http://blog.developpez.com/brutus/p6316/ubuntu/configurer_d ddclient annonce à OVH le changement d’IP. OVH va alors changer votre IP. Il faut ajouter dans le fichier de configuration : + * votre identifiant et votre mot de passe DynHost * votre nom de domaine diff --git a/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.it.md b/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.it.md index b22ab3c54..d0b6a6f89 100644 --- a/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.it.md +++ b/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.it.md @@ -22,14 +22,15 @@ Scegliete la sezione **Zona DNS**, e poi **Aggiungere un record**: Ora dovrete aggiungere la redirezione del DNS così come specificato nella [configurazione standard delle zone del DNS](/dns_config) Cliccate su "Modifica in modalità testo", lasciando invariate le prime 4 righe: + ```bash $TTL 3600 -@ IN SOA dns104.ovh.net. tech.ovh.net. (2020083101 86400 3600 3600000 60) +@ IN SOA dns104.ovh.net. tech.ovh.net. (2020083101 86400 3600 3600000 60) IN NS dns104.ovh.net. IN NS ns104.ovh.net. ``` -cancellate tutto il resto e sostituitelo con la configurazione necessaria per raggiungere il vostro server come illustrato nel paragrafo [questa pagina](/dns config). +cancellate tutto il resto e sostituitelo con la configurazione necessaria per raggiungere il vostro server come illustrato nel paragrafo [questa pagina](/dns config). ### IP dinamico @@ -45,8 +46,8 @@ Seguite [questa guida](http://blog.developpez.com/brutus/p6316/ubuntu/configurer ddclient si occuperà di avvisare OVH quando il vostro IP cambierà e OVH adatterà la sua configurazione. Nel file di configurazione di ddclient dovrete aggiungere: + * il vostro user e la vostra password DynHost * il nome del vostro dominio Seguite anche questa [guida creata da OVH](https://docs.ovh.com/fr/fr/web/domains/utilisation-dynhost/). - diff --git a/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.md b/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.md index 4fcc5cc17..3124074b5 100644 --- a/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.md +++ b/pages/02.administer/55.providers/05.registrar/ovh/manualdns/manualdns.md @@ -22,14 +22,15 @@ Click on the **DNS Zone** tab, then on **Add an entry**: Now you need to add the DNS redirections as specified by the [standard DNS zone configuration](/dns_config) Click on "Change in text format", keep the first four lines: + ```bash $TTL 3600 -@ IN SOA dns104.ovh.net. tech.ovh.net. (2020083101 86400 3600 3600000 60) +@ IN SOA dns104.ovh.net. tech.ovh.net. (2020083101 86400 3600 3600000 60) IN NS dns104.ovh.net. IN NS ns104.ovh.net. ``` -then erase everything below, and replace it with the configuration generated by YunoHost as explained in [this page](/dns_config). +then erase everything below, and replace it with the configuration generated by YunoHost as explained in [this page](/dns_config). ### Dynamic IP @@ -45,6 +46,7 @@ Follow [this tutorial](http://blog.developpez.com/brutus/p6316/ubuntu/configurer ddclient will take care of telling OVH that the IP has changed. Then OVH will update the IP. You need to add in the configuration file: + * your login and password DynHost * your domain name diff --git a/pages/02.administer/55.providers/05.registrar/registrar.it.md b/pages/02.administer/55.providers/05.registrar/registrar.it.md index 63c1f51ee..a892d1367 100644 --- a/pages/02.administer/55.providers/05.registrar/registrar.it.md +++ b/pages/02.administer/55.providers/05.registrar/registrar.it.md @@ -22,7 +22,6 @@ Non sono supportati tutti i registrar. Fino ad ora la comunità ha testato e val Questa lista può aiutarti a scegliere un registrar se conti di acquistare un nome a dominio da usare con YunoHost. - | Registrar | Compatibilità | Facilità per ottenere una chiave API | Howto | | --------- | ------------- | ------------------ | | [Gandi](https://www.gandi.net) | ✔ (testato) | ✔ | [Obtain an API key](/providers/registrar/gandi/autodns) | diff --git a/pages/02.administer/55.providers/05.registrar/registrar.md b/pages/02.administer/55.providers/05.registrar/registrar.md index 33d4c7362..62efa294a 100644 --- a/pages/02.administer/55.providers/05.registrar/registrar.md +++ b/pages/02.administer/55.providers/05.registrar/registrar.md @@ -22,7 +22,6 @@ Not all registrars are supported. So far, the community tested and validated the The list below can help you to choose a registrar if you plan to buy a domain name to use it with YunoHost. - | Registrar | Compatibility | Easy to obtain an API key | Howto | | --------- | ------------- | ------------------ | | [Gandi](https://www.gandi.net) | ✔ (tested) | ✔ | [Obtain an API key](/providers/registrar/gandi/autodns) | diff --git a/pages/02.administer/55.providers/10.isp/free/isp_free.fr.md b/pages/02.administer/55.providers/10.isp/free/isp_free.fr.md index 35d056a1b..a063547dc 100644 --- a/pages/02.administer/55.providers/10.isp/free/isp_free.fr.md +++ b/pages/02.administer/55.providers/10.isp/free/isp_free.fr.md @@ -13,7 +13,7 @@ routes: #### Accès à l’administration de la box (v5/v6) -##### Freebox ≤ v5 +##### Freebox ≤ v5 Rendez-vous sur la [console d'administration du site de free](https://subscribe.free.fr/login/). @@ -25,7 +25,7 @@ Allez à l’adresse : [mafreebox.freebox.fr](http://mafreebox.freebox.fr) puis [Liste des ports à ouvrir](/isp_box_config). -##### Freebox ≤ v5 +##### Freebox ≤ v5 Cela se passe dans la section *Ma Freebox / Configurer mon routeur*. Il faut : @@ -35,8 +35,8 @@ Cela se passe dans la section *Ma Freebox / Configurer mon routeur*. Il faut : La présence conjointe de ces deux règles permettent d'accéder à votre serveur de l'extérieur comme de l'intérieur de votre réseau local. ##### Freebox v6 -[Tutoriel d’ouverture des ports sur Freebox](http://www.astuces-pratiques.fr/informatique/ouvrir-un-port-sur-la-freebox-revolution) +[Tutoriel d’ouverture des ports sur Freebox](http://www.astuces-pratiques.fr/informatique/ouvrir-un-port-sur-la-freebox-revolution) #### Déblocage de l’envoi de courriel @@ -49,34 +49,40 @@ Pour pouvoir envoyer des mails, passez le blocage en « inactif ». #### Fonction NAS de la Freebox Il faut installer le paquet `cifs-utils` + ```bash -$ sudo apt install cifs-utils +sudo apt install cifs-utils ``` Il faut créer un point de montage (ici `/home/monlogin/freebox`) + ```bash -$ mkdir ~/freebox +mkdir ~/freebox ``` On monte le répertoire NAS par défaut avec les droits de lecture / écriture pour tous + ```bash -$ sudo mount -t cifs //mafreebox.freebox.fr/Disque\ dur/ /home/monlogin/freebox -o guest,iocharset=utf8,file_mode=0777,dir_mode=0777 +sudo mount -t cifs //mafreebox.freebox.fr/Disque\ dur/ /home/monlogin/freebox -o guest,iocharset=utf8,file_mode=0777,dir_mode=0777 ``` ##### Automatiser le montage Une ligne à ajouter à la fin du `/etc/fstab` : + ```bash //mafreebox.freebox.fr/Disque\040dur/ /home/monlogin/freebox cifs _netdev,guest,uid=monlogin,gid=users,iocharset=utf8 0 0 ``` Le `_netdev` signale que c'est un périphérique réseau, afin que le système ne le monte que s'il a accès au réseau. `guest` est le mode d'identification à la Freebox : pour une connexion authentifiée, placez vos identifiants dans un fichier sous la forme + ```bash username=your_user password=your_pass domain=FREEBOX ``` + et remplacez `guest` par `credentials=/path/to/file` (c'est aussi possible de spécifier directement `username=xx,password=xx` dans le fstab, mais déconseillé pour des raisons de sécurité) `uid` et `gid` sont pour les id user et group auxquels appartiendra le répertoire une fois monté. Par défault (sur la Freebox V5 en tout cas), ils se retrouvent avec les uid/gid de 4242. Il est aussi possible de mettre des droits particuliers avec les paramètres `file_mode=0777,dir_mode=0777`. diff --git a/pages/02.administer/55.providers/10.isp/isp.md b/pages/02.administer/55.providers/10.isp/isp.md index 27fc87395..24597f686 100644 --- a/pages/02.administer/55.providers/10.isp/isp.md +++ b/pages/02.administer/55.providers/10.isp/isp.md @@ -24,38 +24,38 @@ Here is a non-comprehensive list of internet service providers by country, which [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="Africa"] - * [Ivory Coast](/isp/country:civ) +- [Ivory Coast](/isp/country:civ) [/ui-tab] [ui-tab title="Asia"] - * [South Korea](/isp/country:kor) +- [South Korea](/isp/country:kor) [/ui-tab] [ui-tab title="Europe"] - * [Belgium (nl)](/isp/country:belnl) - * [Belgium (fr)](/isp/country:belfr) - * [Finland](/isp/country:fin) - * [France](/isp/country:fra) - * [Hungary](/isp/country:hun) - * [Ireland](/isp/country:irl) - * [Sweden](/isp/country:swe) - * [Switzerland](/isp/country:che) - * [UK](/isp/country:gbr) +- [Belgium (nl)](/isp/country:belnl) +- [Belgium (fr)](/isp/country:belfr) +- [Finland](/isp/country:fin) +- [France](/isp/country:fra) +- [Hungary](/isp/country:hun) +- [Ireland](/isp/country:irl) +- [Sweden](/isp/country:swe) +- [Switzerland](/isp/country:che) +- [UK](/isp/country:gbr) [/ui-tab] [ui-tab title="North america"] - * [Canada](/isp/country:can) - * [USA](/isp/country:usa) +- [Canada](/isp/country:can) +- [USA](/isp/country:usa) [/ui-tab] [ui-tab title="Oceania"] [/ui-tab] [ui-tab title="South america"] - * [Brazil](/isp/country:bra) +- [Brazil](/isp/country:bra) [/ui-tab] [/ui-tabs] @@ -71,12 +71,11 @@ A "no" may cause problems for using your server or may require you to make addit | Fournisseur d’accès | Box/ routeur | uPnP activable | [Port 25 ouvrable](/email)| [Hairpinning](http://fr.wikipedia.org/wiki/Hairpinning) | [Reverse DNS](https://en.wikipedia.org/wiki/Reverse_DNS_lookup) | IP fixe | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| **Proximus** | BBox2 | oui (activé) | oui | **non** | **non** | **non** | -| | BBox3 | oui (activé) | oui | **non** | **non** | **non** | -| **Scarlet** | BBox2 | oui (activé) | oui | **non** | **non** | **non** | - -**Proximus** ne serait pas ouvert à l’auto-hébergement. L’ouverture des ports serait plus difficile afin d’éviter tout SPAM. Il serait préférable de passer par [Neutrinet](http://neutrinet.be), un des [membres de la Fédération French Data Network](http://www.ffdn.org/fr/membres). +| **Proximus*- | BBox2 | oui (activé) | oui | **non*- | **non*- | **non*- | +| | BBox3 | oui (activé) | oui | **non*- | **non*- | **non*- | +| **Scarlet*- | BBox2 | oui (activé) | oui | **non*- | **non*- | **non*- | +**Proximus*- ne serait pas ouvert à l’auto-hébergement. L’ouverture des ports serait plus difficile afin d’éviter tout SPAM. Il serait préférable de passer par [Neutrinet](http://neutrinet.be), un des [membres de la Fédération French Data Network](http://www.ffdn.org/fr/membres). {% elseif country == 'belnl' %} @@ -84,31 +83,29 @@ A "no" may cause problems for using your server or may require you to make addit | Service provider | Box/ router | uPnP beschikbaar | [Poort 25 openen mogelijk](/email)| [Hairpinning](http://fr.wikipedia.org/wiki/Hairpinning) | [Reverse DNS](https://en.wikipedia.org/wiki/Reverse_DNS_lookup) | vaste IP | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| **Proximus** | BBox2 | ja (geactiveerd) | ja | **nee** | **nee** | **nee** | -| | BBox3 | ja (geactiveerd) | ja | **nee** | **nee** | **nee** | -| **Scarlet** | BBox2 | ja (geactiveerd) | ja | **nee** | **nee** | **nee** | - -**Proximus** zou niet openstaan voor self-hosting. Het openen van de poorten zou moeilijker zijn om SPAM te voorkomen. Het loont de moeite om een vpn te gebruiken. +| **Proximus*- | BBox2 | ja (geactiveerd) | ja | **nee*- | **nee*- | **nee*- | +| | BBox3 | ja (geactiveerd) | ja | **nee*- | **nee*- | **nee*- | +| **Scarlet*- | BBox2 | ja (geactiveerd) | ja | **nee*- | **nee*- | **nee*- | +**Proximus*- zou niet openstaan voor self-hosting. Het openen van de poorten zou moeilijker zijn om SPAM te voorkomen. Het loont de moeite om een vpn te gebruiken. {% elseif country == 'bra' %} ### Brazil + | Service provider | Box (modem/router) | uPnP available | Port 25 openable | [Hairpinning](http://en.wikipedia.org/wiki/Hairpinning) | Customizable reverse DNS | Fix IP | | --- | --- | --- | --- | --- | --- | --- | | Global Village Telecom | Multiple | Yes | No. Only for Fix IP| No | No | Yes, extra charge. | - {% elseif country == 'can' %} ### Canada + | Service provider | Box (modem/router) | uPnP available | Port 25 openable | [Hairpinning](http://en.wikipedia.org/wiki/Hairpinning) | Customizable reverse DNS | Fix IP | | --- | --- | --- | --- | --- | --- | --- | | Telus | Multiple | - | No. Extra charge | - | - | No. Extra charge | | TekSavvy | Multiple | - | Yes | No | - | No. Extra charge | - - {% elseif country == 'fin' %} ### Finland @@ -121,30 +118,28 @@ A "no" may cause problems for using your server or may require you to make addit [^fi-port25]: Regulations in Finland prohibit the use of Port 25 for consumers. - {% elseif country == 'fra' %} ### France Tous les fournisseurs d’accès à Internet [membres de la Fédération French Data Network](http://www.ffdn.org/fr/membres) ont une politique favorable à l’auto-hébergement. -* ✔ : oui -* ✘ : non + +- ✔ : oui +- ✘ : non | Fournisseur d’accès | OVH | [Free](/isp_free) | [SFR](/isp_sfr) | [Orange](/isp_orange) | Bouygues
Télécom | Darty | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| **Box/routeur** | Personnel/OVH Télécom | Freebox | Neufbox | Livebox | Bbox | Dartybox | -| **[UPnP](https://fr.wikipedia.org/wiki/Universal_Plug_and_Play)** | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | +| **Box/routeur*- | Personnel/OVH Télécom | Freebox | Neufbox | Livebox | Bbox | Dartybox | +| **[UPnP](https://fr.wikipedia.org/wiki/Universal_Plug_and_Play)*- | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | **[Port 25 ouvrable](/email)**
(fermé par défaut) | ✔ | ✔ | ✔ | ✘ | ✔ | ✔ | -| **[Hairpinning](http://fr.wikipedia.org/wiki/Hairpinning)** | ✔ | ✔ | ✔/✘ | ✔ (depuis la Livebox 4) | ✔ | ✔ | -| **[Reverse DNS](https://en.wikipedia.org/wiki/Reverse_DNS_lookup)
personnalisable ** | ✔ | ✔ (sauf IPv6, pas de support, et buggué sur certaines plages d'adresses ipv4) | … | ✘ (XXX.pro.dns-orange.fr disponible sur les abonnements orange pro) | ✘ | ✘ | -| **[IP fixe](/dns_dynamicip)** | ✔ | ✔ | ✔/✘ | ✘ (en option depuis la Livebox 3 et sur les abonnements orange pro) | ✔ | ✔ | -| **[IPv6](https://fr.wikipedia.org/wiki/IPv6)** | ✔ | ✔ | ✔ | ✔ | … | … | -| **[Non listé sur le DUL](https://en.wikipedia.org/wiki/Dialup_Users_List)** | … | ✘ | … | … | … | … | +| **[Hairpinning](http://fr.wikipedia.org/wiki/Hairpinning)*- | ✔ | ✔ | ✔/✘ | ✔ (depuis la Livebox 4) | ✔ | ✔ | +| **[Reverse DNS](https://en.wikipedia.org/wiki/Reverse_DNS_lookup)
personnalisable*- | ✔ | ✔ (sauf IPv6, pas de support, et buggué sur certaines plages d'adresses ipv4) | … | ✘ (XXX.pro.dns-orange.fr disponible sur les abonnements orange pro) | ✘ | ✘ | +| **[IP fixe](/dns_dynamicip)*- | ✔ | ✔ | ✔/✘ | ✘ (en option depuis la Livebox 3 et sur les abonnements orange pro) | ✔ | ✔ | +| **[IPv6](https://fr.wikipedia.org/wiki/IPv6)*- | ✔ | ✔ | ✔ | ✔ | … | … | +| **[Non listé sur le DUL](https://en.wikipedia.org/wiki/Dialup_Users_List)*- | … | ✘ | … | … | … | … | Pour une liste plus complète et précise, référez-vous à la très bonne documentation de [wiki.auto-hebergement.fr](http://wiki.auto-hebergement.fr/fournisseurs/fai#d%C3%A9tail_des_fai). -**Astuce** : [FDN](http://www.fdn.fr) fournit des [VPN](http://www.fdn.fr/-VPN-.html) permettant de rapatrier une (ou plusieurs sur demande) IPv4 fixe et un /48 en IPv6 et ainsi « nettoyer » votre connexion si vous êtes chez l’un des FAI *limitants* du tableau ci-dessus. - - +**Astuce** : [FDN](http://www.fdn.fr) fournit des [VPN](http://www.fdn.fr/-VPN-.html) permettant de rapatrier une (ou plusieurs sur demande) IPv4 fixe et un /48 en IPv6 et ainsi « nettoyer » votre connexion si vous êtes chez l’un des FAI *limitants- du tableau ci-dessus. {% elseif country == 'hun' %} @@ -155,26 +150,25 @@ Pour une liste plus complète et précise, référez-vous à la très bonne docu | DIGI Távközlési és Szolgáltató Kft. | Yes | Yes | No. Business only. | No | No. Business only | No. Business only | | Telekom Magyarország | Yes | Yes | No | No | No | No | -**Notice** : DIGI allows non-business users to subscribe to their business plan, for roughly the same price as the regular plan. Fix IP is an additional subscription for business plan users. +**Notice*- : DIGI allows non-business users to subscribe to their business plan, for roughly the same price as the regular plan. Fix IP is an additional subscription for business plan users. {% elseif country == 'irl' %} ### Ireland + | Service provider | Box (modem/router) | uPnP available | Port 25 openable | [Hairpinning](http://en.wikipedia.org/wiki/Hairpinning) | Customizable reverse DNS | Fix IP | | --- | --- | --- | --- | --- | --- | --- | | Whizzy Internet | Multiple | Yes | Yes| Yes | Yes | Yes | - - {% elseif country == 'civ' %} ### Côte d'Ivoire | Fournisseur d’accès | Box/ routeur | uPnP activable | [Port 25 ouvrable](/email)| [Hairpinning](http://fr.wikipedia.org/wiki/Hairpinning) | [Reverse DNS](https://en.wikipedia.org/wiki/Reverse_DNS_lookup) | IP fixe | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| **Orange** | Livebox2 | oui (activé) | non | **non** | **non** | **non** | -| **Moov** | | oui (activé) | | | | | -| **MTN** | | oui (activé) | | | | | +| **Orange*- | Livebox2 | oui (activé) | non | **non*- | **non*- | **non*- | +| **Moov*- | | oui (activé) | | | | | +| **MTN*- | | oui (activé) | | | | | {% elseif country == 'swe' %} @@ -188,8 +182,6 @@ Pour une liste plus complète et précise, référez-vous à la très bonne docu Ownit reserves port 3 and 4 of their router to TV. With a simple call to their hotline, explaining that you want to selfhost, they can reassign one of the ports to be in bridge mode. It means that your server will have its own public fixed IP address, in addition to the modem's. - - {% elseif country == 'che' %} ### Switzerland @@ -202,8 +194,6 @@ Most of non business IP provided by ISP are blacklisted. | Swisscom | Multiple | No | Yes | No | No | No | | VTX | Multiple | No | Yes | No | - | - | - - {% elseif country == 'kor' %} ### South Korea @@ -214,10 +204,10 @@ Most of non business IP provided by ISP are blacklisted. | KT(SkyLife, Qook&Show) | Multiple | Yes | Yes | No | - | Partial | | SKT (SK Broadband) | Multiple | Yes | Yes | No | - | Partial | - {% elseif country == 'gbr' %} ### UK + | Service provider | Box (modem/router) | uPnP available | Port 25 openable | [Hairpinning](http://en.wikipedia.org/wiki/Hairpinning) | Customizable reverse DNS | Fix IP | | --- | --- | --- | --- | --- | --- | --- | | BT Internet | Yes | - | Yes| - | - | No | @@ -228,6 +218,7 @@ Most of non business IP provided by ISP are blacklisted. {% elseif country == 'usa' %} ### USA + | Service provider | Box (modem/router) | uPnP available | Port 25 openable | [Hairpinning](http://en.wikipedia.org/wiki/Hairpinning) | Customizable reverse DNS | Fix IP | | --- | --- | --- | --- | --- | --- | --- | | Cox | Multiple | Yes | No. Only for business class customer. | No | No | Yes, as a business class customer | @@ -236,6 +227,4 @@ Most of non business IP provided by ISP are blacklisted. | AT&T| Multiple | Yes | No. Only for business class customer. | unknown. | unknown. | unknown. | | Xfinity (Comcast)| Multiple | Yes | No. Only for business class customer. | unknown. | unknown. | Yes, as a business class customer| - {% endif %} - diff --git a/pages/02.administer/55.providers/10.isp/orange/isp_orange.fr.md b/pages/02.administer/55.providers/10.isp/orange/isp_orange.fr.md index e308d26f4..82b7fccf5 100644 --- a/pages/02.administer/55.providers/10.isp/orange/isp_orange.fr.md +++ b/pages/02.administer/55.providers/10.isp/orange/isp_orange.fr.md @@ -47,6 +47,7 @@ Si vous avez une erreur "Authentification requise", la solution est la suivante ```bash sudo nano /etc/postfix/main.cf ``` + puis, rajouter à la ligne : ```bash @@ -68,6 +69,7 @@ ajouter # mdp_fai.conf [smtp.orange.fr]:25 adresseemail@chez.orange:son-mot-de-passe ``` + avec votre mot de passe du compte d'orange. Intégrer le mot de passe à Postfix : @@ -92,7 +94,8 @@ Si ils ne sont pas présents, installez-les : apt install libsasl2-modules sasl2-bin ``` -Il est possible que postfix ne prenne pas en compte tout de suite vos modifications. Pour le forcer à le faire, exécutez +Il est possible que postfix ne prenne pas en compte tout de suite vos modifications. Pour le forcer à le faire, exécutez + ```bash systemctl restart postfix ``` diff --git a/pages/02.administer/55.providers/10.isp/sfr/isp_sfr.fr.md b/pages/02.administer/55.providers/10.isp/sfr/isp_sfr.fr.md index 803748766..3ec4f5401 100644 --- a/pages/02.administer/55.providers/10.isp/sfr/isp_sfr.fr.md +++ b/pages/02.administer/55.providers/10.isp/sfr/isp_sfr.fr.md @@ -12,12 +12,14 @@ routes: *Trouvez la liste d’autres fournisseurs d’accès à Internet **[ici](/isp)**.* #### Accès à l’administration de la box -* Allez à cette adresse : http://192.168.1.1. + +* Allez à cette adresse : . * Authentifiez-vous, soit en appuyant sur le bouton de la box pendant 5 secondes soit avec les identifiants d’administration. ![](image://sfr-authentification.png?resize=900) #### Courrier électronique + Pour pouvoir envoyer des mails, il faut désactiver le filtrage. ![](image://sfr-filtrage.png?resize=600) diff --git a/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.de.md b/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.de.md index 4fe05ccdd..1afffb70a 100644 --- a/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.de.md +++ b/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.de.md @@ -9,24 +9,28 @@ routes: Es ist unüblich, zu Hause einen Server einzurichten, und die meisten Internetanschlüsse, die Privatpersonen zur Verfügung stehen, sind für diesen Zweck ungeeignet. Ein netzneutrales VPN, das eine feste IPv4-Adresse und IPv6-Adressen bereitstellt, kann helfen, einige der Einschränkungen oder Schwierigkeiten zu überwinden. -! Vorsicht: nicht alle bestehenden VPN-Anbieter erfüllen diese Bedingungen, vergewissern Sie sich, dass der von Ihnen gewählte Anbieter sie erfüllt. +! **Vorsicht**: nicht alle bestehenden VPN-Anbieter erfüllen diese Bedingungen, vergewissern Sie sich, dass der von Ihnen gewählte Anbieter sie erfüllt. ## Vorteile ### Plug & Play + Indem Sie ein VPN auf Ihrem Server einrichten, können Sie ihn für den Rest des Internets zugänglich machen, ohne die Konfiguration des Routers, an den Sie ihn anschließen, ändern zu müssen. Dies kann sehr praktisch sein, wenn Sie in den Urlaub fahren, umziehen oder einen Internetausfall haben, da Sie das Gerät einfach an eine Person Ihres Vertrauens anschließen können, ohne den Router der Person konfigurieren zu müssen, die Ihnen hilft. Außerdem ersparen Sie sich die Mühe, die Ports Ihres Routers zu öffnen und das Hairpinning zu umgehen. ### Keine Mikro-DNS-Ausfälle + Wenn Ihr Internetanschluss keine feste öffentliche IP hat, müssen Sie einen dynamischen Domänennamen (Dynamic DNS) einrichten. Diese Lösung mag akzeptabel sein, aber das DNS wird nur in regelmäßigen Abständen aktualisiert (alle zwei Minuten, wenn es sich um einen `noho.st` oder `nohost.me` Domänennamen handelt). Es besteht also die Möglichkeit, dass dies gelegentlich zu Darstellungsfehlern im Browser führt oder dass sogar eine andere Website angezeigt wird (die Risiken sind jedoch geringer, da die Praxis des Self-Hosting nicht weit verbreitet ist). -Mit einem neutralen VPN wird dieses Problem umgangen, da das VPN mit einer virtuellen Internetverbindung verglichen werden kann, die eine eigene feste IPv4-Adresse hat, so dass der Domänenname nicht aktualisiert werden muss. +Mit einem neutralen VPN wird dieses Problem umgangen, da das VPN mit einer virtuellen Internetverbindung verglichen werden kann, die eine eigene feste IPv4-Adresse hat, so dass der Domänenname nicht aktualisiert werden muss. ### Der Fall der E-Mail + E-Mail ist eines der komplexesten Protokolle, die man selbst hosten kann, und in der Regel ist es das, was ein Benutzer zuletzt selbst hostet. In der Tat kann es leicht passieren, dass vom Server gesendete E-Mails von den SMTP-Servern der Empfänger abgelehnt werden. Um dies zu vermeiden, müssen Sie u. a. : + - den umgekehrten DNS der Internetverbindung des Servers (oder VPN) konfigurieren - eine feste IPv4 - dass diese IPv4 aus allen Blacklists entfernt werden kann (insbesondere darf die IP nicht in der DUL enthalten sein) @@ -37,15 +41,20 @@ Leider beachtet keiner der gängigsten französischen Internetanbieter alle dies Um dies zu vermeiden, kann die Verwendung eines VPN, das diese Punkte berücksichtigt, eine Alternative darstellen. ### Vertrauen + Wenn Sie nicht möchten, dass der Inhalt der Kommunikation Ihres Servers von Geräten im Netz Ihres Internetanbieters ausspioniert wird, können Sie ein VPN verwenden, um Ihre Kommunikation zu verschlüsseln und Ihr Vertrauen in einen VPN-Anbieter zu setzen. Zur Erinnerung: Seit 2015 hat die Regierung offiziell Blackboxes bei großen Netzbetreibern installiert, um die gesamte digitale Kommunikation in Frankreich abzuhören und so die wissenschaftlichen, wirtschaftlichen und industriellen Interessen Frankreichs zu schützen. ## Benachteiligung + ### Kosten + Ein neutrales VPN ist mit Kosten verbunden, da der Betreiber, der es bereitstellt, einen Server betreiben und Bandbreite nutzen muss. Die Preise für die assoziativen VPNs des FFDN liegen bei etwa 6 € pro Monat. ### Packet Routing + Wenn Sie ein VPN auf Ihrem Server einrichten, wird die Übertragung einer Datei von einem Computer im lokalen Netzwerk zum Server, der das VPN nutzt, über das Ende des VPN, d.h. über den Server des VPN-Anbieters, laufen, wenn Sie keine besondere Konfiguration einrichten. Um dies zu vermeiden, gibt es zwei Lösungen : + - Wenn Sie den Server in einen Router umwandeln und die Heimgeräte daran anschließen, profitieren auch diese Geräte von der VPN-Vertraulichkeit. - Verwenden Sie den YunoHost-Server als DNS-Resolver, wenn Sie zu Hause sind, um die Domänennamen des Servers auf die lokale IP und nicht auf die öffentliche IP umzuleiten. Dies kann entweder auf jedem Gerät oder auf dem Router erfolgen (sofern letzterer dies zulässt). diff --git a/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.es.md b/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.es.md index d6cdd1c1f..997a46938 100644 --- a/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.es.md +++ b/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.es.md @@ -9,7 +9,7 @@ routes: Dado que la instalación de un servidor en casa es una práctica poco habitual, la mayoría de las conexiones a Internet que se proporcionan a los particulares no son adecuadas para este fin. Una VPN de red neutra que proporcione una dirección IPv4 fija y direcciones IPv6 puede ayudar a superar algunas limitaciones o dificultades. -! Advertencia: no todos los proveedores de VPN existentes cumplen estos requisitos, asegúrese de que el que elija los cumpla. +! **Advertencia**: no todos los proveedores de VPN existentes cumplen estos requisitos, asegúrese de que el que elija los cumpla. ## Ventajas @@ -45,7 +45,9 @@ Para superar esto, el uso de una VPN que respete estos puntos puede ser una alte Por último, si no quiere que el contenido de las comunicaciones de su servidor sea espiable por los equipos presentes en la red de su proveedor de servicios de Internet, puede utilizar una VPN para cifrar sus comunicaciones y deportar su confianza a un proveedor de VPN. A modo de recordatorio, desde 2015, el gobierno despliega oficialmente cajas negras en los principales operadores de red cuyo objetivo es espiar todas las comunicaciones digitales francesas para, entre otras cosas, preservar los intereses científicos, económicos e industriales de Francia. ## Desvenjajas + ### Coste + Una VPN neutra tiene un coste, ya que el operador que la proporciona debe gestionar un servidor y utilizar el ancho de banda. Los precios de las VPN asociadas a FFDN rondan los 6 euros al mes. ### Enrutamiento de paquetes diff --git a/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.fr.md b/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.fr.md index ae8665e3c..f903b026a 100644 --- a/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.fr.md +++ b/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.fr.md @@ -9,24 +9,28 @@ routes: L'installation d'un serveur chez soi étant une pratique peu courante, la plupart des connexions Internet fournies aux particuliers sont inadaptées à sa mise en pratique. Un VPN respectant la neutralité du net et fournissant une adresse IPv4 fixe et des adresses IPv6 peut permettre de contourner certaines limitations ou certaines difficultés. -! Attention : tous les fournisseurs VPN existants ne remplissent pas ces conditions, assurez-vous bien que celui que vous choisissez les remplit. +! **Attention** : tous les fournisseurs VPN existants ne remplissent pas ces conditions, assurez-vous bien que celui que vous choisissez les remplit. ## Avantages ### Plug & Play + En configurant un VPN sur votre serveur, vous serez en mesure de le rendre accessible au reste d'Internet sans avoir à modifier la configuration du routeur auquel vous le branchez. Ce point peut être vraiment pratique si vous partez en vacances, que vous déménagez ou si vous avez une coupure d'Internet, car vous serez en mesure de le brancher facilement chez une personne de confiance sans avoir besoin de configurer le routeur de la personne qui vous aide. De la même façon, vous vous économisez l'ouverture des ports de votre routeur ainsi que le contournement du hairpinning. ### Pas de micro-coupure DNS + Si votre connexion Internet n'a pas d'IP publique fixe, vous serez obligé de mettre en place un nom de domaine dynamique (Dynamique DNS). Cette solution peut être acceptable, mais la mise à jour du DNS ne se fera qu'à intervalle régulier (Toutes les deux minutes si c'est un nom de domaine en `noho.st` ou `nohost.me`). Il y a donc une chance que cela provoque de temps en temps des erreurs d'affichage dans le navigateur, voir même qu'un autre site s'affiche (les risques sont toutefois réduits car la pratique de l'auto-hébergement n'est pas répandue). -Avec un VPN neutre, ce problème est contourné car le VPN peut être comparé à une connexion Internet Virtuelle, qui a sa propre adresse IPv4 fixe, dès lors plus besoin de mettre à jour le nom de domaine. +Avec un VPN neutre, ce problème est contourné car le VPN peut être comparé à une connexion Internet Virtuelle, qui a sa propre adresse IPv4 fixe, dès lors plus besoin de mettre à jour le nom de domaine. ### Le cas du mail + Le mail est un des protocoles les plus complexes à auto-héberger, en général c'est ce qu'un utilisateur auto-héberge en dernier. En effet, il est très facile de se retrouver dans une situation où les emails envoyés par le serveur sont refusés par les serveurs SMTP destinataires. Pour éviter ça il faut entre autre : + - configurer le reverse DNS de la connexion Internet (ou du VPN) du serveur - une IPv4 fixe - que cette IPv4 soit enlevable de toutes les listes noires (notamment l'IP ne doit pas être sur le DUL) @@ -37,15 +41,20 @@ Malheureusement, aucun des FAI français les plus courants ne respecte la totali Pour pallier cela, l'usage d'un VPN respectant ces points peut être une alternative. ### Confiance + Enfin, si vous ne souhaitez pas que le contenu des communications de votre serveur soit espionnable par des équipements présents sur le réseau de votre fournisseur d'accès à Internet, vous pouvez utiliser un VPN pour chiffrer vos communications et déporter votre confiance sur un fournisseur de VPN. Rappel, depuis 2015, le gouvernement déploie officiellement des boîtes noires chez les gros opérateurs réseau qui ont pour objectif de mettre sur écoute l'ensemble des communications numériques françaises entre autre pour préserver les intérêts scientifiques, économiques et industrielles de la France. ## Inconvénient + ### Coût + Un VPN neutre a un coût puisque l'opérateur qui le fournit doit faire fonctionner un serveur et utiliser de la bande passante. Les prix des VPN associatifs de la FFDN sont autour de 6 € par mois. ### Trajet des paquets + Lorsque l'on met en place un VPN sur son serveur, si on ne met pas en place de configuration particulière, le transfert d'un fichier d'un ordinateur du réseau local vers le serveur utilisant le VPN, passera par le bout du VPN c'est-à-dire par le serveur du fournisseur de VPN. Pour pallier ce point, il y a deux solutions : + - transformer son serveur en routeur et connecter les équipements de la maison à ce dernier, ces équipements bénéficieront alors de la confidentialité du VPN également. - utiliser le serveur YunoHost comme résolveur DNS lorsque l'on est chez soi, de façon à rediriger les noms de domaines du serveur l'IP locale plutôt que l'IP publique. Cette opération peut se faire soit sur chaque équipement, soit sur le routeur (si ce dernier le permet). diff --git a/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.it.md b/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.it.md index 05fafd1b0..66ceadff6 100644 --- a/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.it.md +++ b/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.it.md @@ -9,24 +9,28 @@ routes: Poiché installare un server a casa è una pratica abbastanza poco comune molte connessioni Internet casalinghe non sono realmente utilizzabili per questo scopo. Una VPN rispettosa della neutralità di rete (net neutrality) con un indirizzo IPv4 fisso e indirizzi IPv6 può aiutare a superare alcune limitazioni e difficoltà. -! Attenzione: non tutti i provider di VPN rispettano queste condizioni, controllate che quello scelto le rispetti. +! **Attenzione**: non tutti i provider di VPN rispettano queste condizioni, controllate che quello scelto le rispetti. ## Vantaggi ### Plug & Play + Usare una VPN per il vostro server vi permetterà di renderlo accessibile a tutta Internet senza dover fare alcun cambiamento al router al quale lo connettete. Questa cosa risulta estremamente comoda se state andando in vacanza, se state traslocando o nel caso di una disconnessione da Internet poiché potrete facilmente riconnettere il server da qualcuno di fiducia senza necessità di riconfigurare il router della persone che vi sta aiutando. Allo stesso modo vi risparmierete il problema di aprire le porte del vostro router per bypassare l'hairpinning. ### Nessun micro distacco del DNS + Se la vostra connessione ad Internet non ha un IP pubblico fisso dovrete utilizzare un sistema di nome a dominio dinamico (Dynamic DNS). La soluzione è accettabile però il DNS verrà aggiornato ad intervalli regolari (ad esempio con i domini registrati su `noho.st` e `nohost.me` ogni due minuti). Di conseguenza è possibile che i browser possano mostrare degli errori di tanto in tanto o che addirittura venga mostrato un altro sito (anche se questa possibilità è abbastanza remota in quanto il self-hosting non è ancora molto diffuso). Con una VPN neutrale il problema è bypassato in quanto la VPN può essere assimilata ad una connessione ad Internet virtuale con un indirizzo IPv4 fisso e quindi il dominio non deve essere aggiornato. ### La questione della posta elettronica + La posta elettronica è uno dei protocolli più complessi per il self-hosting e di conseguenza quello che viene impostato per ultimo. E difatti è molto facile trovarsi nella situazione in cui le email inviate dal server vengono rifiutate dai server SMTP di destinazione. Per evitare questa situazione dovete: + - configurare il reverse DNS della connessione ad Internet del server (o della VPN) - un Ipv4 statico - fare in modo che questo indirizzo IPv4 sia eliminabile da tutte le blacklist (in particolare l'IP non deve essere nel DUL) @@ -37,15 +41,20 @@ Purtroppo quasi nessun IPS francese diffuso (e neanche italiano) permette di ris Di conseguenza usare una VPN che rispetta queste richieste è una valida alternativa. ### Fiducia + Infine, se non volete che la comunicazioni del vostro server possano essere intercettate dall'infrastruttura di rete del vostro ISP potete usare la VPN per cifrare le vostre comunicazioni e spostare la fiducia al provider della VPN. Ricordate che fin dal 2015 il governo (francese) installa ufficialmente delle `black box` nelle sedi dei grandi operatori di rete con l'obbiettivo di intercettare tutte le comunicazioni digitali francesi per controllare gli interessi scientifici, economici e industriali della Francia (non è chiaro cosa succede in Italia). ## Svantaggi + ### Costi + Una VPN neutrale presenta dei costi aggiuntivi poiché l'operatore che a fornisce deve gestire un server e consumare banda. Il costo di una VPN di un associato a FFDN (consorzio francese di operatori di rete sociali) si aggira intorno ai 6€ al mese. ### Packet path + Usando una VPN su vostro server, a meno di particolari configurazioni, la strada percorsa dai file da un computer sulla vostra rete locale al server della VPN passerà dal nodo terminale della VPN, cioè dal server del provider. Ci sono due possibili soluzioni a questo problema: + - trasformare il server in un router e connettere attraverso questo gli apparecchi casalinghi che così anche questi godranno della protezione della VPN. - usare il server YunoHost in un resolver del DNS a casa di modo da redirigere i nomi a dominio locali ad indirizzi locali invece che quelli pubblici. Questa Questa operazione deve essere compiuta per tutti gli apparecchi oppure sul router (se lo permette). diff --git a/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.md b/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.md index 0f8b3f520..9d2afb948 100644 --- a/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.md +++ b/pages/02.administer/55.providers/15.vpn/01.vpn/vpn_advantage.md @@ -9,24 +9,28 @@ routes: Since setting up a server at home is an uncommon practice, most Internet connections provided to individuals are unsuitable for this purpose. A net neutral VPN providing a fixed IPv4 address and IPv6 addresses can help to circumvent some limitations or difficulties. -! Beware: not all existing VPN providers meet these conditions, make sure the one you choose meets them. +! **Beware**: not all existing VPN providers meet these conditions, make sure the one you choose meets them. ## Advantages ### Plug & Play + By setting up a VPN on your server, you'll be able to make it accessible to the rest of the Internet without having to change the configuration of the router you connect it to. This can be really handy if you are going on vacation, moving or have an Internet disconnection, as you will be able to easily connect it to someone you trust without having to configure the router of the person who is helping you. In the same way, you save yourself the trouble of opening your router's ports and bypassing hairpinning. ### No micro DNS outages + If your Internet connection does not have a fixed public IP, you will be forced to set up a dynamic domain name (Dynamic DNS). This solution may be acceptable, but the DNS will only be updated at regular intervals (every two minutes if it is a `noho.st` or `nohost.me` domain name). So there is a chance that this will cause some display errors in the browser from time to time, or even that another site will be displayed (the risks are however reduced because the practice of self-hosting is not widespread). -With a neutral VPN, this problem is circumvented because the VPN can be compared to a Virtual Internet connection, which has its own fixed IPv4 address, so no need to update the domain name. +With a neutral VPN, this problem is circumvented because the VPN can be compared to a Virtual Internet connection, which has its own fixed IPv4 address, so no need to update the domain name. ### The case of email + Email is one of the most complex protocols to self-host, usually it is what a user self-hosts last. Indeed, it is very easy to find yourself in a situation where emails sent by the server are refused by the recipient SMTP servers. To avoid this you need to: + - configure the reverse DNS of the server's Internet connection (or VPN) - a fixed IPv4 - that this IPv4 is removable from all blacklists (notably the IP must not be on the DUL) @@ -37,15 +41,20 @@ Unfortunately, none of the most common French ISPs respect all these points. To overcome this, the use of a VPN respecting these points can be an alternative. ### Trust + Finally, if you do not want the content of your server's communications to be spied on by equipment present on your ISP's network, you can use a VPN to encrypt your communications and deport your trust to a VPN provider. Remember, since 2015, the government officially deploys black boxes at the large network operators whose objective is to tap all French digital communications to preserve the scientific, economic and industrial interests of France. ## Disadvantage + ### Cost + A neutral VPN has a cost since the operator who provides it must run a server and use bandwidth. The prices of the FFDN's associative VPNs are around 6 € per month. ### Packet path + When you set up a VPN on your server, if you don't set up any particular configuration, the transfer of a file from a computer on the local network to the server using the VPN, will go through the end of the VPN i.e. through the server of the VPN provider. To solve this problem, there are two solutions: + - transform the server into a router and connect the home equipments to it, these equipments will then benefit from the VPN confidentiality too. - use the YunoHost server as a DNS resolver when you are at home, in order to redirect the server's domain names to the local IP rather than the public IP. This operation can be done either on each equipment or on the router (if the latter allows it). diff --git a/pages/02.administer/55.providers/15.vpn/vpn.md b/pages/02.administer/55.providers/15.vpn/vpn.md index 334c7b6b5..852731c6c 100644 --- a/pages/02.administer/55.providers/15.vpn/vpn.md +++ b/pages/02.administer/55.providers/15.vpn/vpn.md @@ -14,13 +14,12 @@ routes: Since setting up a server at home is an uncommon practice, most Internet connections provided to individuals are unsuitable for this purpose especially if you desire to send mail. A net neutral VPN providing a dedicated fixed public IPv4 address and IPv6 addresses [can help to circumvent some limitations or difficulties](/vpn_advantage). - Below, you can find a list of providers compatible for self-hosting and especially those providing .cube format for VPNClient apps and those providing [internetcube](https://internetcu.be). !!! By **compatible for self-hosting** we means VPN offers with at least: -!!! * a fixed dedicated public IPv4 -!!! * port forwarding or opened features -!!! * net neutrality: no traffic analysis, no user data resale, no alteration of traffic (without legal obligations)... +!!! - a fixed dedicated public IPv4 +!!! - port forwarding or opened features +!!! - net neutrality: no traffic analysis, no user data resale, no alteration of traffic (without legal obligations)... ------------------ @@ -32,10 +31,10 @@ Below, you can find a list of providers compatible for self-hosting and especial ¹ [Pay what you want](https://en.wikipedia.org/wiki/Pay_what_you_want) !!! If you try an other VPN provider that include **public dedicated ipv4 and port forwarding**, feel free to contribute to this documentation. We need people to test specific offers of those commercial providers: -!!! * [VPN area](https://vpnarea.com/front/home/dedicated-ip) ✘ does not allow forwarding port 80. Running a webserver is against their TOS. -!!! * [Trust zone](https://trust.zone/fr/order?p=25) -!!! * [PureVPN](https://www.purevpn.fr/ip-vpn-dedie) -!!! * [RapidVPN](https://www.rapidvpn.com/vpn) +!!! *[VPN area](https://vpnarea.com/front/home/dedicated-ip) ✘ does not allow forwarding port 80. Running a webserver is against their TOS. +!!!* [Trust zone](https://trust.zone/fr/order?p=25) +!!! *[PureVPN](https://www.purevpn.fr/ip-vpn-dedie) +!!!* [RapidVPN](https://www.rapidvpn.com/vpn) ## French speaking-site diff --git a/pages/02.administer/55.providers/20.server/server.md b/pages/02.administer/55.providers/20.server/server.md index 0c688dc58..a4cd23969 100644 --- a/pages/02.administer/55.providers/20.server/server.md +++ b/pages/02.administer/55.providers/20.server/server.md @@ -14,15 +14,13 @@ routes: ## Pre-installed YunoHost Offers - * [Alsace Réseau Neutre](https://arn-fai.net) (VPS) FFDN CHATONS - - * [Association ECOWAN](https://ecowan.fr) (VPS) - - * [Scaleway Dedibox](https://www.scaleway.com/en/dedibox/operating-systems/) (dedicated server) +- [Alsace Réseau Neutre](https://arn-fai.net) (VPS) FFDN CHATONS +- [Association ECOWAN](https://ecowan.fr) (VPS) +- [Scaleway Dedibox](https://www.scaleway.com/en/dedibox/operating-systems/) (dedicated server) ## YunoHost IT outsourcing - * [ReflexLibre](https://reflexlibre.net) (France only) CHATONS +- [ReflexLibre](https://reflexlibre.net) (France only) CHATONS @@ -64,4 +65,3 @@ curl -k -i -H "Accept: application/json" \ }; - diff --git a/pages/02.administer/admindoc.es.md b/pages/02.administer/admindoc.es.md index 7a8fd7fd9..67a1364b2 100644 --- a/pages/02.administer/admindoc.es.md +++ b/pages/02.administer/admindoc.es.md @@ -9,4 +9,4 @@ routes: ### Administrar -# Descubre el auto-hospedaje, cómo instalar y usar tu YunoHost \ No newline at end of file +# Descubre el auto-hospedaje, cómo instalar y usar tu YunoHost diff --git a/pages/02.administer/admindoc.it.md b/pages/02.administer/admindoc.it.md index 0b5090d93..ae434ffd9 100644 --- a/pages/02.administer/admindoc.it.md +++ b/pages/02.administer/admindoc.it.md @@ -1,7 +1,5 @@ - - - --- + title: Guida di amministrazione template: chapter taxonomy: diff --git a/pages/03.user_guide/05.emailclients/email_configure_client.de.md b/pages/03.user_guide/05.emailclients/email_configure_client.de.md index 27d221a7f..08d04fa4a 100644 --- a/pages/03.user_guide/05.emailclients/email_configure_client.de.md +++ b/pages/03.user_guide/05.emailclients/email_configure_client.de.md @@ -16,13 +16,15 @@ Moderne Mail-Clients sollten in der Lage sein, sich automatisch zu konfigurieren Hier sind die Elemente, die Sie eingeben sollten, um Ihren Mail-Client manuell zu konfigurieren (`domain.tld` bezieht sich auf das, was nach dem @ in Ihrer E-Mail Adresse steht, und `Benutzername` auf das, was vor dem @ steht). | Protokoll | Port | Verschlüsselung | Authentifizierung | Benutzername | -| :--: | :-: | :--: | :--: | :--: | +| :--: | :-: | :--: | :--: | :--: | | IMAP | 993 | SSL/TLS | Normales Passwort | `Benutzername` (ohne die `@domain.tld`) | | SMTP | 587 | STARTTLS | Normales Passwort | `Benutzername` (ohne die `@domain.tld`) | ### Client für Client + [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="Mozilla Thunderbird"] + ##### ![](image://thunderbird.png?resize=50&classes=inline) Mozilla Thunderbird konfigurieren (auf einem Desktop-Computer) Um ein neues Konto in Thunderbird manuell zu konfigurieren, fügen Sie die Kontoinformationen hinzu und wählen dann Port 993 mit SSL/TLS für IMAP und Port 587 mit STARTTLS für SMTP. Wählen Sie anschließend "Normales Passwort" für die Authentifizierung und klicken Sie auf "Erweiterte Konfiguration". Möglicherweise müssen Sie die Zertifikatsausnahmen für das Abrufen von E-Mails und nach dem Senden Ihrer ersten E-Mail akzeptieren. Vergessen Sie nicht, den Punkt vor dem Domainnamen zu entfernen. @@ -34,6 +36,7 @@ Um ein neues Konto in Thunderbird manuell zu konfigurieren, fügen Sie die Konto [/ui-tab] [ui-tab title="K-9 Mail"] + ##### ![](image://k9mail.png?resize=50&classes=inline) K-9 Mail konfigurieren (auf Android) Führen Sie die folgenden Schritte aus. (Wie bei Thunderbird müssen Sie möglicherweise an einigen Stellen Zertifikate akzeptieren) @@ -43,9 +46,9 @@ Führen Sie die folgenden Schritte aus. (Wie bei Thunderbird müssen Sie möglic ![](image://k9mail_config_3.png?resize=280&classes=inline) ![](image://k9mail_config_4.png?resize=280&classes=inline) - [/ui-tab] [ui-tab title="Dekko"] + ##### ![](image://dekko-app.png?resize=50&classes=inline) Dekko konfigurieren (auf Ubuntu Touch) Beim ersten Mal können Sie einfach "Konto hinzufügen" wählen. Wenn Sie bereits ein Konto eingerichtet haben, tippen Sie auf das Hamburger-Menü, dann auf das Zahnrad, wählen Sie Mail, Konten und drücken Sie das '+'-Symbol. diff --git a/pages/03.user_guide/05.emailclients/email_configure_client.es.md b/pages/03.user_guide/05.emailclients/email_configure_client.es.md index 871841d60..8f8a56c87 100644 --- a/pages/03.user_guide/05.emailclients/email_configure_client.es.md +++ b/pages/03.user_guide/05.emailclients/email_configure_client.es.md @@ -19,7 +19,6 @@ A continuación puedes encontrar los elementos a configurar en el cliente de cor | IMAP | 993 | SSL/TLS | Normal password | `nombre_de_usuario` (sin `@domain.tld`) | | SMTP | 587 | STARTTLS | Normal password | `nombre_de_usuario` (sin `@domain.tld`) | - ### ![](image://thunderbird.png?resize=50&classes=inline) Configurar Mozilla Thunderbird (en un ordenador) Para configurar manualmente un nuevo cuenta en Thunderbird, añadir las informaciones de la cuenta, y después seleccionar el puerto 993 con SSL/TLS para IMAP, y puerto 587 con STARTTLS para SMTP. Después seleccionar 'Normal Password' para Autenticación y haz click en el botón 'Advanced Config'. Se puede que tendrás que aceptar los certificados para que todo funciona normalmente. diff --git a/pages/03.user_guide/05.emailclients/email_configure_client.fr.md b/pages/03.user_guide/05.emailclients/email_configure_client.fr.md index 3f5b33d06..0c396ab4e 100644 --- a/pages/03.user_guide/05.emailclients/email_configure_client.fr.md +++ b/pages/03.user_guide/05.emailclients/email_configure_client.fr.md @@ -16,14 +16,15 @@ Normalement, votre client email devrait recevoir la configuration automatiquemen Voici les éléments que vous devrez entrer pour configurer manuellement votre client email (`votre.domaine.tld` fait référence à ce qui est après le @ dans votre adresse email, et `nom_utilisateur` ce qui est avant @). | Protocole | Port | Chiffrement | Authentification | Login | -| :--: | :-: | :--: | :--: | :--: | +| :--: | :-: | :--: | :--: | :--: | | IMAP | 993 | SSL/TLS | Mot de passe normal | `nom_utilisateur` (sans `@votre.domaine.tld`) | | SMTP | 587 | STARTTLS | Mot de passe normal | `nom_utilisateur` (sans `@votre.domaine.tld`) | - ### Client par client + [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="Mozilla Thunderbird"] + ##### ![](image://thunderbird.png?resize=50&classes=inline) Configurer Mozilla Thunderbird Pour configurer manuellement un nouveau compte dans Thunderbird commencez par remplir les informations de base (nom, adresse et mot de passe), cliquez sur Continuer puis Configuration Manuelle. Enlevez le `.` avant le nom de domaine. Sélectionnez le port 993 avec SSL/TLS pour IMAP, et le port 587 avec STARTTLS pour SMTP. Sélectionnez 'Mot de passe normal' pour l'authentification. Testez la configuration puis validez (il vous faudra ensuite peut-être accepter des certificats pour que tout fonctionne correctement). @@ -36,6 +37,7 @@ Pour configurer manuellement un nouveau compte dans Thunderbird commencez par re [/ui-tab] [ui-tab title="K-9 Mail"] + ##### ![](image://k9mail.png?resize=50&classes=inline) Configurer K-9 Mail (sur Android) Suivez les instructions suivantes (comme pour Thunderbird, il vous faudra peut-être accepter des certificats à un moment). @@ -48,6 +50,7 @@ Suivez les instructions suivantes (comme pour Thunderbird, il vous faudra peut- [/ui-tab] [ui-tab title="Dekko"] + ##### ![](image://dekko-app.png?resize=50&classes=inline) Configurer Dekko (sur Ubuntu Touch) 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 '+'. diff --git a/pages/03.user_guide/05.emailclients/email_configure_client.it.md b/pages/03.user_guide/05.emailclients/email_configure_client.it.md index c1647a306..5f37680cb 100644 --- a/pages/03.user_guide/05.emailclients/email_configure_client.it.md +++ b/pages/03.user_guide/05.emailclients/email_configure_client.it.md @@ -16,13 +16,15 @@ Normalmente, il vostro client email si configura automaticamente quando aggiunge Ecco i valori da immettere per la configurazione manuale del vostro client mail (`vostro.dominio.tld` si riferisce a quello che appare dopo la @ nel vostro indirizzo mail, `nome utente` è riferito a quello che appare prima della @). |Protocollo | Porta | Sicurezza della connessione | Metodo di autenticazione | Nome utente -| :--: | :-: | :--: | :--: | :--: | +| :--: | :-: | :--: | :--: | :--: | | IMAP | 993 | SSL/TLS | Password normale | nome utente (senza `@vostro.domino.tld`) | | SMTP | 587 | STARTTLS | Password normale| nome utente (senza `@vostro.domino.tld`) | ### Esempio di alcuni client + [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="Mozilla Thunderbird"] + ##### ![](image://thunderbird.png?resize=50&classes=inline) Configurazione di Mozilla Thunderbird (su computer desktop) Per configurare manualmente un nuovo account in Thunderbird, iniziate ad inserire le informazioni iniziali (nome, indirizzo e password), cliccate su Continua e poi su Configurazione Manuale selezionando la porta 993 con SSL/TLS per IMAP e la porta 587 con STARTTLS per SMTP. Selezionate 'Password normale' come autenticazione e poi cliccate su 'Configurazione avanzata'. Può darsi che dobbiate accettare l'eccezione per il certificato prima di riuscire a scaricare l'email e prima di riuscire ad inviare la prima email. Non dimenticate di togliere il punto prima del nome del dominio. @@ -34,6 +36,7 @@ Per configurare manualmente un nuovo account in Thunderbird, iniziate ad inserir [/ui-tab] [ui-tab title="K-9 Mail"] + ##### ![](image://k9mail.png?resize=50&classes=inline) Configurazione di K-9 Mail (per Android) Seguite le istruzioni seguenti (come per dovrete forse accettare i certificati affinché tutto funzioni correttamente): @@ -43,9 +46,9 @@ Seguite le istruzioni seguenti (come per dovrete forse accettare i certificati a ![](image://k9mail_config_3.png?resize=280&classes=inline) ![](image://k9mail_config_4.png?resize=280&classes=inline) - [/ui-tab] [ui-tab title="Dekko"] + ##### ![](image://dekko-app.png?resize=50&classes=inline) Configurazione di Dekko (per Ubuntu Touch) Se nessun account è già configurato, potete semplicemente scegliere "Aggiungi account". Se un account è già presente, premete sul menù a panino e in seguito sugli ingranaggi, scegliete Mail, Accounts e il simbolo '+'. @@ -58,4 +61,3 @@ Selezionate IMAP. Compilate i campi e premete Successivo. Dekko cercherà la con ![](image://dekko_config_4.png?resize=280&classes=inline) [/ui-tab] [/ui-tabs] - diff --git a/pages/03.user_guide/05.emailclients/email_configure_client.md b/pages/03.user_guide/05.emailclients/email_configure_client.md index d5a95bdcd..b9095a090 100644 --- a/pages/03.user_guide/05.emailclients/email_configure_client.md +++ b/pages/03.user_guide/05.emailclients/email_configure_client.md @@ -16,13 +16,15 @@ Modern mail clients should be able to configure themselves automatically. If aut Here are the element you should enter to manually configure your mail client (`domain.tld` refers to what's after the @ in your email address, and `username` what's before @). | Protocol | Port | Encryption | Authentication | Username | -| :--: | :-: | :--: | :--: | :--: | +| :--: | :-: | :--: | :--: | :--: | | IMAP | 993 | SSL/TLS | Normal password | `username` (without the `@domain.tld`) | | SMTP | 587 | STARTTLS | Normal password | `username` (without the `@domain.tld`) | ### Client by client + [ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="Mozilla Thunderbird"] + ##### ![](image://thunderbird.png?resize=50&classes=inline) Configure Mozilla Thunderbird (on a desktop computer) To manually configure a new account in Thunderbird, add the account information, then select port 993 with SSL/TLS for IMAP, and port 587 with STARTTLS for SMTP. Afterwards select 'Normal Password' for Authentication and click on 'Advanced Config'. You may need to accept the certificate exceptions for fetching mails and after you send your first mail. Don't forget to remove the dot before the domain name. @@ -34,6 +36,7 @@ To manually configure a new account in Thunderbird, add the account information, [/ui-tab] [ui-tab title="K-9 Mail"] + ##### ![](image://k9mail.png?resize=50&classes=inline) Configure K-9 Mail (on Android) Follow the following steps. (As for Thunderbird, you might need to accept certificates at some points) @@ -43,9 +46,9 @@ Follow the following steps. (As for Thunderbird, you might need to accept certif ![](image://k9mail_config_3.png?resize=280&classes=inline) ![](image://k9mail_config_4.png?resize=280&classes=inline) - [/ui-tab] [ui-tab title="Dekko"] + ##### ![](image://dekko-app.png?resize=50&classes=inline) Configure Dekko (on Ubuntu Touch) The first time you can simply choose "Add account". If you already have an account configured, tap the hamburger menu then tap the gear, choose Mail, Accounts and press the '+'-symbol. diff --git a/pages/03.user_guide/10.email_migration/email_migration.fr.md b/pages/03.user_guide/10.email_migration/email_migration.fr.md index 69859b6ea..63be34557 100644 --- a/pages/03.user_guide/10.email_migration/email_migration.fr.md +++ b/pages/03.user_guide/10.email_migration/email_migration.fr.md @@ -20,10 +20,13 @@ Cet outil doit être installé sur votre ordinateur de bureau. La procédure de [Site d’ImapSync](http://imapsync.lamiral.info/) Installez ImapSync sur votre ordinateur client en suivant ce [guide](http://imapsync.lamiral.info/INSTALL) : + ```bash sudo dnf install imapsync # Sous Fedora ``` + Transférez les mails d’un serveur à l’autre : + ```bash imapsync --host1 --port1 993 --ssl1 --user1 --password1 \ --host2 --port2 993 --ssl2 --user2 --password2 @@ -36,11 +39,15 @@ Notez que les paramètres de transfert `--port 993` et `--ssl` sont spécifiques [Site de Larch](https://github.com/rgrove/larch/) Après avoir préalablement installé `gem`, installez `larch` sur votre ordinateur client : + ```bash sudo gem install larch ``` + Transférez les mails d’un serveur à l’autre : + ```bash larch -a -f imaps://serveur_d'origine.org -t imaps://serveur_de_destination.org ``` + Pour d’autres types de transferts référez-vous à la documentation de Larch. diff --git a/pages/03.user_guide/10.email_migration/email_migration.md b/pages/03.user_guide/10.email_migration/email_migration.md index 20d40c0e5..3db5245b5 100644 --- a/pages/03.user_guide/10.email_migration/email_migration.md +++ b/pages/03.user_guide/10.email_migration/email_migration.md @@ -20,10 +20,13 @@ This tool must be installed on your desktop computer. The transfer method looks [ImapSync site](http://imapsync.lamiral.info/) Install ImapSync on your client computer by following this [guide](http://imapsync.lamiral.info/INSTALL): + ```bash sudo dnf install imapsync # Under Fedora ``` + Transfer emails from one server to another: + ```bash imapsync --host1 --port1 993 --ssl1 --user1 --password1 \ --host2 --port2 993 --ssl2 --user2 --password2 @@ -36,11 +39,15 @@ Note that transfer settings `--port 993` and `--ssl` are specific to YunoHost em [Larch site](https://github.com/rgrove/larch/) After beforehand installed `gem`, install `larch` on your client computer: + ```bash sudo gem install larch ``` + Transfer emails from one server to another: + ```bash larch -a -f imaps://serveur_d'origine.org -t imaps://serveur_de_destination.org ``` + For other types of transfer refer to [Larch documentation](https://github.com/rgrove/larch#label-Usage). diff --git a/pages/03.user_guide/15.xmpp/xmpp.es.md b/pages/03.user_guide/15.xmpp/xmpp.es.md index 69466c08c..fcd7f01a9 100644 --- a/pages/03.user_guide/15.xmpp/xmpp.es.md +++ b/pages/03.user_guide/15.xmpp/xmpp.es.md @@ -11,9 +11,9 @@ routes: YunoHost está instalado con un servidor de mensajería instantánea Metronome que implementa el [protocolo XMPP](https://es.wikipedia.org/wiki/Extensible_Messaging_and_Presence_Protocol). -XMPP es un protocolo abierto y extensible que también permite crear salones de discusión, compartir status y datos, echar llamadas en VoIP y hacer videoconferencias. +XMPP es un protocolo abierto y extensible que también permite crear salones de discusión, compartir status y datos, echar llamadas en VoIP y hacer videoconferencias. -Todas las aplicaciones basadas en XMPP son compatibles entre ellas : cuando utilizas un cliente XMPP puedes discutir con cualquier persona que tenga una cuenta XMPP/Jabber. Este protocolo ya es utilizado por millones de personas en el mundo. +Todas las aplicaciones basadas en XMPP son compatibles entre ellas : cuando utilizas un cliente XMPP puedes discutir con cualquier persona que tenga una cuenta XMPP/Jabber. Este protocolo ya es utilizado por millones de personas en el mundo. ## Cuenta XMPP/Jabber @@ -22,11 +22,13 @@ Una cuenta XMPP/Jabber está basada en un ID bajo la forma `usuario@dominio.tld` ## Conectarse a XMPP Existen varios clientes web de tipo red social, como : + - [Movim](https://movim.eu) - [ConverseJS](https://conversejs.org/) - [Libervia/Salut à Toi](https://salut-a-toi.org/) También puedes utilizar un cliente Desktop como : + - [Gajim](https://gajim.org/es/) (Linux, Windows) - [Dino](https://dino.im) (Linux) - [Thunderbird](https://www.thunderbird.net/es-ES/) (multiplataformas) @@ -34,6 +36,7 @@ También puedes utilizar un cliente Desktop como : - [Profanity](https://profanity-im.github.io/) (Linux) ... o un cliente smartphone : + - [Conversations](https://conversations.im/) (Android) - [Xabber](http://xabber.com) (Android) - [Movim](https://movim.eu) (Android) @@ -42,18 +45,18 @@ También puedes utilizar un cliente Desktop como : - [Monal](https://monal.im/) (iOS) - [Kaidan](https://www.kaidan.im/) (Ubuntu Touch / Plasma Mobile) -Aquí tienes una lista más exhaustiva de clientes XMPP (en) : https://xmpp.org/software/clients.html +Aquí tienes una lista más exhaustiva de clientes XMPP (en) : -### Cifrar tu conversaciones con OMEMO : +### Cifrar tu conversaciones con OMEMO Es posible cifrar tu conversaciones XMPP con la ayuda de [OMEMO](https://xmpp.org/extensions/xep-0384.html), por ejemplo utilizando Gajim : -* Instalar `gajim` y el plugin `gajim-omemo` -* Activar el plugin en `Tools > Plugins` -* Activar el cifrado en una conversación con un contacto que también tiene OMEMO activado. +- Instalar `gajim` y el plugin `gajim-omemo` +- Activar el plugin en `Tools > Plugins` +- Activar el cifrado en una conversación con un contacto que también tiene OMEMO activado. -### Salón de discusión +### Salón de discusión -Para crear un salón de discusión (Multi-user chat) en tu servidor YunoHost, utiliza el ID nombredelsalon@muc.dominio.tld (donde dominio.tld es el dominio principal de tu servidor). +Para crear un salón de discusión (Multi-user chat) en tu servidor YunoHost, utiliza el ID (donde dominio.tld es el dominio principal de tu servidor). Si utilizas un nombre de dominio personal, es necesario [añadir una redirección de tipo CNAME para el subdominio `muc.`](/dns_config) en tu servidor DNS. diff --git a/pages/03.user_guide/15.xmpp/xmpp.fr.md b/pages/03.user_guide/15.xmpp/xmpp.fr.md index 8ac317816..fa5f6ba9b 100644 --- a/pages/03.user_guide/15.xmpp/xmpp.fr.md +++ b/pages/03.user_guide/15.xmpp/xmpp.fr.md @@ -54,13 +54,14 @@ Voici une liste plus exhaustive des clients XMPP : [https://fr.wikipedia.org/wi ## Chiffrer ses conversations avec OMEMO Il est possible de rendre les conversations plus sécurisées et privées en les chiffrant à l'aide de [OMEMO](https://xmpp.org/extensions/xep-0384.html), notamment en utilisant Gajim : + - Installez `gajim` et le plugin `gajim-omemo` ; - Activez le plugin dans `Outils > Plugins` ; - Activez le chiffrement dans une conversation avec un contact disposant de OMEMO. ## Salon de discussion -Pour créer un salon de discussion (Multi-user chat) sur votre serveur YunoHost, utilisez l’identifiant nomsalon@muc.domaine.tld (où domaine.tld est le domaine principal de votre serveur). +Pour créer un salon de discussion (Multi-user chat) sur votre serveur YunoHost, utilisez l’identifiant (où domaine.tld est le domaine principal de votre serveur). Si vous utilisez un nom de domaine personnel, il est nécessaire d’[ajouter une redirection de type CNAME pour le sous domaine `muc.`](/dns_config) au niveau de votre serveur DNS. diff --git a/pages/03.user_guide/15.xmpp/xmpp.it.md b/pages/03.user_guide/15.xmpp/xmpp.it.md index 6e146657a..91266e2c7 100644 --- a/pages/03.user_guide/15.xmpp/xmpp.it.md +++ b/pages/03.user_guide/15.xmpp/xmpp.it.md @@ -9,7 +9,7 @@ routes: ![](image://XMPP_logo.png?resize=100) -L'installazione di YunoHost comprende il server di messaggistica istantanea Metronome che supporta il [protocollo XMPP](https://it.wikipedia.org/wiki/Extensible_Messaging_and_Presence_Protocol) (precedentemente conosciuto come Jabber). +L'installazione di YunoHost comprende il server di messaggistica istantanea Metronome che supporta il [protocollo XMPP](https://it.wikipedia.org/wiki/Extensible_Messaging_and_Presence_Protocol) (precedentemente conosciuto come Jabber). Questo protocollo utilizzato da milioni di persone nel mondo è un protocollo aperto. Tutte le applicazioni basate su XMPP sono tra di loro compatibili: quando utilizzate un client XMPP potete interagire con chiunque possieda un account XMPP. @@ -20,7 +20,7 @@ XMPP è un protocollo espandibile: ciò significa che gli utenti possono configu Per utilizzare XMPP è necessario disporre di un account che rispetti questa sintassi come identificativo: `utente@mio.dominio.tld` e di una password. -In YunoHost un account XMPP è creato automaticamente per ogni utente. +In YunoHost un account XMPP è creato automaticamente per ogni utente. L'identificativo XMPP corrisponde all'indirizzo mail principale di ogni utente e relativa password. ## Collegarsi al proprio account XMPP YunoHost @@ -56,6 +56,7 @@ Qui un elenco completo dei client XMPP [Qui](https://fr.wikipedia.org/wiki/Liste ## Cifrare le conversazioni con OMEMO È possibile proteggere e cifrare le conversazioni con l'uso di [OMEMO encryption](https://xmpp.org/extensions/xep-0384.html), ben supportato in Gajim: + - Installate `gajim` e il plugim `gajim-omemo`. - Attivate il plugin nel menù `Strumenti > Plugins`. - Attivate la cifratura in una conversazione con un contatto che adotta OMEMO diff --git a/pages/03.user_guide/15.xmpp/xmpp.md b/pages/03.user_guide/15.xmpp/xmpp.md index 03767c822..1337a1a26 100644 --- a/pages/03.user_guide/15.xmpp/xmpp.md +++ b/pages/03.user_guide/15.xmpp/xmpp.md @@ -51,11 +51,12 @@ You can connect to your YunoHost XMPP account in different ways. - [Siskin IM](https://siskin.im/) (iOS) - [Kaidan](https://www.kaidan.im/) (Ubuntu Touch / Plasma Mobile) -Here is an exhaustive list of XMPP clients: https://xmpp.org/software/clients.html +Here is an exhaustive list of XMPP clients: ## Encrypt conversations with OMEMO XMPP chats can be made secure and private using [OMEMO encryption](https://xmpp.org/extensions/xep-0384.html), for instance using Gajim: + - Install `gajim` and the plugin `gajim-omemo`. - Turn on the plugin in `Tools > Plugins`. - Turn on the encryption in the chat with somebody who also has OMEMO. diff --git a/pages/03.user_guide/user_overview.fr.md b/pages/03.user_guide/user_overview.fr.md index 3c5f7d4c1..5e900b79d 100644 --- a/pages/03.user_guide/user_overview.fr.md +++ b/pages/03.user_guide/user_overview.fr.md @@ -8,4 +8,4 @@ routes: default: '/user_guide' --- -!! Cette section est en cours d'élaboration. \ No newline at end of file +!! Cette section est en cours d'élaboration. diff --git a/pages/03.user_guide/user_overview.md b/pages/03.user_guide/user_overview.md index c7b7616c0..a31c91a66 100644 --- a/pages/03.user_guide/user_overview.md +++ b/pages/03.user_guide/user_overview.md @@ -8,4 +8,4 @@ routes: default: '/user_guide' --- -!! This section is being worked on. \ No newline at end of file +!! This section is being worked on. diff --git a/pages/04.applications/15.framasoft/apps_framasoft.md b/pages/04.applications/15.framasoft/apps_framasoft.md index 43a3f4d8b..52c7c3549 100644 --- a/pages/04.applications/15.framasoft/apps_framasoft.md +++ b/pages/04.applications/15.framasoft/apps_framasoft.md @@ -9,42 +9,42 @@ routes: | Framasoft App | Original project | Package | | :---: | :---: | :---: | -| Framabag | [Wallabag ](https://www.wallabag.it) | [[fa=git /]](https://github.com/YunoHost-Apps/wallabag2_ynh) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.status.svg) ![](https://dash.yunohost.org/integration/wallabag2.svg) | -| Framabee | [Searx ](https://searx.ir) | [[fa=git /]](https://github.com/YunoHost-Apps/searx_ynh) ![](https://ci-apps.yunohost.org/ci/badges/searx.status.svg) ![](https://dash.yunohost.org/integration/searx.svg) | -| Framabin | [PrivateBin ](https://privatebin.info) | [[fa=git /]](https://github.com/YunoHost-apps/zerobin_ynh) ![](https://ci-apps.yunohost.org/ci/badges/zerobin.status.svg) ![](https://dash.yunohost.org/integration/zerobin.svg) | -| Framaboard | [Kanboard ](https://kanboard.org) | [[fa=git /]](https://github.com/YunoHost-Apps/kanboard_ynh) ![](https://ci-apps.yunohost.org/ci/badges/kanboard.status.svg) ![](https://dash.yunohost.org/integration/kanboard.svg) | -| Framabookin | [BicBucStriim ](https://github.com/rvolz/BicBucStriim) | [[fa=git /]](https://github.com/YunoHost-Apps/bicbucstriim_ynh) ![](https://ci-apps.yunohost.org/ci/badges/bicbucstriim.status.svg) ![](https://dash.yunohost.org/integration/bicbucstriim.svg) | -| Framacalc | [Ethercalc ](https://ethercalc.net) | [[fa=git /]](https://github.com/YunoHost-Apps/ethercalc_ynh) ![](https://ci-apps.yunohost.org/ci/badges/ethercalc.status.svg) ![](https://dash.yunohost.org/integration/ethercalc.svg) | -| Framacarte | [uMap ](http://umap.openstreetmap.fr) | [[fa=git /]](https://github.com/YunoHost-Apps/umap_ynh) ![](https://ci-apps.yunohost.org/ci/badges/umap.status.svg) ![](https://dash.yunohost.org/integration/umap.svg) | -| Framaclic | [Dolomon ](https://dolomon.org) | Non Packagé | -| Framadate | [OpenSondage ](https://framadate.org) | [[fa=git /]](https://github.com/YunoHost-Apps/opensondage_ynh) ![](https://ci-apps.yunohost.org/ci/badges/opensondage.status.svg) ![](https://dash.yunohost.org/integration/opensondage.svg) | -| Framadrive | [Nextcloud ](https://nextcloud.com) | [[fa=git /]](https://github.com/YunoHost-apps/nextcloud_ynh) ![](https://ci-apps.yunohost.org/ci/badges/nextcloud.status.svg) ![](https://dash.yunohost.org/integration/nextcloud.svg) | -| Framadrop | [Lufi ](https://framagit.org/fiat-tux/hat-softwares/lufi) | [[fa=git /]](https://github.com/YunoHost-Apps/lufi_ynh) ![](https://ci-apps.yunohost.org/ci/badges/lufi.status.svg) ![](https://dash.yunohost.org/integration/lufi.svg) | -| Framaestro | [Framaestro ](https://framaestro.org) | [[fa=git /]](https://github.com/YunoHost-Apps/framaestro_ynh) ![](https://ci-apps.yunohost.org/ci/badges/framaestro.status.svg) ![](https://dash.yunohost.org/integration/framaestro.svg) | -| Framaforms | [Framaforms ](https://framaforms.org) | [[fa=git /]](https://github.com/YunoHost-Apps/framaforms_ynh) ![](https://ci-apps.yunohost.org/ci/badges/framaforms.status.svg) ![](https://dash.yunohost.org/integration/framaforms.svg) | -| Framagames | [Framagames ](https://framagames.org) | [[fa=git /]](https://github.com/YunoHost-Apps/framagames_ynh) ![](https://ci-apps.yunohost.org/ci/badges/framagames.status.svg) ![](https://dash.yunohost.org/integration/framagames.svg) | +| Framabag | [Wallabag](https://www.wallabag.it) | [[fa=git /]](https://github.com/YunoHost-Apps/wallabag2_ynh) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.status.svg) ![](https://dash.yunohost.org/integration/wallabag2.svg) | +| Framabee | [Searx](https://searx.ir) | [[fa=git /]](https://github.com/YunoHost-Apps/searx_ynh) ![](https://ci-apps.yunohost.org/ci/badges/searx.status.svg) ![](https://dash.yunohost.org/integration/searx.svg) | +| Framabin | [PrivateBin](https://privatebin.info) | [[fa=git /]](https://github.com/YunoHost-apps/zerobin_ynh) ![](https://ci-apps.yunohost.org/ci/badges/zerobin.status.svg) ![](https://dash.yunohost.org/integration/zerobin.svg) | +| Framaboard | [Kanboard](https://kanboard.org) | [[fa=git /]](https://github.com/YunoHost-Apps/kanboard_ynh) ![](https://ci-apps.yunohost.org/ci/badges/kanboard.status.svg) ![](https://dash.yunohost.org/integration/kanboard.svg) | +| Framabookin | [BicBucStriim](https://github.com/rvolz/BicBucStriim) | [[fa=git /]](https://github.com/YunoHost-Apps/bicbucstriim_ynh) ![](https://ci-apps.yunohost.org/ci/badges/bicbucstriim.status.svg) ![](https://dash.yunohost.org/integration/bicbucstriim.svg) | +| Framacalc | [Ethercalc](https://ethercalc.net) | [[fa=git /]](https://github.com/YunoHost-Apps/ethercalc_ynh) ![](https://ci-apps.yunohost.org/ci/badges/ethercalc.status.svg) ![](https://dash.yunohost.org/integration/ethercalc.svg) | +| Framacarte | [uMap](http://umap.openstreetmap.fr) | [[fa=git /]](https://github.com/YunoHost-Apps/umap_ynh) ![](https://ci-apps.yunohost.org/ci/badges/umap.status.svg) ![](https://dash.yunohost.org/integration/umap.svg) | +| Framaclic | [Dolomon](https://dolomon.org) | Non Packagé | +| Framadate | [OpenSondage](https://framadate.org) | [[fa=git /]](https://github.com/YunoHost-Apps/opensondage_ynh) ![](https://ci-apps.yunohost.org/ci/badges/opensondage.status.svg) ![](https://dash.yunohost.org/integration/opensondage.svg) | +| Framadrive | [Nextcloud](https://nextcloud.com) | [[fa=git /]](https://github.com/YunoHost-apps/nextcloud_ynh) ![](https://ci-apps.yunohost.org/ci/badges/nextcloud.status.svg) ![](https://dash.yunohost.org/integration/nextcloud.svg) | +| Framadrop | [Lufi](https://framagit.org/fiat-tux/hat-softwares/lufi) | [[fa=git /]](https://github.com/YunoHost-Apps/lufi_ynh) ![](https://ci-apps.yunohost.org/ci/badges/lufi.status.svg) ![](https://dash.yunohost.org/integration/lufi.svg) | +| Framaestro | [Framaestro](https://framaestro.org) | [[fa=git /]](https://github.com/YunoHost-Apps/framaestro_ynh) ![](https://ci-apps.yunohost.org/ci/badges/framaestro.status.svg) ![](https://dash.yunohost.org/integration/framaestro.svg) | +| Framaforms | [Framaforms](https://framaforms.org) | [[fa=git /]](https://github.com/YunoHost-Apps/framaforms_ynh) ![](https://ci-apps.yunohost.org/ci/badges/framaforms.status.svg) ![](https://dash.yunohost.org/integration/framaforms.svg) | +| Framagames | [Framagames](https://framagames.org) | [[fa=git /]](https://github.com/YunoHost-Apps/framagames_ynh) ![](https://ci-apps.yunohost.org/ci/badges/framagames.status.svg) ![](https://dash.yunohost.org/integration/framagames.svg) | | Framagenda | [Nextcloud Calendar](https://apps.nextcloud.com/apps/calendar) | c.f. Nextcloud | -| Framagit | [GitLab ](https://about.gitlab.com) | [[fa=git /]](https://github.com/YunoHost-Apps/gitlab_ynh) ![](https://ci-apps.yunohost.org/ci/badges/gitlab.status.svg) ![](https://dash.yunohost.org/integration/gitlab.svg) | -| Frama.link | [Lstu ](https://lstu.fr) | [[fa=git /]](https://github.com/YunoHost-Apps/lstu_ynh) ![](https://ci-apps.yunohost.org/ci/badges/lstu.status.svg) ![](https://dash.yunohost.org/integration/lstu.svg) | -| Framalistes | [Sympa ](http://www.sympa.org) | [[fa=git /]](https://github.com/alexAubin/sympa_ynh) ![](https://ci-apps.yunohost.org/ci/badges/sympa.status.svg) ![](https://dash.yunohost.org/integration/sympa.svg) | -| Framanews | [TinyTinyRSS ](https://tt-rss.org) | [[fa=git /]](https://github.com/YunoHost-apps/ttrss_ynh) ![](https://ci-apps.yunohost.org/ci/badges/ttrss.status.svg) ![](https://dash.yunohost.org/integration/ttrss.svg) | -| Framanotes | [Turtl ](https://turtlapp.com) | [[fa=git /]](https://github.com/YunoHost-Apps/turtl_ynh) ![](https://ci-apps.yunohost.org/ci/badges/turtl.status.svg) ![](https://dash.yunohost.org/integration/turtl.svg) | +| Framagit | [GitLab](https://about.gitlab.com) | [[fa=git /]](https://github.com/YunoHost-Apps/gitlab_ynh) ![](https://ci-apps.yunohost.org/ci/badges/gitlab.status.svg) ![](https://dash.yunohost.org/integration/gitlab.svg) | +| Frama.link | [Lstu](https://lstu.fr) | [[fa=git /]](https://github.com/YunoHost-Apps/lstu_ynh) ![](https://ci-apps.yunohost.org/ci/badges/lstu.status.svg) ![](https://dash.yunohost.org/integration/lstu.svg) | +| Framalistes | [Sympa](http://www.sympa.org) | [[fa=git /]](https://github.com/alexAubin/sympa_ynh) ![](https://ci-apps.yunohost.org/ci/badges/sympa.status.svg) ![](https://dash.yunohost.org/integration/sympa.svg) | +| Framanews | [TinyTinyRSS](https://tt-rss.org) | [[fa=git /]](https://github.com/YunoHost-apps/ttrss_ynh) ![](https://ci-apps.yunohost.org/ci/badges/ttrss.status.svg) ![](https://dash.yunohost.org/integration/ttrss.svg) | +| Framanotes | [Turtl](https://turtlapp.com) | [[fa=git /]](https://github.com/YunoHost-Apps/turtl_ynh) ![](https://ci-apps.yunohost.org/ci/badges/turtl.status.svg) ![](https://dash.yunohost.org/integration/turtl.svg) | | Framapad | [Etherpad](https://etherpad.org) + [MyPads](https://framagit.org/framasoft/Etherpad/ep_mypads) | [[fa=git /]](https://github.com/YunoHost-Apps/etherpad_mypads_ynh) ![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.status.svg) ![](https://dash.yunohost.org/integration/etherpad_mypads.svg) | -| Framapiaf | [Mastodon ](https://joinmastodon.org) | [[fa=git /]](https://github.com/YunoHost-Apps/mastodon_ynh) ![](https://ci-apps.yunohost.org/ci/badges/mastodon.status.svg) ![](https://dash.yunohost.org/integration/mastodon.svg) | -| Framapic | [Lutim ](https://lut.im/) | [[fa=git /]](https://github.com/YunoHost-Apps/lutim_ynh) ![](https://ci-apps.yunohost.org/ci/badges/lutim.status.svg) ![](https://dash.yunohost.org/integration/lutim.svg) | -| Framasites | [Grav ](https://getgrav.org) | [[fa=git /]](https://github.com/YunoHost-Apps/grav_ynh) ![](https://ci-apps.yunohost.org/ci/badges/grav.status.svg) ![](https://dash.yunohost.org/integration/grav.svg) | -| Framaslides | [Strut ](https://strut.io) | [[fa=git /]](https://github.com/YunoHost-Apps/strut_ynh) ![](https://ci-apps.yunohost.org/ci/badges/strut.status.svg) ![](https://dash.yunohost.org/integration/strut.svg) | -| Framasphère | [Diaspora ](https://diasporafoundation.org) | [[fa=git /]](https://github.com/aymhce/diaspora_ynh) ![](https://ci-apps.yunohost.org/ci/badges/diaspora.status.svg) ![](https://dash.yunohost.org/integration/diaspora.svg) | -| Framatalk | [Jitsi Meet ](https://meet.jit.si) | [[fa=git /]](https://github.com/YunoHost-Apps/jitsi_ynh) ![](https://ci-apps.yunohost.org/ci/badges/jitsi.status.svg) ![](https://dash.yunohost.org/integration/jitsi.svg) | -| Framateam | [Mattermost ](https://mattermost.com) | [[fa=git /]](https://github.com/YunoHost-Apps/mattermost_ynh) ![](https://ci-apps.yunohost.org/ci/badges/mattermost.status.svg) ![](https://dash.yunohost.org/integration/mattermost.svg) | -| Framatrad | [Weblate ](https://weblate.org) | [[fa=git /]](https://github.com/YunoHost-Apps/weblate_ynh) ![](https://ci-apps.yunohost.org/ci/badges/weblate.status.svg) ![](https://dash.yunohost.org/integration/weblate.svg) | -| Framatube | [Peertube ](https://joinpeertube.org) | [[fa=git /]](https://github.com/YunoHost-Apps/peertube_ynh) ![](https://ci-apps.yunohost.org/ci/badges/peertube.status.svg) ![](https://dash.yunohost.org/integration/peertube.svg) | -| Framavectoriel | [SVG-Edit ](https://github.com/SVG-Edit/svgedit) | [[fa=git /]](https://github.com/YunoHost-Apps/svgedit_ynh) ![](https://ci-apps.yunohost.org/ci/badges/svgedit.status.svg) ![](https://dash.yunohost.org/integration/svgedit.svg) | -| Framavox | [Loomio ](https://www.loomio.org) | Non packagé | -| Framemo | [Scrumblr ](http://scrumblr.ca) | [[fa=git /]](https://github.com/YunoHost-Apps/scrumblr_ynh) ![](https://ci-apps.yunohost.org/ci/badges/scrumblr.status.svg) ![](https://dash.yunohost.org/integration/scrumblr.svg) | -| Framindmap | [Wisemapping ](https://www.wisemapping.com) | [[fa=git /]](https://github.com/YunoHost-Apps/wisemapping_ynh) ![](https://ci-apps.yunohost.org/ci/badges/wisemapping.status.svg) ![](https://dash.yunohost.org/integration/wisemapping.svg) | -| Framinetest | [Minetest ](https://www.minetest.net) | [[fa=git /]](https://github.com/YunoHost-Apps/minetest_ynh) ![](https://ci-apps.yunohost.org/ci/badges/minetest.status.svg) ![](https://dash.yunohost.org/integration/minetest.svg) | -| MyFrama | [Shaarli ](https://github.com/shaarli/Shaarli) | [[fa=git /]](https://github.com/YunoHost-Apps/shaarli_ynh) ![](https://ci-apps.yunohost.org/ci/badges/shaarli.status.svg) ![](https://dash.yunohost.org/integration/shaarli.svg) | +| Framapiaf | [Mastodon](https://joinmastodon.org) | [[fa=git /]](https://github.com/YunoHost-Apps/mastodon_ynh) ![](https://ci-apps.yunohost.org/ci/badges/mastodon.status.svg) ![](https://dash.yunohost.org/integration/mastodon.svg) | +| Framapic | [Lutim](https://lut.im/) | [[fa=git /]](https://github.com/YunoHost-Apps/lutim_ynh) ![](https://ci-apps.yunohost.org/ci/badges/lutim.status.svg) ![](https://dash.yunohost.org/integration/lutim.svg) | +| Framasites | [Grav](https://getgrav.org) | [[fa=git /]](https://github.com/YunoHost-Apps/grav_ynh) ![](https://ci-apps.yunohost.org/ci/badges/grav.status.svg) ![](https://dash.yunohost.org/integration/grav.svg) | +| Framaslides | [Strut](https://strut.io) | [[fa=git /]](https://github.com/YunoHost-Apps/strut_ynh) ![](https://ci-apps.yunohost.org/ci/badges/strut.status.svg) ![](https://dash.yunohost.org/integration/strut.svg) | +| Framasphère | [Diaspora](https://diasporafoundation.org) | [[fa=git /]](https://github.com/aymhce/diaspora_ynh) ![](https://ci-apps.yunohost.org/ci/badges/diaspora.status.svg) ![](https://dash.yunohost.org/integration/diaspora.svg) | +| Framatalk | [Jitsi Meet](https://meet.jit.si) | [[fa=git /]](https://github.com/YunoHost-Apps/jitsi_ynh) ![](https://ci-apps.yunohost.org/ci/badges/jitsi.status.svg) ![](https://dash.yunohost.org/integration/jitsi.svg) | +| Framateam | [Mattermost](https://mattermost.com) | [[fa=git /]](https://github.com/YunoHost-Apps/mattermost_ynh) ![](https://ci-apps.yunohost.org/ci/badges/mattermost.status.svg) ![](https://dash.yunohost.org/integration/mattermost.svg) | +| Framatrad | [Weblate](https://weblate.org) | [[fa=git /]](https://github.com/YunoHost-Apps/weblate_ynh) ![](https://ci-apps.yunohost.org/ci/badges/weblate.status.svg) ![](https://dash.yunohost.org/integration/weblate.svg) | +| Framatube | [Peertube](https://joinpeertube.org) | [[fa=git /]](https://github.com/YunoHost-Apps/peertube_ynh) ![](https://ci-apps.yunohost.org/ci/badges/peertube.status.svg) ![](https://dash.yunohost.org/integration/peertube.svg) | +| Framavectoriel | [SVG-Edit](https://github.com/SVG-Edit/svgedit) | [[fa=git /]](https://github.com/YunoHost-Apps/svgedit_ynh) ![](https://ci-apps.yunohost.org/ci/badges/svgedit.status.svg) ![](https://dash.yunohost.org/integration/svgedit.svg) | +| Framavox | [Loomio](https://www.loomio.org) | Non packagé | +| Framemo | [Scrumblr](http://scrumblr.ca) | [[fa=git /]](https://github.com/YunoHost-Apps/scrumblr_ynh) ![](https://ci-apps.yunohost.org/ci/badges/scrumblr.status.svg) ![](https://dash.yunohost.org/integration/scrumblr.svg) | +| Framindmap | [Wisemapping](https://www.wisemapping.com) | [[fa=git /]](https://github.com/YunoHost-Apps/wisemapping_ynh) ![](https://ci-apps.yunohost.org/ci/badges/wisemapping.status.svg) ![](https://dash.yunohost.org/integration/wisemapping.svg) | +| Framinetest | [Minetest](https://www.minetest.net) | [[fa=git /]](https://github.com/YunoHost-Apps/minetest_ynh) ![](https://ci-apps.yunohost.org/ci/badges/minetest.status.svg) ![](https://dash.yunohost.org/integration/minetest.svg) | +| MyFrama | [Shaarli](https://github.com/shaarli/Shaarli) | [[fa=git /]](https://github.com/YunoHost-Apps/shaarli_ynh) ![](https://ci-apps.yunohost.org/ci/badges/shaarli.status.svg) ![](https://dash.yunohost.org/integration/shaarli.svg) | ### See also diff --git a/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.ca.md b/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.ca.md index 8d878678a..15a6b6544 100644 --- a/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.ca.md +++ b/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.ca.md @@ -22,22 +22,22 @@ Organitzacions sense ànim de lucre, ONGs o qualsevol tipus d'associació. Normalment les organitzacions sense ànim de lucre han de donar alguns serveis públics: * Consell d'administració / Comitè director / Voluntàries amb: - * [Correus electrònics](#mails) - * [Calendari](#calendar) - * [Contacte](#contact) - * [Fitxers compartits / Drive](#shared-files) - * [Missatgeria instantània](#instant-communication) - * [Intranet / base de coneixements](#intranet) - * [ERP / Comptabilitat](#erp-accounting) + * [Correus electrònics](#mails) + * [Calendari](#calendar) + * [Contacte](#contact) + * [Fitxers compartits / Drive](#shared-files) + * [Missatgeria instantània](#instant-communication) + * [Intranet / base de coneixements](#intranet) + * [ERP / Comptabilitat](#erp-accounting) * Membres amb: - * [Pàgina web pública amb accés privat i individual](#public-web-site) - * [Adhesió](#membership) - * [Inscripció a esdeveniments](#events-registration) - * [Butlletí d'informació](#newsletter-mailing) - * [Fòrum](#forum) + * [Pàgina web pública amb accés privat i individual](#public-web-site) + * [Adhesió](#membership) + * [Inscripció a esdeveniments](#events-registration) + * [Butlletí d'informació](#newsletter-mailing) + * [Fòrum](#forum) * Públic amb: - * [Pàgina web pública](#public-web-site) - * [Butlletí d'informació](#newsletter-mailing) + * [Pàgina web pública](#public-web-site) + * [Butlletí d'informació](#newsletter-mailing) ## Quan @@ -46,6 +46,7 @@ Quan l'organització estigui preparada per a fer el pas. ## On El servidor YunoHost de l'organització pot estar allotjat en diferents llocs: + * Allotjament propi en un servidor, ordinador o Raspberry darrera una connexió ADSL, SDSL o fibra * Serveis d'allotjament de [Chatons](https://chatons.org), [librehosters](https://framagit.org/librehosters/awesome-librehosters) * Serveis d'allotjament comercials que ofereixin màquines virtuals Debian @@ -54,7 +55,6 @@ El servidor YunoHost de l'organització pot estar allotjat en diferents llocs: YunoHost pot cobrir la majoria de necessitats d'una organització sense ànim de lucre i permet tenir el control sobre les dades de l'organització. - ## Com ### YunoHost @@ -64,6 +64,7 @@ YunoHost és una distribució GNU/Linux basada en Debian empaquetada amb program ![](https://upload.wikimedia.org/wikipedia/commons/0/07/Yunohost_user_portal.png) YunoHost de base ofereix: + * Un sistema d'aplicacions * Una interfície web * Una interfície per línia de comandes (CLI): Moulinette @@ -89,6 +90,7 @@ De base, YunoHost ofereix un sistema de correus electrònics disponible utilitza Els comptes de correu electrònic es poden gestionar per mitjà de la interfície web o de la línia de comandes. Els comptes creats es guarden en l'OpenLDAP. Es poden instal·lar paquets addicionals per donar més funcionalitats al sistema de correu electrònic de YunoHost: + * Un client web utilitzant [Roundcube](https://github.com/YunoHost-Apps/roundcube_ynh), [Rainloop](https://github.com/YunoHost-Apps/rainloop_ynh) * ActiveSync utilitzant [Z-Push](https://github.com/YunoHost-Apps/z-push_ynh) * Un grup de difusió interna utilitzant [Mailman](https://github.com/YunoHost-Apps/mailman_ynh) @@ -96,12 +98,14 @@ Es poden instal·lar paquets addicionals per donar més funcionalitats al sistem ### Calendari Per oferir calendaris personals o compartits haureu d'instal·lar: + * [Nextcloud](https://github.com/YunoHost-Apps/nextcloud_ynh) * [Baikal](https://github.com/YunoHost-Apps/baikal_ynh) ### Contactes Per oferir un sistema de contactes personal haureu d'instal·lar: + * [Nextcloud](https://github.com/YunoHost-Apps/nextcloud_ynh) * [Baïkal](https://github.com/YunoHost-Apps/baikal_ynh) @@ -115,28 +119,33 @@ Els fitxers estaran disponibles a través d'una interfície web o bé utilitzant De base YunoHost ofereix un servidor XMPP, pel que podeu instal·lar un client web: [Jappix](https://github.com/YunoHost-Apps/jappix_ynh). També podeu instal·lar un servidor matrix: + * El servidor: [Synapse](https://github.com/YunoHost-Apps/synapse_ynh) * Un client web: [Riot](https://github.com/YunoHost-Apps/riot_ynh) ### Intranet Per a una organització sense ànim de lucre, una bona manera d'implementar una intranet és oferir una wiki interna per a que les usuàries puguin llegir, editar i afegir contingut. Vegeu aquí alguns paquets que permeten implementar una wiki: + * [DokuWiki](https://github.com/YunoHost-Apps/docuwiki_ynh) utilitzant la sintaxi wiki * [Wiki.js](https://github.com/YunoHost-Apps/wikijs_ynh) utilitzant la sintaxi markdown ### ERP / Comptabilitat Arribats a un cert punt una organització sense ànim de lucre podria necessitar un sistema de comptabilitat / ERP, aquí hi ha dos propostes: + * [OpenERP/Odoo](https://github.com/YunoHost-Apps/libreerp_ynh) * [Dolibarr](https://github.com/YunoHost-Apps/dolibarr_ynh) ### Pàgina web pública Hi ha múltiples maneres d'implementar una pàgina web pública: + * Un pàgina simple amb HTML, CSS, etc. utilitzant: [Custom Webapp](https://github.com/YunoHost-Apps/my_webapp_ynh) * Utilitzant un CMS (sistema de gestió de contingut) com [Wordpress](https://github.com/YunoHost-Apps/_ynh), [Drupal](https://github.com/YunoHost-Apps/drupal_ynh) , [Grav](https://github.com/YunoHost-Apps/grav_ynh), [PluXml](https://github.com/YunoHost-Apps/pluxml_ynh) Però us proposem una alternativa una mica més potent: [CiviCRM on Drupal 7](https://github.com/YunoHost-Apps/civicrm_drupal7_ynh): + * Drupal és un entorn de treball potent de codi obert per la gestió de contingut * amb CiviCRM que és un CRM de codi obert per a les organitzacions sense ànim de lucre @@ -162,6 +171,7 @@ YunoHost ofereix el seu propi sistema de còpies de seguretat. Abans de cada act Les còpies de seguretat de YunoHost s'emmagatzemen localment a `/home/yunohost.backup/archives`. Però per un servidor en producció, còpies de seguretat locals no són suficients, així que s'hauran d'implementar còpies de seguretat alternatives: + * Còpia de seguretat de la màquina virtual si ho permet el sistema d'allotjament. * [Archivist](https://github.com/YunoHost-Apps/archivist_ynh) és un sistema de còpies de seguretat automàtiques del servidor. Les còpies de seguretat es poden enviar a d'altres llocs, locals o distants. * [Borg](https://github.com/YunoHost-Apps/borg_ynh) i [Borg Server](https://github.com/YunoHost-Apps/borgserver_ynh) permeten externalitzar les còpies de seguretat. @@ -187,7 +197,7 @@ Però per un servidor en producció, còpies de seguretat locals no són suficie * [Mastodon](https://github.com/YunoHost-Apps/mastodon_ynh) * [Pleroma](https://github.com/YunoHost-Apps/pleroma_ynh) * [Mobilizon](https://github.com/YunoHost-Apps/mobilizon_ynh) - + #### Blog federat * [Plume](https://github.com/YunoHost-Apps/plume_ynh) diff --git a/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.fr.md b/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.fr.md index 787d31128..575a91994 100644 --- a/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.fr.md +++ b/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.fr.md @@ -46,6 +46,7 @@ Lorsque l'organisation à but non lucratif est prête à franchir le pas. ## Où Le serveur YunoHost peut être hébergé à différents endroits : + * Hébergement en propre sur un serveur, un ordinateur ou Raspberry derrière ADSL, SDSL ou Fibre * [Chatons](https://chatons.org), [librehosters](https://framagit.org/librehosters/awesome-librehosters) * Services d'hébergement commercial fournissant une machine virtuelle Debian @@ -63,6 +64,7 @@ YunoHost est une distribution basée sur Debian GNU/Linux qui automatise l’ins ![](https://upload.wikimedia.org/wikipedia/commons/0/07/Yunohost_user_portal.png) YunoHost fournit immédiatement: + * Un système d'application * Une interface Web * Une interface de ligne de commande (CLI) : Moulinette @@ -88,6 +90,7 @@ YunoHost fournit par défaut un système de messagerie disponible en utilisant P Les comptes de messagerie seront gérés à l'aide de l'interface Web ou de la ligne de commande. Les comptes créés sont stockés dans OpenLDAP. Des packages supplémentaires peuvent être installés pour fournir davantage de fonctionnalités au système de messagerie YunoHost : + * un webmail en utilisant [Roundcube](https://github.com/YunoHost-Apps/roundcube_ynh), [Rainloop](https://github.com/YunoHost-Apps/rainloop_ynh) * ActiveSync utilisant [Z-Push](https://github.com/YunoHost-Apps/z-push_ynh) * Groupe de distribution interne en utilisant [Mailman](https://github.com/YunoHost-Apps/mailman_ynh) @@ -95,12 +98,14 @@ Des packages supplémentaires peuvent être installés pour fournir davantage de ### Calendrier Pour fournir des calendriers personnels ou partagés, vous devrez installer : + * [Nextcloud](https://github.com/YunoHost-Apps/nextcloud_ynh) * [Baïkal](https://github.com/YunoHost-Apps/baikal_ynh) ### Contact Pour fournir un système de contact personnel, vous devrez installer : + * [Nextcloud](https://github.com/YunoHost-Apps/nextcloud_ynh) * [Baïkal](https://github.com/YunoHost-Apps/baikal_ynh) @@ -114,28 +119,33 @@ Les fichiers seront disponibles à partir d'une interface Web ou à l'aide d'un Par défaut, YunoHost fournit immédiatement un serveur XMPP pour lequel vous pouvez installer un client Web : [Jappix](https://github.com/YunoHost-Apps/jappix_ynh) Vous pouvez également installer un serveur Matrix : + * Le serveur : [Synapse](https://github.com/YunoHost-Apps/synapse_ynh) * Un client Web : [Element](https://github.com/YunoHost-Apps/element_ynh) ### Intranet Pour une organisation à but non lucratif, un bon moyen de mettre en œuvre un intranet est de fournir un wiki permettant aux utilisateurs internes de lire, éditer et ajouter du contenu. Voici quelques paquets pour implémenter un wiki : + * [DokuWiki](https://github.com/YunoHost-Apps/docuwiki_ynh) utilisant une syntaxe wiki * [Wiki.js](https://github.com/YunoHost-Apps/wikijs_ynh) utilisant une syntaxe Markdown ### ERP / Comptabilité À un moment donné, une organisation à but non lucratif pourrait avoir besoin d’un système de Comptabilité / ERP, voici deux propositions : + * [OpenERP/Odoo](https://github.com/YunoHost-Apps/libreerp_ynh) * [Dolibarr](https://github.com/YunoHost-Apps/dolibarr_ynh) ### Site Web Public Il existe plusieurs façons d'implémenter un site Web public : + * Un simple site HTML, CSS, etc. en utilisant : [Custom Webapp](https://github.com/YunoHost-Apps/my_webapp_ynh) * Utiliser un CMS (système de gestion de contenu) comme [WordPress](https://github.com/YunoHost-Apps/_ynh), [Drupal](https://github.com/YunoHost-Apps/drupal_ynh), [Grav](https://github.com/YunoHost-Apps/grav_ynh), [PluXml](https://github.com/YunoHost-Apps/pluxml_ynh) Mais nous proposerons quelque chose de plus puissant : [CiviCRM on Drupal 7](https://github.com/YunoHost-Apps/civicrm_drupal7_ynh) : + * Drupal qui est un puissant framework de gestion de contenu * avec CiviCRM qui est un CRM open source à destination des organisations à but non lucratif @@ -161,6 +171,7 @@ YunoHost fournit son propre système de sauvegarde. Avant toute mise à niveau d Les sauvegardes YunoHost sont stockées localement dans `/home/yunohost.backup/archives`. Mais pour la production, la sauvegarde stockée localement ne suffit pas, vous devez donc mettre en œuvre des stratégies de sauvegarde supplémentaires : + * Sauvegarde de la machine virtuelle si fournie par le système d'hébergement. * [Archivist](https://github.com/YunoHost-Apps/archivist_ynh) est un système de sauvegarde automatique de votre serveur. Vos sauvegardes peuvent être envoyées à de nombreux autres endroits, locaux ou distants. * [Borg](https://github.com/YunoHost-Apps/borg_ynh) and [Borg Server](https://github.com/YunoHost-Apps/borgserver_ynh) permettent d'externaliser les sauvegardes. diff --git a/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.md b/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.md index e477d4926..f164a8cea 100644 --- a/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.md +++ b/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.md @@ -46,6 +46,7 @@ When ready to move forward. ## Where You YunoHost for non profit can be hosted in several places: + * Own hosting on a server, computer or Raspberry behind ASDL, SDSL or Fiber * [Chatons](https://chatons.org), [librehosters](https://framagit.org/librehosters/awesome-librehosters) hosting services * Commercial hosting services providing Debian virtual machine @@ -64,6 +65,7 @@ YunoHost is a Debian GNU/Linux based distribution packaged with free software th ![](https://upload.wikimedia.org/wikipedia/commons/0/07/Yunohost_user_portal.png) Out of the box YunoHost provide: + * A system of application * A web interface * A command-line interface (CLI): Moulinette @@ -89,6 +91,7 @@ From scratch, YunoHost provide mail system available using POP/IMAP/SMTP. Mails accounts will be managed using the web interface or the command line. Created accounts are stored in OpenLDAP. Additional package can be installed to provide more functionality to the YunoHost mail system: + * Webmail using [Roundcube](https://github.com/YunoHost-Apps/roundcube_ynh), [Rainloop](https://github.com/YunoHost-Apps/rainloop_ynh) * ActiveSync using [Z-Push](https://github.com/YunoHost-Apps/z-push_ynh) * Internal distribution group using [Mailman](https://github.com/YunoHost-Apps/mailman_ynh) @@ -96,12 +99,14 @@ Additional package can be installed to provide more functionality to the YunoHos ### Calendar To provide personal or shared calendars you will need to install: + * [Nextcloud](https://github.com/YunoHost-Apps/nextcloud_ynh) * [Baïkal](https://github.com/YunoHost-Apps/baikal_ynh) ### Contact To provide personal contact system you will need to install: + * [Nextcloud](https://github.com/YunoHost-Apps/nextcloud_ynh) * [Baïkal](https://github.com/YunoHost-Apps/baikal_ynh) @@ -115,30 +120,35 @@ Files will be available from a web interface or using a synchronization client. Out of the box, YunoHost provide an XMPP server, for which you can install a web client: [Jappix](https://github.com/YunoHost-Apps/jappix_ynh). You can also install a matrix server: + * The server: [Synapse](https://github.com/YunoHost-Apps/synapse_ynh) * A web client: [Element](https://github.com/YunoHost-Apps/element_ynh) ### Intranet For an non-profit organization a good way to implement an intranet is to provide a wiki to let internal users read, edit and add content. Here are some packages to implement a wiki: + * [DokuWiki](https://github.com/YunoHost-Apps/docuwiki_ynh) using wiki syntax * [Wiki.js](https://github.com/YunoHost-Apps/wikijs_ynh) using Markdown syntax ### ERP / Accounting At some time a non-profit organization could need an accounting/erp system, here are two propositions: + * [OpenERP/Odoo](https://github.com/YunoHost-Apps/libreerp_ynh) * [Dolibarr](https://github.com/YunoHost-Apps/dolibarr_ynh) ### Public Web Site There are several way to implement a Public Web Site: + * Simple HTML, CSS, etc. Website using: [Custom Webapp](https://github.com/YunoHost-Apps/my_webapp_ynh) * Using a CMS (Content Management System) like [WordPress](https://github.com/YunoHost-Apps/_ynh), [Drupal](https://github.com/YunoHost-Apps/drupal_ynh), [Grav](https://github.com/YunoHost-Apps/grav_ynh), [PluXml](https://github.com/YunoHost-Apps/pluxml_ynh) But we will propose something more powerful: [CiviCRM on Drupal 7](https://github.com/YunoHost-Apps/civicrm_drupal7_ynh): + * Drupal that is a powerful open source content management framework -* with CiviCRM that is an open source constituent relationship management for non-profits +* with CiviCRM that is an open source constituent relationship management for non-profits #### Membership @@ -162,6 +172,7 @@ YunoHost provide is own backup system. Before any package upgrade, YunoHost back YunoHost backup are stored localy in `/home/yunohost.backup/archives`. But for production, localy stored backup are not enough, so you will need to implement aditional backup strategies: + * Backup of the the Virtual Machine if provided by the hosting system. * [Archivist](https://github.com/YunoHost-Apps/archivist_ynh) is an automatic backup system for your server. Your backups can be send to many other places, local or distant. * [Borg](https://github.com/YunoHost-Apps/borg_ynh) and [Borg Server](https://github.com/YunoHost-Apps/borgserver_ynh) allow to externalize backups. diff --git a/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.oc.md b/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.oc.md index 842133bb1..17f923f75 100644 --- a/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.oc.md +++ b/pages/04.applications/20.app_bundle/05.ngo/use_case_non-profit_organisations.oc.md @@ -46,6 +46,7 @@ Quand l'organizacion sens tòca lucrativa es prèsta a passar lo pas. ## Ont Lo servidor YunoHost pòt èsser albergat a diferents endreches : + * Albergament en pròpri sus un servidor, un ordenador o Raspberry darrièr una connexion ADSL, SDSL o Fibra * [Chatons](https://chatons.org), [librehosters](https://framagit.org/librehosters/awesome-librehosters) * Servicis d'albergament comercial que fornís una maquina virtuala Debian @@ -63,6 +64,7 @@ YunoHost es una distribucion basada sus Debian GNU/Linux qu’automatiza l’ins ![](https://upload.wikimedia.org/wikipedia/commons/0/07/Yunohost_user_portal.png) YunoHost provesís sul pic: + * Un sistèma d'aplicacion * Una interfàcia web * Una interfàcia en linha de comanda (CLI) : Moulinette @@ -88,6 +90,7 @@ A la prima installacion YunoHost fornís un sistèma de messatjariá disponible Los comptes de messatjariá seràn gerits amb l'interfàcia Web o en linha de comanda. Los comptes creats seràn gardats dins l’OpenLDAP. De paquets suplementaris pòdon èsser installats per provesir mai de foncionalitats al sistèma de messatjariá YunoHost : + * un webmail en utilizant [Roundcube](https://github.com/YunoHost-Apps/roundcube_ynh), [Rainloop](https://github.com/YunoHost-Apps/rainloop_ynh) * ActiveSync utilizant [Z-Push](https://github.com/YunoHost-Apps/z-push_ynh) * Grop de distribucion intèrne en utilizant [Mailman](https://github.com/YunoHost-Apps/mailman_ynh) @@ -95,12 +98,14 @@ De paquets suplementaris pòdon èsser installats per provesir mai de foncionali ### Calendièr Per fornir de calendièrs personals o partejats, vos calrà installar : + * [Nextcloud](https://github.com/YunoHost-Apps/nextcloud_ynh) * [Baïkal](https://github.com/YunoHost-Apps/baikal_ynh) ### Contacte Per fornir un sistèma de contacte personal, vos caldrà installar : + * [Nextcloud](https://github.com/YunoHost-Apps/nextcloud_ynh) * [Baikal](https://github.com/YunoHost-Apps/baikal_ynh) @@ -114,28 +119,33 @@ Las fichièrs seràn disponibles d’una interfàcia web estant o amb un client Tras l’installacion YunoHost fornís sul pic un servidor XMPP per lo qual podètz installar un client Web : [Jappix](https://github.com/YunoHost-Apps/jappix_ynh) Podètz tanben installar un servidor Matrix : + * Lo servidor: [Synapse](https://github.com/YunoHost-Apps/synapse_ynh) * Un client web: [Riot](https://github.com/YunoHost-Apps/riot_ynh) ### Intranet Per una organizacion sens tòca lucrativa, un bon biais de metre en plaça un intranet es de fornir un wiki que permet als utilizaires intèrne de legir, modificar e ajustar de contengut. Vaquí unes paquets per installar un wiki : + * [DokuWiki](https://github.com/YunoHost-Apps/docuwiki_ynh) utiliza la sintaxi wiki * [Wiki.js](https://github.com/YunoHost-Apps/wikijs_ynh) utiliza la sintaxi markdown ### ERP / Comptabilitat Arriba un moment ont a l’organizacion sens tòca lucrativa li pòsca far besonh un sistèma de comptabilitat / ERP, vaquí doas proposicions : + * [OpenERP/Odoo](https://github.com/YunoHost-Apps/libreerp_ynh) * [Dolibarr](https://github.com/YunoHost-Apps/dolibarr_ynh) ### Site Web Public Existís mantuns biaisses de construire un site Web public : + * Un simple site HTML, CSS, etc. en utilizant : [Custom Webapp](https://github.com/YunoHost-Apps/my_webapp_ynh) * Utilizar un CMS (sistèma de gestion de contengut) coma [Wordpress](https://github.com/YunoHost-Apps/_ynh), [Drupal](https://github.com/YunoHost-Apps/drupal_ynh), [Grav](https://github.com/YunoHost-Apps/grav_ynh), [PluXml](https://github.com/YunoHost-Apps/pluxml_ynh) Mas prepausam quicòm de mai potent : [CiviCRM on Drupal 7](https://github.com/YunoHost-Apps/civicrm_drupal7_ynh) : + * Drupal qu’es un framework potent de gestion de contengut * amb CiviCRM qu’es un CRM OpenSource a destinacion de las organizacions sens tòca lucrativa @@ -161,6 +171,7 @@ YunoHost fornís son pròpri sistèma de salvagarda. Abans tota mesa a nivèl de Las salvagardas YunoHost son gardadas localament dins `/home/yunohost.backup/archives`. Mas per la produccion, la salvagarda gardada localament basta pas, vos cal emplegar d’estrategias de salvagarda suplementàrias : + * Salvagarda de la maquina virtuala se fornida pel sistèma d’albergament. * [Archivist](https://github.com/YunoHost-Apps/archivist_ynh) es un sistèma de salvagarda automatic de vòstre servidor. Vòstras salvagardas pòdon èsser enviadas a mantun endreches, locals o alonhats. * [Borg](https://github.com/YunoHost-Apps/borg_ynh) e [Borg Server](https://github.com/YunoHost-Apps/borgserver_ynh) permeton d’externalizar las salvagardas. diff --git a/pages/04.applications/20.app_bundle/app_bundle.md b/pages/04.applications/20.app_bundle/app_bundle.md index 52d238b4b..0d5fa4a5b 100644 --- a/pages/04.applications/20.app_bundle/app_bundle.md +++ b/pages/04.applications/20.app_bundle/app_bundle.md @@ -9,4 +9,4 @@ routes: ! TODO: this page needs to be written -This page aims to list app bundles to answer to typical use cases. \ No newline at end of file +This page aims to list app bundles to answer to typical use cases. diff --git a/pages/05.community/10.chat_rooms/chat_rooms.es.md b/pages/05.community/10.chat_rooms/chat_rooms.es.md index 06331a9ad..ff0f697a3 100644 --- a/pages/05.community/10.chat_rooms/chat_rooms.es.md +++ b/pages/05.community/10.chat_rooms/chat_rooms.es.md @@ -10,14 +10,15 @@ routes: El proyecto YunoHost utiliza salas de chat como medio de communicación. Puede unirse a una sala de chat utilizando : + - un [cliente IRC](https://es.wikipedia.org/wiki/Anexo:Clientes_IRC) por ejemplo [KiwiIRC](https://web.libera.chat/#yunohost) - un [cliente XMPP](https://es.wikipedia.org/wiki/Anexo:Comparaci%C3%B3n_de_clientes_de_mensajer%C3%ADa_instant%C3%A1nea) - un [cliente Matrix](https://matrix.org/docs/guides/faq.html#what-clients-are-available%3F) - #### Sala de chat de ayuda y soporte Existen salas publicas de chat de [soporte](/help) y ayuda para YunoHost: + - IRC: **#yunohost** on libera.chat ; - Matrix: **[#yunohost:matrix.org](https://matrix.to/#/#yunohost:matrix.org)** ; - XMPP: **[support@conference.yunohost.org](xmpp:support@conference.yunohost.org?join)** @@ -25,6 +26,7 @@ Existen salas publicas de chat de [soporte](/help) y ayuda para YunoHost: #### sala de chat para desarrolladores Salas de chat para el desarollo de YunoHost: + - IRC: **#yunohost-dev** on libera.chat ; - Matrix: **#[yunohost-dev:matrix.org](https://matrix.to/#/#yunohost-dev:libera.chat)** ; - XMPP: **[dev@conference.yunohost.org](xmpp:dev@conference.yunohost.org?join)** @@ -33,14 +35,18 @@ Actualmente, la sala principal de chat para contribuciones en YunoHost Para mas ayuda, vea la sala de chat **#yunohost** encima. #### Sala de chat para las integración de aplicaciones + Estos permite la ayuda mutua para los integradores de aplicaciones y también para conversar de evoluciones et de herramientas de integración continua. + - IRC: **#yunohost-apps** en libera.chat - Matrix: **[#yunohost-apps:matrix.org](https://matrix.to/#/#yunohost-apps:matrix.org)** - XMPP: **[apps@conference.yunohost.org](xmpp:apps@conference.yunohost.org?join)** -#### Sala de chat de Documentación +#### Sala de chat de Documentación + Lugar donde la comunidad conversa sincroniza y mantiene actualisado la documentación en los aspectos varios como (backend, frontend, apps, proyecto, comunidad...) Puede tambien compartir sus materiales sobre YunoHost (videos, presentaciones, etc.). + - IRC: **#yunohost-doc** on libera.chat - Matrix: **[#yunohost-doc:matrix.org](https://matrix.to/#/#yunohost-doc:matrix.org)** - XMPP: **[doc@conference.yunohost.org](xmpp:doc@conference.yunohost.org?join)** diff --git a/pages/05.community/10.chat_rooms/chat_rooms.fr.md b/pages/05.community/10.chat_rooms/chat_rooms.fr.md index f91c5e503..573d46077 100644 --- a/pages/05.community/10.chat_rooms/chat_rooms.fr.md +++ b/pages/05.community/10.chat_rooms/chat_rooms.fr.md @@ -10,19 +10,23 @@ routes: Parmi d’autres outils, le projet YunoHost se sert de salons de discussions pour communiquer. Vous pouvez rejoindre ces salons avec : + - un [Client IRC](https://fr.wikipedia.org/wiki/Liste_de_clients_IRC) par exemple [KiwiIRC](https://web.libera.chat/#yunohost) - un [Client XMPP](https://fr.wikipedia.org/wiki/Clients_XMPP) - un [Client Matrix](https://linuxfr.org/news/matrix-pour-decentraliser-skype-whatsapp-signal-slack-et-discord) - #### Salon d'entraide et de support + Le salon d’[entraide](/help) est là pour permettre aux utilisateurs de YunoHost de s'aider mutuellement. + - IRC : **#yunohost** sur libera.chat (voir KiwiIRC ci-dessus) - Matrix : **[#yunohost:matrix.org](https://matrix.to/#/#yunohost:matrix.org)** - XMPP : **[support@conference.yunohost.org](xmpp:support@conference.yunohost.org?join)** #### Développement + Salon de développement du cœur de YunoHost : + - IRC : **#yunohost-dev** sur libera.chat - Matrix : **[#yunohost-dev:matrix.org](https://matrix.to/#/#yunohost-dev:matrix.org)** - XMPP : **[dev@conference.yunohost.org](xmpp:dev@conference.yunohost.org?join)** @@ -31,15 +35,19 @@ C'est le salon principal pour les contributions autour du projet. Pour chercher de l’aide, merci d'aller sur le salon d’entraide ci-dessus. #### Applications + Salon de développement du packaging d’application. Il permet aux packageurs de s’entraider. Il sert également à discuter de l’évolution du packaging, des outils d’intégration continue sur les applications. + - IRC : **#yunohost-apps** sur libera.chat - Matrix : **[#yunohost-apps:matrix.org](https://matrix.to/#/#yunohost-apps:matrix.org)** - XMPP : **[apps@conference.yunohost.org](xmpp:apps@conference.yunohost.org?join)** #### Documentation + Le salon de documentation du projet YunoHost. Il permet aux contributeurs d'échanger, pour synchroniser et maintenir une documentation à jour sur les différents aspects du projet : backend, frontend, apps, projet, communauté... Vous pouvez aussi y partager vos communications au public à propos de YunoHost (présentations, vidéos...) pour permettre leur référencement dans la documentation. + - IRC : **#yunohost-doc** sur libera.chat - Matrix : **[#yunohost-doc:matrix.org](https://matrix.to/#/#yunohost-doc:matrix.org)** - XMPP : **[doc@conference.yunohost.org](xmpp:doc@conference.yunohost.org?join)** diff --git a/pages/05.community/10.chat_rooms/chat_rooms.md b/pages/05.community/10.chat_rooms/chat_rooms.md index 72863030c..f28461f91 100644 --- a/pages/05.community/10.chat_rooms/chat_rooms.md +++ b/pages/05.community/10.chat_rooms/chat_rooms.md @@ -10,6 +10,7 @@ routes: Among other communication tools, YunoHost project use chat rooms to communicate. You could join those chat rooms using: + - an [IRC Client](https://en.wikipedia.org/wiki/Comparison_of_Internet_Relay_Chat_clients) for example [KiwiIRC](https://web.libera.chat/#yunohost) - an [XMPP client](https://en.wikipedia.org/wiki/Comparison_of_instant_messaging_clients) - a [Matrix client](https://matrix.org/docs/guides/faq.html#what-clients-are-available%3F) @@ -27,6 +28,7 @@ There is a [support](/help) chat room for YunoHost users mutual support and help #### Development chat room YunoHost core development chat room: + - IRC: **#yunohost-dev** on libera.chat - Matrix: **[#yunohost-dev:matrix.org](https://matrix.to/#/#yunohost-dev:matrix.org)** - XMPP: **[dev@conference.yunohost.org](xmpp:dev@conference.yunohost.org?join)** @@ -35,16 +37,20 @@ Currently, the main chat room for contributions on YunoHost project. For help, please see **#yunohost** chat room above. #### Applications chat room + Application packaging development chat room. It allow packagers to help each other. It also allow to discuss packaging evolution, continuous integration tools: + - IRC: **#yunohost-apps** on libera.chat - Matrix: **[#yunohost-apps:matrix.org](https://matrix.to/#/#yunohost-apps:matrix.org)** - XMPP: **[apps@conference.yunohost.org](xmpp:apps@conference.yunohost.org?join)** #### Documentation chat room -YunoHost project documentation chat room. It allow people to discuss, synchronize and maintain + +YunoHost project documentation chat room. It allow people to discuss, synchronize and maintain an up-to-date documentation on the differents aspects of the project (backend, frontend, apps, project, community...). You may also share here your public communications about YunoHost (videos, presentations, etc.), to allow proper referencing. + - IRC: **#yunohost-doc** on libera.chat - Matrix: **[#yunohost-doc:matrix.org](https://matrix.to/#/#yunohost-doc:matrix.org)** - XMPP: **[doc@conference.yunohost.org](xmpp:doc@conference.yunohost.org?join)** diff --git a/pages/05.community/15.help/help.fr.md b/pages/05.community/15.help/help.fr.md index 7cbbfaa5b..57d0b247f 100644 --- a/pages/05.community/15.help/help.fr.md +++ b/pages/05.community/15.help/help.fr.md @@ -34,7 +34,7 @@ S'il vous plaît, changez votre pseudo, nous avons des légions de `ynhuser`s. !!! - IRC (`#yunohost` on libera.chat, [en utilisant Kiwiirc](https://web.libera.chat/#yunohost)) !!! - XMPP (`support@conference.yunohost.org`) -## ... ou demandez sur le forum ! +## ... ou demandez sur le forum S'il vous plaît, suivez le canevas des messages de la section Support. Cela aide tout le monde à comprendre le contexte de votre demande. diff --git a/pages/05.community/15.help/help.it.md b/pages/05.community/15.help/help.it.md index 54426b7c1..6b6c04461 100644 --- a/pages/05.community/15.help/help.it.md +++ b/pages/05.community/15.help/help.it.md @@ -59,4 +59,3 @@ document.getElementById("goDevroom").onclick = function() { window.location.href = "https://web.libera.chat/#yunohost-dev"; } - diff --git a/pages/05.community/15.help/help.md b/pages/05.community/15.help/help.md index 35df1a73d..89a4dfbf0 100644 --- a/pages/05.community/15.help/help.md +++ b/pages/05.community/15.help/help.md @@ -34,7 +34,7 @@ Please change your username, as we got legions of `ynhuser`s. !!! - IRC (`#yunohost` on libera.chat, [using kiwiirc](https://web.libera.chat/#yunohost)) !!! - XMPP (`support@conference.yunohost.org`) -## ... or ask on the forum ! +## ... or ask on the forum Please follow the Support section post template. It helps everyone understand the context of your request. diff --git a/pages/05.community/20.faq/faq.de.md b/pages/05.community/20.faq/faq.de.md index 5a066f243..739bf3aff 100644 --- a/pages/05.community/20.faq/faq.de.md +++ b/pages/05.community/20.faq/faq.de.md @@ -15,7 +15,6 @@ YunoHost basiert auf Debian, also auch auf Lizenzen von Debian Bestandteilen. Die Anwendungen und Applikations-Pakete stehen unter ihren jeweiligen, eigenen Lizenzen. - #### Was ist das Ziel von YunoHost ? Wir glauben, dass Dezentralisierung sowie Kontrolle und Verantwortung über die eigenen Daten und Dienste ein wichtiger Bestandteil einer freien und demokratischen Gesellschaft ist. @@ -24,7 +23,6 @@ Das YunoHost Projekt zielt darauf ab, eigenverantwortliches Hosting zu demokrati Wir bieten eine Software an, die es für jeden möglichst einfach machen soll, einen eigenen Server zu betreiben und zu verwalten - mit einem minimalen Aufwand an Wissen und Zeit. - #### Aber was *macht* YunoHost überhaupt ? YunoHost könnte eine Distribution oder ein Betriebssystem genannt werden, aber es ist eigentlich "nur" eine Ebene, die über Debian betrieben wird und welche die meiste, schwierige Arbeit für Sie übernimmt. @@ -33,23 +31,19 @@ Zum Beispiel, wenn Sie Wordpress installieren möchten, müssten Sie einige Befe Mehr Informationen finden Sie [hier](/whatsyunohost) ! - #### Kann ich meine eigene, persönliche Internetseite mit YunoHost betreiben ? Ja ! Werfen Sie einen Blick auf die [Custom Web app](https://github.com/YunoHost-Apps/my_webapp_ynh). Dort erhalten Sie ein "leeres Gefäß" : nach der Installation, laden Sie einfach Ihre Dateien and den jeweiligen Ort hoch (via SSH/SCP or SFTP). PHP und eine SQL Datenbank steht Ihnen bei Bedarf zur Verfügung. - #### Kann ich viele voneinander unabhängige Internetseiten mit unterschiedlichen Domain-Namen betreiben ? Ja ! YunoHost ermöglicht das Anlegen mehrerer Benutzer und Domain-Namen. Manche Apllikationen wie *WordPress* oder *Web App Multi Custom* sind mehrinstanzenfähig und können mehrmals installiert werden. - #### Wieso kann ich Anwendungen nicht über die IP-Adresse erreichen ? Die [SSO](https://github.com/Kloadut/SSOwat/) (Single Sign-on) Technik kann Benutzer nicht richtig authentifizieren, wenn sie auf den Server nur über die IP zugreifen. Wenn Sie keine Möglichkeit haben, die DNS korrekt zu konfigurieren, können Sie als temporäre Notlösung [die `Hosts` Datei (letztes §)](/dns_local_network) auf Ihrem Computer modifizieren. - #### Was ist das Geschäftsmodell von YunoHost ? Momentan wird YunoHost nur von Freiwiligen betrieben, die in ihrer Freizeit an dem Projekt arbeiten. Im Grunde ist bisher kein Geld im Spiel (abgesehen von Serverkosten oder Stickern :P). @@ -58,7 +52,6 @@ Vor dem Hintergrund, dass einige Mitwirkende sehr viel zeit in das Projekt inves Dies könnte durch Spenden oder öffentliche Gelder erricht werden. Einige Mitwirkenden arbeiten an professionellen Angeboten in Zusammenhang mit YunoHost. - #### Kann ich für das Projekt spenden ? Ja, das können Sie ! YunoHost braucht Geld, um die Server und Domain-Namen zu bezahlen. Wir möchten außerdem erreichen, dass die Mitwirkenden weiterhin zum Projekt beitragen können und sich nicht nach anderen Jobs umschauen müssen. @@ -67,7 +60,6 @@ Sie können [auf Liberapay spenden](https://liberapay.com/yunohost). Wenn Ihnen das möglich ist, können Sie auch gerne Sachspenden leisten (ein Teil unserer Infrastruktur ist auf Server von Dritten angewiesen). - #### Wie kann ich zum Projekt beitragen ? Es gibt viele Wege [zum Projekt beizutragen](/contribute) :). @@ -76,12 +68,10 @@ Zögern Sie nicht, mit uns über Ihre Ideen zu sprechen! Es ist ein weit verbreitetes Missverständnis, dass Neulinge bei offenen Softwareprojekten nicht "ausreichend qualifiziert" sind. Wer ist das schon :) ? Was wirklich zählt, ist, [dass Sie mögen, was Sie tun](https://www.youtube.com/watch?v=zIbR5TAz2xQ&t=113s), nett zu anderen Menschen, geduldig und starrköpfig gegenüber Maschinen sind und etwas freie Zeit haben. Abgesehen davon ist einfach alles was Sie tun können, schon mehr als genug! - #### Was sind YunoHost organisatorische Grundsätze ? Das beschreiben wir in [diesem Dokument](/project_organization) :). - #### Werdet ihr YunoHosts für [Lieblingsdistribution hier einfügen] portieren ? Die kurze Antwort: Nein. Wir haben nicht die Energie dafür und es ist eh irrelevant. @@ -95,7 +85,6 @@ Die kurze Antwort: Nein. Wir haben nicht die Energie dafür und es ist eh irrele

Sollte Sie das nicht überzeugen, gibt es ausreichend andere Projekte für andere Distributionen mit einer anderen Philosophie dahinter.

- #### Ich hab gesehen, wie das Packen von Apps funktioniert? Warum erfindet ihr das Rad neu und benutzt nicht [hier bevorzugtes Paketformat einfügen] ? Kurze Antwort: Machen wir nicht. diff --git a/pages/05.community/20.faq/faq.fr.md b/pages/05.community/20.faq/faq.fr.md index f443438d1..8b9438d5e 100644 --- a/pages/05.community/20.faq/faq.fr.md +++ b/pages/05.community/20.faq/faq.fr.md @@ -15,7 +15,6 @@ YunoHost est basé sur Debian, donc sur les licences des éléments sur lesquels Les applications et leurs paquets ont leurs licences respectives. - #### Quel est l’objectif de YunoHost ? Nous pensons que la décentralisation d’Internet, et la reprise du contrôle et de la responsabilité des données et services par les personnes est un enjeu crucial pour garantir une société libre et démocratique. @@ -24,7 +23,6 @@ Le projet YunoHost cherche à démocratiser l’auto-hébergement. Nous fournissons un logiciel qui cherche à rendre simple le fait de gérer et d’administrer un serveur soi-même, en minimisant les compétences et le temps requis. - #### Mais qu’est-ce que ça fait *vraiment* ? YunoHost est à la fois une distribution, dans le sens où c'est une version de GNU/Linux-Debian dédié à un objectif précis et que YunoHost distribue un ensemble d'applications via son catalogue, mais c'est aussi un « simple » programme qui configure Debian de manière automatique, et gère les manipulations pénibles à votre place. @@ -33,13 +31,11 @@ Par exemple, pour installer un WordPress à la main, il vous faudrait taper tout Plus d’informations sur [cette page](/whatsyunohost) ! - #### Puis-je gérer mon propre site web avec YunoHost ? Oui ! Il faut regarder du côté de [cette app](https://github.com/YunoHost-Apps/my_webapp_ynh). Elle fournit une « coquille vide » : après l’installation, il suffit d’envoyer vos fichiers (via SSH/SCP ou SFTP) au bon endroit. Il est aussi possible d’avoir du PHP et une base de donnée SQL si besoin. - #### Peut-on héberger plusieurs sites indépendants avec des noms de domaines différents ? On peut tout à fait héberger plusieurs sites web car YunoHost est multi-domaine et que certaines applications de gestion de sites web, comme *WordPress* ou *My Webapp*, sont multi-instances, c’est-à-dire que l’application peut-être installée plusieurs fois. @@ -48,14 +44,12 @@ On peut tout à fait héberger plusieurs sites web car YunoHost est multi-domain Pour des raisons techniques, le [SSO](https://github.com/YunoHost/SSOwat/) ne permet pas aux utilisateurs de se connecter à l’espace utilisateur lorsque l’on accède au serveur uniquement avec l’IP. Si vous ne pouvez réellement pas configurer un nom de domaine, une solution temporaire peut être de modifier le [fichier `hosts` (dernier §)](/dns_local_network) de son ordinateur. - #### Quel est le modèle économique de YunoHost ? YunoHost est maintenu par une équipe de bénévoles travaillant pendant leur temps libre. Le projet reçoit régulièrement des dons qui financent principalement des frais de serveurs et de communication (stickers ;P). Le projet a reçu dans le passé (ou continue de recevoir) des subventions de la part d'organismes comme [NLnet](https://nlnet.nl/) ou [CodeLutin](https://www.codelutin.com/) pour financer des développements précis. Les dons au projet étant de plus en plus important, des initiatives sont en cours pour tenter de redistribuer l'argent aux contributeur·ice·s principales et ainsi aider à pérenniser le projet. Des contributeur·ice·s mènent par ailleurs des activités professionnelles basées partiellement sur YunoHost. - #### Puis-je faire un don au projet ? Oui, c'est possible ! YunoHost a besoin de payer des serveurs et noms de domaine, et nous souhaitons permettre aux contributeur·ice·s de continuer à développer YunoHost plutôt que de chercher un emploi ailleurs. @@ -64,7 +58,6 @@ Pour faire un don ça se passe via [notre interface de don](https://donate.yunoh Si vous le pouvez, vous pouvez aussi faire des contributions en nature (une partie de notre infrastructure vient d'associations qui nous fournissent des serveurs). - #### Comment puis-je contribuer au projet ? Il existe [plusieurs façons de contribuer](/contribute) :). @@ -77,7 +70,6 @@ Le syndrome de l'imposteur (ne pas se sentir « assez compétent·e ») est asse Elle est décrite dans [ce document](/project_organization) :). - #### Pouvez-vous porter YunoHost sur [ma distro préférée] ? Si vous vous préoccupez des guéguerres de distro, ou pensez que « Debian c’est sale », vous n’êtes pas le public de YunoHost. @@ -92,7 +84,7 @@ Des personnes ont été tentées de comparer le système de packaging de YunoHos YunoHost manipule des abstractions haut-niveau (apps, domaines, utilisateurs…) et définit un environnement standard (NGINX, Postfix, Metronome, SSOwat...) et, grâce à cela, peut gérer la configuration à la place de l’administrateur. -#### Quand est-ce que [cette fonctionnalité] sera ajoutée ? Pourquoi [cette app] n'a pas encore été packagée ? Je n'en reviens pas que vous ne fassiez pas encore [cela] ! +#### Quand est-ce que [cette fonctionnalité] sera ajoutée ? Pourquoi [cette app] n'a pas encore été packagée ? Je n'en reviens pas que vous ne fassiez pas encore [cela] Nous ne donnons pas de calendrier. diff --git a/pages/05.community/20.faq/faq.it.md b/pages/05.community/20.faq/faq.it.md index 93e8a55aa..0953c8c82 100644 --- a/pages/05.community/20.faq/faq.it.md +++ b/pages/05.community/20.faq/faq.it.md @@ -15,7 +15,6 @@ YunoHost è basato sulla distribuzione Debian, quindi rispetta le licenze degli I programmi e i pacchetti hanno la loro propria licenza. - #### Quale obbiettivo si prefigge YunoHost? Siamo convinti che la decentralizzazione di Internet, e il riappropriarsi della responsabilità e del controllo dei nostri dati e servizi, sia una questione essenziale per garantire una società libera e democratica. @@ -24,7 +23,6 @@ Il progetto YunoHost cerca di democratizzare il self hosting. Mettiamo a disposizione un software che facilita la gestione e l'amministrazione, in proprio, di un server, riducendo le competenze necessarie e il tempo richiesto. - #### In pratica cosa *fa* YunoHost? YunoHost è contemporaneamente una distribuzione, cioè una versione di GNU/Linux-Debian dedicata ad uno scopo preciso e arricchita da un insieme di applicazioni che YunoHost contempla nel suo catalogo, sia un "semplice" programma che configura Debian in maniera automatica e gestisce per voi le configurazioni più difficili. @@ -41,12 +39,10 @@ Certamente! [Qui](https://github.com/YunoHost-Apps/my_webapp_ynh). trovate tutto Si è possibile ospitare più siti con domini diversi in quanto YunoHost accetta più nomi di dominio e alcuni programmi di gestione di siti web, come *Wordpress* o *My Webapp*, gestiscono più istanze, potendo quindi installarli più volte. - #### Perché non posso accedere alle mie applicazioni con l'indirizzo IP del server? Per motivi tecnici il [SSO](https://github.com/YunoHost/SSOwat/) (Single Sign On) non permette agli utilizzatori di connettersi alla propria dashboard quando si accede al server con il suo indirizzo IP. Se non potete configurare il DNS, una soluzione temporanea è quella di modificare il [file 'hosts' (ultimo §)](/dns_local_network) del proprio computer. - #### Su quale modello economico si basa YunoHost ? YunoHost è sviluppato da una comunità di volontari durante il loro tempo libero. Il progetto riceve regolarmente donazioni che finanziano principalmente le spese per i server e le spese di marketing (gli adesivi ;P). Il progetto ha ricevuto (o riceve attualmente) sovvenzioni da parte di organizzazioni quali [NLnet](https://nlnet.nl/) o [CodeLutin](https://www.codelutin.com/) al fine di finaziare lo sviluppo di parti ben definite. @@ -69,12 +65,10 @@ Fateci conoscere le vostre idee! Un malinteso comune per i nuovi arrivati nei progetti di software libero è quello di credere di "non essere abbastanza competenti". Nella realtà nessuno è "sufficientemente competente" :). Quello che veramente conta è: [piacere per quello che si fa](https://www.youtube.com/watch?v=zIbR5TAz2xQ&t=113s), essere empatici con le persone del progetto, essere pazienti e testardi con i computer, e avere tempo libero. Fare il possibile è già abbastanza! - #### Quale è lo progetto politico di YunoHost ? È spiegato in [questo documento](/project_organization) :). - #### Potete migrare YunoHost verso la mia [distro preferita] ? Se vi appassiona la guerriglia tra distribuzioni, o pensate che 'Debian fa schifo', YunoHost non fa per voi. @@ -83,14 +77,13 @@ YunoHost è rivolto ad un pubblico di semplici appassionati, che desiderano semp Se questo non vi convince, esistono altri progetti basati su altre distribuzioni e altre filosofie. - #### Ho studiato come funziona il packaging delle app. Perché reinventate [il mio formato preferito dei pacchetti]? Qualcuno ha cercato di paragonare il sistema di packaging di YunoHost con altri (come ad esempio il `.deb` di Debian) nonostante abbiano scopi diversi. I sistemi di packaging tradizionali sono pensati per installare gli elementi di basso livello come i files, comandi, programmi o servizi sul sistema. Spesso è poi delegato a voi il compito di configurarli opportunamente, semplicemente perché non esiste un ambiente standard. Normalmente le applicazioni web richiedono un importante lavoro di configurazione in quanto hanno bisogno di interfacciarsi con un server web e un database (e l'interfaccia di connessione unica / SSO). YunoHost esegue delle astrazioni di alto livello (applicazioni, domini, utenti...) e configura un ambiente standard (NGINX, Metronome, SSOwat...) e, grazie a questo, può gestire la configurazione invece che delegarla all'amministratore. -#### Quando implementerete [il programma che mi piacerebbe]? Perché [la mia app preferita] non è stata compilata? Trovo incredibile che non abbiate ancora implementato [la mia app preferita]! +#### Quando implementerete [il programma che mi piacerebbe]? Perché [la mia app preferita] non è stata compilata? Trovo incredibile che non abbiate ancora implementato [la mia app preferita] Noi non fissiamo un calendario. @@ -103,12 +96,13 @@ Se desiderate che la vostra app preferita sia implementata e documentata [aiutat La regola principale è includere nel catalogo ufficiale solo programmi distribuiti con una licenza di software libero. Tuttavia nello sviluppo di YunoHost sono apparsi alcuni casi dubbi a causa di programmi che potrebbero essere importanti per gli scopi e che coincidono con il suo spirito pur non essendo precisamente software libero. Sono situazioni come: + - programmi che promuovono l'uso di servizi centralizzati pensato proprio per evitarne l'uso diretto; - programmi che hanno dipendenze o altro non liberi; - "nuove" licenze post-open-source / etiche-ma-non-libere come ad esempio [ACSL](https://anticapitalist.software/), the [HL3](https://firstdonoharm.dev/) o [CoopCycle License](https://github.com/coopcycle/coopcycle-web/blob/master/LICENSE); - modelli "open-core", clausole di protezione di marchi o su licenze "business-related" (come ad esempio BSL) pensate per mantenere i progetti pur rimanendo eticamente accettabili. -Pur rimanendo convinti che i principi del software libero siano un passi essenziali per quelli che sono [gli obbiettivi di YunoHost](#what-s-yunohost-goal) pensiamo anche che questi siano mezzi e non fini. Rifiutiamo la visione purista secondo la quale il software è libero o proprietario e la premessa erronea che la tecnologia sia fondamentalmente neutrale. Crediamo che i programmi e la tecnologia possano e debbano esistere oltre la definizione di software libero pensata 40 anni fa (vedi anche: [Freedom isn't Free](https://logicmag.io/failure/freedom-isnt-free/) e [Post-Open Source](https://www.boringcactus.com/2020/08/13/post-open-source.html)). +Pur rimanendo convinti che i principi del software libero siano un passi essenziali per quelli che sono [gli obbiettivi di YunoHost](#what-s-yunohost-goal) pensiamo anche che questi siano mezzi e non fini. Rifiutiamo la visione purista secondo la quale il software è libero o proprietario e la premessa erronea che la tecnologia sia fondamentalmente neutrale. Crediamo che i programmi e la tecnologia possano e debbano esistere oltre la definizione di software libero pensata 40 anni fa (vedi anche: [Freedom isn't Free](https://logicmag.io/failure/freedom-isnt-free/) e [Post-Open Source](https://www.boringcactus.com/2020/08/13/post-open-source.html)). Di conseguenza il progetto permette l'inclusione nel catalogo ufficiale ***caso per caso*** di applicazioni che non si definiscono "software libero" ma considerati etici e degni di interesse per [gli obbiettivi di YunoHost](#what-s-yunohost-goal). Queste applicazioni sono segnalate nel catalogo e un messaggio apposito viene mostrato prima dell'installazione. @@ -119,6 +113,7 @@ Se usate YunoHost per la vostra iniziativa commerciale è vostra responsabilità ### Perché non includete la [caratteristica X]? YunoHost è pensata per utenti non particolarmente capaci tecnicamente e cerca di rimanere semplice nell'interfaccia. Allo stesso tempo, il progetto è tempi ed energie limitate per la manutenzione e lo sviluppo. Di conseguenza dobbiamo abbassare la priorità delle richieste di caratteristiche o anche di rifiutarle completamente basandosi sui seguenti criteri: + - è utile solo per utenti avanzati, fuori dallo scopo del progetto; - introduce troppe complicazioni nell'interfaccia; - copre solo problemi poco realistici; diff --git a/pages/05.community/20.faq/faq.md b/pages/05.community/20.faq/faq.md index 1fc73d7d5..d7303722b 100644 --- a/pages/05.community/20.faq/faq.md +++ b/pages/05.community/20.faq/faq.md @@ -15,7 +15,6 @@ YunoHost is based on Debian, so on Debian's components' licenses. Applications and applications packages have their own licenses. - #### What's YunoHost goal? We believe that decentralizing the Internet, and empowering people to take control and responsibility back over their own data and services, is a crucial issue to guarantee a free and democratic society. @@ -24,7 +23,6 @@ The YunoHost project aims to democratize self-hosting. It provides a software that aims to make it easy for people to run and administer their own server, with minimal knowledge and required time. - #### But what does YunoHost exactly *do*? YunoHost is a distribution, in the sense that it is a purpose-specific version of GNU/Linux-Debian and it distributes a set of application via its catalog, but it is also "just" a program that automatically configures Debian and does most of the hard work for you. @@ -41,12 +39,10 @@ Yes! Have a look at the [Custom Web app](https://github.com/YunoHost-Apps/my_web Yes! YunoHost is multi-user and multi-domain. Some applications like *WordPress* or *My webapp*, are multi-instances, which means that the application can be installed many times. - #### Why can't I access applications via the IP address? The [SSO](https://github.com/Kloadut/SSOwat/) (single sign-on) cannot properly authenticate users when they access your server with only its IP. If you really can't properly configure the DNS, you can temporarily work around it by [modifying the `hosts` file (last §)](/dns_local_network) on your computer. - #### What's YunoHost's business model? YunoHost is maintained by volunteers working on their free time. The project regularly receives donations which pay for the servers' bills and stickers. The project received (or continues to receive) grants from organization like [NLnet](https://nlnet.nl/) or [CodeLutin](https://www.codelutin.com/) to fund specific developments @@ -69,12 +65,10 @@ Don't hesitate to come talk to us about your ideas! A common misconception for newcomers in free software projects is to think that they are "not skilled enough". In practice, nobody is "skilled" :). What really matter is: [liking what you do](https://www.youtube.com/watch?v=zIbR5TAz2xQ&t=113s), being friendly with other human beings, being patient and stubborn with machines, and having some free time. Other than that, just doing what you can is already awesome! - #### How is the YunoHost project organized? It is described in [this document](/project_organization) :). - #### Will you port YunoHost to [insert favorite distro]? If you care about distrowars, or think 'Debian is dirty', then YunoHost is not for you. @@ -83,14 +77,13 @@ YunoHost is aimed at non-tech people who just want their server to work. Debian If this does not convince you, there are other projects running on other distributions or with different philosophies. - #### I checked how apps packaging work. Why are you reinventing [insert favorite package format]? People have been tempted to compare YunoHost packages to traditional package managers (such as Debian's `.deb`), which hold a different purpose. Traditional package managers are meant to install low-level purpose of installing files, commands, programs and services on the system. It is often your duty to configure them properly, simply because there is no standard server setup. Typically, web apps requires a lot of configuration because they rely on a web server and a database (and the single sign-on). YunoHost manages high-level abstractions (apps, domains, users...) and defines a standard setup (NGINX, Postfix, Metronome, SSOwat...) and, because of this, can handle the configuration for the user. -#### When will [this feature] be implemented? Why isn't [that app] packaged yet? I cannot believe you do not do [this] yet! +#### When will [this feature] be implemented? Why isn't [that app] packaged yet? I cannot believe you do not do [this] yet We do not give timelines. @@ -103,9 +96,10 @@ If you really want to have a feature implemented or documented, or an app packag The rule of thumb is that we only include software licensed under a free-software license in the official app catalog. However, as YunoHost evolved, some gray-cases appeared with softwares that would be relevant for YunoHost's goal and match its spirit, while not being strictly-speaking free-software. Situations such as: + - software promoting the use of centralized services, though precisely to avoid their direct usage ; - software relying on non-free dependencies or assets ; -- "new" post-open-source / ethical-yet-not-free licenses such as the [ACSL](https://anticapitalist.software/), the [HL3](https://firstdonoharm.dev/) or the [CoopCycle License](https://github.com/coopcycle/coopcycle-web/blob/master/LICENSE) ; +- "new" post-open-source / ethical-yet-not-free licenses such as the [ACSL](https://anticapitalist.software/), the [HL3](https://firstdonoharm.dev/) or the [CoopCycle License](https://github.com/coopcycle/coopcycle-web/blob/master/LICENSE) ; - "open-core" models, trademark clauses, or business-related license clauses (such as the BSL) which are meant to ensure the project's sustainability while still remaining ethical. While we believe free software principles are an essential footstep towards [YunoHost's goal](#what-s-yunohost-goal), we believe they are a means and not an end. We reject the purist vision according to which software is either free or proprietary, and the flawed premise that technology is fundamentally neutral. We believe that ethical software and technology can and should exist beyond the definition of free software layed 40 years ago (see also: [Freedom isn't Free](https://logicmag.io/failure/freedom-isnt-free/) and [Post-Open Source](https://www.boringcactus.com/2020/08/13/post-open-source.html)). @@ -119,8 +113,9 @@ If you run YunoHost for your business, you are responsible for doing your due di ### Why won't you include [feature X] ? YunoHost is primarily designed for not-so-tech-savvy users and aims to remain relatively simple in terms of UI/UX. At the same time, the project has limited time and energy available to be maintained and developed. Therefore we may lower the priority of features, or refuse entirely the inclusion of features, based on the criteria that they: + - would only be meaningful for advanced / power-users stuff which is out of the scope of the project ; -- would introduce too much UI/UX bloat ; +- would introduce too much UI/UX bloat ; - would only cover unrealistic threat models ; - would be there only to satisfy purists ; -- or overall would not be worth it in terms of development/maintenance time/energy for what it brings to the project. \ No newline at end of file +- or overall would not be worth it in terms of development/maintenance time/energy for what it brings to the project. diff --git a/pages/05.community/30.project_sponsors/sponsors_partners.fr.md b/pages/05.community/30.project_sponsors/sponsors_partners.fr.md index e180c8a69..796c54f87 100644 --- a/pages/05.community/30.project_sponsors/sponsors_partners.fr.md +++ b/pages/05.community/30.project_sponsors/sponsors_partners.fr.md @@ -10,7 +10,8 @@ routes: Afin d'avancer et de faire fonctionner le projet, en plus du travail des bénévoles et des dons, YunoHost bénéficie du soutien de mécènes et de partenaires. Une liste des mécènes de YunoHost, fournissant l'infrastructure et des services aux projets : -- [GITOYEN](https://gitoyen.net) : association regroupant plusieurs entreprises et associations intervenant comme fournisseur d’infrastructure d’hébergement et d’accès à Internet. + +- [GITOYEN](https://gitoyen.net) : association regroupant plusieurs entreprises et associations intervenant comme fournisseur d’infrastructure d’hébergement et d’accès à Internet. - [GLOBENET](http://www.globenet.org) : association militante, au service de la liberté d’expression, proposant des services Internet. - [LDN-NET](https://ldn-fai.net/) : association pour la défense d’un Internet libre, neutre et décentralisé dont le moyen d’action principale est d’être un fournisseur d’accès à Internet (FAI) assocatif et local. - [NBS System](https://www.nbs-system.com/): société spécialisée dans l’hébergement, la sécurisation des Clouds, l’infogérance (Systèmes d’information, Applications SaaS, Plateformes web) et les services managés. @@ -18,5 +19,6 @@ Une liste des mécènes de YunoHost, fournissant l'infrastructure et des service - [TETANEUTRAL-NET](https://tetaneutral.net/) : fournisseur d'accès à Internet associatif opérant actuellement un réseau radio sur Toulouse et ses environs et un hébergeur. Une liste des partenaires de YunoHost : + - [FFDN](https://www.ffdn.org/) : La fédération FDN regroupe des fournisseurs d'accès à Internet associatifs se reconnaissant dans des valeurs communes : bénévolat, solidarité, fonctionnement démocratique et à but non lucratif ; défense et promotion de la neutralité du Net. - [Framasoft](https://framasoft.org/) : association d’éducation populaire, un groupe d’ami·es convaincu·es qu’un monde numérique émancipateur est possible, persuadé·es qu’il adviendra grâce à des actions concrètes sur le terrain et en ligne avec vous et pour vous ! diff --git a/pages/05.community/30.project_sponsors/sponsors_partners.md b/pages/05.community/30.project_sponsors/sponsors_partners.md index 7cb0e06e4..2a33631e9 100644 --- a/pages/05.community/30.project_sponsors/sponsors_partners.md +++ b/pages/05.community/30.project_sponsors/sponsors_partners.md @@ -10,6 +10,7 @@ routes: In order to advance and make the project works, in addition to the work of volunteers and donations, YunoHost benefits from the support of sponsors and partners. Here is a list of YunoHost sponsors, providing infrastructure and services to the project: + - [GITOYEN](https://gitoyen.net): association bringing together several companies and associations acting as a provider of hosting infrastructure and Internet access. - [GLOBENET](http://www.globenet.org): activist association, at the service of freedom of expression, offering internet services. - [LDN-NET](https://ldn-fai.net/) : association for the defense of a free, neutral and decentralized Internet whose main means of action is to be an Internet access provider associative and local. @@ -18,5 +19,6 @@ Here is a list of YunoHost sponsors, providing infrastructure and services to th - [TETANEUTRAL-NET](https://tetaneutral.net/): associative Internet access provider currently operating a radio network in Toulouse and its surroundings and a hoster. Here is a list of YunoHost partners: + - [FFDN](https://www.ffdn.org/): The FDN federation gathers associative Internet Access Providers who recognize themselves in common values: volunteering, solidarity, democratic functioning and non-profit; defense and promotion of net neutrality. - [Framasoft](https://framasoft.org/) : popular education association, a group of friends convinced that an emancipatory digital world is possible, convinced that it will happen thanks to concrete actions on the ground and online with you and for you! diff --git a/pages/05.community/35.project_budget/project_budget.fr.md b/pages/05.community/35.project_budget/project_budget.fr.md index b2b5a3c65..09478d1aa 100644 --- a/pages/05.community/35.project_budget/project_budget.fr.md +++ b/pages/05.community/35.project_budget/project_budget.fr.md @@ -18,24 +18,24 @@ routes: * Developpement : 20K€ * Location Serveur : ~500 € - * VPS Scaleway: 20.33*12: 243.96€/year - * VPS Digital O. (forum): 172.80€/year + * VPS Scaleway: 20.33*12: 243.96€/year + * VPS Digital O. (forum): 172.80€/year * Noms de domaine : ~150 € - * nohost.me : 11.99 €HT/ans - * ynh.fr : 6.99 €HT/ans (doit être confirmé avec frju ?) - * noho.st : ~35 €TTC/ans - * yunohost.org : 13.99 €HT/ans - * yunohost.com : 9.99 €HT/ans - * labriqueinter.net : 12.49 €Ht/ans - * internetcu.be : 17.99 €HT/ans -* Communication : ~400 € - * Stickers : 100€ - * Tracts : 100€ - * T-shirt : 200€ -* Déplacements (ex. : aller aux conférences) : ~700 € - * AG FFDN 2020 : 225€ (en tout) - * Event colibris : 150€ - * FOSDEM ou autre conf : 300€ + * nohost.me : 11.99 €HT/ans + * ynh.fr : 6.99 €HT/ans (doit être confirmé avec frju ?) + * noho.st : ~35 €TTC/ans + * yunohost.org : 13.99 €HT/ans + * yunohost.com : 9.99 €HT/ans + * labriqueinter.net : 12.49 €Ht/ans + * internetcu.be : 17.99 €HT/ans +* Communication : ~400 € + * Stickers : 100€ + * Tracts : 100€ + * T-shirt : 200€ +* Déplacements (ex. : aller aux conférences) : ~700 € + * AG FFDN 2020 : 225€ (en tout) + * Event colibris : 150€ + * FOSDEM ou autre conf : 300€ * Compte bancaire fees : 7×12 € soit ~100 € * Brique Camp : 500€ diff --git a/pages/05.community/35.project_budget/project_budget.md b/pages/05.community/35.project_budget/project_budget.md index 19f4e059e..1e0f3ca48 100644 --- a/pages/05.community/35.project_budget/project_budget.md +++ b/pages/05.community/35.project_budget/project_budget.md @@ -18,21 +18,21 @@ routes: * Development: 20K€ * Server renting: 500€ - * VPS Scaleway: 20.33*12: 243.96€/year - * VPS Digital O. (forum): 172.80€/year + * VPS Scaleway: 20.33*12: 243.96€/year + * VPS Digital O. (forum): 172.80€/year * Domain names: ~150€ - * nohost.me: 11.99€HT/year - * ynh.fr: 6.99€HT/year (to be confirmed with frju?) - * noho.st: ~35€ TTC/year - * YunoHost.org: 13.99€HT/year - * YunoHost.com: 9.99€HT/year - * labriqueinter.net: 12.49€HT/year - * internetcu.be: 17.99€HT/year + * nohost.me: 11.99€HT/year + * ynh.fr: 6.99€HT/year (to be confirmed with frju?) + * noho.st: ~35€ TTC/year + * YunoHost.org: 13.99€HT/year + * YunoHost.com: 9.99€HT/year + * labriqueinter.net: 12.49€HT/year + * internetcu.be: 17.99€HT/year * Communication: ~400€ -* Travel (e.g. to go to conferences): ~700€ - * AG FFDN 2020: 225€ (en tout) - * Event colibris: 150€ - * FOSDEM ou autre conf: 300€ +* Travel (e.g. to go to conferences): ~700€ + * AG FFDN 2020: 225€ (en tout) + * Event colibris: 150€ + * FOSDEM ou autre conf: 300€ * Bank account fees: 7x12€ => ~100€ * Brique Camp: 500€ diff --git a/pages/05.community/35.security_team/security_team.fr.md b/pages/05.community/35.security_team/security_team.fr.md index 3186cffb9..34278b75e 100644 --- a/pages/05.community/35.security_team/security_team.fr.md +++ b/pages/05.community/35.security_team/security_team.fr.md @@ -20,4 +20,4 @@ uid YunoHost Security sub 4096R/446838AF 2016-07-01 ``` -Voyez https://gist.github.com/opi/4496024dc3ff29ab2e068fd57092ab7c et https://twitter.com/yunohost/status/748975105393459200 pour d'autres empreintes de confiance +Voyez et pour d'autres empreintes de confiance diff --git a/pages/05.community/35.security_team/security_team.md b/pages/05.community/35.security_team/security_team.md index fd97120b7..d698ba4f8 100644 --- a/pages/05.community/35.security_team/security_team.md +++ b/pages/05.community/35.security_team/security_team.md @@ -19,4 +19,4 @@ uid YunoHost Security sub 4096R/446838AF 2016-07-01 ``` -See https://gist.github.com/opi/4496024dc3ff29ab2e068fd57092ab7c or https://twitter.com/yunohost/status/748975105393459200 for other trustable fingerprints +See or for other trustable fingerprints diff --git a/pages/05.community/40.press_kit/press_kit.md b/pages/05.community/40.press_kit/press_kit.md index c59c579cf..1c41b1c25 100644 --- a/pages/05.community/40.press_kit/press_kit.md +++ b/pages/05.community/40.press_kit/press_kit.md @@ -10,35 +10,36 @@ routes: --- ! TODO: Add logo and kakemono file -! TODO: Add kakemono photo https://matrix-client.matrix.org/_matrix/media/r0/download/pijean.ovh/TqtyOjqllOeSXYziawxeGzIP +! TODO: Add kakemono photo ! TODO: Add "About YunoHost" section ! TODO: Add email contact ## Talks / conf - (EN) [BattleMeshV12 - YunoHost and the Internet Cube (Brique Internet)](https://www.battlemesh.org/BattleMeshV12/Events#YunoHost_and_the_Internet_Cube_.28Brique_Internet.29) -* (EN) [FOSDEM 2019 - The operating system to build the decentralized Internet](https://cinema.yunohost.support/videos/watch/1eb49594-0283-4a01-8691-3817a3cb31e6) ([slides](https://github.com/YunoHost/yunohost-fosdem-2019)) -* (FR) [Capitole du libre 2018 - YunoHost: un des chemins vers la décentralisation - Bram](https://www.youtube.com/watch?v=OEXEStoOYpw) ([slides](https://psycojoker.github.io/yunohost-cdl-2018/)) -* (FR) [Journées du logiciel libre 2018 - YunoHost : vers l’auto-hébergement et au-delà - Bram](https://www.videos-libr.es/videos/watch/45b48b1e-1b10-4e09-b29a-a404bd42c5d0) ([slides](https://psycojoker.github.io/yunohost-jdll-2018/)) -* (FR) Ubuntu Party Novembre 2017 - De Framasoft à YunoHost, réapproprions nous le cloud ([slides](https://blog.genma.fr/?De-Framasoft-a-Yunohost-reapproprions-nous-le-cloud)) -* (FR) [Capitole du libre 2017 - YunoHost : vers l'auto-hébergement et au-delà - JimboJoe](https://2017.capitoledulibre.org/programme/#yunohost-vers-lauto-hebergement-et-au-dela) ([slides](https://github.com/YunoHost/yunohost-cdl-2017/raw/master/YunoHost-CDL2017.pdf)) -* (FR) [PSES 2017 – Construire l’Internet du Futur avec YunoHost – Aleks, ljf](https://data.passageenseine.org/2017/aleks-ljf_internet-futur-yunohost.webm) ([slides](https://data.passageenseine.org/2017/aleks-ljf_internet-futur-yunohost.pdf)) -* (FR) [Université de technologie de compiègne 2017 – Agir pour un internet éthique – LJF](http://webtv.utc.fr/watch_video.php?v=O34AA7RBR1AH) -* (EN) [FOSDEM 2017 – Internet Cube – kload](https://archive.fosdem.org/2017/schedule/event/internet_cube/) -* (EN) [FOSDEM 2017 – YunoHost – Bram](https://archive.fosdem.org/2017/schedule/event/yunohost/) -* (FR) [Capitole du libre 2016 – 1 an et ½ de Brique Internet – Bram](http://videos2016.capitoledulibre.org/communaute-du-libre/bram-1-an-et-demi-de-brique-internet.mp4) -* (FR) [PSES 2015 - La Brique Internet](http://www.youtube.com/watch?v=NCRn0yRfkIE) -* (FR) [THSF 2015 – beudbeud](https://vimeo.com/128055751) -* (FR) [RMLL 2014 - Hébergez-vous ! – kload & beudbeud]() -* (FR) [Capitole du libre 2013 - L’auto-hébergement pour tous avec YunoHost - beudbeud](http://2013.capitoledulibre.org/conferences/internet-libre/lauto-hebergement-pour-tous-avec-yunohost.html) -* (EN) [FOSDEM 2013 — kload](https://www.youtube.com/watch?v=siN1OLAgGJk) +- (EN) [FOSDEM 2019 - The operating system to build the decentralized Internet](https://cinema.yunohost.support/videos/watch/1eb49594-0283-4a01-8691-3817a3cb31e6) ([slides](https://github.com/YunoHost/yunohost-fosdem-2019)) +- (FR) [Capitole du libre 2018 - YunoHost: un des chemins vers la décentralisation - Bram](https://www.youtube.com/watch?v=OEXEStoOYpw) ([slides](https://psycojoker.github.io/yunohost-cdl-2018/)) +- (FR) [Journées du logiciel libre 2018 - YunoHost : vers l’auto-hébergement et au-delà - Bram](https://www.videos-libr.es/videos/watch/45b48b1e-1b10-4e09-b29a-a404bd42c5d0) ([slides](https://psycojoker.github.io/yunohost-jdll-2018/)) +- (FR) Ubuntu Party Novembre 2017 - De Framasoft à YunoHost, réapproprions nous le cloud ([slides](https://blog.genma.fr/?De-Framasoft-a-Yunohost-reapproprions-nous-le-cloud)) +- (FR) [Capitole du libre 2017 - YunoHost : vers l'auto-hébergement et au-delà - JimboJoe](https://2017.capitoledulibre.org/programme/#yunohost-vers-lauto-hebergement-et-au-dela) ([slides](https://github.com/YunoHost/yunohost-cdl-2017/raw/master/YunoHost-CDL2017.pdf)) +- (FR) [PSES 2017 – Construire l’Internet du Futur avec YunoHost – Aleks, ljf](https://data.passageenseine.org/2017/aleks-ljf_internet-futur-yunohost.webm) ([slides](https://data.passageenseine.org/2017/aleks-ljf_internet-futur-yunohost.pdf)) +- (FR) [Université de technologie de compiègne 2017 – Agir pour un internet éthique – LJF](http://webtv.utc.fr/watch_video.php?v=O34AA7RBR1AH) +- (EN) [FOSDEM 2017 – Internet Cube – kload](https://archive.fosdem.org/2017/schedule/event/internet_cube/) +- (EN) [FOSDEM 2017 – YunoHost – Bram](https://archive.fosdem.org/2017/schedule/event/yunohost/) +- (FR) [Capitole du libre 2016 – 1 an et ½ de Brique Internet – Bram](http://videos2016.capitoledulibre.org/communaute-du-libre/bram-1-an-et-demi-de-brique-internet.mp4) +- (FR) [PSES 2015 - La Brique Internet](http://www.youtube.com/watch?v=NCRn0yRfkIE) +- (FR) [THSF 2015 – beudbeud](https://vimeo.com/128055751) +- (FR) [RMLL 2014 - Hébergez-vous ! – kload & beudbeud]() +- (FR) [Capitole du libre 2013 - L’auto-hébergement pour tous avec YunoHost - beudbeud](http://2013.capitoledulibre.org/conferences/internet-libre/lauto-hebergement-pour-tous-avec-yunohost.html) +- (EN) [FOSDEM 2013 — kload](https://www.youtube.com/watch?v=siN1OLAgGJk) ## Articles / Press review [![](image://Linuxfr.png?resize=180)](https://linuxfr.org/news/yunohost-2-0-l-auto-hebergement-a-portee-de-clic) [![](image://linux-pratique-96.jpg?resize=150)](https://www.linux-pratique.com/2016/07/et-si-vous-passiez-a-lauto-hebergement/) [![](image://linux-magazine-208.jpg?resize=150)](https://www.linux-magazine.com/Issues/2018/208/YunoHost) -* LinuxFr (french): + +- LinuxFr (french): - [YunoHost 2.0 : self hosting at click range](https://linuxfr.org/news/yunohost-2-0-l-auto-hebergement-a-portee-de-clic) - [Internet cube and YunoHost projects evolutions](https://linuxfr.org/news/evolutions-des-projets-la-brique-internet-et-yunohost-des-versions-2-2-2-4-et-2-5) - (FR) [Linux Pratique n°96 – YunoHost, l’auto-hébergement à portée de main – juillet 2016](http://connect.ed-diamond.com/Linux-Pratique/LP-096/YunoHost-l-auto-hebergement-a-portee-de-main) @@ -64,9 +65,9 @@ routes: - (EN) [35C3: Hands-on introduction to self-Hosting with YunoHos](https://events.ccc.de/congress/2018/wiki/index.php/Session:Hands-on_introduction_to_self-Hosting_with_YunoHost) - (FR) [Journées du Logiciel Libre 2019: l'auto-hébergement avec YunoHost](https://pretalx.jdll.org/jdll2019/talk/88GSPH/) -## YunoHost was cited in : +## YunoHost was cited in -* [EXPERIMENTA 2018](https://livestream.com/accounts/26482307/events/8034656/player?width=960&height=540&enableInfoAndActivity=true&defaultDrawer=&autoPlay=true&mute=false) at 57.47 (depuis https://www.experimenta.fr/direct/) -* [Capitole du libre 2017 - « Contributopia », Dégoogliser ne suffit pas](https://www.youtube.com/watch?v=ip6_VMkWpr8&feature=youtu.be&t=4793) -* [Contributopia - Essaimage (Framasoft)](https://contributopia.org/fr/essaimage/) +- [EXPERIMENTA 2018](https://livestream.com/accounts/26482307/events/8034656/player?width=960&height=540&enableInfoAndActivity=true&defaultDrawer=&autoPlay=true&mute=false) at 57.47 (depuis ) +- [Capitole du libre 2017 - « Contributopia », Dégoogliser ne suffit pas](https://www.youtube.com/watch?v=ip6_VMkWpr8&feature=youtu.be&t=4793) +- [Contributopia - Essaimage (Framasoft)](https://contributopia.org/fr/essaimage/) - (FR) [Triple A: Émission Underscore #144 du 19 mai 2019](https://www.triplea.fr/blog/podcast/emission-underscore-144-du-19-mai-2019/) diff --git a/pages/06.contribute/05.write_documentation/01.writing_documentation_guide/doc_writing_guide.fr.md b/pages/06.contribute/05.write_documentation/01.writing_documentation_guide/doc_writing_guide.fr.md index 296d25f13..109510a56 100644 --- a/pages/06.contribute/05.write_documentation/01.writing_documentation_guide/doc_writing_guide.fr.md +++ b/pages/06.contribute/05.write_documentation/01.writing_documentation_guide/doc_writing_guide.fr.md @@ -9,14 +9,14 @@ routes: ## Page de documentation utilisateurs·rices / administrateurs⋅rices -Ajouter un bouton installer en un clic (comme par exemple : https://yunohost.org/app_piwigo) et un bouton sur le niveau d'intégration de l'application. +Ajouter un bouton installer en un clic (comme par exemple : ) et un bouton sur le niveau d'intégration de l'application. Classement des applications disponibles par tags (genre, Git, gestion associations, courriels, etc.). ## Quelques usages types et d'ordre général (trame de rédaction) - + Lorsqu'un lien renvoie vers une page qui n'est pas dans la langue de la page d'origine, il est d'usage d'ajouter `(en)`(Pour un lien qui pointe vers une page en anglais). - + renommer les images dans l'ordre suivant :`nomapplication_descriptif.ext` ++ Lorsqu'un lien renvoie vers une page qui n'est pas dans la langue de la page d'origine, il est d'usage d'ajouter `(en)`(Pour un lien qui pointe vers une page en anglais). ++ renommer les images dans l'ordre suivant :`nomapplication_descriptif.ext` ### Trame générale documentation applications @@ -29,9 +29,9 @@ Classement des applications disponibles par tags (genre, Git, gestion associatio 1. Une partie sur les limitations liées à YunoHost. 1. Une partie sur les clients desktop (s'il en existe). Lien vers différentes applications tierces s'il en existe plusieurs (lien possible avec le catalogue d'applications [framalibre.org](https://framalibre.org)) ou un lien vers la page concernant les applications desktop si des applications officielles sont fournies. 1. Une partie avec : - - le lien vers le site officiel - - le lien vers la documentation officielle - - les liens vers le package de YunoHost et issues + + le lien vers le site officiel + + le lien vers la documentation officielle + + les liens vers le package de YunoHost et issues Trame pour la rédaction des pages de documentations : [ici](/app_writing_guide) diff --git a/pages/06.contribute/05.write_documentation/01.writing_documentation_guide/doc_writing_guide.md b/pages/06.contribute/05.write_documentation/01.writing_documentation_guide/doc_writing_guide.md index b853e359b..de09bd959 100644 --- a/pages/06.contribute/05.write_documentation/01.writing_documentation_guide/doc_writing_guide.md +++ b/pages/06.contribute/05.write_documentation/01.writing_documentation_guide/doc_writing_guide.md @@ -9,13 +9,13 @@ routes: ## Users / Administrators documentation pages -Add a one-click install button (such as https://yunohost.org/app_piwigo) and a button on the application integration level. +Add a one-click install button (such as ) and a button on the application integration level. Classification of available applications by tags (genre, Git, association management, e-mails, etc.). ## Some typical and general uses (writing framework) - + rename the images in the following order:`description_application.ext`. ++ rename the images in the following order:`description_application.ext`. ### General frame application documentation @@ -28,9 +28,9 @@ Classification of available applications by tags (genre, Git, association manage 1. A part on limitations related to YunoHost. 1. A part on desktop clients (if any). A link to different third-party applications if there are several (possible link to the applications catalgue [framalibre.org](https://framalibre.org)) or a link to the page about desktop applications if official applications are provided. 1. A part with: - - the link to the official site - - the link to the documentation - - Links to the YunoHost package and issues + + the link to the official site + + the link to the documentation + + Links to the YunoHost package and issues Screen for writing documentation pages: [here](/app_writing_guide) diff --git a/pages/06.contribute/05.write_documentation/02.markdown_guide/doc_markdown_guide.fr.md b/pages/06.contribute/05.write_documentation/02.markdown_guide/doc_markdown_guide.fr.md index 7ea595fba..35326d316 100644 --- a/pages/06.contribute/05.write_documentation/02.markdown_guide/doc_markdown_guide.fr.md +++ b/pages/06.contribute/05.write_documentation/02.markdown_guide/doc_markdown_guide.fr.md @@ -14,6 +14,7 @@ Markdown permet de formater du texte à l'aide de balises, il permet une lecture ## Les différents niveaux de titres En rédigeant des titres comme suit : + ```markdown # Titre de niveau 1 ## Titre de niveau 2 @@ -24,11 +25,17 @@ En rédigeant des titres comme suit : ``` Ils apparaissent comme cela : + # Titre de niveau 1 + ## Titre de niveau 2 + ### Titre de niveau 3 + #### Titre de niveau 4 + ##### Titre de niveau 5 + ###### Titre de niveau 6 ## Formatage dans les paragraphes @@ -61,6 +68,7 @@ s'affichera comme tel : [Texte à afficher](https://lelien.tld) C'est identique pour les pages de la documentation, excepté que le lien est interne. Le nom de la page est sa route par défault définie dans son *header*: + ```markdown [Page du wiki](/write_documentation) ``` @@ -71,6 +79,7 @@ Le lien renverra vers la page avec la bonne configuration de langue si la page e ! Notez qu'il ne faut donc pas préciser le code de langue au début des liens vers d'autres pages de la documentation : `/fr`, `/en`, etc. sont superflus. ### Créer des ancres + Une ancre permet de faire un lien vers un point précis dans une page, c'est comme ça que fonctionnent les index en haut de page. Pour créer une ancre, il faut insérer du code à l'endroit de l'ancre sous la forme suivante : ```markdown @@ -98,13 +107,15 @@ Pour afficher des images, le principe est identique aux liens, excepté l'ajout ```markdown ![Logo YunoHost](image://logo.png) ``` -![Logo YunoHost](image://logo.png) +![Logo YunoHost](image://logo.png) Il est possible de faire un lien avec une image, exemple : + ```markdown [![Logo YunoHost](image://logo.png)](/write_documentation) ``` + [![Logo YunoHost](image://logo.png)](/write_documentation) L'encart de *texte à afficher en cas d'impossibilité de chargement de l'image* entre les crochets dans le lien de l'image n'est pas obligatoire mais fortement recommandé. @@ -120,6 +131,7 @@ Les citations permettent de mettre en valeur un propos tenu par une autre person >> Et une seconde citation >> avec des doubles chevrons ``` + S'affichera : >Du texte de citation du premier niveau @@ -174,6 +186,7 @@ On obtient : Pour créer une liste non ordonnée, il faut utiliser les symboles `*`, `+` ou `*`. Cela ne changera pas l'apparence du marqueur dans la restitution du texte. C'est l'incrémentation de la liste qui définira le visuel. Pour une meilleure lecture du texte brut, il peut être pratique d'utiliser les différents symboles pour marquer l'incrémentation, mais ce sont bien les trois espaces avant la sous-liste qui désigneront l'incrémentation. Comme tel : + ```markdown + Liste 1 + Liste 2 @@ -192,19 +205,23 @@ Comme tel : ``` Ce qui affichera : + + Liste 1 + Liste 2 + liste 3 - - Liste 3a - - Liste 3b - * Liste 3b1 - * Liste 3b2 - * Liste 3b3 - + Liste 1 - + Liste 2 - + liste 3 + + Liste 3a + + Liste 3b + + Liste 3b1 + + Liste 3b2 + + Liste 3b3 + + Liste 1 + + Liste 2 + + liste 3 + - Liste 4 + * Liste 5 + + liste 6 ## Les tableaux @@ -221,6 +238,7 @@ Pour créer un tableau, il faut utiliser la barre verticale `|` (appelé 'pipe') | Une ligne formatée | | Et du **texte en gras** | Ou en *italique* | | D'autres lignes | |![une image](image://cd.jpg) | [Ou un lien](/contributordoc) | ``` + Ce qui affichera ça : | **Un tableau** | Une colonne | Une seconde | Autant que l'on veut | @@ -244,16 +262,19 @@ Ce qui donnera au rendu : Soit inline, par exemple pour mettre en valeur une touche comme `Ctrl` ''' + ```markdown ou directement en bloc. La seule différence est dans la quantité d'accents graves : Minimum trois accents graves en ouverture et fermeture de bloc et deux accents graves qui encadrent le morceau de texte à formater dans une ligne ``` + ''' + ## Liens utiles - + La documentation du langage originel Markdown : [daringfireball.net/projects/markdown (en)](https://daringfireball.net/projects/markdown/) - + Tutoriel Markdown sur [markdowntutorial.com](https://markdowntutorial.com) ++ La documentation du langage originel Markdown : [daringfireball.net/projects/markdown (en)](https://daringfireball.net/projects/markdown/) ++ Tutoriel Markdown sur [markdowntutorial.com](https://markdowntutorial.com) ## Aller plus loin diff --git a/pages/06.contribute/05.write_documentation/02.markdown_guide/doc_markdown_guide.md b/pages/06.contribute/05.write_documentation/02.markdown_guide/doc_markdown_guide.md index fdec1bf2e..a16b546a1 100644 --- a/pages/06.contribute/05.write_documentation/02.markdown_guide/doc_markdown_guide.md +++ b/pages/06.contribute/05.write_documentation/02.markdown_guide/doc_markdown_guide.md @@ -14,6 +14,7 @@ Markdown allows text to be formatted using tags, it allows *human* reading of th ## The different levels of titles By writing titles as follows: + ```markdown # Level 1 title ## Level 2 title @@ -24,11 +25,17 @@ By writing titles as follows: ``` They appear like this: + # Level 1 title + ## Level 2 title + ### Level 3 title + #### Level 4 title + ##### Level 5 title + ###### Level 6 title ## Formatting in paragraphs @@ -61,6 +68,7 @@ will be displayed as such: [Text to display](https://lelien.tld) It is the same for the documentation pages, except that the link is internal. The page name is its default route, as defined in its page header: + ```markdown [Wiki Page](/write_documentation) ``` @@ -71,6 +79,7 @@ The link will return to the page with the correct language setting if the page e ! Note that language codes are thus not to be included at the beginning of the links to other documentation pages: `/en`, `/fr`, etc. are superfluous. ### Create anchors + An anchor allows you to make a link to a specific point in a page, that's how the indexes at the top of the page work. To create an anchor, you need to insert code at the anchor location in the following form : ```markdown @@ -98,13 +107,15 @@ To display images, the principle is the same as for links, except that a `!` is ```markdown ![YunoHost Logo](image://logo.png) ``` -![YunoHost Logo](image://logo.png) +![YunoHost Logo](image://logo.png) It is possible to make a link with an image, for example: + ```markdown [![YunoHost Logo](image://logo.png)](/write_documentation) ``` + [![YunoHost Logo](image://logo.png)](/write_documentation) The insert of *text to be displayed if the image cannot be loaded* between the brackets in the image link is not mandatory but strongly recommended. @@ -120,6 +131,7 @@ Quotes are used to highlight a statement made by another person, the wiki itself >> And a second quote >> with double rafters ``` + Will be displayed: >First level quotation text @@ -174,6 +186,7 @@ You get: To create an unordered list, use the symbols `*`, `+` or `*`. This will not change the appearance of the marker in the text output. It is the incrementing of the list that will define the visual. For a better reading of the plain text, it may be good to use the different symbols to mark the increment, but it is the three spaces before the sub-list that will indicate the increment. As such: + ```markdown + List 1 + List 2 @@ -192,19 +205,23 @@ As such: ``` This will read: + + List 1 + List 2 + list 3 - - List 3a - - List 3b - * List 3b1 - * List 3b2 - * List 3b3 - + List 1 - + List 2 - + list 3 + + List 3a + + List 3b + + List 3b1 + + List 3b2 + + List 3b3 + + List 1 + + List 2 + + list 3 + - List 4 + * List 5 + + list 6 ## Tables @@ -221,6 +238,7 @@ To create an array, use the vertical bar `|` and dashes `--`. It is mandatory to | | And formatted line | | And bold text | | Or *italic* | | More lines | |![An image](image://cd.jpg) | [Or a link](/contributordoc) | ``` + Which would say this: | **One table** | One column | One second | As many as you want | @@ -230,7 +248,7 @@ Which would say this: ## Code block -To display plain text, `blocks of code' can be created using the grave accent `Alt Gr + è` : +To display plain text, `blocks of code' can be created using the grave accent`Alt Gr + è` : ```markdown Either inline, for example to highlight a key like `Ctrl`. @@ -244,17 +262,19 @@ Which will give the rendering: Either inline, for example to highlight a key like `Ctrl`. ''' + ```markdown or directly as a block. The only difference is in the amount of bass accents: At least three low pitched accents at the opening and closing of the block and two low pitched accents that frame the piece of text to be formatted in a line. ``` + ''' ## Useful links - + The documentation of the original Markdown language: [daringfireball.net/projects/markdown](https://daringfireball.net/projects/markdown/) - + Markdown Tutorial on [markdowntutorial.com](https://markdowntutorial.com) ++ The documentation of the original Markdown language: [daringfireball.net/projects/markdown](https://daringfireball.net/projects/markdown/) ++ Markdown Tutorial on [markdowntutorial.com](https://markdowntutorial.com) ## Going further diff --git a/pages/06.contribute/05.write_documentation/03.git/doc_use_git.fr.md b/pages/06.contribute/05.write_documentation/03.git/doc_use_git.fr.md index ddcf15169..ce98554ad 100644 --- a/pages/06.contribute/05.write_documentation/03.git/doc_use_git.fr.md +++ b/pages/06.contribute/05.write_documentation/03.git/doc_use_git.fr.md @@ -10,11 +10,12 @@ routes: Il est bien sûr possible de contribuer directement sur la documentation de YunoHost, mais ce n’est pas la manière la plus pratique de le faire tant pour le·la contributeur·rice que pour la personne qui va injecter votre contribution dans la documentation. Voici un tutoriel pour comprendre et créer une contribution à la documentation de YunoHost en utilisant l’outil [Git (en)](https://git-scm.com/) et [github.com](http://github.com/) qui est le service de forge Git qui héberge et stocke le code source de YunoHost ainsi que sa documentation. ## Création d’un compte sur github.com + Pour pouvoir envoyer vos contributions via GitHub, il est nécessaire d’avoir un compte sur GitHub. Pour créer le compte vous aurez besoin d’une adresse e-mail valide à laquelle vous avez accès. GitHub est un outil puissant qui propose de nombreuses fonctionnalités, l’interface peut être un peu effrayante au début. Vous n’êtes pas obligé·e de donner vos noms et prénoms, vous pouvez utiliser un pseudonyme (lors de l’inscription `Username`). - ## Forker la documentation de YunoHost dans votre dépôt personnel + Forker le code source permet de créer une nouvelle branche de développement d’un code source de logiciel ou dans le cas présent, le code source de la documentation. En créant une nouvelle branche, cela vous permet de modifier le code et d’ajouter vos contributions sans altérer le code de la branche `master` qui est le rendu public de la documentation. Ce qui vous permet de ne pas devoir tout marquer mais le faire en plusieurs étapes. (Notamment pour les contributions demandant plus de temps de travail). Forker un projet sur GitHub est extrêmement simple, il suffit de cliquer sur le bouton Fork, cela créera un nouveau dépôt sur votre espace de GitHub. @@ -29,24 +30,30 @@ Dans le titre du nouveau dépôt, vous verrez de quelle provenance vient le dép > Il n’est pas possible d’avoir un fork du dépot d’un·e contributeur·rice et le fork dépôt d’origine au même moment dans votre propre dépôt. ## Modifier et ajouter votre contribution + Une fois le dépôt forké (copié), il faudra créer une nouvelle branche de développement au sein de votre dépôt. C’est à travers cette branche que vous allez modifier les fichiers et ainsi proposer des améliorations de la documentation. Le fait que ce soit une nouvelle branche vous permettra par la suite de faire une Pull Request, c’est à dire une demande d’ajout de vos contributions au sein de la branche `master` qui est la branche principale de la documentation. Les règles de développement sur GitHub changent selon les développeurs de chaque dépôt, certains ont une branche testing dans laquelle il faut proposer les contributions. Plus d’informations sur ce qu’est une branche sur git-scm.com : [Les branches avec Git - Ce qu’est une branche](https://git-scm.com/book/fr/v1/Les-branches-avec-Git-Ce-qu-est-une-branche). ## Envoyer votre contribution par une Pull Request + Faire une Pull Request correspond au moment où vous souhaitez partager votre travail avec le reste des contributeurs⋅rices et l’intégrer au dépot master (dépôt principal de YunoHost). Lors de la publication d’une Pull Request, couramment nommée PR, les contributeurs⋅rices pourront amender, commenter, ajouter, corriger votre contribution avant intégration complète au dépôt. ## Suivre votre contribution et prendre en compte les retours des contributeurs·trices + Lorsque vous avez déjà fait une PR (Pull Request), les modifications de votre branche de développement sur le dépôt Git se rajouteront automatiquement à la PR. Cela ne nécessite aucune action supplémentaire. Vous pouvez aussi intégrer les propositions de modifications de contributeurs, qui lorsqu’ils·elles auditeront le code, peuvent trouver des erreurs ou de nouvelles formulations plus adaptées. ## Faire remonter des erreurs et des souhaits par des issues + YunoHost dispose d’un dépôt Git spécifique pour le recueil des issues : [github.com/YunoHost/issues](https://github.com/YunoHost/issues) Une issue aussi appelé ticket, est un problème identifié ou alors un souhait de développement ; dans le cas présent pour la documentation, mais c’est valable pour tout dépôt logiciel. Dans le cadre de la documentation de YunoHost il sera surtout proposé des issues pour le développement de la documentation, les problèmes identifiés étant facilement corrigeables. ## Aller plus loin avec Git et travailler sur son poste de travail + Utiliser la puissance de Git et ainsi travailler sur son ordinateur personnel, permet entre autres de ne pas avoir à créer de `commit` à chaque enregistrement intermédiaire des pages de documentations modifiées. Cela permet aussi d’utiliser des outils et logiciels qui permettent une distinction plus facile des codes utilisés dans une page de documentation. - Ressource en ligne : [docs.microsoft.com - Configurer un référentiel Git localement pour la documentation](https://docs.microsoft.com/fr-fr/contribute/get-started-setup-local) ## Quelques ressources ailleurs sur le net pour aller plus loin - - [Gérer son code avec Git et GitHub - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) - - [Interface utilisateurs·trices de Git - git-scm.com](https://git-scm.com/download/gui/linux) + +- [Gérer son code avec Git et GitHub - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) +- [Interface utilisateurs·trices de Git - git-scm.com](https://git-scm.com/download/gui/linux) diff --git a/pages/06.contribute/05.write_documentation/03.git/doc_use_git.md b/pages/06.contribute/05.write_documentation/03.git/doc_use_git.md index 82a372893..76aa62a67 100644 --- a/pages/06.contribute/05.write_documentation/03.git/doc_use_git.md +++ b/pages/06.contribute/05.write_documentation/03.git/doc_use_git.md @@ -10,10 +10,12 @@ routes: It is of course possible to contribute directly to the YunoHost documentation, but this is not the most convenient way to do so for both the contributor and the person who will inject your contribution into the documentation. Here is a tutorial to understand and create a contribution to the YunoHost documentation using [Git](https://git-scm.com/) and [github.com](http://github.com/) which is the Git forge service that hosts and stores the YunoHost source code and documentation. ## Create an account on github.com + To be able to send your contributions via GitHub, you need to have an account on GitHub, to create the account you will need a valid email address that you have access to. GitHub is a powerful tool with many features, the interface can be a little scary at first. You don't have to give your first and last names, you can use a nickname (when you register `Username`). ## Fork the YunoHost documentation in your personal repository + To fork the source code allows you to create a new branch of development of a software source code or in this case the source code of the documentation. By creating a new branch, this allows you to modify the code and add your contributions without altering the code of the `master` branch, which is the public release of the documentation. This allows you not to have to write down everything at once, but to do it in several steps. (Especially for contributions that require more time). Forking a project on GitHub is extremely simple, just click on the Fork button, this will create a new repository on your GitHub account. @@ -26,24 +28,30 @@ In the title of the new repository, you will see where the repository comes from > It is not possible to have a fork from a contributor's repository and the original repository fork at the same time in your own account. ## Modify and add your contribution + Once the repository is forked (copied), you will need to create a new development branch within your repository. It is through this branch that you will modify the files and thus propose improvements to the documentation. The fact that it is a new branch will allow you to make a Pull Request, i.e. a request to add your contributions to the `master` branch, which is the main documentation branch. The development rules on GitHub change depending on the developers of each repository, some have a testing branch in which to offer contributions. More information on what a branch on git-scm.com is: [Branching with Git - What a branch is](https://git-scm.com/book/fr/v1/Les-branches-avec-Git-Ce-qu-est-une-branche). ## Send your contribution by a Pull Request + Create a Pull Request when you want to share your work with the other contributors and integrate it into the master repository (YunoHost's main repository). When publishing a Pull Request, commonly called PR, contributors will be able to amend, comment, add, correct your contribution before it is fully integrated into the repository. ## Track your contribution and take into account feedback from contributors + When you've already create a Pull Request (PR), changes to your development branch in the Git repository will automatically be added to the PR. This doesn't require any additional action. You can also include proposed changes from contributors, who, when they audit the code, may find errors or new, better wording. ## Bringing up mistakes and wishes through issues + YunoHost has a specific Git repository to collect issues: [github.com/YunoHost/issues](https://github.com/YunoHost/issues) An issue, also called a ticket, is an identified problem or a development wish; in this case for documentation, but it is valid for any software repository. Within the framework of the YunoHost documentation it will be mainly proposed issues for the development of the documentation, the identified problems being easily correctable. ## Going further with Git and working on your workstation + Using the power of Git to work on your personal computer means you don't have to create a `commit` each time you save modified documentation pages. It also allows you to use tools and software that make it easier to distinguish between tags used in a documentation page. - Online resource: [docs.microsoft.com - Setting up a Git repository locally for documentation](https://docs.microsoft.com/fr-fr/contribute/get-started-setup-local) ## Some resources elsewhere on the net to go further - - [Managing your code with Git and GitHub - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) - - [Git User Interface - git-scm.com](https://git-scm.com/download/gui/linux) + +- [Managing your code with Git and GitHub - openclassrooms.com](https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github) +- [Git User Interface - git-scm.com](https://git-scm.com/download/gui/linux) diff --git a/pages/06.contribute/05.write_documentation/write_documentation.de.md b/pages/06.contribute/05.write_documentation/write_documentation.de.md index c3cf71c68..f9e1ef060 100644 --- a/pages/06.contribute/05.write_documentation/write_documentation.de.md +++ b/pages/06.contribute/05.write_documentation/write_documentation.de.md @@ -48,15 +48,15 @@ Die Struktur des Repositorys wird nachfolgend beschrieben: # Enthält die Anweisungen, keine sensiblen # oder nutzlosen Dateien an das Git-Repository zu senden + -- README.md -``` +``` -!!!! Weitere Informationen zu den Funktionen von Grav finden Sie in der [Dokumentation](https://learn.getgrav.org?target=_blank). Der Rest dieser Seite zeigt Ihnen einige spezifische Anweisungen, die Sie zur Dokumentation von YunoHost beachten sollten.. +!!!! Weitere Informationen zu den Funktionen von Grav finden Sie in der [Dokumentation](https://learn.getgrav.org?target=_blank). Der Rest dieser Seite zeigt Ihnen einige spezifische Anweisungen, die Sie zur Dokumentation von YunoHost beachten sollten.. -## Grav-Header +## Grav-Header -Jede Seite beginnt mit einem Header, der Grav Anweisungen zur Verarbeitung gibt. Werfen wir einen Blick in die Kopfzeile dieser Seite: +Jede Seite beginnt mit einem Header, der Grav Anweisungen zur Verarbeitung gibt. Werfen wir einen Blick in die Kopfzeile dieser Seite: -``` +``` --- title: Dokumentation schreiben template: docs @@ -65,19 +65,21 @@ taxonomie: routes: default: '/write_documentation' --- -``` +``` + 1. Die Kopfzeile beginnt und endet mit einer Zeile, die `---` enthält 2. Der `title:` verwaltet die erste Titel-Überschrift der Seite, ihren Namen im Navigationsmenü links und den Namen des Browser-Tab`s -3. Die Punkte `template` und `taxonomie` sollten immer unverändert bleiben. Sie weisen Grav an, das richtige Theme zu verwenden und die Seiten richtig auf zu bauen. -4. Die Schlüssel `routes` und `default` machen die Seite standardmäßig unter `https://yunohost.org/docs/write_documentation` verfügbar, um sie nicht unter `https://yunohost.org/docs/contribute/write_documentation` aufrufen zu müssen, wo sie in der Verzeichnishierarchie gespeichert ist. +3. Die Punkte `template` und `taxonomie` sollten immer unverändert bleiben. Sie weisen Grav an, das richtige Theme zu verwenden und die Seiten richtig auf zu bauen. +4. Die Schlüssel `routes` und `default` machen die Seite standardmäßig unter `https://yunohost.org/docs/write_documentation` verfügbar, um sie nicht unter `https://yunohost.org/docs/contribute/write_documentation` aufrufen zu müssen, wo sie in der Verzeichnishierarchie gespeichert ist. -## Syntax +## Syntax Sie können die Markdown-Syntax verwenden. Weitere Informationen finden Sie in der [Dokumentation](/doc_markdown_guide). -! Beachten Sie, dass Sprachcodes nicht am Anfang der Links zu anderen Dokumentationsseiten stehen dürfen: `/en`,` /fr` usw. sind überflüssig. +! Beachten Sie, dass Sprachcodes nicht am Anfang der Links zu anderen Dokumentationsseiten stehen dürfen: `/en`,`/fr` usw. sind überflüssig. + +Um die Markdown-Funktionen zu verbessern, werden zusätzliche Plugins in Grav installiert. In der eigenen Dokumentation auf GitHub erfahren Sie, wie Sie sie verwenden. -Um die Markdown-Funktionen zu verbessern, werden zusätzliche Plugins in Grav installiert. In der eigenen Dokumentation auf GitHub erfahren Sie, wie Sie sie verwenden. ``` anchors external_links @@ -88,26 +90,27 @@ markdown-notices presentation presentation-deckset shortcode-core -``` +``` -## Sonderseiten +## Sonderseiten -Einige Seiten der Dokumentation werden automatisch oder dynamisch generiert. +Einige Seiten der Dokumentation werden automatisch oder dynamisch generiert. -| Seite | Pfad | Anmerkungen | +| Seite | Pfad | Anmerkungen | | --------------- | ------- | ------- | -| Apps-Katalog | `/pages/02.applications/01.catalog/apps.md` | Ruft [app.json](https://github.com/YunoHost/apps/blob/master/apps.json?target=_blank) ab und verarbeitet sie | -| Apps-Helfer | `pages/04.contribute/04.packaging_apps/11.helpers/package_apps_helpers.md` | Erstellt von diesem [Skript](https://github.com/YunoHost/yunohost/blob/dev/doc/generate_helper_doc.py?target=_blank) aus dieser [Vorlage](https://github.com/YunoHost/yunohost/blob/dev/doc/helper_doc_template.md?target=_blank) | -| Pro-App-Dokumentation | `pages/02.applications/02.docs/docs.md` | Listet die Unterseiten im selben Verzeichnis auf, deren Header `taxonomy.category: docs, apps` enthält +| Apps-Katalog | `/pages/02.applications/01.catalog/apps.md` | Ruft [app.json](https://github.com/YunoHost/apps/blob/master/apps.json?target=_blank) ab und verarbeitet sie | +| Apps-Helfer | `pages/04.contribute/04.packaging_apps/11.helpers/package_apps_helpers.md` | Erstellt von diesem [Skript](https://github.com/YunoHost/yunohost/blob/dev/doc/generate_helper_doc.py?target=_blank) aus dieser [Vorlage](https://github.com/YunoHost/yunohost/blob/dev/doc/helper_doc_template.md?target=_blank) | +| Pro-App-Dokumentation | `pages/02.applications/02.docs/docs.md` | Listet die Unterseiten im selben Verzeichnis auf, deren Header `taxonomy.category: docs, apps` enthält ## Hosten Sie Ihre eigene Testdokumentation -! Diese Anweisungen müssen noch vollständig getestet werden. Bitte helfen Sie uns, indem Sie Probleme melden, die Sie möglicherweise mit ihnen haben. +! Diese Anweisungen müssen noch vollständig getestet werden. Bitte helfen Sie uns, indem Sie Probleme melden, die Sie möglicherweise mit ihnen haben. + +0. Forken Sie das YunoHost Dokumentations Repository +1. Installieren Sie das YunoHost-Paket Grav : `yunohost app install grav` +2. Installieren Sie die folgenden Plugins durch das Grav Admin-Panel oder CLI: -0. Forken Sie das YunoHost Dokumentations Repository -1. Installieren Sie das YunoHost-Paket Grav : `yunohost app install grav` -2. Installieren Sie die folgenden Plugins durch das Grav Admin-Panel oder CLI: -``` +``` anchors breadcrumbs external_links @@ -122,27 +125,28 @@ presentation presentation-deckset shortcode-core tntsearch -``` -3. Git Sync Plugin einrichten. +``` + +3. Git Sync Plugin einrichten. 1. Melden Sie sich mit Ihren Anmeldeinformationen auf GitHub an - 2. Legen Sie das Repo fest, z. B. `https://github.com/username/doc`. - 3. Kopieren Sie die URL des Webhooks, z. B. `https://grav.example/_git-sync-ca25c111f0de`. - 4. Grundeinstellungen> Ordner im Sync: `pages`` images` `themes` - 5. Git Repo-Einstellungen> Benutzer nicht erforderlich: Aktiviert - 6. Git Repo-Einstellungen> Web Hooks-Geheimnis: Aktiviert - 7. Erweiterte Einstellungen> Lokaler Branch:`master` + 2. Legen Sie das Repo fest, z. B. `https://github.com/username/doc`. + 3. Kopieren Sie die URL des Webhooks, z. B. `https://grav.example/_git-sync-ca25c111f0de`. + 4. Grundeinstellungen> Ordner im Sync: `pages`` images` `themes` + 5. Git Repo-Einstellungen> Benutzer nicht erforderlich: Aktiviert + 6. Git Repo-Einstellungen> Web Hooks-Geheimnis: Aktiviert + 7. Erweiterte Einstellungen> Lokaler Branch:`master` 8. Erweiterte Einstellungen> Remote Branch: `master` - (Sie können` master` ändern, wenn Sie an einem anderen Zweig arbeiten möchten, aber vergessen Sie nicht, ihn zuerst auf GitHub zu erstellen.) + (Sie können`master` ändern, wenn Sie an einem anderen Zweig arbeiten möchten, aber vergessen Sie nicht, ihn zuerst auf GitHub zu erstellen.) 9. Erweiterte Einstellungen> Committer-Name: Ihr GitHub-Benutzername - 10. Erweiterte Einstellungen> Committer-E-Mail : Ihre E-Mail auf GitHub + 10. Erweiterte Einstellungen> Committer-E-Mail : Ihre E-Mail auf GitHub 4. Lokale Kopie speichern und zurücksetzen -5. Konfigurieren Sie `commits` und `tree` in `config/theme/yunohost-docs.yaml`, so das sie auf Ihren Fork des Repositorys verweisen. -6. Stellen Sie sicher, dass die Verzeichnisse `user/pages/01.home` und `user/pages/02.typography` gelöscht werden. -7. Konfiguration> System: - 1. Sprache> Unterstützt: `en` `fr` `de` `es` `ar` - 2. Sprache> Standardsprache überschreiben:` en` - 3. Sprache> Sprache vom Browser einstellen: `Ja` - 4. HTTP-Header> Etag: `Ja` - 5. Erweitert> Blueprint-Kompatibilität:` Ja` - 6. Erweitert> YAML-Kompatibilität: `Ja` - 7. Erweitert> Twig-Kompatibilität:` Ja` +5. Konfigurieren Sie `commits` und `tree` in `config/theme/yunohost-docs.yaml`, so das sie auf Ihren Fork des Repositorys verweisen. +6. Stellen Sie sicher, dass die Verzeichnisse `user/pages/01.home` und `user/pages/02.typography` gelöscht werden. +7. Konfiguration> System: + 1. Sprache> Unterstützt: `en` `fr` `de` `es` `ar` + 2. Sprache> Standardsprache überschreiben:`en` + 3. Sprache> Sprache vom Browser einstellen: `Ja` + 4. HTTP-Header> Etag: `Ja` + 5. Erweitert> Blueprint-Kompatibilität:`Ja` + 6. Erweitert> YAML-Kompatibilität: `Ja` + 7. Erweitert> Twig-Kompatibilität:`Ja` diff --git a/pages/06.contribute/05.write_documentation/write_documentation.fr.md b/pages/06.contribute/05.write_documentation/write_documentation.fr.md index 7249951e0..07a2b3de5 100644 --- a/pages/06.contribute/05.write_documentation/write_documentation.fr.md +++ b/pages/06.contribute/05.write_documentation/write_documentation.fr.md @@ -80,6 +80,7 @@ Vous pouvez utiliser la syntaxe Markdown, consultez la page de [documentation d ! Notez qu'il ne faut pas préciser le code de langue au début des liens vers d'autres pages de la documentation : `/fr`, `/en`, etc. sont superflus. Pour étendre les fonctionnalités de Markdown, des extensions ont été ajoutées à Grav. Vous pouvez consulter leur propre documentation sur GitHub pour découvrir comment vous en servir. + ```text anchors external_links @@ -109,6 +110,7 @@ Quelques pages de la documentation sont générées automatiquement ou dynamique 0. *Fork* le dépôt de la documentation YunoHost sur GitHub 1. Installez l'app Grav pour YunoHost : `yunohost app install grav` 2. Installez les extensions suivantes via l'admin ou la ligne de commande de Grav : + ```text anchors breadcrumbs @@ -125,6 +127,7 @@ presentation-deckset shortcode-core tntsearch ``` + 3. Paramétrez l'extension Git Sync. 1. Choisissez `GitHub` et vos identifiants GitHub 2. Entrez l'adresse de votre *fork*, par exemple `https://github.com/username/doc` @@ -136,9 +139,9 @@ tntsearch 8. "Advanced settings" > "remote branch" : `master` (vous pouvez changer `master` en une autre branche si vous le souhaitez, mais n'oubliez pas de la créer au préalable sur GitHub) 9. "Advanced settings" > "Committer Name" : votre nom d'utilisateur sur GitHub - 10. "Advanced settings" > "Committer Email" : votre email renseigné sur GitHub - 11. Enregistrez et cliquez sur "Reset Local Copy" - 12. Renseignez les adresses dans les clés `commits` et `tree` dans `config/themes/yunohost-docs.yaml` pour quelles pointent vers l'adresse de votre *fork* sur GitHub +10. "Advanced settings" > "Committer Email" : votre email renseigné sur GitHub +11. Enregistrez et cliquez sur "Reset Local Copy" +12. Renseignez les adresses dans les clés `commits` et `tree` dans `config/themes/yunohost-docs.yaml` pour quelles pointent vers l'adresse de votre *fork* sur GitHub 4. Assurez-vous que les dossiers `user/pages/01.home` et `user/pages/02.typography` sont supprimés. 5. Dans l'administration de Grav, dans "Configuration" > "System" : 1. "Language" > "Supported" : `en` `fr` `de` `es` `ar` diff --git a/pages/06.contribute/05.write_documentation/write_documentation.md b/pages/06.contribute/05.write_documentation/write_documentation.md index a1fbc4b2e..06adbea4f 100644 --- a/pages/06.contribute/05.write_documentation/write_documentation.md +++ b/pages/06.contribute/05.write_documentation/write_documentation.md @@ -81,6 +81,7 @@ You can use Markdown syntax, refer to the [documentation](/doc_markdown_guide) f ! Note that language codes are not to be included at the beginning of the links to other documentation pages: `/en`, `/fr`, etc. are superfluous. To improve Markdown capabilities, additional plugins are installed in Grav. You can refer to their own documentation on GitHub to see how to use them. + ```text anchors external_links @@ -110,6 +111,7 @@ Some pages of the documentation are automatically or dynamically generated. 0. Fork YunoHost documentation repository 1. Install Grav's YunoHost package: `yunohost app install grav` 2. Install the following plugins through Grav's admin panel or CLI: + ```text anchors breadcrumbs @@ -126,6 +128,7 @@ presentation-deckset shortcode-core tntsearch ``` + 3. Set-up Git Sync plugin. 1. Choose GitHub and your credentials on GitHub 2. Set the repo, e.g. `https://github.com/username/doc` @@ -137,9 +140,9 @@ tntsearch 8. Advanced settings > remote branch: `master` (you can change `master` if you want to work on another branch, but do not forget to create it on GitHub first) 9. Advanced settings > Committer Name: your GitHub username - 10. Advanced settings > Committer Email: your email saved on GitHub - 11. Save and Reset Local Copy - 12. Set `commits` and `tree` keys in `config/themes/yunohost-docs.yaml` to point to your fork's repository +10. Advanced settings > Committer Email: your email saved on GitHub +11. Save and Reset Local Copy +12. Set `commits` and `tree` keys in `config/themes/yunohost-docs.yaml` to point to your fork's repository 4. Make sure `user/pages/01.home` and `user/pages/02.typography` directories are deleted. 5. Configuration > System: 1. Language > Supported: `en` `fr` `de` `es` `ar` diff --git a/pages/06.contribute/10.packaging_apps/10.manifest/docs.md b/pages/06.contribute/10.packaging_apps/10.manifest/docs.md index 20abfbd29..254c39956 100644 --- a/pages/06.contribute/10.packaging_apps/10.manifest/docs.md +++ b/pages/06.contribute/10.packaging_apps/10.manifest/docs.md @@ -104,7 +104,6 @@ The declaration of antifeatures is a 3-steps process: The format of this section is a `dict` where keys are antifeature IDs, and the values are translated strings (`dict` of `lang code`->`str`). - ## Install questions This section contains questions that should be asked to the admin prior to starting the actual install @@ -135,17 +134,17 @@ This section contains questions that should be asked to the admin prior to start ``` - `domain` and `path` (with `type = "domain"/"path"`) are classic questions to allow the admin to choose where the app is installed (in terms of web url endpoint) - - e.g. if the admin answers `domain.tld` and `/foobar`, the app will be available under `domain.tld/foobar` - - some webapp do require a full dedicated domain and do not support the "subpath" install scheme. In that case, you typically want to remove the `path` question entirely - - these questions are part of YunoHost's generic app questions and therefore you do not need to define the `ask.en` strings that contain the actual question displayed in the UI along the line of "Choose a domain to install this app on" + - e.g. if the admin answers `domain.tld` and `/foobar`, the app will be available under `domain.tld/foobar` + - some webapp do require a full dedicated domain and do not support the "subpath" install scheme. In that case, you typically want to remove the `path` question entirely + - these questions are part of YunoHost's generic app questions and therefore you do not need to define the `ask.en` strings that contain the actual question displayed in the UI along the line of "Choose a domain to install this app on" - `init_main_permission` is also a classic question (similar to `is_public` in v1 packaging) and define what user group will be able to access the app after it is installed. Typical answer are : `visitors` (= everybody including anonymous users, the app is "public"), `all_users` (= only people with a YunoHost account, the app is "private"), or any custom user group that may have been defined by the YunoHost admins prior to the install. - `prefered_pet` is a custom question: - - `ask.en` defines the human-readable question to be asked (at least the english version) - - `help.en` is an optional additional message to provide further info about this question - - `type` is the type of question, in this case `string` - - in this example, we don't want a free user input but choosing between `cat`, `dog` or `both` (with proper human-readable versions of these choices) - - this will later automatically create a yunohost app setting named `prefered_pet` - - .. and in the bash install script, the bash variable will automatically be available `$prefered_pet` with the chosen value + - `ask.en` defines the human-readable question to be asked (at least the english version) + - `help.en` is an optional additional message to provide further info about this question + - `type` is the type of question, in this case `string` + - in this example, we don't want a free user input but choosing between `cat`, `dog` or `both` (with proper human-readable versions of these choices) + - this will later automatically create a yunohost app setting named `prefered_pet` + - .. and in the bash install script, the bash variable will automatically be available `$prefered_pet` with the chosen value ### Regarding install question types @@ -180,6 +179,7 @@ The resource section corresponds to recurring app needs that are to be provision ``` In this example: + - `sources.main`: the URL+checksum from which the app sources will be downloaded + validated - `system_user`: a system (unix) user will be created for this app, using the app id as username. - `install_dir`: an install dir will be initialized, named `/var/www/$app` by default. Additional `owner` and `group` property allow to change the owner/group and r/w/x permissions on the created folder. diff --git a/pages/06.contribute/10.packaging_apps/20.scripts/scripts.md b/pages/06.contribute/10.packaging_apps/20.scripts/scripts.md index 6901d3bc2..699103480 100644 --- a/pages/06.contribute/10.packaging_apps/20.scripts/scripts.md +++ b/pages/06.contribute/10.packaging_apps/20.scripts/scripts.md @@ -59,7 +59,6 @@ ynh_add_nginx_config Note that the scripts are run with the `set -eu` options (except for the remove script), which means that any failing command or use of non-existing variable will trigger an error and stop the script execution. - ## Variables available in a script context Special variables are automatically defined in the context of a script: @@ -70,7 +69,6 @@ Special variables are automatically defined in the context of a script: - Note that some settings are automatically created/updated by app ressources. For example, the `install_dir` setting will automatically be available too and corresponds to typically `/var/www/$app` - In the `change_url` context, variables called `new_domain`, `new_path`, `old_domain`, `old_path` will be available, as well as `change_domain` and `change_path` equal to `0` (false) or `1` (true) depending if the domain / path changed - ## Setting system Application often need to store long term information in between scripts triggered by the admin. For this, YunoHost has a key-value store for each application called "setting" and is stored in `/etc/yunohost/apps/$app/settings.yml`. @@ -127,7 +125,6 @@ location __PATH__/ { } ``` - ## App sources App sources were historically defined in `conf/app.src` files containing the URL + checksum of assets to download. @@ -147,10 +144,17 @@ More infos on the `source` resource in [the resource system documentation](/pack ## Common operations (TODO/FIXME) #### installing/upgrading app sources + #### adding configurations + #### adding a systemd service + #### curl / automatizing install forms + #### classic stuff for nodejs apps + #### classic stuff for php apps + #### classic stuff for python apps + #### classic stuff for ??? apps diff --git a/pages/06.contribute/10.packaging_apps/40.testing/testing.md b/pages/06.contribute/10.packaging_apps/40.testing/testing.md index 9125bfe96..e4665b21c 100644 --- a/pages/06.contribute/10.packaging_apps/40.testing/testing.md +++ b/pages/06.contribute/10.packaging_apps/40.testing/testing.md @@ -22,11 +22,12 @@ It is pretty straightforward to run considering that you should only need Python ## Package check [Package check](https://github.com/YunoHost/package_check) is a more elaborate software that will tests many scenarios for you app such as: + - installing, removing and reinstalling your app + validating that the app can indeed be accessed on its URL endpoint (with no 404/502 error) - - when installing on a root domain (`domain.tld/`) - - when installing in a domain subpatch (`domain.tld/foobar`) - - installing in private mode - - installing multiple instances + - when installing on a root domain (`domain.tld/`) + - when installing in a domain subpatch (`domain.tld/foobar`) + - installing in private mode + - installing multiple instances - upgrading from the same version - upgrading from older versions - backup/restore @@ -60,18 +61,17 @@ While this definition may vary with time, the current definition as of February - level 7 (« All tests succeeded + No linter warning ») : Pass all test (including for example upgrade from past commits) and no warning reported by the linter - level 8 (« Maintained and long-term good quality ») : The app is not flagged as not-maintained / alpha / deprecated / obsolete in the catalog, and has been at least level 5 during the past ~year - ## Continous integration (CI) The YunoHost project also developed an interface called [`yunorunner`](https://github.com/YunoHost/yunorunner) which interfaces with `package_check`, handles a job queue, and automatically add jobs to the queue using some triggers. The two major ones are: + - [The "official" CI](https://ci-apps.yunohost.org/ci): This where the "official" quality level of each app comes from. Jobs are triggered after each commit on the repo's master branch. - [The "dev" CI](https://ci-apps-dev.yunohost.org/ci/): This is where people validate their pull request which is often more convenient than running `package_check` yourself, and has the advantage of the results being automatically public, which facilitates collective debugging. Members of the YunoHost-Apps organization can trigger jobs on the dev CI directly from a pull request simply by commenting something like `!testme` (cf for example [here](https://github.com/YunoHost-Apps/nextcloud_ynh/pull/532#issuecomment-1402751409)). A .png summary of the tests will be automatically displayed once the job completes (and you can click the link to see the entire job execution and debug it). - #### Why create `package_check` + `yunorunner` rather than using well-known solutions like Gitlab-CI ? Constrain 1 : Gitlab-CI or other similar solutions are mostly based around Docker, while we use LXC. In particular, we do want to reuse LXC snapshots of successful install during other tests (upgrade, backup/restore, ..) rather than reinstalling the app from scratch everytime, which drastically reduces the test time. We could do so using Gitlab artifacts, but such artifacts are automatically made public which is not convenient because they contain a full filesystem and their only use it to speed up the test process. Moreover, in the Gitlab-CI paradigm, jobs are not running on the same machine and they would need to download the snapshot which can be lengthy. The other mechanism, caching, is explicitly advertised as not reliable in Gitlab's-CI doc. What would be helpful would be some non-public artifact system (see similar discussion [here](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/336)) diff --git a/pages/06.contribute/10.packaging_apps/50.publishing/publishing.md b/pages/06.contribute/10.packaging_apps/50.publishing/publishing.md index 2ffce5579..baccfe79e 100644 --- a/pages/06.contribute/10.packaging_apps/50.publishing/publishing.md +++ b/pages/06.contribute/10.packaging_apps/50.publishing/publishing.md @@ -11,6 +11,6 @@ The official YunoHost's app catalog is maintained [in this repository](https://g For your app to be made available to everybody, you should make a pull request that adds your app inside the `apps.toml` (see the [detailed instructions in the README](https://github.com/YunoHost/apps/#how-to-add-your-app-to-the-application-catalog)) -Note that the "real" catalog used by YunoHost servers is https://app.yunohost.org/default/v3/apps.json which is rebuilt every 4 hours. +Note that the "real" catalog used by YunoHost servers is which is rebuilt every 4 hours. NB: The `level` key is not to be set manually by maintainers. The `yunohost-bot` will [automatically create a pull request](https://github.com/YunoHost/apps/blob/master/tools/update_app_levels/update_app_levels.py) every Friday evening with results from the official CI, which are then to be manually reviewed and merged by the community. diff --git a/pages/06.contribute/10.packaging_apps/60.advanced/20.config_panels/config_panels.md b/pages/06.contribute/10.packaging_apps/60.advanced/20.config_panels/config_panels.md index c022bebfb..a5aafce42 100644 --- a/pages/06.contribute/10.packaging_apps/60.advanced/20.config_panels/config_panels.md +++ b/pages/06.contribute/10.packaging_apps/60.advanced/20.config_panels/config_panels.md @@ -20,6 +20,7 @@ To create configuration panels for apps, you should at least create a `config_pa The `config_panel.toml` describes one or several panels, containing sections, each containing questions generally binded to a params in the app's actual configuration files. Let's imagine that the upstream app is configured using this simple `config.yml` file stored in the app's install directory (typically `/var/www/$app/config.yml`): + ```yaml title: 'My dummy app' theme: 'white' @@ -28,6 +29,7 @@ max_age: 365 ``` We could for example create a simple configuration panel for it like this one, by following the syntax `[PANEL.SECTION.QUESTION]`: + ```toml version = "1.0" [main] @@ -61,10 +63,12 @@ Here we have created one `main` panel, containing the `main` and `limits` sectio ### Questions short keys have to be unique For performance reasons, questions short keys have to be unique in all the `config_panel.toml` file, not just inside its panel or its section. Hence it's not possible to have: + ```toml [manual.vpn.server_ip] [advanced.dns.server_ip] ``` + In which two questions have "real variable name" `is server_ip` and therefore conflict with each other. ! Some short keys are forbidden cause it can interfer with config scripts (`old`, `file_hash`, `types`, `binds`, `formats`, `changed`) and you probably should avoid to use common settings name to avoid to bind your question to this settings (e.g. `id`, `install_time`, `mysql_pwd`, `path`, `domain`, `port`, `db_name`, `current_revision`, `admin`) @@ -73,7 +77,6 @@ In which two questions have "real variable name" `is server_ip` and therefore co See [the full list of questions types and properties](/dev/forms) - ### Reading and writing values You can read and write values with 2 mechanisms: the `bind` property in the `config_panel.toml` and for complex use cases the getter/setter in a `config` script. @@ -99,6 +102,7 @@ bind = ":__INSTALL_DIR__/config.yml" In which case, YunoHost will look for something like a key/value, with the key being `theme`. If the question id in the config panel (here, `theme`) differs from the key in the actual conf file (let's say it's not `theme` but `css_theme`), then you can write: + ```toml [main.main.theme] # (other properties ommited) @@ -107,7 +111,8 @@ bind = "css_theme:__FINALPATH__/config.yml" !!!! Note: This mechanism is quasi language agnostic and will use regexes to find something that looks like a key=value or common variants. However, it does assume that the key and value are stored on the same line. It doesn't support multiline text or file in a variable with this method. If you need to save multiline content in a configuration variable, you should create a custom getter/setter (see below). -Nested syntax is also supported, which may be useful for example to remove ambiguities about stuff looking like: +Nested syntax is also supported, which may be useful for example to remove ambiguities about stuff looking like: + ```json { "foo": { @@ -119,7 +124,7 @@ Nested syntax is also supported, which may be useful for example to remove ambig } ``` -which we can `bind` to using: +which we can `bind` to using: ```toml bind = "foo>max:__INSTALL_DIR__/conf.json" @@ -128,6 +133,7 @@ bind = "foo>max:__INSTALL_DIR__/conf.json" #### Read / write an entire file Useful when using a question `file` or `text` for which you want to save the raw content directly as a file on the system. + ```toml [main.main.logo] # (other properties ommited) @@ -137,13 +143,14 @@ bind = "__INSTALL_DIR__/img/logo.png" ### Custom getter / setter Sometimes the `bind` mechanism is not enough: - * the config file format is not supported (e.g. xml, csv) - * the data is not contained in a config file (e.g. database, directory, web resources...) - * the data should be written but not read (e.g. password) - * the data should be read but not written (e.g. fetching status information) - * we want to change other things than the value (e.g. the choices list of a select) - * the question answer contains several values to dispatch in several places - * and so on + +* the config file format is not supported (e.g. xml, csv) +* the data is not contained in a config file (e.g. database, directory, web resources...) +* the data should be written but not read (e.g. password) +* the data should be read but not written (e.g. fetching status information) +* we want to change other things than the value (e.g. the choices list of a select) +* the question answer contains several values to dispatch in several places +* and so on You can create specific getter/setters functions inside the `scripts/config` of your app to customize how the information is read/written. @@ -161,9 +168,10 @@ ynh_app_config_run $1 #### Getter -A question's getter is the function used to read the current value/state. Custom getters are defined using bash functions called `getter__QUESTION_SHORT_KEY()` which returns data through stdout. +A question's getter is the function used to read the current value/state. Custom getters are defined using bash functions called `getter__QUESTION_SHORT_KEY()` which returns data through stdout. Stdout can generated using one of those formats: + 1) either a raw format, in which case the return is binded directly to the value of the question 2) or a yaml format, in this case you dynamically provide properties for your question (for example the `style` of an `alert`, the list of available `choices` of a `select`, etc.) @@ -184,11 +192,13 @@ get__timezone() { echo "$(cat /etc/timezone)" } ``` + [/details] [details summary="Basic example with yaml-formated stdout : Display a list of available plugins" class="helper-card-subtitle text-muted"] `config_panel.toml` + ```toml [main.plugins.plugins] ask = "Plugin to activate" @@ -238,6 +248,7 @@ EOF fi } ``` + [/details] #### Setter @@ -264,6 +275,7 @@ set__timezone() { ynh_print_info "The timezone has been changed to $timezone" } ``` + [/details] ## Validation @@ -271,12 +283,14 @@ set__timezone() { You will often need to validate data answered by the user before to save it somewhere. Validation can be made with regex through `pattern` argument + ```toml pattern.regexp = '^.+@.+$' pattern.error = 'An email is required for this field' ``` You can also restrict several types with a choices list. + ```toml choices.foo = "Foo (some explanation)" choices.bar = "Bar (moar explanation)" @@ -291,6 +305,7 @@ Some other type specific argument exist like | `boolean` | `yes` `no` | Finally, if you need specific or multi variable validation, you can use custom validators function: + ```bash validate__login_user() { if [[ "${#login_user}" -lt 4 ]]; then echo 'User login is too short, should be at least 4 chars'; fi @@ -330,10 +345,11 @@ ynh_app_config_apply() { ``` List of main configuration helpers - * `ynh_app_config_get` - * `ynh_app_config_show` - * `ynh_app_config_validate` - * `ynh_app_config_apply` - * `ynh_app_config_run` + +* `ynh_app_config_get` +* `ynh_app_config_show` +* `ynh_app_config_validate` +* `ynh_app_config_apply` +* `ynh_app_config_run` More info on this can be found by reading [vpnclient_ynh config script](https://github.com/YunoHost-Apps/vpnclient_ynh/blob/master/scripts/config) diff --git a/pages/06.contribute/10.packaging_apps/60.advanced/30.sso_ldap_integration/sso_ldap_integration.md b/pages/06.contribute/10.packaging_apps/60.advanced/30.sso_ldap_integration/sso_ldap_integration.md index 249a73119..7fd57c012 100644 --- a/pages/06.contribute/10.packaging_apps/60.advanced/30.sso_ldap_integration/sso_ldap_integration.md +++ b/pages/06.contribute/10.packaging_apps/60.advanced/30.sso_ldap_integration/sso_ldap_integration.md @@ -10,6 +10,7 @@ routes: One powerful aspect of YunoHost is that apps are meant to be integrated with the SSO/LDAP stack, such that users logged in on YunoHost's user portal can be directly logged in each app without having to create an account in each of them nor having to re-log in each app every time. It should be stressed that there are two different aspects here: + - the LDAP integration, meaning that the user accounts in the app are directly mapped to YunoHost user accounts - the SSO integration, meaning that a user logged in on the YunoHost user portal is automatically logged in on the app as well. @@ -44,10 +45,8 @@ fastcgi_param REMOTE_USER $remote_user; `$remote_user` being a special variable in NGINX that maps to the user provided in the HTTP Basic Auth headers. The PHP application will then use the `HTTP_REMOTE_USER` info in its code. - TODO/FIXME: moar explanations of how this is done for non-PHP apps? - ## Configuring SSOwat permissions for the app SSOwat permissions are configured using the 'permission' resource in your app's manifest.toml @@ -69,7 +68,6 @@ admin.allowed = "admins" # Initialize the access for the "admins" group ... Yo See the page about app resources for the full description of behavior and properties. - ## Logging out on the app vs. Logging out of YunoHost A common [known issue](https://github.com/YunoHost/issues/issues/501) is that sometimes, logging out of YunoHost apps will not log people out of every app. This is for example the case for [Nextcloud](https://github.com/YunoHost-Apps/nextcloud_ynh/issues/19), because it uses its own authentication cookies which are not cleared when people log out of YunoHost. This is not trivial to fix. diff --git a/pages/06.contribute/10.packaging_apps/60.advanced/50.hooks/packaging_apps_hooks.fr.md b/pages/06.contribute/10.packaging_apps/60.advanced/50.hooks/packaging_apps_hooks.fr.md index 5bbb3490f..446fdddc5 100644 --- a/pages/06.contribute/10.packaging_apps/60.advanced/50.hooks/packaging_apps_hooks.fr.md +++ b/pages/06.contribute/10.packaging_apps/60.advanced/50.hooks/packaging_apps_hooks.fr.md @@ -11,26 +11,32 @@ YunoHost comprend un mécanisme de hooks déclenchés lors de nombreuses opérat Le cas le plus évident est l'ajout d'un utilisateur. Si vous aviez un hook `post_user_create`, ce hook sera déclenché dès qu'un utilisateur sera ajouté. ## Comment ajouter un hook personnalisé sur une instance spécifique + !!! Nous imaginons ci-dessous que nous voulons lancer une commande après chaque création d'utilisateur pour ajouter l'utilisateur à l'utilisateur samba. Vous devez créer un répertoire avec le nom des hooks dans `/etc/yunohost/hooks.d/` : -``` + +```bash mkdir -p /etc/yunohost/hooks.d/post_user_create ``` Créez ensuite un script bash à l'intérieur de ce répertoire, préfixé par 2 chiffres et un tiret : + ```bash nano /etc/yunohost/hooks.d/post_user_create/05-add-user-to-samba ``` ## Comment ajouter un hook dans un paquetage d'application + Si vous empaquetez une application, vous ne devez pas mettre vous-même le hook dans `/etc/yunohost/hooks.d` mais vous devez créer un répertoire hooks à la racine de votre paquet. -``` + +```text . ├─── conf ├─── hooks ├── scripts ``` + Dans le dossier des hooks, créer un script bash appelé avec le type de hook que vous voulez créer par exemple `post_create_user`. ## -> [Liste des hooks et leurs variables](https://yunohost.org/en/packaging_apps_hooks) diff --git a/pages/06.contribute/10.packaging_apps/60.advanced/50.hooks/packaging_apps_hooks.md b/pages/06.contribute/10.packaging_apps/60.advanced/50.hooks/packaging_apps_hooks.md index 4894506d1..c9d212d83 100644 --- a/pages/06.contribute/10.packaging_apps/60.advanced/50.hooks/packaging_apps_hooks.md +++ b/pages/06.contribute/10.packaging_apps/60.advanced/50.hooks/packaging_apps_hooks.md @@ -12,28 +12,33 @@ YunoHost includes a hook mechanism triggered on a lot of operation changing the The most obvious case is adding a user. If you had a `post_user_create` hook, this hook will be triggered as soon as a user is added. ## How to add a custom hook on a specific instance + !!! Below we imagine we want to run a command after each user creation to add the user to samba user. You should create a directory with the name of the hooks into `/etc/yunohost/hooks.d/`: -``` + +```bash mkdir -p /etc/yunohost/hooks.d/post_user_create ``` - Next create a bash script inside this directory prefixed by 2 numbers and a dash: + ```bash nano /etc/yunohost/hooks.d/post_user_create/05-add-user-to-samba ``` By default, the directory must be readable and traversable by root, but if you notice your hook is not run at all by YunoHost, you can check permissions with `ls -l /etc/yunohost/hooks.d/` and apply these commands if needed: -``` + +```bash chown root:root /etc/yunohost/hooks.d/post_user_create chmod u+rx /etc/yunohost/hooks.d/post_user_create ``` ## How to add a hook in an app package + If you are packaging an app, you should not set by yourself the hook into `/etc/yunohost/hooks.d` instead you should create a hooks dir at the root of your package. -``` + +```text . ├── conf ├── hooks @@ -43,30 +48,34 @@ If you are packaging an app, you should not set by yourself the hook into `/etc/ In the hooks dir, create a bash script called with the type of hook you want to create for example `post_create_user`. ## Hooks referencies + ### User and permissions + #### post_user_create + [details summary="Triggered after user creation" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost user create` or equivalent action in webadmin. ##### Environment variables - - YNH_USER_USERNAME: The username of the created user - - YNH_USER_MAIL: The mail of the created user - - YNH_USER_PASSWORD: The **clear** password of the created user - - YNH_USER_FIRSTNAME: The firstname of the created user ([should be removed in future](https://github.com/YunoHost/issues/issues/296)) - - YNH_USER_LASTNAME: The lastname of the created user ([should be removed in future](https://github.com/YunoHost/issues/issues/296)) +- YNH_USER_USERNAME: The username of the created user +- YNH_USER_MAIL: The mail of the created user +- YNH_USER_PASSWORD: The **clear** password of the created user +- YNH_USER_FIRSTNAME: The firstname of the created user ([should be removed in future](https://github.com/YunoHost/issues/issues/296)) +- YNH_USER_LASTNAME: The lastname of the created user ([should be removed in future](https://github.com/YunoHost/issues/issues/296)) ##### Positionnal arguments (deprecated) - - $1: The username of the created user - - $2: The mail of the created user +- $1: The username of the created user +- $2: The mail of the created user ##### No waited return ##### Examples ###### Send automatically a mail to new user + ```bash #!/bin/bash domain=$(cat /etc/hostname) @@ -80,11 +89,11 @@ The admin of $domain echo $message | mail -s "Welcome on $domain !" $YNH_USER_MAIL ``` -[/details] - +[/details] #### post_user_delete + [details summary="Triggered at the end of user deletion" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost user delete` or equivalent action in webadmin. @@ -93,22 +102,23 @@ This hook is run at the end of the command `yunohost user delete` or equivalent ##### Positionnal arguments - - $1: The username of the user deleted - - $2: True if --purge option is used +- $1: The username of the user deleted +- $2: True if --purge option is used ##### No waited return ##### Examples -###### +###### + ```bash #!/bin/bash ``` -[/details] - +[/details] ### post_user_update + [details summary="Triggered at the end of the user update" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost user update` or equivalent action in webadmin. @@ -116,13 +126,14 @@ This hook is run at the end of the command `yunohost user update` or equivalent ##### Environment variables ! Only arguments given to the cli/api are given as environment variable. - - YNH_USER_USERNAME: The username of the updated user - - YNH_USER_FIRSTNAME: The firstname of the updated user ([should be removed in future](https://github.com/YunoHost/issues/issues/296)) - - YNH_USER_LASTNAME: The lastname of the updated user ([should be removed in future](https://github.com/YunoHost/issues/issues/296)) - - YNH_USER_PASSWORD: The new password of the updated user - - YNH_USER_MAILS: The mail and mail aliases of the updated user seperated by comma - - YNH_USER_MAILFORWARDS: The list of forward mails of the updated user separated by comma - - YNH_USER_MAILQUOTA: The quota of the updated user (could be 0 or a number following by one of this unit: b, k, M, G or T) + +- YNH_USER_USERNAME: The username of the updated user +- YNH_USER_FIRSTNAME: The firstname of the updated user ([should be removed in future](https://github.com/YunoHost/issues/issues/296)) +- YNH_USER_LASTNAME: The lastname of the updated user ([should be removed in future](https://github.com/YunoHost/issues/issues/296)) +- YNH_USER_PASSWORD: The new password of the updated user +- YNH_USER_MAILS: The mail and mail aliases of the updated user seperated by comma +- YNH_USER_MAILFORWARDS: The list of forward mails of the updated user separated by comma +- YNH_USER_MAILQUOTA: The quota of the updated user (could be 0 or a number following by one of this unit: b, k, M, G or T) ##### No positionnal arguments @@ -131,6 +142,7 @@ This hook is run at the end of the command `yunohost user update` or equivalent ##### Examples ###### Send a mail on password changing + ```bash #!/bin/bash " @@ -143,11 +155,11 @@ If you have not asked for changing your password, you probably should contact th echo $message | mail -s "Your password has been changed on $domain !" $YNH_USER_USERNAME ``` -[/details] - +[/details] ### post_app_addaccess + [details summary="Triggered after adding a permission to users or groups " class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost user permission add` or equivalent action in webadmin. @@ -156,19 +168,19 @@ This hook is run at the end of the command `yunohost user permission add` or equ ##### Positionnal arguments (deprecated) - - $1: The app name - - $2: The list of users added separated by comma - - $3: The name of the sub permission (`main`, `admin`, etc.) - - $4: The list of groups added separated by comma +- $1: The app name +- $2: The list of users added separated by comma +- $3: The name of the sub permission (`main`, `admin`, etc.) +- $4: The list of groups added separated by comma ##### No waited return ##### Examples -[/details] - +[/details] ### post_app_removeaccess + [details summary="Triggered after removing a pemission to users or groups" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost user permission remove` or equivalent action in webadmin. @@ -177,24 +189,21 @@ This hook is run at the end of the command `yunohost user permission remove` or ##### Positionnal arguments (deprecated) - - $1: The app name - - $2: The list of users removed from the permission separated by comma - - $3: The name of the sub permission (`main`, `admin`, etc.) - - $4: The list of groups removed from the permission separated by comma +- $1: The app name +- $2: The list of users removed from the permission separated by comma +- $3: The name of the sub permission (`main`, `admin`, etc.) +- $4: The list of groups removed from the permission separated by comma ##### No waited return ##### Examples -[/details] - - - - - +[/details] ## Domain, certificates and DNS + ### post_domain_add + [details summary="Triggered at the end of the domain add operation" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost domain add` or equivalent action in webadmin. @@ -203,22 +212,22 @@ This hook is run at the end of the command `yunohost domain add` or equivalent a ##### Positionnal arguments (deprecated) - - $1: The domain added +- $1: The domain added ##### No waited return ##### Examples -###### +###### + ```bash ``` -[/details] - - +[/details] ### post_domain_remove + [details summary="Triggered after removing the domain" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost domain remove` or equivalent action in webadmin. @@ -227,17 +236,16 @@ This hook is run at the end of the command `yunohost domain remove` or equivalen ##### Positionnal arguments (deprecated) - - $1: The domain removed +- $1: The domain removed ##### No waited return ##### Examples -[/details] - - +[/details] ### post_cert_update + [details summary="Triggered after Let's encrypt certificate update" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost domain cert update` or equivalent action in webadmin. @@ -246,37 +254,39 @@ This hook is run at the end of the command `yunohost domain cert update` or equi ##### Positionnal arguments - - $1: The domain for which we have updated the certificate +- $1: The domain for which we have updated the certificate ##### No waited return ##### Examples ###### Restart a service after cert renewal + ```bash #!/bin/bash systemctl restart gemserv ``` -[/details] - - +[/details] ### custom_dns_rules + [details summary="Customized your DNS rules for your domains" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost domain dns suggest` or equivalent action in webadmin. -Thanks to This hook you can customize +Thanks to This hook you can customize ##### No environment variable ##### Positionnal arguments - - $1: The base domain for which we want to build a DNS suggestion +- $1: The base domain for which we want to build a DNS suggestion ##### Waited return + The script should return a JSON array with dictionnary in this format: + ```json [ { @@ -288,10 +298,10 @@ The script should return a JSON array with dictionnary in this format: ] ``` - ##### Examples ###### Validate Let's Encrypt DNS challenge with a YunoHost DynDNS domain + ```bash #!/bin/bash if [[ "$1" == "XXXX.nohost.me" ]] ; then @@ -306,48 +316,49 @@ if [[ "$1" == "XXXX.nohost.me" ]] ; then fi ``` -[/details] - - - +[/details] ## Apps + ### post_app_change_url + [details summary="Triggered after an app has changed of URL" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost app change-url` or equivalent action in webadmin. ##### Environment variables - - YNH_APP_OLD_DOMAIN: The old domain of the app - - YNH_APP_OLD_PATH: The old path of the app - - YNH_APP_NEW_DOMAIN: The new domain of the app - - YNH_APP_NEW_PATH: The new path of the app +- YNH_APP_OLD_DOMAIN: The old domain of the app +- YNH_APP_OLD_PATH: The old path of the app +- YNH_APP_NEW_DOMAIN: The new domain of the app +- YNH_APP_NEW_PATH: The new path of the app ##### No positionnal arguments ##### No waited return ##### Examples + [/details] ### post_app_upgrade + [details summary="Triggered on app upgrade" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost app upgrade` or equivalent action in webadmin. ##### Environment variables - - YNH_APP_ID: The app id (for example nextcloud) - - YNH_APP_INSTANCE_NAME: The app instance name (for example nextcloud__2) - - YNH_APP_INSTANCE_NUMBER: The app instance number (for example 2) - - YNH_APP_MANIFEST_VERSION: The app manifest version (for example 1 or ?) - - YNH_ARCH: The arch as returned by `dpkg --print-architecture` - - YNH_APP_UPGRADE_TYPE: The type of upgrade (UPGRADE_PACKAGE, UPGRADE_APP, UPGRADE_FULL) - - YNH_APP_MANIFEST_VERSION: The version number - - YNH_APP_CURRENT_VERSION: The version number of the app (in the yunohost format) - - NO_BACKUP_UPGRADE: 1 if we don't want to backup else 0 +- YNH_APP_ID: The app id (for example nextcloud) +- YNH_APP_INSTANCE_NAME: The app instance name (for example nextcloud__2) +- YNH_APP_INSTANCE_NUMBER: The app instance number (for example 2) +- YNH_APP_MANIFEST_VERSION: The app manifest version (for example 1 or ?) +- YNH_ARCH: The arch as returned by `dpkg --print-architecture` +- YNH_APP_UPGRADE_TYPE: The type of upgrade (UPGRADE_PACKAGE, UPGRADE_APP, UPGRADE_FULL) +- YNH_APP_MANIFEST_VERSION: The version number +- YNH_APP_CURRENT_VERSION: The version number of the app (in the yunohost format) +- NO_BACKUP_UPGRADE: 1 if we don't want to backup else 0 ##### No positionnal arguments @@ -356,6 +367,7 @@ This hook is run at the end of the command `yunohost app upgrade` or equivalent ##### Examples ###### Change a settings in an app config file (unmanaged by config panel) + ```bash #!/bin/bash @@ -368,71 +380,79 @@ if [[ "$app" == "etherpad_mypads" ]]; then fi ``` + [/details] ### post_app_install + [details summary="Triggered at the end of an app installation" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost app install` or equivalent action in webadmin. ##### Environment variables - - YNH_APP_ID: The app id (for example nextcloud) - - YNH_APP_INSTANCE_NAME: The app instance name (for example nextcloud__2) - - YNH_APP_INSTANCE_NUMBER: The app instance number (for example 2) - - YNH_APP_MANIFEST_VERSION: The app manifest version (for example 1 or ?) - - YNH_ARCH: The arch as returned by `dpkg --print-architecture` - - YNH_APP_ARG_XXXXXXX: The argument of the manifest +- YNH_APP_ID: The app id (for example nextcloud) +- YNH_APP_INSTANCE_NAME: The app instance name (for example nextcloud__2) +- YNH_APP_INSTANCE_NUMBER: The app instance number (for example 2) +- YNH_APP_MANIFEST_VERSION: The app manifest version (for example 1 or ?) +- YNH_ARCH: The arch as returned by `dpkg --print-architecture` +- YNH_APP_ARG_XXXXXXX: The argument of the manifest ##### No positionnal arguments ##### No waited return ##### Examples -[/details] +[/details] ### post_app_remove + [details summary="Triggered after removing an app" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost app remove` or equivalent action in webadmin. ##### Environment variables - - YNH_APP_ID: The app id (for example nextcloud) - - YNH_APP_INSTANCE_NAME: The app instance name (for example nextcloud__2) - - YNH_APP_INSTANCE_NUMBER: The app instance number (for example 2) - - YNH_APP_MANIFEST_VERSION: The app manifest version (for example 1 or ?) - - YNH_ARCH: The arch as returned by `dpkg --print-architecture` - - YNH_APP_PURGE: 1 if the --purge option has been activated +- YNH_APP_ID: The app id (for example nextcloud) +- YNH_APP_INSTANCE_NAME: The app instance name (for example nextcloud__2) +- YNH_APP_INSTANCE_NUMBER: The app instance number (for example 2) +- YNH_APP_MANIFEST_VERSION: The app manifest version (for example 1 or ?) +- YNH_ARCH: The arch as returned by `dpkg --print-architecture` +- YNH_APP_PURGE: 1 if the --purge option has been activated ##### No positionnal arguments ##### No waited return ##### Examples + [/details] ## Backup / Restore + ### backup + [details summary="Add some files to backup" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost backup create` or equivalent action in webadmin. ##### Environment variables - - YNH_BACKUP_DIR: The work dir in which we can store temporary data to backup like database dump - - YNH_BACKUP_CSV: The CSV in which we add the things to backup. Don't use this directly and use ynh_backup helper instead. - - YNH_APP_BACKUP_DIR: To document +- YNH_BACKUP_DIR: The work dir in which we can store temporary data to backup like database dump +- YNH_BACKUP_CSV: The CSV in which we add the things to backup. Don't use this directly and use ynh_backup helper instead. +- YNH_APP_BACKUP_DIR: To document ##### Positionnal arguments - - $1: The work dir in which we can store temporary data to backup like database dump + +- $1: The work dir in which we can store temporary data to backup like database dump ##### No waited return ##### Examples ###### Backup some files in more (for example your custom hooks) + ```bash #!/bin/bash @@ -457,26 +477,30 @@ ynh_backup "/etc/yunohost/hooks.d/backup/99-conf_custom" ynh_backup "/etc/yunohost/hooks.d/restore/99-conf_custom" ``` + [/details] ### restore + [details summary="Restore some files" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost backup restore` or equivalent action in webadmin. ##### Environment variables - - YNH_BACKUP_DIR: The work dir in which we can store temporary data to backup like database dump - - YNH_BACKUP_CSV: The CSV in which we add the things to backup. Don't use this directly and use ynh_backup helper instead. +- YNH_BACKUP_DIR: The work dir in which we can store temporary data to backup like database dump +- YNH_BACKUP_CSV: The CSV in which we add the things to backup. Don't use this directly and use ynh_backup helper instead. ##### Positionnal arguments - - $1: The work dir in which we can store temporary data to backup like database dump + +- $1: The work dir in which we can store temporary data to backup like database dump ##### No waited return ##### Examples ###### restore custom files + ```bash #!/bin/bash @@ -505,6 +529,7 @@ ynh_restore_file "/etc/yunohost/hooks.d/restore/99-conf_custom" [/details] ### backup_method + [details summary="Define a new way to backup and restore files" class="helper-card-subtitle text-muted"] This hook is run during the command `yunohost backup create` or equivalent action in webadmin. @@ -514,21 +539,20 @@ This hook is called several times with different action keywords. ##### No environment variables ##### Positionnal arguments - - - - $1: The action ("need_mount", "backup", "mount") - - $2: The work dir - - $3: The name of the backup - - $4: The repository in which the backup should be done - - $5: An estimation size of the files to backup - - $6: A description of the archive +- $1: The action ("need_mount", "backup", "mount") +- $2: The work dir +- $3: The name of the backup +- $4: The repository in which the backup should be done +- $5: An estimation size of the files to backup +- $6: A description of the archive ##### No waited return ##### Examples ###### A very simple backup on rotationnal disks + ```bash #!/bin/bash set -euo pipefail @@ -565,35 +589,40 @@ esac exit 0 ``` + [/details] ## Configuration and firewall + ### post_iptable_rules + [details summary="Triggered after reloaded the firewall rules" class="helper-card-subtitle text-muted"] This hook is run at the end of the command `yunohost firewall reload` or equivalent action in webadmin. ##### No environment variables - ##### Positionnal arguments - - $1: True if upnp has succeeded - - $2: True if ipv6 is available +- $1: True if upnp has succeeded +- $2: True if ipv6 is available ##### No waited return ##### Examples ###### Forbid completely the outgoing 25 port except for postfix user + ```bash #!/bin/bash iptables -A OUTPUT -p tcp --dport 25 -m owner --uid-owner postfix -j ACCEPT iptables -A OUTPUT -p tcp --dport 25 -m tcp -j REJECT --reject-with icmp-port-unreachable ``` + [/details] ### conf_regen + [details summary="Change configuration suggested as default config in regen-conf mechanism" class="helper-card-subtitle text-muted"] This hook is run during the command `yunohost tools regen-conf` or equivalent action in webadmin. @@ -602,21 +631,22 @@ This hook is called several times with different actions keywords (pre and post ##### Environment variables - - YNH_DOMAINS: The list of domains managed by YunoHost separated by comma - - YNH_MAIN_DOMAINS: The list of main domains separated by comma +- YNH_DOMAINS: The list of domains managed by YunoHost separated by comma +- YNH_MAIN_DOMAINS: The list of main domains separated by comma ##### Positionnal arguments - - $1: The pre or post action - - $2: Empty string due to legacy - - $3: Empty string due to legacy - - $4: In post mode the list of file which should be modified. In pre mode the dir in which we store pending configuration +- $1: The pre or post action +- $2: Empty string due to legacy +- $3: Empty string due to legacy +- $4: In post mode the list of file which should be modified. In pre mode the dir in which we store pending configuration ##### No waited return ##### Examples ###### Fix the warning about postfix compatibility mode in postfix logs + ```bash #!/bin/bash @@ -629,5 +659,5 @@ postfix_conf=$pending_dir/../postfix/etc/postfix/main.cf echo ' compatibility_level = 2' >> $postfix_conf ``` -[/details] +[/details] diff --git a/pages/06.contribute/10.packaging_apps/80.resources/03.git/packaging_apps_git.fr.md b/pages/06.contribute/10.packaging_apps/80.resources/03.git/packaging_apps_git.fr.md index 829a8f5dd..a7594c249 100644 --- a/pages/06.contribute/10.packaging_apps/80.resources/03.git/packaging_apps_git.fr.md +++ b/pages/06.contribute/10.packaging_apps/80.resources/03.git/packaging_apps_git.fr.md @@ -19,7 +19,7 @@ Commençons par la partie facile, GitHub est livré avec une interface web "faci *Tout d'abord et malheureusement, il n'y a pas moyen de contourner ça, vous devez avoir un compte sur GitHub.* -#### Branches +### Branches Ensuite, et c'est probablement l'une des choses les plus importantes, **ne travaillez pas directement sur la branche master**. Désolé, il fallait que ce soit dit ! @@ -32,7 +32,7 @@ La bonne habitude à prendre est de travailler à partir de la branche testing, Pour voir et modifier la branche actuelle, utilisez ce bouton : ![](image://github_branch.png) -#### Modifier un fichier +### Modifier un fichier Maintenant que vous êtes sur la bonne branche, voyons comment éditer un fichier sur GitHub. @@ -42,7 +42,7 @@ Vous pouvez éditer n'importe quel fichier en utilisant l'icône du petit crayon Si vous n'avez pas la permission d'écrire sur le dépôt, vous verrez (comme sur l'image) que vous allez créer un fork (nous verrons plus loin ce qu'est un fork). Si vous avez la permission d'écrire, vous allez simplement modifier le fichier, sans forker. -#### Validez vos modifications +### Validez vos modifications Lorsque vous avez fini de modifier le fichier, vous pouvez faire un commit de vos modifications. Derrière ce mot, l'idée est assez simple, vous allez juste enregistrer vos modifications... @@ -54,7 +54,7 @@ Le deuxième champ est un champ plus grand pour une explication plus complète, Enfin, si vous modifiez un dépôt sur lequel vous avez la permission d'écrire, vous pouvez soit faire un commit directement sur la branche en cours, soit créer une nouvelle branche. Il est généralement préférable de créer une nouvelle branche, de cette façon vous gardez vos modifications sur une version *parallèle* du dépôt. Vos modifications seront discutées dans une pull request (expliquée ci-dessous) puis finalement fusionnées dans la branche d'origine. -#### Forker ou ne pas forker +### Forker ou ne pas forker Un fork est une copie d'un dépôt sur votre propre compte. Nous avons déjà vu que si vous n'avez pas l'autorisation d'écrire dans un dépôt, la modification d'un fichier créera automatiquement un fork. @@ -69,7 +69,7 @@ Nous avons vu comment éditer un fichier, et comment cela peut forker l'applicat Mais, lorsque vous voulez éditer plusieurs fichiers, l'interface GitHub n'est pas vraiment la meilleure solution. Dans une telle situation, vous préférerez cloner le dépôt et travailler sur un dépôt local. Il se peut que vous deviez tout de même forker sur votre propre compte pour pouvoir enregistrer vos modifications si vous n'avez pas les autorisations sur le dépôt distant. -#### Pull request +### Pull request Après avoir effectué vos commits, que ce soit sur une branche ou un fork, vous souhaitez proposer vos modifications pour qu'elles soient intégrées dans le dépôt principal, ou dans la branche d'origine. Pour ce faire, vous allez créer une pull request. GitHub vous demande généralement directement si vous souhaitez le faire. @@ -78,7 +78,7 @@ Sinon, vous trouverez le bouton de création d'une pull request juste ici : Lors de la création d'une pull request à partir d'un fork, pour faciliter le travail de révision du code, **ne jamais** décocher la case *Allow edits from maintainers*. Cette option permet simplement aux mainteneurs du dépôt d'origine de modifier directement votre travail. -#### Organisation YunoHost-Apps +### Organisation YunoHost-Apps Conformément au [guide de création d'applications dans YunoHost](/packaging_apps_intro), votre application doit être intégrée à l'organisation YunoHost-Apps, mais si vous n'avez jamais contribué à une application auparavant ou si vous n'avez jamais eu d'application dans cette organisation, vous n'en aurez peut-être pas l'autorisation. @@ -89,7 +89,6 @@ En bas de la page, vous trouverez *Transfer ownership*. Dans le champ *New owner’s GitHub username or organization name*, tapez *YunoHost-Apps*. Votre dépôt sera déplacé dans l'organisation, vous n'avez pas besoin de supprimer le dépôt d'origine. - ## Travailler avec Git en local Comme nous l'avons vu, vous pouvez faire beaucoup de choses directement sur GitHub. @@ -97,7 +96,7 @@ Mais lorsque vous devez modifier plusieurs fichiers, ou lorsque vous devez trava Avant d'aller dans la partie infernale de Git, voyons 2 façons différentes de commencer à travailler avec Git. -#### Premier cas : Créer un nouveau package +### Premier cas : Créer un nouveau package Vous avez découvert, choqué, que la merveilleuse application que vous aimez utiliser tous les jours n'a pas encore son package YunoHost. Et parce que vous êtes sympa, vous avez décidé de créer vous-même le package, pour que tout le monde puisse apprécier cette application. Quelle bonne idée ! @@ -105,19 +104,21 @@ Quelle bonne idée ! Le mieux est de commencer par l'[application d'exemple](https://github.com/YunoHost/example_ynh). Mais comme nous l'avons déjà expliqué, vous ne voulez pas forker, parce que si vous le faites, vous allez garder ce lien vers l'application d'exemple et c'est vraiment ennuyeux. Donc, vous allez le faire différemment. Vous allez cloner ! -##### `git clone` +#### `git clone` Pour cloner, vous allez faire : + ```bash git clone https://github.com/YunoHost/example_ynh ``` + `git clone` téléchargera une copie du dépôt. Vous aurez le dépôt complet, avec ses branches, ses commits, et tout le reste (dans cet apparent petit répertoire `.git`). git clone est généralement le point de départ de tout travail local avec Git. *Toutefois, si vous comptez envoyer vos modifications sur le dépôt distant sur GitHub, assurez-vous d'avoir les droits d'écriture sur ce dépôt. Sinon, forkez avant et clonez votre fork, pour lequel vous avez la permission.* -##### Mon nouveau package, suite +#### Mon nouveau package, suite Dans le contexte d'un nouveau package, vous devrez également créer un dépôt sur GitHub pour y mettre votre package. Ce qui n'est pas plus compliqué qu'un gros bouton vert *New*. @@ -132,27 +133,29 @@ Copiez tous les fichiers de l'application example_ynh, **excepté le répertoire Vous êtes prêt à travailler sur votre nouveau package ! -#### Deuxième cas : Travailler localement sur un dépôt +### Deuxième cas : Travailler localement sur un dépôt Vous disposez déjà d'un dépôt, mais ce que vous voulez, c'est travailler localement, de sorte que vous puissiez modifier plusieurs fichiers. Il vous suffit de cloner le dépôt, le répertoire .git est le lien vers le dépôt distant. Rien d'autre à faire qu'un `git clone`. -#### Branches +### Branches Vous avez bien votre copie local du dépôt, mais comme vous avez lu attentivement cette documentation jusque-là, vous savez que vous devez vous assurer d'être sur la branche testing avant de commencer à travailler. Pour voir les branches, et savoir sur quelle branche vous êtes réellement, alors que vous êtes dans le répertoire de votre dépôt, tapez `git branch`. La branche courante est mise en évidence et précédée d'un "\*". -#### `git checkout` +### `git checkout` S'il apparaît que vous n'êtes pas sur la branche où vous vouliez être, ou que vous êtes en fait sur master (ce qui est mal !), vous pouvez passer à une autre branche avec `git checkout`. + ```bash git checkout testing ``` + *Lisez attentivement ce que Git dit quand vous validez une commande, n'oubliez jamais que Git est sournois...* -#### `git pull` avant tout +### `git pull` avant tout Vous êtes enfin dans la bonne branche, et prêt à travailler. **Attendez ! Un vilain piège vous attend...** @@ -161,17 +164,20 @@ Avant de vous retrouver dans une situation inextricable. Commencez par un `git p *Parfois, vous rencontrerez une situation impossible où Git vous dira que vous ne pouvez pas pull parce que vous avez des changements locaux. Mais vous ne vous souciez pas de ces modifications locales, vous voulez juste obtenir la dernière version de la branche distante. Mais Git ne se soucie pas de ce que VOUS voulez...* *Je dois admettre que ma seule solution est aussi efficace que sale... Un bon vieux `rm -r` du dépôt et un `git clone`* -#### Il est temps de travailler +### Il est temps de travailler Vous pouvez finalement travailler sur votre code. Lorsque vous êtes enfin d'accord avec ce que vous avez fait, il est temps de valider votre travail. La première étape consiste à informer Git sur le(s) fichier(s) à valider. Pour ce faire, nous utiliserons `git add`. + ```bash git add mon_fichier ajouter mon_autre_fichier et_aussi_celui_ci ``` + Si vous souhaitez valider l'ensemble de votre travail, vous pouvez aussi simplement faire + ```bash git add --all ``` @@ -179,14 +185,14 @@ git add --all Pour vérifier l'état actuel de votre validation, vous pouvez utiliser `git status`. Il vous montrera quels fichiers seront inclus dans votre commit, et quels fichiers sont modifiés, mais pas encore inclus. `git status -v` vous indiquera également quelle partie des fichiers est modifiée. Une bonne façon de s'assurer que vous n'avez pas fait d'erreur avant de faire un commit. -#### `git checkout -b` +### `git checkout -b` Avant de faire un commit, ou après, ou avant de commencer à travailler. Quand vous en avez envie ! Vous devriez envisager d'ajouter votre travail à une branche séparée, de cette façon, il sera facile de créer une pull request dans la branche testing et de discuter avec les autres packagers de ce que vous suggérez de changer. Pour créer une nouvelle branche et passer à cette branche, vous pouvez utiliser `git checkout -b my_new_branch`. -#### `git commit` +### `git commit` Faire un commit, c'est simplement valider son travail dans Git. Comme vous pouvez le faire dans GitHub. Pour avoir les mêmes champs que vous aviez sur GitHub, avec le nom du commit, et une explication plus longue. Vous pouvez simplement utiliser `git commit`. @@ -194,15 +200,17 @@ La première ligne, avant les commentaires, est pour le nom du commit. Après tous les commentaires, vous pouvez ajouter une explication si vous le souhaitez. Si vous voulez faire un commit avec seulement un nom pour votre commit, vous pouvez utiliser une simple commande : + ```bash git commit -m "My commit name" ``` -#### `git push` vers le dépôt distant +### `git push` vers le dépôt distant Vos modifications sont validées, mais uniquement sur votre clone local du dépôt. Maintenant, vous devez renvoyer ces modifications sur le dépôt distant sur GitHub. Pour ce faire, vous devez savoir quelle est votre branche actuelle. (Si vous ne le savez pas, `git branch` vous donnera cette information). Ensuite, vous pouvez git push + ```bash git push -u origin BRANCH_NAME ``` diff --git a/pages/06.contribute/10.packaging_apps/80.resources/03.git/packaging_apps_git.md b/pages/06.contribute/10.packaging_apps/80.resources/03.git/packaging_apps_git.md index 7a6f58520..8df77e680 100644 --- a/pages/06.contribute/10.packaging_apps/80.resources/03.git/packaging_apps_git.md +++ b/pages/06.contribute/10.packaging_apps/80.resources/03.git/packaging_apps_git.md @@ -19,7 +19,7 @@ Let's go first for the easy part, GitHub comes with an "easy" web interface to d *First things first, unfortunately there's no way around, you need an account on GitHub.* -#### Branches +### Branches Then, probably one of the most important thing, **do not work directly on the master branch**. Sorry, it has to be said ! @@ -32,7 +32,7 @@ The usual thing to do is to work from the testing branch, and when everything is To see and change the current branch, use this button: ![](image://github_branch.png) -#### Edit a file +### Edit a file Now that you're on the right branch, let's see how to edit a file on GitHub. @@ -42,7 +42,7 @@ You can edit any file by using the small pencil icon: If you don't have the permission to write on the repository, you will see (as on the picture) that you're going to create a fork (we'll see below what a fork is). If you have the permission to write, you will just edit the file, without forking. -#### Commit your changes +### Commit your changes When you're done with your modification on the file, you can commit your changes. Behind that word, the idea is quite simple, you're just going to save your changes... @@ -54,7 +54,7 @@ The second field is a large one for a more complete explanation, if you need it. Finally, if you're editing a repository on which you have permission to write, you can either commit directly to the current branch or create a new branch. It's usually better to create a new branch, that way you keep your modifications on a *parallel* version of the repository. Your modifications will be discussed in a pull request (explained below) then finally merged into the original branch. -#### To fork or not to fork +### To fork or not to fork A fork is a copy of a repository into your own account. We have seen before that if you don't have permission to write into a repository, editing a file will automatically create a fork. @@ -69,7 +69,7 @@ We have seen how to edit a file, and how this could fork the app. But, when you want to edit multiple files, the GitHub interface isn't really the best way. In such situation, you would rather clone the repository and work on a local repository. You may still need to fork on your own account to be able to save your modifications if you don't have the permission on the distant repository. -#### Pull request +### Pull request After you have committed your changes, whether on a branch or a fork, you want to propose your modifications to be integrated into the main repository, or the original branch. To do so, you're going to *create a pull request*. GitHub usually ask you directly if you want to do so. @@ -78,7 +78,7 @@ Otherwise, you'll find the button to create a pull request just here: When creating a pull request from a fork, to ease the work of the reviewers, **do never** uncheck the checkbox *Allow edits from maintainers*. That option simply allow the maintainers of the original repository to edit directly your work. -#### YunoHost-Apps organization +### YunoHost-Apps organization Following the [guide for packaging application within YunoHost](/packaging_apps_intro), your app has to be into the YunoHost-Apps organization, but if you have never contributed to an app before or never had any app into this organization you may not have the permission. @@ -89,7 +89,6 @@ At the bottom of the page, you will find *Transfer ownership*. Into the field *New owner’s GitHub username or organization name*, type *YunoHost-Apps*. Your repo will be moved into the organization, you don't have to remove the original repository. - ## Working with Git locally As we have seen, you can do a lot of things directly on GitHub. @@ -97,7 +96,7 @@ But when you need to edit multiple files, or when you need to work on your code Before going to the hellish part of Git, let's see two different ways to start working with Git. -#### First case: Creating a new package +### First case: Creating a new package You have shockingly discovered that the wonderful app you love to use everyday does not yet have its YunoHost package. And because you're nice, you decided to create yourself the package, so everyone will enjoy that app the way you do. What a good idea! @@ -105,19 +104,21 @@ What a good idea! The best is to start from the [example app](https://github.com/YunoHost/example_ynh). But as we have explained before, you don't want to fork, because if you do so, you're going to keep that link to the example app and it's really annoying. So, you're going to do it differently. You're going to clone! -##### git clone +#### git clone To clone, you're going to do: + ```bash git clone https://github.com/YunoHost/example_ynh ``` + `git clone` will download a copy of the repository. You will have the complete repository, with its branches, commits, and everything (into that apparently little `.git` directory). To git clone is usually the starting point of any local work with Git. *A side note though, if you expect to send your modifications back to the distant repository on GitHub, be sure to have the permission to write on this repository. Otherwise, fork before and clone your fork, on which you do have the permission.* -##### My brand new package, continued +#### My brand new package, continued In the context of a new package, you will also need to create a repository on GitHub to nest your package. Which is as simple as a big green *New* button. @@ -132,27 +133,29 @@ Copy all the files from the example_ynh app, **except the .git directory** (You You're ready to work on your new package ! -#### Second case: Working locally on a repository +### Second case: Working locally on a repository You already have a repository, but what you want is just to work locally, so you can modify multiple files. Simply clone the repository, the .git directory is the link to the distant repository. Nothing else to do than a `git clone`. -#### Branches +### Branches You do have your local copy of the repository, but because you have read carefully this documentation until then, you know that you should be sure to be on the testing branch before starting to work. To see the branches, and to know on which you actually are, while into the directory of your repository, type `git branch`. The current branch is highlighted and preceded by a `*`. -#### `git checkout` +### `git checkout` If it appears that you're not on the branch you wanted to be, or you're actually on master (which is bad !), you can move to another branch with `git checkout` + ```bash git checkout testing ``` + *Read carefully what Git says when you validate a command, do never forget that Git is sneaky...* -#### `git pull` before anything else +### `git pull` before anything else You're finally on the right branch, and ready to work. **Wait ! A nasty trap is waiting for you...** @@ -161,17 +164,20 @@ Before ending up in an inextricable situation. Start with a `git pull` to update *Sometimes, you will encounter an impossible situation where Git is saying that you can't pull because you have local changes. But you don't care of those local modifications, you just want to get the last version of the distant branch. But Git don't care about what YOU want...* *I have to admit that my only solution is as highly efficient as dirty... A good old `rm -r` of the repository and a `git clone`* -#### Let's work +### Let's work Eventually, you can work on your code. When you are finally ok with what you have done, it's time to validate your work. The first step is to inform Git about which file(s) to validate. To do so, we'll use `git add` + ```bash git add my_file git add my_other_file and_also_this_one ``` + If you want to validate all your work, you can also simply do + ```bash git add --all ``` @@ -179,14 +185,14 @@ git add --all To check the current status of your validation, you can use `git status`. It will show you which files will be included into your commit, and which files are modified, but not yet included. `git status -v` will show also which part of the files are modified. A good way to be sure that you didn't make a mistake before committing. -#### `git checkout -b` +### `git checkout -b` Before committing, or after, or before starting to work. Whenever you feel like it ! You should consider adding your work to a separate branch, that way, it will be easy to create a pull request to merge into the testing branch and discuss with the other packagers what you suggest to change. To create a new branch and move to this branch, you can use `git checkout -b my_new_branch`. -#### `git commit` +### `git commit` To commit is simply to validate your work in Git. As you can do in GitHub. To have the same fields that you had on GitHub, with the name of the commit, and a longer explanation. You can simply use `git commit`. @@ -194,15 +200,17 @@ The first line, before the comments, is for the name of the commit. After all the comments, you can add an explanation if you want to. If you want to commit with only a name for your commit, you can use a simple command: + ```bash git commit -m "My commit name" ``` -#### Push to the distant repository +### Push to the distant repository Your changes are validated, but only on your local clone of the repository. Now, you have to send those modifications back to the distant repository on GitHub. In order to do that, you need to know what is your current branch. (If you don't know, `git branch` will give you that info). Then you can git push + ```bash git push -u origin BRANCH_NAME ``` diff --git a/pages/06.contribute/10.packaging_apps/80.resources/04.virtualbox/packaging_apps_virtualbox.fr.md b/pages/06.contribute/10.packaging_apps/80.resources/04.virtualbox/packaging_apps_virtualbox.fr.md index d132ab692..eba5dea02 100644 --- a/pages/06.contribute/10.packaging_apps/80.resources/04.virtualbox/packaging_apps_virtualbox.fr.md +++ b/pages/06.contribute/10.packaging_apps/80.resources/04.virtualbox/packaging_apps_virtualbox.fr.md @@ -20,7 +20,7 @@ Nous parlerons ici de VirtualBox, pour son approche graphique facile à utiliser ## Installer VirtualBox -Depuis un système GNU/Linux, installer simplement le paquet `virtualbox-qt`. +Depuis un système GNU/Linux, installer simplement le paquet `virtualbox-qt`. Depuis un système Windows ou macOS, il faudra se référer à la page de [téléchargement de VirtualBox](https://www.virtualbox.org/wiki/Downloads) pour récupérer le fichier d'installation adéquat. Le paquet virtualbox est déprécié depuis Debian 9, un fichier d'installation `.deb` est disponible sur la même page. Quel que soit votre système, il ne devrait pas être nécessaire d'installer l'extension pack ou les additions invités. @@ -83,6 +83,7 @@ On se connecte à la machine virtuelle comme à n'importe quel serveur YunoHost, ```bash ssh admin@mon.domain ``` + Ou, si le domaine n'a pas été ajouté dans le hosts, en utilisant son ip. ```bash diff --git a/pages/06.contribute/10.packaging_apps/80.resources/04.virtualbox/packaging_apps_virtualbox.md b/pages/06.contribute/10.packaging_apps/80.resources/04.virtualbox/packaging_apps_virtualbox.md index 4a3c12afd..d81eda8b0 100644 --- a/pages/06.contribute/10.packaging_apps/80.resources/04.virtualbox/packaging_apps_virtualbox.md +++ b/pages/06.contribute/10.packaging_apps/80.resources/04.virtualbox/packaging_apps_virtualbox.md @@ -82,6 +82,7 @@ Virtual machine connection is similar to any YunoHost server connection, that is ```bash ssh admin@my.domain ``` + Or, if the domain has not been added to the `hosts` file, via its IP address. ```bash diff --git a/pages/06.contribute/10.packaging_apps/80.resources/11.helpers/packaging_apps_helpers.md b/pages/06.contribute/10.packaging_apps/80.resources/11.helpers/packaging_apps_helpers.md index b21bc6ee6..444f3dcda 100644 --- a/pages/06.contribute/10.packaging_apps/80.resources/11.helpers/packaging_apps_helpers.md +++ b/pages/06.contribute/10.packaging_apps/80.resources/11.helpers/packaging_apps_helpers.md @@ -9,27 +9,27 @@ routes: Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/doc/generate_helper_doc.py) on 01/03/2024 (YunoHost version 11.2.10.3) - ## APPS #### ynh_install_apps + [details summary="Install others YunoHost apps" class="helper-card-subtitle text-muted"] **Usage**: `ynh_install_apps --apps="appfoo?domain=domain.foo&path=/foo appbar?domain=domain.bar&path=/bar&admin=USER&language=fr&is_public=1&pass?word=pass&port=666"` **Arguments**: + - `-a`, `--apps=`: apps to install **Details**:
Requires YunoHost version *.*.* or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apps#L9) [/details] ---------------- #### ynh_remove_apps + [details summary="Remove other YunoHost apps" class="helper-card-subtitle text-muted"] **Usage**: `ynh_remove_apps` @@ -39,28 +39,22 @@ Other YunoHost apps will be removed only if no other apps need them. Requires YunoHost version *.*.* or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apps#L65) [/details] ---------------- #### ynh_spawn_app_shell + [details summary="Spawn a Bash shell with the app environment loaded" class="helper-card-subtitle text-muted"] **Usage**: `ynh_spawn_app_shell --app="app" | arg: -a, --app= - the app ID` **Examples**: - - -- ` ynh_spawn_app_shell --app="APP" <<< 'echo "$USER"'` - - - -- ` ynh_spawn_app_shell --app="APP" < /tmp/some_script.bash` - - + +- `ynh_spawn_app_shell --app="APP" <<< 'echo "$USER"'` + +- `ynh_spawn_app_shell --app="APP" < /tmp/some_script.bash` **Details**:
Requires YunoHost version 11.0.* or higher, and that the app relies on packaging v2 or higher. @@ -68,21 +62,20 @@ The spawned shell will have environment variables loaded and environment files s from the app's service configuration file (defaults to $app.service, overridable by the packager with `service` setting). If the app relies on a specific PHP version, then `php` will be aliased that version. The PHP command will also be appended with the `phpflags` settings. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apps#L128) [/details] ---------------- - ## APT #### ynh_package_is_installed + [details summary="Check either a package is installed or not" class="helper-card-subtitle text-muted"] **Usage**: `ynh_package_is_installed --package=name` **Arguments**: + - `-p`, `--package=`: the package name to check **Returns**: 0 if the package is installed, 1 else. @@ -92,18 +85,18 @@ If the app relies on a specific PHP version, then `php` will be aliased that ver **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L53) [/details] ---------------- #### ynh_package_version + [details summary="Get the version of an installed package" class="helper-card-subtitle text-muted"] **Usage**: `ynh_package_version --package=name` **Arguments**: + - `-p`, `--package=`: the package name to get version **Returns**: the version or an empty string @@ -113,13 +106,12 @@ Requires YunoHost version 2.2.4 or higher. **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L75) [/details] ---------------- #### ynh_package_update + [details summary="Update package index files" class="helper-card-subtitle text-muted"] **Usage**: `ynh_package_update` @@ -127,86 +119,86 @@ Requires YunoHost version 2.2.4 or higher. **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L107) [/details] ---------------- #### ynh_package_install + [details summary="Install package(s)" class="helper-card-subtitle text-muted"] **Usage**: `ynh_package_install name [name [...]]` **Arguments**: + - `name`: the package name to install **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L117) [/details] ---------------- #### ynh_package_remove + [details summary="Remove package(s)" class="helper-card-subtitle text-muted"] **Usage**: `ynh_package_remove name [name [...]]` **Arguments**: + - `name`: the package name to remove **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L128) [/details] ---------------- #### ynh_package_autoremove + [details summary="Remove package(s) and their uneeded dependencies" class="helper-card-subtitle text-muted"] **Usage**: `ynh_package_autoremove name [name [...]]` **Arguments**: + - `name`: the package name to remove **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L138) [/details] ---------------- #### ynh_package_autopurge + [details summary="Purge package(s) and their uneeded dependencies" class="helper-card-subtitle text-muted"] **Usage**: `ynh_package_autopurge name [name [...]]` **Arguments**: + - `name`: the package name to autoremove and purge **Details**:
Requires YunoHost version 2.7.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L148) [/details] ---------------- #### ynh_install_app_dependencies + [details summary="Define and install dependencies with a equivs control file" class="helper-card-subtitle text-muted"] **Usage**: `ynh_install_app_dependencies dep [dep [...]]` **Arguments**: + - `dep`: the package name to install in dependence. - `"dep1|dep2|…"`: You can specify alternatives. It will require to install (dep1 or dep2, etc). @@ -217,30 +209,29 @@ example : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5" Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L225) [/details] ---------------- #### ynh_add_app_dependencies + [details summary="Add dependencies to install with ynh_install_app_dependencies" class="helper-card-subtitle text-muted"] **Usage**: `ynh_add_app_dependencies --package=phpversion [--replace]` **Arguments**: + - `-p`, `--package=`: Packages to add as dependencies for the app. **Details**:
Requires YunoHost version 3.8.1 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L338) [/details] ---------------- #### ynh_remove_app_dependencies + [details summary="Remove fake package and its dependencies" class="helper-card-subtitle text-muted"] **Usage**: `ynh_remove_app_dependencies` @@ -250,18 +241,18 @@ Dependencies will removed only if no other package need them. Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L357) [/details] ---------------- #### ynh_install_extra_app_dependencies + [details summary="Install packages from an extra repository properly." class="helper-card-subtitle text-muted"] **Usage**: `ynh_install_extra_app_dependencies --repo="repo" --package="dep1 dep2" [--key=key_url] [--name=name]` **Arguments**: + - `-r`, `--repo=`: Complete url of the extra repository. - `-p`, `--package=`: The packages to install from this extra repository - `-k`, `--key=`: url to get the public key. @@ -270,21 +261,20 @@ Requires YunoHost version 2.6.4 or higher. **Details**:
Requires YunoHost version 3.8.1 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/apt#L391) [/details] ---------------- - ## BACKUP #### ynh_backup + [details summary="Add a file or a directory to the list of paths to backup" class="helper-card-subtitle text-muted"] **Usage**: `ynh_backup --src_path=src_path [--dest_path=dest_path] [--is_big] [--not_mandatory]` **Arguments**: + - `-s`, `--src_path=`: file or directory to bind or symlink or copy. it shouldn't be in the backup dir. - `-d`, `--dest_path=`: destination file or directory inside the backup dir - `-b`, `--is_big`: Indicate data are big (mail, video, image ...) @@ -299,6 +289,7 @@ creates the parent destination directory If `dest_path` is ended by a slash it complete this path with the basename of `src_path`. Example in the context of a wordpress app : + ``` ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" # => This line will be added into CSV file @@ -343,13 +334,12 @@ all backups for this app until the setting is removed. Requires YunoHost version 2.4.0 or higher. Requires YunoHost version 3.5.0 or higher for the argument `--not_mandatory` - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L64) [/details] ---------------- #### ynh_restore + [details summary="Restore all files that were previously backuped in a core backup script or app backup script" class="helper-card-subtitle text-muted"] **Usage**: `ynh_restore` @@ -357,36 +347,29 @@ Requires YunoHost version 3.5.0 or higher for the argument `--not_mandatory` **Details**:
Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L179) [/details] ---------------- #### ynh_restore_file + [details summary="Restore a file or a directory" class="helper-card-subtitle text-muted"] **Usage**: `ynh_restore_file --origin_path=origin_path [--dest_path=dest_path] [--not_mandatory]` **Arguments**: + - `-o`, `--origin_path=`: Path where was located the file or the directory before to be backuped or relative path to $YNH_CWD where it is located in the backup archive - `-d`, `--dest_path=`: Path where restore the file or the dir. If unspecified, the destination will be `ORIGIN_PATH` or if the `ORIGIN_PATH` doesn't exist in the archive, the destination will be searched into `backup.csv` - `-m`, `--not_mandatory`: Indicate that if the file is missing, the restore process can ignore it. **Examples**: - - -- ` ynh_restore_file -o "/etc/nginx/conf.d/$domain.d/$app.conf"` - - - + +- `ynh_restore_file -o "/etc/nginx/conf.d/$domain.d/$app.conf"` + - `You can also use relative paths:` - - - -- ` ynh_restore_file -o "conf/nginx.conf"` - - + +- `ynh_restore_file -o "conf/nginx.conf"` **Details**:
Use the registered path in backup_list by ynh_backup to restore the file at the right place. @@ -402,18 +385,18 @@ if no, search for a match in the csv (eg: conf/nginx.conf) and restore it into Requires YunoHost version 2.6.4 or higher. Requires YunoHost version 3.5.0 or higher for the argument --not_mandatory - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L238) [/details] ---------------- #### ynh_store_file_checksum + [details summary="Calculate and store a file checksum into the app settings" class="helper-card-subtitle text-muted"] **Usage**: `ynh_store_file_checksum --file=file` **Arguments**: + - `-f`, `--file=`: The file on which the checksum will performed, then stored. **Details**:
@@ -421,18 +404,18 @@ $app should be defined when calling this helper Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L306) [/details] ---------------- #### ynh_backup_if_checksum_is_different + [details summary="Verify the checksum and backup the file if it's different" class="helper-card-subtitle text-muted"] **Usage**: `ynh_backup_if_checksum_is_different --file=file` **Arguments**: + - `-f`, `--file=`: The file on which the checksum test will be perfomed. **Returns**: the name of a backup file, or nothing @@ -443,18 +426,18 @@ modified config files. Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L357) [/details] ---------------- #### ynh_delete_file_checksum + [details summary="Delete a file checksum from the app settings" class="helper-card-subtitle text-muted"] **Usage**: `ynh_delete_file_checksum --file=file` **Arguments**: + - `-f`, `--file=`: The file for which the checksum will be deleted **Details**:
@@ -462,19 +445,19 @@ $app should be defined when calling this helper Requires YunoHost version 3.3.1 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L397) [/details] ---------------- #### ynh_backup_before_upgrade + [details summary="Make a backup in case of failed upgrade" class="helper-card-subtitle text-muted"] **Usage**: `ynh_backup_before_upgrade` **Details**:
Usage in a package script: + ``` ynh_backup_before_upgrade ynh_clean_setup () { @@ -485,19 +468,19 @@ Usage in a package script: Requires YunoHost version 2.7.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L432) [/details] ---------------- #### ynh_restore_upgradebackup + [details summary="Restore a previous backup if the upgrade process failed" class="helper-card-subtitle text-muted"] **Usage**: `ynh_restore_upgradebackup` **Details**:
Usage in a package script: + ``` ynh_backup_before_upgrade ynh_clean_setup () { @@ -508,25 +491,23 @@ Usage in a package script: Requires YunoHost version 2.7.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/backup#L480) [/details] ---------------- - ## CONFIG - ## FAIL2BAN #### ynh_add_fail2ban_config + [details summary="Create a dedicated fail2ban config (jail and filter conf files)" class="helper-card-subtitle text-muted"] **Usage**: `1: ynh_add_fail2ban_config --logpath=log_file --failregex=filter [--max_retry=max_retry] [--ports=ports] 2: ynh_add_fail2ban_config --use_template` **Arguments**: + - `-l`, `--logpath=`: Log file to be checked by fail2ban - `-r`, `--failregex=`: Failregex to be looked for by fail2ban - `-m`, `--max_retry=`: Maximum number of retries allowed before banning IP address - default: 3 @@ -541,6 +522,7 @@ See the documentation of `ynh_add_config` for a description of the template format and how placeholders are replaced with actual variables. Generally your template will look like that by example (for synapse): + ``` f2b_jail.conf: [__APP__] @@ -550,6 +532,7 @@ f2b_jail.conf: logpath = /var/log/__APP__/logfile.log maxretry = 3 ``` + ``` f2b_filter.conf: [INCLUDES] @@ -574,22 +557,22 @@ matched by a group named "`host`". The tag "``" can be used for standard IP/hostname matching and is only an alias for `(?:::f{4,6}:)?(?P[\w\-.^_]+)` You can find some more explainations about how to make a regex here : -https://www.fail2ban.org/wiki/index.php/MANUAL_0_8#Filters + To validate your regex you can test with this command: + ``` fail2ban-regex /var/log/YOUR_LOG_FILE_PATH /etc/fail2ban/filter.d/YOUR_APP.conf ``` Requires YunoHost version 4.1.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/fail2ban#L62) [/details] ---------------- #### ynh_remove_fail2ban_config + [details summary="Remove the dedicated fail2ban config (jail and filter conf files)" class="helper-card-subtitle text-muted"] **Usage**: `ynh_remove_fail2ban_config` @@ -597,24 +580,22 @@ Requires YunoHost version 4.1.0 or higher. **Details**:
Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/fail2ban#L134) [/details] ---------------- - ## GETOPTS - ## HARDWARE #### ynh_get_ram + [details summary="Get the total or free amount of RAM+swap on the system" class="helper-card-subtitle text-muted"] **Usage**: `ynh_get_ram [--free|--total] [--ignore_swap|--only_swap]` **Arguments**: + - `-f`, `--free`: Count free RAM+swap - `-t`, `--total`: Count total RAM+swap - `-s`, `--ignore_swap`: Ignore swap, consider only real RAM @@ -625,18 +606,18 @@ Requires YunoHost version 3.5.0 or higher. **Details**:
Requires YunoHost version 3.8.1 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/hardware#L13) [/details] ---------------- #### ynh_require_ram + [details summary="Return 0 or 1 depending if the system has a given amount of RAM+swap free or total" class="helper-card-subtitle text-muted"] **Usage**: `ynh_require_ram --required=RAM [--free|--total] [--ignore_swap|--only_swap]` **Arguments**: + - `-r`, `--required=`: The amount to require, in MB - `-f`, `--free`: Count free RAM+swap - `-t`, `--total`: Count total RAM+swap @@ -648,90 +629,89 @@ Requires YunoHost version 3.8.1 or higher. **Details**:
Requires YunoHost version 3.8.1 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/hardware#L75) [/details] ---------------- - ## LOGGING #### ynh_die + [details summary="Print a message to stderr and exit" class="helper-card-subtitle text-muted"] **Usage**: `ynh_die --message=MSG [--ret_code=RETCODE]` **Arguments**: + - `-m`, `--message=`: Message to display - `-c`, `--ret_code=`: Exit code to exit with **Details**:
Requires YunoHost version 2.4.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L10) [/details] ---------------- #### ynh_print_info + [details summary="Display a message in the 'INFO' logging category" class="helper-card-subtitle text-muted"] **Usage**: `ynh_print_info --message="Some message"` **Arguments**: + - `-m`, `--message=`: Message to display **Details**:
Requires YunoHost version 3.2.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L30) [/details] ---------------- #### ynh_print_warn + [details summary="Print a warning on stderr" class="helper-card-subtitle text-muted"] **Usage**: `ynh_print_warn --message="Text to print"` **Arguments**: + - `-m`, `--message=`: The text to print **Details**:
Requires YunoHost version 3.2.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L56) [/details] ---------------- #### ynh_print_err + [details summary="Print an error on stderr" class="helper-card-subtitle text-muted"] **Usage**: `ynh_print_err --message="Text to print"` **Arguments**: + - `-m`, `--message=`: The text to print **Details**:
Requires YunoHost version 3.2.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L73) [/details] ---------------- #### ynh_exec_err + [details summary="Execute a command and print the result as an error" class="helper-card-subtitle text-muted"] **Usage**: `ynh_exec_err your command and args` **Arguments**: + - `command`: command to execute **Details**:
@@ -739,18 +719,18 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_err Requires YunoHost version 3.2.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L92) [/details] ---------------- #### ynh_exec_warn + [details summary="Execute a command and print the result as a warning" class="helper-card-subtitle text-muted"] **Usage**: `ynh_exec_warn your command and args` **Arguments**: + - `command`: command to execute **Details**:
@@ -758,18 +738,18 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_warn Requires YunoHost version 3.2.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L113) [/details] ---------------- #### ynh_exec_warn_less + [details summary="Execute a command and force the result to be printed on stdout" class="helper-card-subtitle text-muted"] **Usage**: `ynh_exec_warn_less your command and args` **Arguments**: + - `command`: command to execute **Details**:
@@ -777,18 +757,18 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_warn Requires YunoHost version 3.2.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L134) [/details] ---------------- #### ynh_exec_quiet + [details summary="Execute a command and redirect stdout in /dev/null" class="helper-card-subtitle text-muted"] **Usage**: `ynh_exec_quiet your command and args` **Arguments**: + - `command`: command to execute **Details**:
@@ -796,18 +776,18 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_warn Requires YunoHost version 3.2.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L155) [/details] ---------------- #### ynh_exec_fully_quiet + [details summary="Execute a command and redirect stdout and stderr in /dev/null" class="helper-card-subtitle text-muted"] **Usage**: `ynh_exec_quiet your command and args` **Arguments**: + - `command`: command to execute **Details**:
@@ -815,18 +795,18 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_quie Requires YunoHost version 3.2.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L176) [/details] ---------------- #### ynh_exec_and_print_stderr_only_if_error + [details summary="Execute a command and redirect stderr in /dev/null. Print stderr on error." class="helper-card-subtitle text-muted"] **Usage**: `ynh_exec_and_print_stderr_only_if_error your command and args` **Arguments**: + - `command`: command to execute **Details**:
@@ -834,18 +814,18 @@ Note that you should NOT quote the command but only prefix it with ynh_exec_and_ Requires YunoHost version 11.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L197) [/details] ---------------- #### ynh_script_progression + [details summary="Print a progress bar showing the progression of an app script" class="helper-card-subtitle text-muted"] **Usage**: `ynh_script_progression --message=message [--weight=weight] [--time]` **Arguments**: + - `-m`, `--message=`: The text to print - `-w`, `--weight=`: The weight for this progression. This value is 1 by default. Use a bigger value for a longer part of the script. - `-t`, `--time`: Print the execution time since the last call to this helper. Especially usefull to define weights. The execution time is given for the duration since the previous call. So the weight should be applied to this previous call. @@ -854,13 +834,12 @@ Requires YunoHost version 11.2 or higher. **Details**:
Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L257) [/details] ---------------- #### ynh_return + [details summary="Return data to the YunoHost core for later processing (to be used by special hooks like app config panel and core diagnosis)" class="helper-card-subtitle text-muted"] @@ -869,21 +848,20 @@ Requires YunoHost version 3.5.0 or higher. **Details**:
Requires YunoHost version 3.6.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logging#L345) [/details] ---------------- - ## LOGROTATE #### ynh_use_logrotate + [details summary="Use logrotate to manage the logfile" class="helper-card-subtitle text-muted"] **Usage**: `ynh_use_logrotate [--logfile=/log/file] [--specific_user=user/group]` **Arguments**: + - `-l`, `--logfile=`: absolute path of logfile - `-u`, `--specific_user=`: run logrotate as the specified user and group. If not specified logrotate is runned as root. @@ -893,13 +871,12 @@ If no `--logfile` is provided, `/var/log/$app` will be used as default. Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logrotate#L15) [/details] ---------------- #### ynh_remove_logrotate + [details summary="Remove the app's logrotate config." class="helper-card-subtitle text-muted"] **Usage**: `ynh_remove_logrotate` @@ -907,16 +884,14 @@ Requires YunoHost version 2.6.4 or higher. **Details**:
Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/logrotate#L99) [/details] ---------------- - ## MULTIMEDIA #### ynh_multimedia_build_main_dir + [details summary="Initialize the multimedia directory system" class="helper-card-subtitle text-muted"] **Usage**: `ynh_multimedia_build_main_dir` @@ -924,18 +899,18 @@ Requires YunoHost version 2.6.4 or higher. **Details**:
Requires YunoHost version 4.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/multimedia#L11) [/details] ---------------- #### ynh_multimedia_addfolder + [details summary="Add a directory in yunohost.multimedia" class="helper-card-subtitle text-muted"] **Usage**: `ynh_multimedia_addfolder --source_dir="source_dir" --dest_dir="dest_dir"` **Arguments**: + - `-s`, `--source_dir=`: Source directory - The real directory which contains your medias. - `-d`, `--dest_dir=`: Destination directory - The name and the place of the symbolic link, relative to "/home/yunohost.multimedia" @@ -944,104 +919,98 @@ This "directory" will be a symbolic link to a existing directory. Requires YunoHost version 4.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/multimedia#L64) [/details] ---------------- #### ynh_multimedia_addaccess + [details summary="Allow an user to have an write authorisation in multimedia directories" class="helper-card-subtitle text-muted"] **Usage**: `ynh_multimedia_addaccess user_name` **Arguments**: + - `-u`, `--user_name=`: The name of the user which gain this access. **Details**:
Requires YunoHost version 4.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/multimedia#L93) [/details] ---------------- - ## MYSQL #### ynh_mysql_connect_as + [details summary="Open a connection as a user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_mysql_connect_as --user=user --password=password [--database=database]` **Arguments**: + - `-u`, `--user=`: the user name to connect as - `-p`, `--password=`: the user password - `-d`, `--database=`: the database to connect to **Examples**: - - -- ` ynh_mysql_connect_as --user="user" --password="pass" <<< "UPDATE ...;"` - - - -- ` ynh_mysql_connect_as --user="user" --password="pass" < /path/to/file.sql` - - -**Details**:
-Requires YunoHost version 2.2.4 or higher. +- `ynh_mysql_connect_as --user="user" --password="pass" <<< "UPDATE ...;"` +- `ynh_mysql_connect_as --user="user" --password="pass" < /path/to/file.sql` +**Details**:
+Requires YunoHost version 2.2.4 or higher. [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L15) [/details] ---------------- #### ynh_mysql_execute_as_root + [details summary="Execute a command as root user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_mysql_execute_as_root --sql=sql [--database=database]` **Arguments**: + - `-s`, `--sql=`: the SQL command to execute - `-d`, `--database=`: the database to connect to **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L36) [/details] ---------------- #### ynh_mysql_execute_file_as_root + [details summary="Execute a command from a file as root user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_mysql_execute_file_as_root --file=file [--database=database]` **Arguments**: + - `-f`, `--file=`: the file containing SQL commands - `-d`, `--database=`: the database to connect to **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L60) [/details] ---------------- #### ynh_mysql_dump_db + [details summary="Dump a database" class="helper-card-subtitle text-muted"] **Usage**: `ynh_mysql_dump_db --database=database` **Arguments**: + - `-d`, `--database=`: the database name to dump **Returns**: The mysqldump output @@ -1051,18 +1020,18 @@ Requires YunoHost version 2.2.4 or higher. **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L128) [/details] ---------------- #### ynh_mysql_user_exists + [details summary="Check if a mysql user exists" class="helper-card-subtitle text-muted"] **Usage**: `ynh_mysql_user_exists --user=user` **Arguments**: + - `-u`, `--user=`: the user for which to check existence **Returns**: 0 if the user exists, 1 otherwise. @@ -1070,18 +1039,18 @@ Requires YunoHost version 2.2.4 or higher. **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L160) [/details] ---------------- #### ynh_mysql_setup_db + [details summary="Create a database, an user and its password. Then store the password in the app's config" class="helper-card-subtitle text-muted"] **Usage**: `ynh_mysql_setup_db --db_user=user --db_name=name [--db_pwd=pwd]` **Arguments**: + - `-u`, `--db_user=`: Owner of the database - `-n`, `--db_name=`: Name of the database - `-p`, `--db_pwd=`: Password of the database. If not provided, a password will be generated @@ -1092,39 +1061,38 @@ It will also be stored as "`mysqlpwd`" into the app settings. Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L198) [/details] ---------------- #### ynh_mysql_remove_db + [details summary="Remove a database if it exists, and the associated user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_mysql_remove_db --db_user=user --db_name=name` **Arguments**: + - `-u`, `--db_user=`: Owner of the database - `-n`, `--db_name=`: Name of the database **Details**:
Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/mysql#L224) [/details] ---------------- - ## NETWORK #### ynh_find_port + [details summary="Find a free port and return it" class="helper-card-subtitle text-muted"] **Usage**: `ynh_find_port --port=begin_port` **Arguments**: + - `-p`, `--port=`: port to start to search **Returns**: the port number @@ -1134,18 +1102,18 @@ Requires YunoHost version 2.6.4 or higher. **Details**:
Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/network#L12) [/details] ---------------- #### ynh_port_available + [details summary="Test if a port is available" class="helper-card-subtitle text-muted"] **Usage**: `ynh_find_port --port=XYZ` **Arguments**: + - `-p`, `--port=`: port to check **Returns**: 0 if the port is available, 1 if it is already used by another process. @@ -1155,18 +1123,18 @@ Requires YunoHost version 2.6.4 or higher. **Details**:
Requires YunoHost version 3.8.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/network#L36) [/details] ---------------- #### ynh_validate_ip4 + [details summary="Validate an IPv4 address" class="helper-card-subtitle text-muted"] **Usage**: `ynh_validate_ip4 --ip_address=ip_address` **Arguments**: + - `-i`, `--ip_address=`: the ipv4 address to check **Returns**: 0 for valid ipv4 addresses, 1 otherwise @@ -1176,18 +1144,18 @@ Requires YunoHost version 3.8.0 or higher. **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/network#L99) [/details] ---------------- #### ynh_validate_ip6 + [details summary="Validate an IPv6 address" class="helper-card-subtitle text-muted"] **Usage**: `ynh_validate_ip6 --ip_address=ip_address` **Arguments**: + - `-i`, `--ip_address=`: the ipv6 address to check **Returns**: 0 for valid ipv6 addresses, 1 otherwise @@ -1197,16 +1165,14 @@ Requires YunoHost version 2.2.4 or higher. **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/network#L119) [/details] ---------------- - ## NGINX #### ynh_add_nginx_config + [details summary="Create a dedicated nginx config" class="helper-card-subtitle text-muted"] **Usage**: `ynh_add_nginx_config` @@ -1217,6 +1183,7 @@ See the documentation of `ynh_add_config` for a description of the template format and how placeholders are replaced with actual variables. Additionally, ynh_add_nginx_config will replace: + - `#sub_path_only` by empty string if `path_url` is not `'/'` - `#root_path_only` by empty string if `path_url` *is* `'/'` @@ -1225,13 +1192,12 @@ location Requires YunoHost version 4.1.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nginx#L19) [/details] ---------------- #### ynh_remove_nginx_config + [details summary="Remove the dedicated nginx config" class="helper-card-subtitle text-muted"] **Usage**: `ynh_remove_nginx_config` @@ -1239,13 +1205,12 @@ Requires YunoHost version 4.1.0 or higher. **Details**:
Requires YunoHost version 2.7.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nginx#L41) [/details] ---------------- #### ynh_change_url_nginx_config + [details summary="Regen the nginx config in a change url context" class="helper-card-subtitle text-muted"] **Usage**: `ynh_change_url_nginx_config` @@ -1253,16 +1218,14 @@ Requires YunoHost version 2.7.2 or higher. **Details**:
Requires YunoHost version 11.1.9 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nginx#L52) [/details] ---------------- - ## NODEJS #### ynh_use_nodejs + [details summary="Load the version of node for an app, and set variables." class="helper-card-subtitle text-muted"] **Usage**: `ynh_use_nodejs` @@ -1289,36 +1252,41 @@ Exemple: $ynh_node_load_PATH $final_path/script_that_use_npm.sh` Finally, to start a nodejs service with the correct version, 2 solutions Either the app is dependent of node or npm, but does not called it directly. In such situation, you need to load PATH : + ``` Environment="__NODE_ENV_PATH__" ExecStart=__FINALPATH__/my_app ``` -You will replace __NODE_ENV_PATH__ with $ynh_node_load_PATH. + +You will replace **NODE_ENV_PATH** with $ynh_node_load_PATH. Or node start the app directly, then you don't need to load the PATH variable + ``` ExecStart=__YNH_NODE__ my_app run ``` -You will replace __YNH_NODE__ with $ynh_node -2 other variables are also available - - $nodejs_path: The absolute path to node binaries for the chosen version. - - $nodejs_version: Just the version number of node for this app. Stored as 'nodejs_version' in settings.yml. +You will replace **YNH_NODE** with $ynh_node -Requires YunoHost version 2.7.12 or higher. +2 other variables are also available +- $nodejs_path: The absolute path to node binaries for the chosen version. +- $nodejs_version: Just the version number of node for this app. Stored as 'nodejs_version' in settings.yml. +Requires YunoHost version 2.7.12 or higher. [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nodejs#L52) [/details] ---------------- #### ynh_install_nodejs + [details summary="Install a specific version of nodejs" class="helper-card-subtitle text-muted"] **Usage**: `ynh_install_nodejs --nodejs_version=nodejs_version` **Arguments**: + - `-n`, `--nodejs_version=`: Version of node to install. When possible, your should prefer to use major version number (e.g. 8 instead of 8.10.0). The crontab will then handle the update of minor versions when needed. **Details**:
@@ -1331,34 +1299,32 @@ Refer to `ynh_use_nodejs` for more information about available commands and vari Requires YunoHost version 2.7.12 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nodejs#L92) [/details] ---------------- #### ynh_remove_nodejs + [details summary="Remove the version of node used by the app." class="helper-card-subtitle text-muted"] **Usage**: `ynh_remove_nodejs` **Details**:
This helper will check if another app uses the same version of node. + - If not, this version of node will be removed. - If no other app uses node, n will be also removed. Requires YunoHost version 2.7.12 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/nodejs#L165) [/details] ---------------- - ## PERMISSION #### ynh_permission_create + [details summary="Create a new permission for the app" class="helper-card-subtitle text-muted"] **Usage**: `ynh_permission_create --permission="permission" [--url="url"] [--additional_urls="second-url" [ "third-url" ]] [--auth_header=true|false] @@ -1366,6 +1332,7 @@ Requires YunoHost version 2.7.12 or higher. [--protected=true|false]` **Arguments**: + - `-p`, `--permission=`: the name for the permission (by default a permission named "main" already exist) - `-u`, `--url=`: (optional) URL for which access will be allowed/forbidden. Note that if 'show_tile' is enabled, this URL will be the URL of the tile. - `-A`, `--additional_urls=`: (optional) List of additional URL for which access will be allowed/forbidden @@ -1380,6 +1347,7 @@ Example 1: `ynh_permission_create --permission=admin --url=/admin --additional_u --label="My app admin" --show_tile=true` This example will create a new permission permission with this following effect: + - A tile named "My app admin" in the SSO will be available for the users alice and bob. This tile will point to the relative url '/admin'. - Only the user alice and bob will have the access to theses following url: /admin, domain.tld/admin, /superadmin @@ -1408,6 +1376,7 @@ For example: re:domain.tld/app/api/[A-Z]*$ -> domain.tld/app/api/[A-Z]*$ Note that globally the parameter 'url' and 'additional_urls' are same. The only difference is: + - 'url' is only one url, 'additional_urls' can be a list of urls. There are no limitation of 'additional_urls' - 'url' is used for the url of tile in the SSO (if enabled with the 'show_tile' parameter) @@ -1418,22 +1387,22 @@ The SSO pass (by default) to the application theses following HTTP header (linke - "Email": user email Generally this feature is usefull to authenticate automatically the user in the application but in some case the application don't work with theses header and theses header need to be disabled to have the application to work correctly. -See https://github.com/YunoHost/issues/issues/1420 for more informations +See for more informations Requires YunoHost version 3.7.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L66) [/details] ---------------- #### ynh_permission_delete + [details summary="Remove a permission for the app (note that when the app is removed all permission is automatically removed)" class="helper-card-subtitle text-muted"] **Usage**: `ynh_permission_delete --permission="permission"` **Arguments**: + - `-p`, `--permission=`: the name for the permission (by default a permission named "main" is removed automatically when the app is removed) **Example**: `ynh_permission_delete --permission=editors` @@ -1441,37 +1410,37 @@ Requires YunoHost version 3.7.0 or higher. **Details**:
Requires YunoHost version 3.7.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L152) [/details] ---------------- #### ynh_permission_exists + [details summary="Check if a permission exists" class="helper-card-subtitle text-muted"] **Usage**: `ynh_permission_exists --permission=permission | exit: Return 1 if the permission doesn't exist, 0 otherwise` **Arguments**: + - `-p`, `--permission=`: the permission to check **Details**:
Requires YunoHost version 3.7.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L169) [/details] ---------------- #### ynh_permission_url + [details summary="Redefine the url associated to a permission" class="helper-card-subtitle text-muted"] **Usage**: `ynh_permission_url --permission "permission" [--url="url"] [--add_url="new-url" [ "other-new-url" ]] [--remove_url="old-url" [ "other-old-url" ]] [--auth_header=true|false] [--clear_urls]` **Arguments**: + - `-p`, `--permission=`: the name for the permission (by default a permission named "main" is removed automatically when the app is removed) - `-u`, `--url=`: (optional) URL for which access will be allowed/forbidden. Note that if you want to remove url you can pass an empty sting as arguments (""). - `-a`, `--add_url=`: (optional) List of additional url to add for which access will be allowed/forbidden. @@ -1482,19 +1451,19 @@ Requires YunoHost version 3.7.0 or higher. **Details**:
Requires YunoHost version 3.7.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L192) [/details] ---------------- #### ynh_permission_update + [details summary="Update a permission for the app" class="helper-card-subtitle text-muted"] **Usage**: `ynh_permission_update --permission "permission" [--add="group" ["group" ...]] [--remove="group" ["group" ...]] [--label="label"] [--show_tile=true|false] [--protected=true|false]` **Arguments**: + - `-p`, `--permission=`: the name for the permission (by default a permission named "main" already exist) - `-a`, `--add=`: the list of group or users to enable add to the permission - `-r`, `--remove=`: the list of group or users to remove from the permission @@ -1505,19 +1474,19 @@ Requires YunoHost version 3.7.0 or higher. **Details**:
Requires YunoHost version 3.7.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L260) [/details] ---------------- #### ynh_permission_has_user + [details summary="Check if a permission has an user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_permission_has_user --permission=permission --user=user | exit: Return 1 if the permission doesn't have that user or doesn't exist, 0 otherwise` **Arguments**: + - `-p`, `--permission=`: the permission to check - `-u`, `--user=`: the user seek in the permission @@ -1526,13 +1495,12 @@ Requires YunoHost version 3.7.0 or higher. **Details**:
Requires YunoHost version 3.7.1 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L329) [/details] ---------------- #### ynh_legacy_permissions_exists + [details summary="Check if a legacy permissions exist" class="helper-card-subtitle text-muted"] **Usage**: `ynh_legacy_permissions_exists @@ -1541,13 +1509,12 @@ Requires YunoHost version 3.7.1 or higher. **Details**:
Requires YunoHost version 4.1.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/permission#L359) [/details] ---------------- #### ynh_legacy_permissions_delete_all + [details summary="Remove all legacy permissions" class="helper-card-subtitle text-muted"] **Usage**: `ynh_legacy_permissions_delete_all` @@ -1558,10 +1525,10 @@ Requires YunoHost version 4.1.2 or higher. [/details] ---------------- - ## PHP #### ynh_add_fpm_config + [details summary="Create a dedicated PHP-FPM config" class="helper-card-subtitle text-muted"] **Usage**: `ynh_add_fpm_config` @@ -1586,7 +1553,7 @@ Otherwise, if you want the user to have control over these, we encourage to crea Case 2 (deprecate) : you provided an entire conf/php-fpm.conf -The configuration will be hydrated, replacing __FOOBAR__ placeholders with $foobar values, etc. +The configuration will be hydrated, replacing **FOOBAR** placeholders with $foobar values, etc. The resulting configuration will be deployed to the appropriate place, /etc/php/$phpversion/fpm/pool.d/$app.conf @@ -1626,13 +1593,12 @@ Set as 'high', the process manager will be set at 'static'. There will be always Requires YunoHost version 4.1.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/php#L70) [/details] ---------------- #### ynh_remove_fpm_config + [details summary="Remove the dedicated PHP-FPM config" class="helper-card-subtitle text-muted"] **Usage**: `ynh_remove_fpm_config` @@ -1640,18 +1606,18 @@ Requires YunoHost version 4.1.0 or higher. **Details**:
Requires YunoHost version 2.7.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/php#L284) [/details] ---------------- #### ynh_composer_exec + [details summary="Execute a command with Composer" class="helper-card-subtitle text-muted"] **Usage**: `ynh_composer_exec [--phpversion=phpversion] [--workdir=$install_dir] --commands="commands"` **Arguments**: + - `-v`, `--phpversion`: PHP version to use with composer - `-w`, `--workdir`: The directory from where the command will be executed. Default $install_dir or $final_path - `-c`, `--commands`: Commands to execute. @@ -1659,18 +1625,18 @@ Requires YunoHost version 2.7.2 or higher. **Details**:
Requires YunoHost version 4.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/php#L517) [/details] ---------------- #### ynh_install_composer + [details summary="Install and initialize Composer in the given directory" class="helper-card-subtitle text-muted"] **Usage**: `ynh_install_composer [--phpversion=phpversion] [--workdir=$install_dir] [--install_args="--optimize-autoloader"] [--composerversion=composerversion]` **Arguments**: + - `-v`, `--phpversion`: PHP version to use with composer - `-w`, `--workdir`: The directory from where the command will be executed. Default $install_dir. - `-a`, `--install_args`: Additional arguments provided to the composer install. Argument --no-dev already include @@ -1679,87 +1645,81 @@ Requires YunoHost version 4.2 or higher. **Details**:
Requires YunoHost version 4.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/php#L549) [/details] ---------------- - ## POSTGRESQL #### ynh_psql_connect_as + [details summary="Open a connection as a user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_psql_connect_as --user=user --password=password [--database=database]` **Arguments**: + - `-u`, `--user=`: the user name to connect as - `-p`, `--password=`: the user password - `-d`, `--database=`: the database to connect to **Examples**: - - -- ` ynh_psql_connect_as 'user' 'pass' <<< "UPDATE ...;"` - - - -- ` ynh_psql_connect_as 'user' 'pass' < /path/to/file.sql` - - -**Details**:
-Requires YunoHost version 3.5.0 or higher. +- `ynh_psql_connect_as 'user' 'pass' <<< "UPDATE ...;"` +- `ynh_psql_connect_as 'user' 'pass' < /path/to/file.sql` +**Details**:
+Requires YunoHost version 3.5.0 or higher. [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L18) [/details] ---------------- #### ynh_psql_execute_as_root + [details summary="Execute a command as root user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_psql_execute_as_root --sql=sql [--database=database]` **Arguments**: + - `-s`, `--sql=`: the SQL command to execute - `-d`, `--database=`: the database to connect to **Details**:
Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L39) [/details] ---------------- #### ynh_psql_execute_file_as_root + [details summary="Execute a command from a file as root user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_psql_execute_file_as_root --file=file [--database=database]` **Arguments**: + - `-f`, `--file=`: the file containing SQL commands - `-d`, `--database=`: the database to connect to **Details**:
Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L64) [/details] ---------------- #### ynh_psql_dump_db + [details summary="Dump a database" class="helper-card-subtitle text-muted"] **Usage**: `ynh_psql_dump_db --database=database` **Arguments**: + - `-d`, `--database=`: the database name to dump **Returns**: the psqldump output @@ -1769,54 +1729,54 @@ Requires YunoHost version 3.5.0 or higher. **Details**:
Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L135) [/details] ---------------- #### ynh_psql_user_exists + [details summary="Check if a psql user exists" class="helper-card-subtitle text-muted"] **Usage**: `ynh_psql_user_exists --user=user | exit: Return 1 if the user doesn't exist, 0 otherwise` **Arguments**: + - `-u`, `--user=`: the user for which to check existence **Details**:
Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L168) [/details] ---------------- #### ynh_psql_database_exists + [details summary="Check if a psql database exists" class="helper-card-subtitle text-muted"] **Usage**: `ynh_psql_database_exists --database=database | exit: Return 1 if the database doesn't exist, 0 otherwise` **Arguments**: + - `-d`, `--database=`: the database for which to check existence **Details**:
Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L190) [/details] ---------------- #### ynh_psql_setup_db + [details summary="Create a database, an user and its password. Then store the password in the app's config" class="helper-card-subtitle text-muted"] **Usage**: `ynh_psql_setup_db --db_user=user --db_name=name [--db_pwd=pwd]` **Arguments**: + - `-u`, `--db_user=`: Owner of the database - `-n`, `--db_name=`: Name of the database - `-p`, `--db_pwd=`: Password of the database. If not provided, a password will be generated @@ -1827,57 +1787,56 @@ It will also be stored as "psqlpwd" into the app settings. Requires YunoHost version 2.7.13 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L234) [/details] ---------------- #### ynh_psql_remove_db + [details summary="Remove a database if it exists, and the associated user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_psql_remove_db --db_user=user --db_name=name` **Arguments**: + - `-u`, `--db_user=`: Owner of the database - `-n`, `--db_name=`: Name of the database **Details**:
Requires YunoHost version 2.7.13 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/postgresql#L265) [/details] ---------------- - ## SETTING #### ynh_app_setting_get + [details summary="Get an application setting" class="helper-card-subtitle text-muted"] **Usage**: `ynh_app_setting_get --app=app --key=key` **Arguments**: + - `-a`, `--app=`: the application id - `-k`, `--key=`: the setting to get **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/setting#L10) [/details] ---------------- #### ynh_app_setting_set + [details summary="Set an application setting" class="helper-card-subtitle text-muted"] **Usage**: `ynh_app_setting_set --app=app --key=key --value=value` **Arguments**: + - `-a`, `--app=`: the application id - `-k`, `--key=`: the setting name to set - `-v`, `--value=`: the setting value to set @@ -1885,36 +1844,36 @@ Requires YunoHost version 2.2.4 or higher. **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/setting#L36) [/details] ---------------- #### ynh_app_setting_delete + [details summary="Delete an application setting" class="helper-card-subtitle text-muted"] **Usage**: `ynh_app_setting_delete --app=app --key=key` **Arguments**: + - `-a`, `--app=`: the application id - `-k`, `--key=`: the setting to delete **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/setting#L62) [/details] ---------------- #### ynh_webpath_available + [details summary="Check availability of a web path" class="helper-card-subtitle text-muted"] **Usage**: `ynh_webpath_available --domain=domain --path_url=path` **Arguments**: + - `-d`, `--domain=`: the domain/host of the url - `-p`, `--path_url=`: the web path to check the availability of @@ -1923,18 +1882,18 @@ Requires YunoHost version 2.2.4 or higher. **Details**:
Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/setting#L123) [/details] ---------------- #### ynh_webpath_register + [details summary="Register/book a web path for an app" class="helper-card-subtitle text-muted"] **Usage**: `ynh_webpath_register --app=app --domain=domain --path_url=path` **Arguments**: + - `-a`, `--app=`: the app for which the domain should be registered - `-d`, `--domain=`: the domain/host of the web path - `-p`, `--path_url=`: the web path to be registered @@ -1944,21 +1903,20 @@ Requires YunoHost version 2.6.4 or higher. **Details**:
Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/setting#L145) [/details] ---------------- - ## STRING #### ynh_string_random + [details summary="Generate a random string" class="helper-card-subtitle text-muted"] **Usage**: `ynh_string_random [--length=string_length]` **Arguments**: + - `-l`, `--length=`: the string length to generate (default: 24) - `-f`, `--filter=`: the kind of characters accepted in the output (default: 'A-Za-z0-9') @@ -1969,18 +1927,18 @@ Requires YunoHost version 2.6.4 or higher. **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/string#L13) [/details] ---------------- #### ynh_replace_string + [details summary="Substitute/replace a string (or expression) by another in a file" class="helper-card-subtitle text-muted"] **Usage**: `ynh_replace_string --match_string=match_string --replace_string=replace_string --target_file=target_file` **Arguments**: + - `-m`, `--match_string=`: String to be searched and replaced in the file - `-r`, `--replace_string=`: String that will replace matches - `-f`, `--target_file=`: File in which the string will be replaced. @@ -1991,18 +1949,18 @@ sub-expressions can be used (see sed manual page for more information) Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/string#L40) [/details] ---------------- #### ynh_replace_special_string + [details summary="Substitute/replace a special string by another in a file" class="helper-card-subtitle text-muted"] **Usage**: `ynh_replace_special_string --match_string=match_string --replace_string=replace_string --target_file=target_file` **Arguments**: + - `-m`, `--match_string=`: String to be searched and replaced in the file - `-r`, `--replace_string=`: String that will replace matches - `-t`, `--target_file=`: File in which the string will be replaced. @@ -2013,18 +1971,18 @@ characters, you can't use some regular expressions and sub-expressions. Requires YunoHost version 2.7.7 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/string#L71) [/details] ---------------- #### ynh_sanitize_dbid + [details summary="Sanitize a string intended to be the name of a database" class="helper-card-subtitle text-muted"] **Usage**: `ynh_sanitize_dbid --db_name=name` **Arguments**: + - `-n`, `--db_name=`: name to correct/sanitize **Returns**: the corrected name @@ -2036,21 +1994,20 @@ Underscorify the string (replace - and . by _) Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/string#L103) [/details] ---------------- - ## SYSTEMD #### ynh_add_systemd_config + [details summary="Create a dedicated systemd config" class="helper-card-subtitle text-muted"] **Usage**: `ynh_add_systemd_config [--service=service] [--template=template]` **Arguments**: + - `-s`, `--service=`: Service name (optionnal, `$app` by default) - `-t`, `--template=`: Name of template file (optionnal, this is 'systemd' by default, meaning `../conf/systemd.service` will be used as template) @@ -2062,35 +2019,35 @@ format and how placeholders are replaced with actual variables. Requires YunoHost version 4.1.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/systemd#L15) [/details] ---------------- #### ynh_remove_systemd_config + [details summary="Remove the dedicated systemd config" class="helper-card-subtitle text-muted"] **Usage**: `ynh_remove_systemd_config [--service=service]` **Arguments**: + - `-s`, `--service=`: Service name (optionnal, $app by default) **Details**:
Requires YunoHost version 2.7.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/systemd#L38) [/details] ---------------- #### ynh_systemd_action + [details summary="Start (or other actions) a service, print a log in case of failure and optionnaly wait until the service is completely started" class="helper-card-subtitle text-muted"] **Usage**: `ynh_systemd_action [--service_name=service_name] [--action=action] [ [--line_match="line to match"] [--log_path=log_path] [--timeout=300] [--length=20] ]` **Arguments**: + - `-n`, `--service_name=`: Name of the service to start. Default : `$app` - `-a`, `--action=`: Action to perform with systemctl. Default: start - `-l`, `--line_match=`: Line to match - The line to find in the log to attest the service have finished to boot. If not defined it don't wait until the service is completely started. @@ -2101,21 +2058,20 @@ Requires YunoHost version 2.7.2 or higher. **Details**:
Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/systemd#L67) [/details] ---------------- - ## USER #### ynh_user_exists + [details summary="Check if a YunoHost user exists" class="helper-card-subtitle text-muted"] **Usage**: `ynh_user_exists --username=username` **Arguments**: + - `-u`, `--username=`: the username to check **Returns**: 0 if the user exists, 1 otherwise. @@ -2125,18 +2081,18 @@ Requires YunoHost version 3.5.0 or higher. **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L12) [/details] ---------------- #### ynh_user_get_info + [details summary="Retrieve a YunoHost user information" class="helper-card-subtitle text-muted"] **Usage**: `ynh_user_get_info --username=username --key=key` **Arguments**: + - `-u`, `--username=`: the username to retrieve info from - `-k`, `--key=`: the key to retrieve @@ -2147,13 +2103,12 @@ Requires YunoHost version 2.2.4 or higher. **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L33) [/details] ---------------- #### ynh_user_list + [details summary="Get the list of YunoHost users" class="helper-card-subtitle text-muted"] **Usage**: `ynh_user_list` @@ -2165,18 +2120,18 @@ Requires YunoHost version 2.2.4 or higher. **Details**:
Requires YunoHost version 2.4.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L53) [/details] ---------------- #### ynh_system_user_exists + [details summary="Check if a user exists on the system" class="helper-card-subtitle text-muted"] **Usage**: `ynh_system_user_exists --username=username` **Arguments**: + - `-u`, `--username=`: the username to check **Returns**: 0 if the user exists, 1 otherwise. @@ -2184,18 +2139,18 @@ Requires YunoHost version 2.4.0 or higher. **Details**:
Requires YunoHost version 2.2.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L64) [/details] ---------------- #### ynh_system_group_exists + [details summary="Check if a group exists on the system" class="helper-card-subtitle text-muted"] **Usage**: `ynh_system_group_exists --group=group` **Arguments**: + - `-g`, `--group=`: the group to check **Returns**: 0 if the group exists, 1 otherwise. @@ -2203,18 +2158,18 @@ Requires YunoHost version 2.2.4 or higher. **Details**:
Requires YunoHost version 3.5.0.2 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L82) [/details] ---------------- #### ynh_system_user_create + [details summary="Create a system user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_system_user_create --username=user_name [--home_dir=home_dir] [--use_shell] [--groups="group1 group2"]` **Arguments**: + - `-u`, `--username=`: Name of the system user that will be create - `-h`, `--home_dir=`: Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home - `-s`, `--use_shell`: Create a user using the default login shell if present. If this argument is omitted, the user will be created with /usr/sbin/nologin shell @@ -2222,40 +2177,42 @@ Requires YunoHost version 3.5.0.2 or higher. **Details**:
Create a nextcloud user with no home directory and /usr/sbin/nologin login shell (hence no login capability) : + ``` ynh_system_user_create --username=nextcloud ``` + Create a discourse user using /var/www/discourse as home directory and the default login shell : + ``` ynh_system_user_create --username=discourse --home_dir=/var/www/discourse --use_shell ``` Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L111) [/details] ---------------- #### ynh_system_user_delete + [details summary="Delete a system user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_system_user_delete --username=user_name` **Arguments**: + - `-u`, `--username=`: Name of the system user that will be create **Details**:
Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L153) [/details] ---------------- #### ynh_exec_as + [details summary="Execute a command as another user" class="helper-card-subtitle text-muted"] **Usage**: `ynh_exec_as $USER COMMAND [ARG ...]` @@ -2263,16 +2220,14 @@ Requires YunoHost version 2.6.4 or higher. **Details**:
Requires YunoHost version 4.1.7 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/user#L179) [/details] ---------------- - ## UTILS #### ynh_abort_if_errors + [details summary="Exits if an error occurs during the execution of the script." class="helper-card-subtitle text-muted"] **Usage**: `ynh_abort_if_errors` @@ -2284,24 +2239,25 @@ and a call to `ynh_clean_setup` is triggered if it has been defined by your scri Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L61) [/details] ---------------- #### ynh_setup_source + [details summary="Download, check integrity, uncompress and patch the source from app.src" class="helper-card-subtitle text-muted"] **Usage**: `ynh_setup_source --dest_dir=dest_dir [--source_id=source_id] [--keep="file1 file2"] [--full_replace]` **Arguments**: + - `-d`, `--dest_dir=`: Directory where to setup sources - `-s`, `--source_id=`: Name of the source, defaults to `main` (when the sources resource exists in manifest.toml) or (legacy) `app` otherwise - `-k`, `--keep=`: Space-separated list of files/folders that will be backup/restored in $dest_dir, such as a config file you don't want to overwrite. For example 'conf.json secrets.json logs' (no trailing `/` for folders) - `-r`, `--full_replace=`: Remove previous sources before installing new sources **Details**:
+ #### New 'sources' resources (See also the resources documentation which may be more complete?) @@ -2337,6 +2293,7 @@ platform = "linux/amd64" # (defaults to "linux/$YNH_ARCH") to be used ``` You may also define assets url and checksum per-architectures such as: + ```toml [resources.sources] [resources.sources.main] @@ -2348,13 +2305,12 @@ You may also define assets url and checksum per-architectures such as: In which case ynh_setup_source --dest_dir="$install_dir" will automatically pick the appropriate source depending on the arch - - #### Legacy format '.src' This helper will read `conf/${source_id}.src`, download and install the sources. The src file need to contains: + ``` SOURCE_URL=Address to download the app archive SOURCE_SUM=Sha256 sum @@ -2366,6 +2322,7 @@ SOURCE_PLATFORM=linux/arm64/v8 ``` The helper will: + - Download the specific URL if there is no local archive - Check the integrity with the specific sha256 sum - Uncompress the archive to `$dest_dir`. @@ -2376,18 +2333,18 @@ The helper will: Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L154) [/details] ---------------- #### ynh_local_curl + [details summary="Curl abstraction to help with POST requests to local pages (such as installation forms)" class="helper-card-subtitle text-muted"] **Usage**: `ynh_local_curl "page_uri" "key1=value1" "key2=value2" ...` **Arguments**: + - `page_uri`: Path (relative to `$path_url`) of the page where POST data will be sent - `key1=value1`: (Optionnal) POST key and corresponding value - `key2=value2`: (Optionnal) Another POST key and corresponding value @@ -2402,31 +2359,26 @@ For multiple calls, cookies are persisted between each call for the same app Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L404) [/details] ---------------- #### ynh_add_config + [details summary="Create a dedicated config file from a template" class="helper-card-subtitle text-muted"] **Usage**: `ynh_add_config --template="template" --destination="destination"` **Arguments**: + - `-t`, `--template=`: Template config file to use - `-d`, `--destination=`: Destination of the config file **Examples**: - - -- ` ynh_add_config --template=".env" --destination="$install_dir/.env" use the template file "../conf/.env"` - - - -- ` ynh_add_config --template="/etc/nginx/sites-available/default" --destination="etc/nginx/sites-available/mydomain.conf"` - - + +- `ynh_add_config --template=".env" --destination="$install_dir/.env" use the template file "../conf/.env"` + +- `ynh_add_config --template="/etc/nginx/sites-available/default" --destination="etc/nginx/sites-available/mydomain.conf"` **Details**:
The template can be by default the name of a file in the conf directory @@ -2435,6 +2387,7 @@ of a YunoHost Package, a relative path or an absolute path. The helper will use the template `template` to generate a config file `destination` by replacing the following keywords with global variables that should be defined before calling this helper : + ``` __PATH__ by $path_url __NAME__ by $app @@ -2444,7 +2397,9 @@ that should be defined before calling this helper : __PHPVERSION__ by $YNH_PHP_VERSION (packaging v1 only, packaging v2 uses phpversion setting implicitly set by apt resource) __YNH_NODE_LOAD_PATH__ by $ynh_node_load_PATH ``` + And any dynamic variables that should be defined before calling this helper like: + ``` __DOMAIN__ by $domain __APP__ by $app @@ -2460,18 +2415,18 @@ into the app settings when configuration is done. Requires YunoHost version 4.1.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L488) [/details] ---------------- #### ynh_read_var_in_file + [details summary="Get a value from heterogeneous file (yaml, json, php, python...)" class="helper-card-subtitle text-muted"] **Usage**: `ynh_read_var_in_file --file=PATH --key=KEY` **Arguments**: + - `-f`, `--file=`: the path to the file - `-k`, `--key=`: the key to get - `-a`, `--after=`: the line just before the key (in case of multiple lines with the name of the key in the file) @@ -2485,7 +2440,7 @@ if you have several identical keys in your files Example of line this helpers can managed correctly .yml title: YunoHost documentation - email: 'yunohost@yunohost.org' + email: '' .json "theme": "colib'ris", "port": 8102 @@ -2500,23 +2455,23 @@ Example of line this helpers can managed correctly user => 20 .py USER = 8102 - user = 'https://donate.local' + user = '' CUSTOM['user'] = 'YunoHost' Requires YunoHost version 4.3 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L646) [/details] ---------------- #### ynh_write_var_in_file + [details summary="Set a value into heterogeneous file (yaml, json, php, python...)" class="helper-card-subtitle text-muted"] **Usage**: `ynh_write_var_in_file --file=PATH --key=KEY --value=VALUE` **Arguments**: + - `-f`, `--file=`: the path to the file - `-k`, `--key=`: the key to set - `-v`, `--value=`: the value to set @@ -2525,13 +2480,12 @@ Requires YunoHost version 4.3 or higher. **Details**:
Requires YunoHost version 4.3 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L724) [/details] ---------------- #### ynh_get_debian_release + [details summary="Fetch the Debian release codename" class="helper-card-subtitle text-muted"] **Usage**: `ynh_get_debian_release` @@ -2541,35 +2495,35 @@ Requires YunoHost version 4.3 or higher. **Details**:
Requires YunoHost version 2.7.12 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L839) [/details] ---------------- #### ynh_secure_remove + [details summary="Remove a file or a directory securely" class="helper-card-subtitle text-muted"] **Usage**: `ynh_secure_remove --file=path_to_remove` **Arguments**: + - `-f`, `--file=`: File or directory to remove **Details**:
Requires YunoHost version 2.6.4 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L870) [/details] ---------------- #### ynh_read_manifest + [details summary="Read the value of a key in a ynh manifest file" class="helper-card-subtitle text-muted"] **Usage**: `ynh_read_manifest --manifest="manifest.json" --key="key"` **Arguments**: + - `-m`, `--manifest=`: Path of the manifest to read - `-k`, `--key=`: Name of the key to find @@ -2578,18 +2532,18 @@ Requires YunoHost version 2.6.4 or higher. **Details**:
Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L904) [/details] ---------------- #### ynh_app_upstream_version + [details summary="Read the upstream version from the manifest or `$YNH_APP_MANIFEST_VERSION`" class="helper-card-subtitle text-muted"] **Usage**: `ynh_app_upstream_version [--manifest="manifest.json"]` **Arguments**: + - `-m`, `--manifest=`: Path of the manifest to read **Returns**: the version number of the upstream app @@ -2603,18 +2557,18 @@ For example, if the manifest contains `4.3-2~ynh3` the function will return `4.3 Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L947) [/details] ---------------- #### ynh_app_package_version + [details summary="Read package version from the manifest" class="helper-card-subtitle text-muted"] **Usage**: `ynh_app_package_version [--manifest="manifest.json"]` **Arguments**: + - `-m`, `--manifest=`: Path of the manifest to read **Returns**: the version number of the package @@ -2626,13 +2580,12 @@ For example, if the manifest contains `4.3-2~ynh3` the function will return `3` Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L976) [/details] ---------------- #### ynh_check_app_version_changed + [details summary="Checks the app version to upgrade with the existing app version and returns:" class="helper-card-subtitle text-muted"] **Usage**: `ynh_check_app_version_changed` @@ -2645,18 +2598,18 @@ of it, when it's not needed Requires YunoHost version 3.5.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L997) [/details] ---------------- #### ynh_compare_current_package_version + [details summary="Compare the current package version against another version given as an argument." class="helper-card-subtitle text-muted"] **Usage**: `ynh_compare_current_package_version --comparison (lt|le|eq|ne|ge|gt) --version ` **Arguments**: + - `--comparison`: Comparison type. Could be : `lt` (lower than), `le` (lower or equal), `eq` (equal), `ne` (not equal), `ge` (greater or equal), `gt` (greater than) - `--version`: The version to compare. Need to be a version in the yunohost package version type (like `2.3.1~ynh4`) @@ -2668,6 +2621,7 @@ Requires YunoHost version 3.5.0 or higher. This helper is usually used when we need to do some actions only for some old package versions. Generally you might probably use it as follow in the upgrade script : + ``` if ynh_compare_current_package_version --comparison lt --version 2.3.2~ynh1 then @@ -2677,9 +2631,6 @@ fi Requires YunoHost version 3.8.0 or higher. - - [Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/helpers/utils#L1027) [/details] ---------------- - diff --git a/pages/06.contribute/10.packaging_apps/80.resources/15.appresources/packaging_apps_resources.md b/pages/06.contribute/10.packaging_apps/80.resources/15.appresources/packaging_apps_resources.md index 541eae2d7..cee66560b 100644 --- a/pages/06.contribute/10.packaging_apps/80.resources/15.appresources/packaging_apps_resources.md +++ b/pages/06.contribute/10.packaging_apps/80.resources/15.appresources/packaging_apps_resources.md @@ -9,7 +9,6 @@ routes: Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/4759ff66a7c93df2f654c11086585131744ad61d/doc/generate_resource_doc.py) on 01/03/2024 (YunoHost version 11.2.10.3) - ---------------- ## Apt @@ -17,6 +16,7 @@ Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/47 Create a virtual package in apt, depending on the list of specified packages that the app needs. The virtual packages is called `$app-ynh-deps` (with `_` being replaced by `-` in the app name, see `ynh_install_app_dependencies`) ##### Example + ```toml [resources.apt] packages = ["nyancat", "lolcat", "sl"] @@ -28,15 +28,18 @@ extras.yarn.packages = ["yarn"] ``` ##### Properties + - `packages`: List of packages to be installed via `apt` - `packages_from_raw_bash`: A multi-line bash snippet (using triple quotes as open/close) which should echo additional packages to be installed. Meant to be used for packages to be conditionally installed depending on architecture, debian version, install questions, or other logic. - `extras`: A dict of (repo, key, packages) corresponding to "extra" repositories to fetch dependencies from ##### Provision/Update + - The code literally calls the bash helpers `ynh_install_app_dependencies` and `ynh_install_extra_app_dependencies`, similar to what happens in v1. - Note that when `packages` contains some phpX.Y-foobar dependencies, this will automagically define a `phpversion` setting equal to `X.Y` which can therefore be used in app scripts ($phpversion) or templates (`__PHPVERSION__`) ##### Deprovision + - The code literally calls the bash helper `ynh_remove_app_dependencies` ---------------- @@ -46,18 +49,21 @@ extras.yarn.packages = ["yarn"] Creates a directory to be used by the app as the data store directory, typically where the app multimedia or large assets added by users are located. The corresponding path is stored in the settings as `data_dir`. This resource behaves very similarly to install_dir. ##### Example + ```toml [resources.data_dir] # (empty - defaults are usually okay) ``` ##### Properties + - `dir`: (default: `/home/yunohost.app/__APP__`) The full path of the data dir - `subdirs`: (default: empty list) A list of subdirs to initialize inside the data dir. For example, `['foo', 'bar']` - `owner`: (default: `__APP__:rwx`) The owner (and owner permissions) for the data dir - `group`: (default: `__APP__:rx`) The group (and group permissions) for the data dir ##### Provision/Update + - if the dir path changed and a folder exists at the old location, the folder will be `mv`'ed to the new location - otherwise, creates the directory if it doesn't exists yet - create each subdir declared and which do not exist already @@ -65,10 +71,12 @@ Creates a directory to be used by the app as the data store directory, typically - save the value of `dir` as `data_dir` in the app's settings, which can be then used by the app scripts (`$data_dir`) and conf templates (`__DATA_DIR__`) ##### Deprovision + - (only if the purge option is chosen by the user) recursively deletes the directory if it exists - also delete the corresponding setting ##### Legacy management + - In the past, the setting may have been called `datadir`. The code will automatically rename it as `data_dir`. - As explained in the 'Provision/Update' section, the folder will also be moved if the location changed @@ -83,24 +91,29 @@ NB: only one DB can be handled in such a way (is there really an app that would NB2: no automagic migration will happen in an suddenly change `type` from `mysql` to `postgresql` or viceversa in its life ##### Example + ```toml [resources.database] type = "mysql" # or : "postgresql". Only these two values are supported ``` ##### Properties + - `type`: The database type, either `mysql` or `postgresql` ##### Provision/Update + - (Re)set the `$db_name` and `$db_user` settings with the sanitized app name (replacing `-` and `.` with `_`) - If `$db_pwd` doesn't already exists, pick a random database password and store it in that setting - If the database doesn't exists yet, create the SQL user and DB using `ynh_mysql_create_db` or `ynh_psql_create_db`. ##### Deprovision + - Drop the DB using `ynh_mysql_remove_db` or `ynh_psql_remove_db` - Deletes the `db_name`, `db_user` and `db_pwd` settings ##### Legacy management + - In the past, the sql passwords may have been named `mysqlpwd` or `psqlpwd`, in which case it will automatically be renamed as `db_pwd` ---------------- @@ -110,17 +123,20 @@ type = "mysql" # or : "postgresql". Only these two values are supported Creates a directory to be used by the app as the installation directory, typically where the app sources and assets are located. The corresponding path is stored in the settings as `install_dir` ##### Example + ```toml [resources.install_dir] # (empty - defaults are usually okay) ``` ##### Properties + - `dir`: (default: `/var/www/__APP__`) The full path of the install dir - `owner`: (default: `__APP__:rwx`) The owner (and owner permissions) for the install dir - `group`: (default: `__APP__:rx`) The group (and group permissions) for the install dir ##### Provision/Update + - during install, the folder will be deleted if it already exists (FIXME: is this what we want?) - if the dir path changed and a folder exists at the old location, the folder will be `mv`'ed to the new location - otherwise, creates the directory if it doesn't exists yet @@ -128,9 +144,11 @@ Creates a directory to be used by the app as the installation directory, typical - save the value of `dir` as `install_dir` in the app's settings, which can be then used by the app scripts (`$install_dir`) and conf templates (`__INSTALL_DIR__`) ##### Deprovision + - recursively deletes the directory if it exists ##### Legacy management + - In the past, the setting was called `final_path`. The code will automatically rename it as `install_dir`. - As explained in the 'Provision/Update' section, the folder will also be moved if the location changed @@ -145,6 +163,7 @@ Additional permissions can be created, typically to have a specific tile and/or The list of allowed user/groups may be initialized using the content of the `init_{perm}_permission` question from the manifest, hence `init_main_permission` replaces the `is_public` question and shall contain a group name (typically, `all_users` or `visitors`). ##### Example + ```toml [resources.permissions] main.url = "/" @@ -156,6 +175,7 @@ admin.allowed = "admins" # Assuming the "admins" group exists (cf future devel ``` ##### Properties (for each perm name) + - `url`: The relative URI corresponding to this permission. Typically `/` or `/something`. This property may be omitted for non-web permissions. - `show_tile`: (default: `true` if `url` is defined) Wether or not a tile should be displayed for that permission in the user portal - `allowed`: (default: nobody) The group initially allowed to access this perm, if `init_{perm}_permission` is not defined in the manifest questions. Note that the admin may tweak who is allowed/unallowed on that permission later on, this is only meant to **initialize** the permission. @@ -164,13 +184,16 @@ admin.allowed = "admins" # Assuming the "admins" group exists (cf future devel - `additional_urls`: (default: none) List of additional URL for which access will be allowed/forbidden ##### Provision/Update + - Delete any permissions that may exist and be related to this app yet is not declared anymore - Loop over the declared permissions and create them if needed or update them with the new values ##### Deprovision + - Delete all permission related to this app ##### Legacy management + - Legacy `is_public` setting will be deleted if it exists ---------------- @@ -182,6 +205,7 @@ Book port(s) to be used by the app, typically to be used to the internal reverse Note that because multiple ports can be booked, each properties is prefixed by the name of the port. `main` is a special name and will correspond to the setting `$port`, whereas for example `xmpp_client` will correspond to the setting `$port_xmpp_client`. ##### Example + ```toml [resources.ports] # (empty should be fine for most apps... though you can customize stuff if absolutely needed) @@ -194,20 +218,24 @@ xmpp_client.exposed = "TCP" # here, we're telling that the port needs to be publ ``` ##### Properties (for every port name) + - `default`: The prefered value for the port. If this port is already being used by another process right now, or is booked in another app's setting, the code will increment the value until it finds a free port and store that value as the setting. If no value is specified, a random value between 10000 and 60000 is used. - `exposed`: (default: `false`) Wether this port should be opened on the firewall and be publicly reachable. This should be kept to `false` for the majority of apps than only need a port for internal reverse-proxying! Possible values: `false`, `true`(=`Both`), `Both`, `TCP`, `UDP`. This will result in the port being opened on the firewall, and the diagnosis checking that a program answers on that port. - `fixed`: (default: `false`) Tells that the app absolutely needs the specific value provided in `default`, typically because it's needed for a specific protocol ##### Provision/Update (for every port name) + - If not already booked, look for a free port, starting with the `default` value (or a random value between 10000 and 60000 if no `default` set) - If `exposed` is not `false`, open the port in the firewall accordingly - otherwise make sure it's closed. - The value of the port is stored in the `$port` setting for the `main` port, or `$port_NAME` for other `NAME`s ##### Deprovision + - Close the ports on the firewall if relevant - Deletes all the port settings ##### Legacy management + - In the past, some settings may have been named `NAME_port` instead of `port_NAME`, in which case the code will automatically rename the old setting. ---------------- @@ -263,14 +291,14 @@ Or more complex examples with several element, including one with asset that dep - `prefetch` : `true` (default) or `false`, wether or not to pre-fetch this asset during the provisioning phase of the resource. If several arch-dependent url are provided, YunoHost will only prefetch the one for the current system architecture. - `url` : the asset's URL - - If the asset's URL depend on the architecture, you may instead provide `amd64.url`, `i386.url`, `armhf.url` and `arm64.url` (depending on what architectures are supported), using the same `dpkg --print-architecture` nomenclature as for the supported architecture key in the manifest + - If the asset's URL depend on the architecture, you may instead provide `amd64.url`, `i386.url`, `armhf.url` and `arm64.url` (depending on what architectures are supported), using the same `dpkg --print-architecture` nomenclature as for the supported architecture key in the manifest - `sha256` : the asset's sha256sum. This is used both as an integrity check, and as a layer of security to protect against malicious actors which could have injected malicious code inside the asset... - - Same as `url` : if the asset's URL depend on the architecture, you may instead provide `amd64.sha256`, `i386.sha256`, ... + - Same as `url` : if the asset's URL depend on the architecture, you may instead provide `amd64.sha256`, `i386.sha256`, ... - `format` : The "format" of the asset. It is typically automatically guessed from the extension of the URL (or the mention of "tarball", "zipball" in the URL), but can be set explicitly: - - `tar.gz`, `tar.xz`, `tar.bz2` : will use `tar` to extract the archive - - `zip` : will use `unzip` to extract the archive - - `docker` : useful to extract files from an already-built docker image (instead of rebuilding them locally). Will use `docker-image-extract` - - `whatever`: whatever arbitrary value, not really meaningful except to imply that the file won't be extracted (eg because it's a .deb to be manually installed with dpkg/apt, or a script, or ...) + - `tar.gz`, `tar.xz`, `tar.bz2` : will use `tar` to extract the archive + - `zip` : will use `unzip` to extract the archive + - `docker` : useful to extract files from an already-built docker image (instead of rebuilding them locally). Will use `docker-image-extract` + - `whatever`: whatever arbitrary value, not really meaningful except to imply that the file won't be extracted (eg because it's a .deb to be manually installed with dpkg/apt, or a script, or ...) - `in_subdir`: `true` (default) or `false`, depending on if there's an intermediate subdir in the archive before accessing the actual files. Can also be `N` (an integer) to handle special cases where there's `N` level of subdir to get rid of to actually access the files - `extract` : `true` or `false`. Defaults to `true` for archives such as `zip`, `tar.gz`, `tar.bz2`, ... Or defaults to `false` when `format` is not something that should be extracted. When `extract = false`, the file will only be `mv`ed to the location, possibly renamed using the `rename` value - `rename`: some string like `whatever_your_want`, to be used for convenience when `extract` is `false` and the default name of the file is not practical @@ -312,9 +340,11 @@ autoupdate.version_regex = "^release-v(.*)$" And the autoupdater will use the matched group (here: `4.1`) as the version. ##### Provision/Update + - For elements with `prefetch = true`, will download the asset (for the appropriate architecture) and store them in `/var/cache/yunohost/download/$app/$source_id`, to be later picked up by `ynh_setup_source`. (NB: this only happens during install and upgrade, not restore) ##### Deprovision + - Nothing (just cleanup the cache) ---------------- @@ -324,21 +354,24 @@ And the autoupdater will use the matched group (here: `4.1`) as the version. Provision a system user to be used by the app. The username is exactly equal to the app id ##### Example + ```toml [resources.system_user] # (empty - defaults are usually okay) ``` ##### Properties + - `allow_ssh`: (default: False) Adds the user to the ssh.app group, allowing SSH connection via this user - `allow_sftp`: (default: False) Adds the user to the sftp.app group, allowing SFTP connection via this user - `allow_email`: (default: False) Enable authentication on the mail stack for the system user and send mail using `__APP__@__DOMAIN__`. A `mail_pwd` setting is automatically defined (similar to `db_pwd` for databases). You can then configure the app to use `__APP__` and `__MAIL_PWD__` as SMTP credentials (with host 127.0.0.1). You can also tweak the user-part of the domain-part of the email used by manually defining a custom setting `mail_user` or `mail_domain` - `home`: (default: `/var/www/__APP__`) Defines the home property for this user. NB: unfortunately you can't simply use `__INSTALL_DIR__` or `__DATA_DIR__` for now ##### Provision/Update + - will create the system user if it doesn't exists yet - will add/remove the ssh/sftp.app groups ##### Deprovision -- deletes the user and group +- deletes the user and group diff --git a/pages/06.contribute/10.packaging_apps/80.resources/20.bash_tips/shell_variables_scope.fr.md b/pages/06.contribute/10.packaging_apps/80.resources/20.bash_tips/shell_variables_scope.fr.md index 7226dd7b3..a7e43a92a 100644 --- a/pages/06.contribute/10.packaging_apps/80.resources/20.bash_tips/shell_variables_scope.fr.md +++ b/pages/06.contribute/10.packaging_apps/80.resources/20.bash_tips/shell_variables_scope.fr.md @@ -11,6 +11,7 @@ Les variables existent pour le shell courant et ses enfants uniquement. Un script exécuté depuis le script n'est pas un enfant, c'est un autre shell qui n'héritera que des variables d'environnement du script appelant, pas des variables globales ou locales. Lors de l'appel d'un script, il n'est pas démarré dans le shell courant, mais dans une nouvelle instance de bash qui hérite des variables d'environnements de son parent. + ```bash var1=value1 export var2=value2 @@ -29,30 +30,33 @@ chmod +x other_script.sh # Ici, var1 n'existe pas, seul var2 existe encore. # Car c'est une variable d'environnement. ``` + Dans le shell courant, d'où le script est appelé, faite + ```bash echo $var1 - $var2 ``` -Aucune des 2 variables n'existent, car leur portée se limite au script appelé. Jamais au parent. +Aucune des 2 variables n'existent, car leur portée se limite au script appelé. Jamais au parent. ### Les fonctions dans un script Utiliser une fonction ne change pas la portée des variables. + ```bash var1=value1 export var2=value2 set_variable () { - var3=value3 - export var4=value4 - - echo "$var1" - echo "$var2" - echo "$var3" - echo "$var4" - # Toutes les variables existent ici - # car la fonction hérite des variables du script. + var3=value3 + export var4=value4 + + echo "$var1" + echo "$var2" + echo "$var3" + echo "$var4" + # Toutes les variables existent ici + # car la fonction hérite des variables du script. } set_variable @@ -80,22 +84,23 @@ chmod +x other_script.sh ### L'usage des variables locales Les variables locales sont limitées à une fonction et ses enfants + ```bash var1=value1 export var2=value2 set_variable () { - var3=value3 - export var4=value4 - local var5=value5 - - echo "$var1" - echo "$var2" - echo "$var3" - echo "$var4" - echo "$var5" - # Toutes les variables existent ici - # car la fonction hérite des variables du script. + var3=value3 + export var4=value4 + local var5=value5 + + echo "$var1" + echo "$var2" + echo "$var3" + echo "$var4" + echo "$var5" + # Toutes les variables existent ici + # car la fonction hérite des variables du script. } set_variable @@ -127,25 +132,26 @@ chmod +x other_script.sh L'intérêt d'utiliser une variable locale est donc de limiter cette variable à la seule fonction qui l'a déclaré. Et donc ne pas polluer le script dans sa globalité avec des variables inutile pour ce dernier. Il existe également un second avantage à l'usage d'une variable locale, c'est de ne pas modifier le contenu d'une variable globale. + ```bash var1=value1 var2=value2 var3=value3 set_variable () { - echo "$var1" - echo "$var2" - echo "$var3" + echo "$var1" + echo "$var2" + echo "$var3" - echo "-" + echo "-" - var2=new_value2 - local var3=new_value3 + var2=new_value2 + local var3=new_value3 - echo "$var1" - echo "$var2" - echo "$var3" - # La valeurs de var2 et var3 sont modifiées dans la fonction + echo "$var1" + echo "$var2" + echo "$var3" + # La valeurs de var2 et var3 sont modifiées dans la fonction } set_variable @@ -163,42 +169,43 @@ echo "$var3" Comme vu précédemment, les variables modifiée ou créée dans la fonction affecte le script car la fonction est exécutée dans le même shell que celui-ci. Cela change si on exécute la fonction dans un sous-shell, la fonction devient un enfant qui hérite de son parent uniquement. + ```bash var1=value1 var2=value2 var3=value3 fonction2 () { - echo "-" - echo "var1=$var1" - echo "var2=$var2" - echo "var3=$var3" - echo "var4=$var4" - echo "var5=$var5" - # Même var3, qui est locale, est héritée par la fonction enfant. + echo "-" + echo "var1=$var1" + echo "var2=$var2" + echo "var3=$var3" + echo "var4=$var4" + echo "var5=$var5" + # Même var3, qui est locale, est héritée par la fonction enfant. } set_variable () { - echo "var1=$var1" - echo "var2=$var2" - echo "var3=$var3" - # Les variables sont héritées du parent. - - echo "-" - - var2=new_value2 - local var3=new_value3 - var4=new_value4 - export var5=new_value5 - - echo "var1=$var1" - echo "var2=$var2" - echo "var3=$var3" - echo "var4=$var4" - echo "var5=$var5" - # La valeurs de var2 et var3 sont modifiées dans la fonction - - (fonction2) + echo "var1=$var1" + echo "var2=$var2" + echo "var3=$var3" + # Les variables sont héritées du parent. + + echo "-" + + var2=new_value2 + local var3=new_value3 + var4=new_value4 + export var5=new_value5 + + echo "var1=$var1" + echo "var2=$var2" + echo "var3=$var3" + echo "var4=$var4" + echo "var5=$var5" + # La valeurs de var2 et var3 sont modifiées dans la fonction + + (fonction2) } (set_variable) diff --git a/pages/06.contribute/10.packaging_apps/80.resources/20.bash_tips/shell_variables_scope.md b/pages/06.contribute/10.packaging_apps/80.resources/20.bash_tips/shell_variables_scope.md index c32b55150..667c3aea1 100644 --- a/pages/06.contribute/10.packaging_apps/80.resources/20.bash_tips/shell_variables_scope.md +++ b/pages/06.contribute/10.packaging_apps/80.resources/20.bash_tips/shell_variables_scope.md @@ -11,6 +11,7 @@ Variables exists for the current shell and its children only. Another script executed from the script is not a child, it's another shell which herited only the environment variables from its caller script, not its globals or locals variables. When a script is called, it isn't started in the current shell, but in a new instance of bash which herite environment variables from its parent. + ```bash var1=value1 export var2=value2 @@ -29,30 +30,33 @@ chmod +x other_script.sh # Here, var1 doesn't exist, only var2 still exists. # Because it's an environment variable. ``` + In your current shell, where you launch this script, try + ```bash echo $var1 - $var2 ``` -None of this 2 variables exists, because their scope is limited to the script itself. Never its parent. +None of this 2 variables exists, because their scope is limited to the script itself. Never its parent. ### Functions inside a script Use a function would not change the scope of variables. + ```bash var1=value1 export var2=value2 set_variable () { - var3=value3 - export var4=value4 - - echo "$var1" - echo "$var2" - echo "$var3" - echo "$var4" - # All variables exists here - # Because the function inherite its variables from the script. + var3=value3 + export var4=value4 + + echo "$var1" + echo "$var2" + echo "$var3" + echo "$var4" + # All variables exists here + # Because the function inherite its variables from the script. } set_variable @@ -80,22 +84,23 @@ chmod +x other_script.sh ### The usage of locales variables Locales variables are limited to the function and its children. + ```bash var1=value1 export var2=value2 set_variable () { - var3=value3 - export var4=value4 - local var5=value5 - - echo "$var1" - echo "$var2" - echo "$var3" - echo "$var4" - echo "$var5" - # All variables exists here - # Because the function inherite its variables from the script. + var3=value3 + export var4=value4 + local var5=value5 + + echo "$var1" + echo "$var2" + echo "$var3" + echo "$var4" + echo "$var5" + # All variables exists here + # Because the function inherite its variables from the script. } set_variable @@ -127,25 +132,26 @@ chmod +x other_script.sh Using a local variable is usefull for limit it scope to the function only. And not bother the script in its globality with useless variables. But there's also another advantage with local variable, do not modify the content of a global variable. + ```bash var1=value1 var2=value2 var3=value3 set_variable () { - echo "$var1" - echo "$var2" - echo "$var3" + echo "$var1" + echo "$var2" + echo "$var3" - echo "-" + echo "-" - var2=new_value2 - local var3=new_value3 + var2=new_value2 + local var3=new_value3 - echo "$var1" - echo "$var2" - echo "$var3" - # Values of var2 and var3 are modified in the function. + echo "$var1" + echo "$var2" + echo "$var3" + # Values of var2 and var3 are modified in the function. } set_variable @@ -163,42 +169,43 @@ echo "$var3" As seen previously, modified or created variables in a function can affect the main script because the function is executed in the same shell. But, the things are different if the function is executed in a sub shell, the function become a child which only inherite from its parent. + ```bash var1=value1 var2=value2 var3=value3 fonction2 () { - echo "-" - echo "var1=$var1" - echo "var2=$var2" - echo "var3=$var3" - echo "var4=$var4" - echo "var5=$var5" - # Even var3, which is local, is inherited from the parent function. + echo "-" + echo "var1=$var1" + echo "var2=$var2" + echo "var3=$var3" + echo "var4=$var4" + echo "var5=$var5" + # Even var3, which is local, is inherited from the parent function. } set_variable () { - echo "var1=$var1" - echo "var2=$var2" - echo "var3=$var3" - # Variables are inherited from the parent. - - echo "-" - - var2=new_value2 - local var3=new_value3 - var4=new_value4 - export var5=new_value5 - - echo "var1=$var1" - echo "var2=$var2" - echo "var3=$var3" - echo "var4=$var4" - echo "var5=$var5" - # Values of var2 and var3 are modified in the function. - - (fonction2) + echo "var1=$var1" + echo "var2=$var2" + echo "var3=$var3" + # Variables are inherited from the parent. + + echo "-" + + var2=new_value2 + local var3=new_value3 + var4=new_value4 + export var5=new_value5 + + echo "var1=$var1" + echo "var2=$var2" + echo "var3=$var3" + echo "var4=$var4" + echo "var5=$var5" + # Values of var2 and var3 are modified in the function. + + (fonction2) } (set_variable) diff --git a/pages/06.contribute/10.packaging_apps/packaging_apps_intro.de.md b/pages/06.contribute/10.packaging_apps/packaging_apps_intro.de.md index a5671b8c8..29b49469d 100644 --- a/pages/06.contribute/10.packaging_apps/packaging_apps_intro.de.md +++ b/pages/06.contribute/10.packaging_apps/packaging_apps_intro.de.md @@ -13,7 +13,6 @@ In dieser Dokumentation findest du alle grundlegenden Konzepte und Vokabeln, die Wir werden detailliert beschreiben, was ein YunoHost-Anwendungspaket ist, wie es funktioniert, wie du dein eigenes Paket erstellst und wie du Hilfe findest, wenn du diese benötigst. - ## 1. Paketierungs-Philosophie Die Möglichkeit, Anwendungen einfach aus einem Katalog zu installieren, ist eine Schlüsselfunktion von YunoHost. Während du in den Prozess der YunoHost-Anwendungspaketierung eintauchst, solltest du dich an diese Schlüsselprinzipien erinnern: @@ -26,7 +25,6 @@ Die Möglichkeit, Anwendungen einfach aus einem Katalog zu installieren, ist ein - Bei der Paketierung von YunoHost-Apps geht es **nicht nur um die Installation** von Quellen und Abhängigkeiten: Es geht auch um Wartung (Upgrade, Backup...) und die Integration der App in das YunoHost-Ökosystem (NGINX, SSO/LDAP, Fail2Ban, Anwendungskatalog, UI/UX...) - ## 2. Voraussetzungen In dieser Dokumentation wird vorausgesetzt, dass: @@ -52,34 +50,34 @@ Verschiedene Tools wurden implementiert, um die Anwendung zu testen und ihr Verh Nach einer Weile bildete sich eine Reihe von gemeinsamen Praktiken und Konventionen heraus, die sich in der `example_ynh`-Vorlagenanwendung widerspiegeln und erhalten. Während es für Entwickler verlockend ist, die Namensschemata von Variablen zu ändern oder die Struktur von Skripten zu refaktorisieren, stellt sich heraus, dass es sogar noch wichtiger ist, sich an die gemeinsamen Praktiken zu halten (auch wenn sie willkürlich und nicht elegant sind), um die Wartung aller Anwendungen durch jedes Mitglied der Paketierungsgemeinschaft über alle Repos hinweg zu erleichtern! -Nichtsdestotrotz war die inhärente Struktur von Anwendungen, auch wenn es Helfer gab, schwer und langweilig zu warten, da sie zu viele redundante Codestücke enthielt oder mit seltsamen historischen Konventionen gefüllt war. **Ein neues v2-Format** [wurde entworfen und zu YunoHost 11.1 Anfang 2023 hinzugefügt] (https://github.com/YunoHost/yunohost/pull/1289) in der Hoffnung, das App-Packaging zu modernisieren und zu vereinfachen und die UI/UX von YunoHost zu verbessern. +Nichtsdestotrotz war die inhärente Struktur von Anwendungen, auch wenn es Helfer gab, schwer und langweilig zu warten, da sie zu viele redundante Codestücke enthielt oder mit seltsamen historischen Konventionen gefüllt war. **Ein neues v2-Format** [wurde entworfen und zu YunoHost 11.1 Anfang 2023 hinzugefügt] () in der Hoffnung, das App-Packaging zu modernisieren und zu vereinfachen und die UI/UX von YunoHost zu verbessern. Es wird jedoch [**ein zukünftiges v3-Format**](https://github.com/YunoHost/issues/issues/2136) geben, um die Paketierung von Anwendungen weiter zu vereinfachen (z.B. durch die Übernahme von NGINX/systemd/... Konfigurationen, die Beseitigung der Notwendigkeit, Skripte zum Entfernen/Backup/Wiederherstellen manuell zu schreiben, usw.) - ## 4. Allgemeiner Überblick über die Struktur einer YunoHost-App Eine YunoHost-Anwendung besteht aus einem Git-Repository. Wir empfehlen dir, einen Blick auf diese Code-Repositories zu werfen, um dich mit der Struktur der App-Repositories vertraut zu machen: + - [die `helloworld_ynh` App](https://github.com/YunoHost-Apps/helloworld_ynh) - [die `example_ynh` app](https://github.com/YunoHost/example_ynh), die alle gängigen Funktionen und empfohlenen Formatierungen veranschaulicht - Deine bevorzugte "Real-Life"-App in der [YunoHost-Apps-Organisation](https://github.com/orgs/YunoHost-Apps/repositories) -Unter den in einem Paket enthaltenen Dateien sind die wichtigsten: +Unter den in einem Paket enthaltenen Dateien sind die wichtigsten: - das **Anwendungsmanifest** `manifest.toml` (oder `.json` in der Vergangenheit) - - Dies kann als der Ausweis der Anwendung angesehen werden, der verschiedene Metadaten enthält. - - Sie enthält auch die Fragen, die bei der Installation der Anwendung gestellt werden. - - und eine Reihe von "Ressourcen" zum Initialisieren, wie z.B. herunterzuladende Quellen oder zu installierende apt-Abhängigkeiten + - Dies kann als der Ausweis der Anwendung angesehen werden, der verschiedene Metadaten enthält. + - Sie enthält auch die Fragen, die bei der Installation der Anwendung gestellt werden. + - und eine Reihe von "Ressourcen" zum Initialisieren, wie z.B. herunterzuladende Quellen oder zu installierende apt-Abhängigkeiten - **scripts/** enthält eine Reihe von Bash-Skripten, die den in YunoHost angebotenen Aktionen entsprechen - - `_common.sh`: gemeinsame Variablen oder eigene Funktionen, die in anderen Skripten enthalten sind - - `install`/`remove`: die Installations- und Deinstallationsprozedur - - `upgrade`: die Upgrade-Prozedur - - `backup`/`restore`: die Sicherungs-/Wiederherstellungsprozeduren - - (`change_url`): Ändern des Ortes, an dem die Anwendung in Bezug auf die Webzugriffsurl installiert ist + - `_common.sh`: gemeinsame Variablen oder eigene Funktionen, die in anderen Skripten enthalten sind + - `install`/`remove`: die Installations- und Deinstallationsprozedur + - `upgrade`: die Upgrade-Prozedur + - `backup`/`restore`: die Sicherungs-/Wiederherstellungsprozeduren + - (`change_url`): Ändern des Ortes, an dem die Anwendung in Bezug auf die Webzugriffsurl installiert ist - **conf/** enthält eine Reihe von Konfigurationsvorlagen, die bei der Installation der Anwendung verwendet werden. Hier sind einige Beispiele für häufig vorkommende Dateien: - - `nginx.conf`: die NGINX (=Webserver) Konfigurationsvorlage für diese Anwendung - - systemd.service": die Konfigurationsvorlage für den systemd-Dienst für diese Anwendung - - config.json/yaml/???`: die Konfigurationsvorlage für die Anwendung + - `nginx.conf`: die NGINX (=Webserver) Konfigurationsvorlage für diese Anwendung + - systemd.service": die Konfigurationsvorlage für den systemd-Dienst für diese Anwendung + - config.json/yaml/???`: die Konfigurationsvorlage für die Anwendung Grob gesagt besteht die Installation selbst im Allgemeinen aus den folgenden Vorgängen (die jedoch je nach Komplexität und von der App verwendeten Technologien variieren können) - nicht unbedingt in dieser genauen Reihenfolge: @@ -104,10 +102,9 @@ Grob gesagt besteht die Installation selbst im Allgemeinen aus den folgenden Vor 6. ??? 7. Die Anwendung ist einsatzbereit! - ## 5. Erstellen deines allerersten YunoHost-Pakets -Wenn du nicht wirklich bei Null anfangen willst oder von [`example_ynh`](https://github.com/YunoHost/example_ynh), ist eine gängige Praxis, eine Anwendung zu identifizieren, die derjenigen ähnlich ist, die du zu paketieren versuchst - typischerweise, weil du dich auf die gleichen Technologien stützt -, das entsprechende Code-Repository zu klonen und die verschiedenen Dateien anzupassen. +Wenn du nicht wirklich bei Null anfangen willst oder von [`example_ynh`](https://github.com/YunoHost/example_ynh), ist eine gängige Praxis, eine Anwendung zu identifizieren, die derjenigen ähnlich ist, die du zu paketieren versuchst - typischerweise, weil du dich auf die gleichen Technologien stützt -, das entsprechende Code-Repository zu klonen und die verschiedenen Dateien anzupassen. TODO/FIXME : hier sollten wir eine Reihe von bekannten Anwendungen für klassische Technologien auflisten diff --git a/pages/06.contribute/10.packaging_apps/packaging_apps_intro.fr.md b/pages/06.contribute/10.packaging_apps/packaging_apps_intro.fr.md index d38403312..7417c3f5f 100644 --- a/pages/06.contribute/10.packaging_apps/packaging_apps_intro.fr.md +++ b/pages/06.contribute/10.packaging_apps/packaging_apps_intro.fr.md @@ -13,7 +13,6 @@ Cette documentation a pour but de fournir tous les concepts de base et le vocabu Nous détaillerons ce qu'est un paquet d'applications YunoHost, comment il fonctionne, comment créer votre propre paquet et comment trouver de l'aide si vous en avez besoin. - ## 1. La Philosophie du Packaging La possibilité d'installer facilement des applications à partir d'un catalogue est une caractéristique clé de YunoHost. Alors que vous vous plongez dans le processus de packaging d'applications de YunoHost, vous devez vous souvenir de ces principes clés : @@ -26,7 +25,6 @@ La possibilité d'installer facilement des applications à partir d'un catalogue - Le packaging d'une application YunoHost **ne se limite pas à l'installation** des sources et des dépendances : il concerne également la maintenance (mise à jour, sauvegarde...) et l'intégration de l'application dans l'écosystème YunoHost (NGINX, SSO/LDAP, Fail2Ban, catalogue d'applications, UI/UX...). - ## 2. Prérequis Avant d'entrer dans le vif du sujet, cette documentation part du principe que : @@ -56,30 +54,30 @@ Néanmoins, même si les aides existaient, la structure inhérente des applicati Cependant, [**un futur format v3** est encore à venir](https://github.com/YunoHost/issues/issues/2136) pour simplifier davantage l'empaquetage des applications (comme la prise en charge des configurations NGINX/systemd/..., l'élimination du besoin d'écrire manuellement des scripts de suppression/sauvegarde/restauration, etc.) - ## 4. Aperçu général de la structure d'une application YunoHost Une application YunoHost est construite dans un dépôt Git. Nous vous encourageons à jeter un coup d'oeil à ces dépôts de code pour vous familiariser avec les structures des dépôts d'applications : -- [l'application `helloworld_ynh`](https://github.com/YunoHost-Apps/helloworld_ynh) + +- [l'application `helloworld_ynh`](https://github.com/YunoHost-Apps/helloworld_ynh) - [l'application `example_ynh`](https://github.com/YunoHost/example_ynh) qui contient toutes les fonctionnalités générales et le formattage recommandé - votre application "réelle" préférée dans la liste des dépots [YunoHost-Apps](https://github.com/orgs/YunoHost-Apps/repositories) Parmi les fichiers contenus dans un paquet, les plus importants sont les suivants : - le **manifeste de l'application** `manifest.toml` (ou `.json` dans le passé) - - Il peut être considéré comme la carte d'identité de l'application, contenant diverses métadonnées. - - Il contient également les questions posées lors de l'installation de l'application. - - ainsi qu'un ensemble de "ressource" à initialiser, telles que les sources de l'app à télécharger ou les dépendances apt à installer + - Il peut être considéré comme la carte d'identité de l'application, contenant diverses métadonnées. + - Il contient également les questions posées lors de l'installation de l'application. + - ainsi qu'un ensemble de "ressource" à initialiser, telles que les sources de l'app à télécharger ou les dépendances apt à installer - **scripts/** contient un ensemble de scripts bash correspondant aux actions exposées dans YunoHost - - `_common.sh`: common variables or custom functions included in other scripts - - `install`/`remove` : la procédure d'installation et de suppression - - `upgrade` : la procédure de mise à niveau - - `backup`/`restore` : les procédures de sauvegarde/restauration - - (`change_url`) : changer l'endroit où l'application est installée en termes de son url d'accès web + - `_common.sh`: common variables or custom functions included in other scripts + - `install`/`remove` : la procédure d'installation et de suppression + - `upgrade` : la procédure de mise à niveau + - `backup`/`restore` : les procédures de sauvegarde/restauration + - (`change_url`) : changer l'endroit où l'application est installée en termes de son url d'accès web - **conf/** contient un ensemble de modèles de configuration utilisés lors de l'installation de l'application. Voici quelques exemples de fichiers couramment trouvés : - - `nginx.conf` : le modèle de configuration de NGINX (=serveur web) pour cette application - - `systemd.service` : le modèle de configuration du service systemd pour cette application - - `config.json/yaml/???` : le modèle de configuration de l'application + - `nginx.conf` : le modèle de configuration de NGINX (=serveur web) pour cette application + - `systemd.service` : le modèle de configuration du service systemd pour cette application + - `config.json/yaml/???` : le modèle de configuration de l'application Grosso modo, l'installation proprement dite se compose généralement des opérations suivantes (qui peuvent toutefois varier en fonction de la complexité et des technologies utilisées par l'application) - pas nécessairement dans cet ordre exact : @@ -104,7 +102,6 @@ Grosso modo, l'installation proprement dite se compose généralement des opéra 6. ??? 7. L'application est prête à l'emploi ! - ## 5. Créer votre tout premier paquet YunoHost A moins que vous ne souhaitiez vraiment partir de zéro ou de [`example_ynh`](https://github.com/YunoHost/example_ynh), une pratique courante consiste à identifier une application similaire à celle que vous essayez d'empaqueter - typiquement parce qu'elle repose sur les mêmes technologies - à cloner le dépôt de code correspondant, et à adapter les différents fichiers. diff --git a/pages/06.contribute/10.packaging_apps/packaging_apps_intro.md b/pages/06.contribute/10.packaging_apps/packaging_apps_intro.md index 59df3dc45..0d17c517a 100644 --- a/pages/06.contribute/10.packaging_apps/packaging_apps_intro.md +++ b/pages/06.contribute/10.packaging_apps/packaging_apps_intro.md @@ -13,7 +13,6 @@ This documentation is here to provide all the basic concepts and vocabulary need We will detail what a YunoHost application package is, how it works, how to make your own package and how to find help if you need it. - ## 1. Packaging philosophy The ability to easily install applications from a catalog is a key feature of YunoHost. While you dive in the process of YunoHost application packaging, you should remember these key principles: @@ -26,7 +25,6 @@ The ability to easily install applications from a catalog is a key feature of Yu - YunoHost app packaging is **not just about installing** sources and dependencies: it's also about maintenance (upgrade, backup...) and integrating the app in the YunoHost ecosystem (NGINX, SSO/LDAP, Fail2Ban, application catalog, UI/UX...) - ## 2. Prerequisites Before diving in, this documentation assumes that: @@ -56,30 +54,30 @@ Nevertheless, even though helpers existed, the inherent structure of apps was ha However, [**a future v3 format** has yet to come](https://github.com/YunoHost/issues/issues/2136) to further simplify app packaging (such as taking care of NGINX/systemd/... configurations, removing the need to manually write remove/backup/restore scripts, etc.) - ## 4. General overview of a YunoHost app structure A YunoHost app consists in a Git repository. We encourage you to have a look at those code repository to get familiar witch app repository structures: + - [the `helloworld_ynh` app](https://github.com/YunoHost-Apps/helloworld_ynh) - [the `example_ynh` app](https://github.com/YunoHost/example_ynh) which illustrates all common features and recommended formatting - your favourite "real-life" app in the [YunoHost-Apps organization](https://github.com/orgs/YunoHost-Apps/repositories) -Among the file contained in a package, the most important ones are: +Among the file contained in a package, the most important ones are: - the **app manifest** `manifest.toml` (or `.json` in the past) - - this can be seen as the ID card of the application, containing various metadatas. - - it also contains the questions asked during the installation of the app. - - and a bunch of "resources" to initialize, such as sources to download or apt dependencies to install + - this can be seen as the ID card of the application, containing various metadatas. + - it also contains the questions asked during the installation of the app. + - and a bunch of "resources" to initialize, such as sources to download or apt dependencies to install - **scripts/** contains a bunch of bash scripts corresponding to actions exposed in YunoHost - - `_common.sh`: common variables or custom functions included in other scripts - - `install`/`remove`: the install and remove procedure - - `upgrade`: the upgrade procedure - - `backup`/`restore`: the backup/restore procedures - - (`change_url`): changing where the app is installed in terms of web access url + - `_common.sh`: common variables or custom functions included in other scripts + - `install`/`remove`: the install and remove procedure + - `upgrade`: the upgrade procedure + - `backup`/`restore`: the backup/restore procedures + - (`change_url`): changing where the app is installed in terms of web access url - **conf/** contains a bunch of configuration templates used when installing the app. Here are some example of commonly found files: - - `nginx.conf`: the NGINX (=web server) configuration template for this app - - `systemd.service`: the systemd service configuration template for this app - - `config.json/yaml/???`: the app's configuration template + - `nginx.conf`: the NGINX (=web server) configuration template for this app + - `systemd.service`: the systemd service configuration template for this app + - `config.json/yaml/???`: the app's configuration template Roughly speaking, the install itself generally consists of the following operations (though these may vary depending on the complexity and technologies used by the app) - not necessarily in that exact order: @@ -104,10 +102,9 @@ Roughly speaking, the install itself generally consists of the following operati 6. ??? 7. Application is ready to use! - ## 5. Creating your very first YunoHost package -Unless you really want to start from scratch or from [`example_ynh`](https://github.com/YunoHost/example_ynh), one common practice is to identify an app similar to the one you're trying to package - typically because it relies on the same technologies - clone the corresponding code repository, and adapt the various files. +Unless you really want to start from scratch or from [`example_ynh`](https://github.com/YunoHost/example_ynh), one common practice is to identify an app similar to the one you're trying to package - typically because it relies on the same technologies - clone the corresponding code repository, and adapt the various files. TODO/FIXME : here we should list a bunch of well-knowh apps for classic technologies diff --git a/pages/06.contribute/15.dev/02.maindomain/maindomain.md b/pages/06.contribute/15.dev/02.maindomain/maindomain.md index 9f06c2091..a9ffe8d35 100644 --- a/pages/06.contribute/15.dev/02.maindomain/maindomain.md +++ b/pages/06.contribute/15.dev/02.maindomain/maindomain.md @@ -8,15 +8,16 @@ routes: --- Here is a list of situations in which we use the main domain concept: + - to expose the web portal: currently the web portal is only reachable through the main domain address (could be changed for multi tenant support in future) - to define the hostname of the machine: we believe we do this to avoid some sudo errors (may be it's not relvant anymore or could be made in /etc/hosts) - to TLS encrypt SMTP and dovecot: so user should define the main domain in their email client to avoid TLS warning -- To be able to do mail forwarding using the main domain as Sender Rewriting Scheme Domain see: https://en.wikipedia.org/wiki/Sender_Rewriting_Scheme +- To be able to do mail forwarding using the main domain as Sender Rewriting Scheme Domain see: - to define default email as (root@ abuse@) but we probably should do it on all parent domain instead -- to define `myhostname` in postfix config, used as EHLO and reverseDNS (refering to https://mxtoolbox.com/emailhealth test it should be a FQDN, so a subdomain) +- to define `myhostname` in postfix config, used as EHLO and reverseDNS (refering to test it should be a FQDN, so a subdomain) - to generate the self-signed Local Authority: having just one allow to upload it in a browser and get an x509 authenticated https connexion. - to define default xmpp DNS field: dns field are only set on the main domain by default -Finally we can imagine some apps use the main domain too, see -https://github.com/search?q=org%3AYunoHost-Apps+main_domain&type=code -https://github.com/search?q=org%3AYunoHost-Apps+current_host&type=code +Finally we can imagine some apps use the main domain too, see + + diff --git a/pages/06.contribute/15.dev/03.forms/forms.md b/pages/06.contribute/15.dev/03.forms/forms.md index b7cdd1916..4de117bdb 100644 --- a/pages/06.contribute/15.dev/03.forms/forms.md +++ b/pages/06.contribute/15.dev/03.forms/forms.md @@ -12,6 +12,7 @@ routes: YunoHost uses a lot of forms. You can found here information on supported types question and properties. ## Questions + !!! Questions are called `Options` in the code. ### Generic properties @@ -19,7 +20,7 @@ YunoHost uses a lot of forms. You can found here information on supported types | Property | Scope | Description | Example | |----------|--------------|-------------|---------| | `type` | Everywhere | Specify the type of the question (see bellow for the list) | `type = "string"` | -| `ask` | Everywhere | The title of the question | `ask.en = "Cats or dogs ?"` | +| `ask` | Everywhere | The title of the question | `ask.en = "Cats or dogs ?"` | | `help` | Everywhere | An help message | `help.en = "Think carefully!"` | | `optional`| Everywhere | Set true if the question is not mandatory | `optional = true` | | `readonly`| Everywhere | Avoid user to be able to change the value | `readonly = true` | @@ -31,18 +32,20 @@ YunoHost uses a lot of forms. You can found here information on supported types | `visible` | ConfigPanel | A simple js expression based on other short keys questions to hide or display dynamically the question| `visible = "login && ! private_key"` | | `bind` | AppConfigPanel | See [App configuration panel doc](/packaging_config_panels) | `bind = "__INSTALL_DIR__/config.yml"` | - * `help`, `optional`, `readonly` and `visible` are also available on panels and sections entities. - * Long help messages could not to be correctly displayed for user using yunohost CLI - * For the moment `default` properties are not supported in app config panel and you have to initialize the value by yourself in config file or settings. - +* `help`, `optional`, `readonly` and `visible` are also available on panels and sections entities. +* Long help messages could not to be correctly displayed for user using yunohost CLI +* For the moment `default` properties are not supported in app config panel and you have to initialize the value by yourself in config file or settings. ### `display_text` (readonly) + Display a simple text. ### `markdown` (readonly) + Display a markdown (if you don't use markdown features, prefer display_text) ### `alert` (readonly) + Display an alert box with different style. | Property | Description | Default | @@ -50,6 +53,7 @@ Display an alert box with different style. | `style` | Style of the alert box (success, info, warning, danger) | info | ### `button` + Display a button with different style (useful for custom actions). | Property | Description | Default | @@ -58,9 +62,11 @@ Display a button with different style (useful for custom actions). | `enabled` | Enable or disable the button | True | ### `string` + Input text monoline. ### `text` + Input text multilines | Property | Description | Default | @@ -68,12 +74,15 @@ Input text multilines | `redact` | Style of the alert box (success, info, warning, danger) | success| ### `password` + Password input. `{}` chars are forbidden and value is not added to logs. ### `color` + Hexadecimal color starting with # with a color picker. ### `number` + An integer. | Property | Description | Example | @@ -83,6 +92,7 @@ An integer. | `step` | Steps between each next possible value | | ### `range` + | Property | Description | Example | |----------|--------------|---------| | `min` | Minimal value | | @@ -90,25 +100,32 @@ An integer. | `step` | Steps between each next possible value | | ### `boolean` + | Property | Description | Example | |----------|--------------|---------| | `yes` | | | | `no` | | | ### `date` + A date picker with date in the format YYYY-MM-DD ### `time` + A time picker ### `email` + An email input ### `path` + ### `url` + By default it ask for a web URL but you can change the `pattern` if you want to. ### `file` + File question | Property | Description | Example | @@ -118,6 +135,7 @@ File question ! This file type is not made for big files transfer, it's just for small logo, or config files. ### `select` + Dropdown | Property | Description | Example | @@ -125,6 +143,7 @@ Dropdown | `choices` | list or dictionary of choices | | ### `tags` + Multi choices selection. | Property | Description | Example | @@ -132,13 +151,17 @@ Multi choices selection. | `choices` | List or dictionary of choices | | ### `domain` + List all added domains ### `app` + List all installed apps ### `user` + List all users ### `group` + List all groups diff --git a/pages/07.help/help.it.md b/pages/07.help/help.it.md index 14b1b893f..658b690d2 100644 --- a/pages/07.help/help.it.md +++ b/pages/07.help/help.it.md @@ -16,13 +16,16 @@ Affinché ci sia possibile aiutarvi, sul forum dovete porre le domande seguendo # Come fare -## Siate gentili e pazienti. +## Siate gentili e pazienti + L'aiuto nei gruppi o sul forum viene fornito dai collaboratori e dagli utilizzatori, tutti volontari. A volte succede di avere fretta o essere stressati da tentativi infruttuosi... prendetevi una pausa, bevete un sorso della vostra bevanda rilassante preferita e poi rileggete. Abbiamo bisogno che siate in una buona condizione mentale per potervi aiutare. -## Spiegate il contesto. +## Spiegate il contesto + La richiesta di aiuto deve essere posta in maniera completa e concisa. Spiegate chiaramente cosa volete ottenere e cosa non riuscite a fare. ## Riportate gli errori e i log + Di fondamentale importanza nelle richieste di aiuto è fornire log e messaggi di errore. Se un comando fallisce, YunoHost ci comunica sempre cosa succede, attraverso un codice di errore o un elenco di stringhe apparentemente incomprensibili. Quando qualcosa non va come dovrebbe, trovate dei pulsanti di colore verde "Condividere con YunoPaste" nella pagina dei Servizi nella pagina webadmin. Cliccando sul pulsante si aprirà una pagina web della quale dovrete condividere l'URL. @@ -39,9 +42,11 @@ Gli screenshot sono i benvenuti. # Da non fare assolutamente ## Evitate il terribile [problema XY](https://xyproblem.info/) -In breve, spiegate quando si verifica il problema. Potete illustrare i tentativi intrapresi per risolverlo ma è importante spiegare ***perché*** avete bisogno di questa particolare soluzione. + +In breve, spiegate quando si verifica il problema. Potete illustrare i tentativi intrapresi per risolverlo ma è importante spiegare ***perché*** avete bisogno di questa particolare soluzione. ## Non siate vaghi + Non date per scontato che le vostre spiegazioni siano comprese, non usate scorciatoie, non abbreviate, non semplificate. Non abbreviate i messaggi di errore. Non scrivete "non funziona", "non si installa", "non carica" e ["lo dice il computer"](https://en.wikipedia.org/wiki/Computer_says_no). @@ -55,15 +60,5 @@ Non è necessario chiedere il permesso per chiedere aiuto. Trattandosi di una ch Non fate domande come fosse un sondaggio, ad esempio "Qualcuno è riuscito a fare andare l'applicazione XY?" Se riscontrate dei problemi con un'applicazione spiegate direttamente il problema riscontrato, illustrate il contesto e condividete i log. ## Non rompete le p...e -La partecipazione al forum e alle chat è un privilegio che può essere rimosso. - - - - - - - - - - +La partecipazione al forum e alle chat è un privilegio che può essere rimosso.