From aa3e0c4eae27213c79c242f5cdff1da533c8dff2 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Fri, 3 May 2024 16:57:29 +0200 Subject: [PATCH] doc: misc typo, smoothing --- doc/DESCRIPTION.md | 4 ++-- doc/POST_INSTALL.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 67204f8..07e01d2 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,6 +1,6 @@ A [Borg](https://borgbackup.readthedocs.io/en/stable/index.html#what-is-borgbackup) integration to backup your YunoHost server to another remote server (e.g. one of your friends). -It works This is the Borg Backup App to be installed on a server to backup. It works in combination with the [Borg Server App](https://apps.yunohost.org/app/borgserver) installed on a host server. +This app is the "client" part, meant to be installed on the server to be backed up. It works in combination with the [borg server app](https://apps.yunohost.org/app/borgserver) installed on a diffent machine. ### Features @@ -13,4 +13,4 @@ It works This is the Borg Backup App to be installed on a server to backup. It w ### Install procedure -Maybe counter-intuitively, you should *first* install this app (`borg_ynh`) and *then* (`borgserver_ynh`) on the other machine. In fact, after the install of `borg_ynh`, a message should be displayed with the info, in particular the SSH public key, to be used to setup `borgserver_ynh` on the other machine. +Maybe counter-intuitively, you should *first* install this app (`borg_ynh`) and *then* (`borgserver_ynh`) on the other machine. In fact, at the end of the install of `borg_ynh`, you will be provided with the info, in particular the SSH public key, to be used to setup `borgserver_ynh` on the other machine. diff --git a/doc/POST_INSTALL.md b/doc/POST_INSTALL.md index 3c687a1..9b16f91 100644 --- a/doc/POST_INSTALL.md +++ b/doc/POST_INSTALL.md @@ -1,11 +1,11 @@ You should check out the admin documentation of this app after installation for more info! -If you selected a remote borg server as backup target, you should now install the "Borg Server" app on __SERVER__ and with the following credentials: +If you selected a remote borg server as backup target, you should now install the "Borg Server" app on `__SERVER__` and with the following credentials (you may need to send this to your friend): - User: `__SSH_USER__` - Public key: `__PUBLIC_KEY__` -Or if you want to use command-line: +Or directly using command line: `yunohost app install https://github.com/YunoHost-Apps/borgserver_ynh -a "ssh_user=__SSH_USER__&public_key=__PUBLIC_KEY__"`