YunoHost-Apps/restic_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/restic_ynh.git synced 2024-09-03 20:16:22 +02:00
Code Issues Activity Actions

Update ADMIN.md

Browse source
This commit is contained in:
Alexandre Aubin 2024-07-10 20:47:13 +02:00 • committed by GitHub
parent 23e05c4b53
commit 6891b390ed
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
doc/ADMIN.md
View file

@ -1,67 +1,22 @@
### Configuring the user on the target server
You should now authorize the public key on the target server using something like:
```
mkdir ~/.ssh -p
touch ~/.ssh/authorized_keys
chmod u=rw,go= ~/.ssh/authorized_keys
cat << EOPKEY >> ~/.ssh/authorized_keys
<paste here the private key displayed at the end of installation>
EOPKEY
```
Optional: to improve security, make sure the user can only connect through SFTP and can only access its home directory on the target server.
On Debian/Ubuntu, this is done using the following snippet. Otherwise refer to your distribution manual (don't forget to replace `servera` with the real username)
```
cat << EOF>> /etc/ssh/sshd_config
Match User servera
ChrootDirectory %h
ForceCommand internal-sftp
AllowTcpForwarding no
X11Forwarding no
EOF
systemctl restart ssh
```
### Test ### Test
At this step your backup should schedule. You can manually trigger backups using: `systemctl start restic.service`
If you want to be sure, you can test it by running on server A: And then make sure to verify the backup contents using: `restic -r sftp:DESTINATION_SERVER:ORIGIN_SERVER/auto_conf snapshots`
```
systemctl start restic.service
```
Next you can verify the backup contents by running on server A (Replace `auto_conf` with `auto_<app>` if you did not choose to backup configuration but only applications)
```
restic -r sftp:serverb.domain.tld:servera.domain.tld/auto_conf snapshots
```
Replace `auto_conf` with `auto_<app>` if you did not choose to backup configuration but only applications.
If you want to check the backups consistency:
```
systemctl start restic_check.service
```
If you want to make a complete check of the backups - keep in mind that this reads all the backed up data, it can take some time depending on your target server upload speed (more on this topic in [the Restic documentation](https://restic.readthedocs.io/en/latest/045_working_with_repos.html#checking-integrity-and-consistency)):
```
systemctl start restic_check_read_data.service
```
### Misc helpful commands ### Misc helpful commands
- Display the apps list to backup: `yunohost app setting restic apps` - Display the apps list to backup: `yunohost app setting restic apps`
- Edit the apps list to backup: `yunohost app setting restic apps -v "nextcloud,wordpress"` - Edit the apps list to backup: `yunohost app setting restic apps -v "nextcloud,wordpress"`
- Launch a backup: `systemctl start restic` - Launch a backup manually: `systemctl start restic`
- Launch a backup check: `systemctl start restic_check.service` - Launch a backup consistency check: `systemctl start restic_check.service`
##### Launch a complete backup check ##### Launch a complete backup check
WARNING: this will read data from your backups destination server.
It may take a quite long time depending on the target server's internet upload speed and hardware performance. If you want to make a complete check of the backups - keep in mind that this reads all the backed up data, it can take some time depending on your target server upload speed (more on this topic in [the Restic documentation](https://restic.readthedocs.io/en/latest/045_working_with_repos.html#checking-integrity-and-consistency)):
``` ```
systemctl start restic_check_read_data.service systemctl start restic_check_read_data.service