From e3fdb5c41f92de68e977de57b965be07136d1af0 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Thu, 11 Jul 2024 00:52:08 +0200 Subject: [PATCH] Misc typo, reword, and droping page that are empty or duplicate --- .../clone_filesystem.fr.md | 7 +++--- .../clone_filesystem.it.md | 7 +++--- .../15.clone_filesystem/clone_filesystem.md | 9 ++++---- .../avoid_hardware_failure.md | 10 ++++----- .../install_unpackaged_app.md | 22 ------------------- .../configuration_management.md | 10 --------- .../60.extend/20.helpers/helpers.md | 5 ----- 7 files changed, 18 insertions(+), 52 deletions(-) delete mode 100644 pages/02.administer/60.extend/05.install_unpackaged_app/install_unpackaged_app.md delete mode 100644 pages/02.administer/60.extend/10.configuration_management/configuration_management.md delete mode 100644 pages/02.administer/60.extend/20.helpers/helpers.md 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 bdb8e3f2..f41551da 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 @@ -1,5 +1,5 @@ --- -title: Créer une image du système +title: Créer une image complète du système de fichier template: docs taxonomy: category: docs @@ -10,8 +10,6 @@ page-toc: depth: 3 --- -!! Les images de cette page sont manquantes - L'outil de sauvegarde de YunoHost ne sauvegarde que les fichiers utiles et se base sur des scripts de restauration pour réinstaller les dépendances de vos applications. Autrement dit, le mécanisme de YunoHost revient à réinstaller, puis réincorporer les données. Réaliser des images complètes du système peut être un moyen complémentaire ou alternatif de sauvegarder votre machine. L'intérêt est que votre système pourra être restauré dans l'état exact du moment de la sauvegarde. @@ -38,6 +36,9 @@ Ci-dessous, quelques documentations pour les fournisseurs les plus connus: - [Scaleway (EN)](https://www.scaleway.com/en/docs/backup-your-data-with-snapshots/) [/ui-tab] [ui-tab title="VirtualBox"] + +!! FIXME: Les images sont manquantes dans cet onglet + Sélectionner la machine virtuelle et cliquer sur `Snapshots`, puis spécifier le nom du snapshot et cliquer sur `OK`. ![Le bouton snapshot se trouve en haut à droite](image://virtualbox-snapshot2.webp) 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 c2bd4b78..ecdd396d 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 @@ -1,5 +1,5 @@ --- -title: Create a filesystem image +title: Snapshotting the entire filesystem template: docs taxonomy: category: docs @@ -10,8 +10,6 @@ page-toc: depth: 3 --- -!! Images are missing on this page - Lo strumento di backup di YunoHost salva solamente i files utili e si basa su degli script di ripristino per reinstallare le dipendenze dei vostri programmi installati. In altre parole, il ripristino di YunoHost prevede in un primo tempo la reinstallazione del sistema e in seguito il ripristino dei dati. Realizzare un'immagine completa può essere un metodo, complementare o alternativo, per un backup del vostro server. Il vantaggio sta nel fatto che il vostro server può essere ripristinato nella stessa configurazione presente al momento del backup. @@ -38,6 +36,9 @@ Sotto la documentazione per i provider più conosciuti: - [Scaleway (EN)](https://www.scaleway.com/en/docs/backup-your-data-with-snapshots/) [/ui-tab] [ui-tab title="VirtualBox"] + +!! FIXME: Images are missing in this section + Seleziona la macchina virtuale e clicca su `Snapshot`, poi indica il nome dello snapshot e clicca `OK`. ![Il bottone per gli snapshot button si trova in alto a destra](image://virtualbox-snapshot2.webp) 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 9d32b1d1..ae08ddcc 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 @@ -1,5 +1,5 @@ --- -title: Create a filesystem image +title: Snapshotting the entire filesystem template: docs taxonomy: category: docs @@ -10,15 +10,13 @@ page-toc: depth: 3 --- -!! Images are missing on this page - YunoHost's backup tool only backs up useful files and relies on restore scripts to reinstall the dependencies of your applications. In other words, YunoHost's mechanism amounts to reinstalling and then reincorporating the data. Making full system images can be a complementary or alternative way to backup your machine. The advantage is that your system can be restored to the exact state it was in at the time of the backup. 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 +## Creating 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). @@ -38,6 +36,9 @@ Below, some documentation for the most known suppliers: - [Scaleway (EN)](https://www.scaleway.com/en/docs/backup-your-data-with-snapshots/) [/ui-tab] [ui-tab title="VirtualBox"] + +!! FIXME: Images are missing in this tab + Select the virtual machine and click `Snapshots`, then specify the snapshot name and click `OK`. ![The snapshot button is located at the top right](image://virtualbox-snapshot2.webp) 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 30fe81e5..83e05b7c 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 @@ -1,10 +1,10 @@ --- -title: Avoid hardware failure +title: Prevent hardware failures template: docs taxonomy: category: docs routes: - default: '/backup/avoid_hardware_failure' + default: '/backup/prevent_hardware_failure' page-toc: active: true depth: 3 @@ -17,13 +17,13 @@ Very often people who self-host don't have proper storage for their system. Leav ## 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. +Ideally, your hard disks should be fixed to prevent 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: +To prevent this: ```bash cat /proc/sys/vm/swappiness @@ -48,7 +48,7 @@ In order to limit hardware failures of storage media, it can be relevant to set There are also more advanced clusters that maximize fault tolerance (failure of 2 disks like RAID6) or storage (see RAID 5). -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. +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 prevents 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: diff --git a/pages/02.administer/60.extend/05.install_unpackaged_app/install_unpackaged_app.md b/pages/02.administer/60.extend/05.install_unpackaged_app/install_unpackaged_app.md deleted file mode 100644 index 7fbe171c..00000000 --- a/pages/02.administer/60.extend/05.install_unpackaged_app/install_unpackaged_app.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Install unpackaged apps -template: docs -taxonomy: - category: docs -routes: - default: '/install_unpackaged_apps' ---- - -## PHP or HTML/JS apps - -If your app is a PHP or HTML/JS app, you probably should use the `Custom Webapp`, also know as `my_webapp`, in order to configure nginx, php, mysql, YunoHost permission and backup for you. - -## Other technologies - -If you use some other technology, you should install it like on a classical Debian. - -To expose the app on the web through nginx and be able to manage access permissions to the webapp, you could use the [`redirect` app](https://github.com/YunoHost-Apps/redirect_ynh/) to create a nginx reverse proxy on your local ip/port running the service. - -!!! You should use the proxy mode of the redirect app and not HTTP redirections mode. - -You probably should create custom backup and restore hooks to integrate your app to your YunoHost backup/restore process. See [Backup and restore hooks](/packaging_apps_hooks#backup-restore) diff --git a/pages/02.administer/60.extend/10.configuration_management/configuration_management.md b/pages/02.administer/60.extend/10.configuration_management/configuration_management.md deleted file mode 100644 index 8578ecb6..00000000 --- a/pages/02.administer/60.extend/10.configuration_management/configuration_management.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Configuration management -template: docs -taxonomy: - category: docs -routes: - default: '/configuration_management' ---- - -!! This page is to be written diff --git a/pages/02.administer/60.extend/20.helpers/helpers.md b/pages/02.administer/60.extend/20.helpers/helpers.md deleted file mode 100644 index 9869ed97..00000000 --- a/pages/02.administer/60.extend/20.helpers/helpers.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: App helpers -template: docs -redirect: '/packaging_apps_scripts_helpers' ----