Initial version of readme.md for restic-backup, rustdesk, sanoid, and tailscale

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "editor.formatOnSave": true
+}

devices/teal/README.md

@@ -1 +1,28 @@
 Principal storage server and host for most services.
+
+# Services
+
+## SystemD Services
+
+* caddy
+* restic-backup
+* rustdesk
+* sanoid
+* tailscale
+* unbound
+* zfs
+
+## Docker Services
+
+Most applications hosted on teal run in Docker containers.  For details of the Docker configuration of hosted applications, see the Git repository at [https://gitea.objectbrokers.com/cjones/containers.git](https://)
+
+Bound data volumes for Docker-hosted applications are generally found in the ZFS pool in subdirectories of /mnt/storage/appdata.
+
+* [Bookstack](../../services/bookstack/readme.md)
+* [Gitea](../../services/gitea/readme.md)
+* [Immich](../../services/immich/readme.md)
+* [Jellyfin](../../services/jellyfin/readme.md)
+* [JRiver Media Center](../../services/mc/readme.md)
+* [Nextcloud](../../services/nextcloud/readme.md)
+* [Portainer](../../services/portainer/readme.md)
+* [Vaultwarden](../../services/vaultwarden/readme.md)

services/bookstack/readme.md

@@ -0,0 +1 @@
+Bookstack provides a self-hosted wiki.  For general information on Bookstack, see [bookstackapp.com](https://www.bookstackapp.com/)

services/caddy/readme.md

@@ -0,0 +1,9 @@
+caddy is a reverse proxy server providing secure access to https-based applications on teal.  Configuration
+
+of the reverse proxy is found in the file /etc/caddy/Caddyfile.
+
+For general information on caddy see [caddy reverse proxy quick start](https://caddyserver.com/docs/quick-starts/reverse-proxy).
+
+```
+
+```

services/gitea/readme.md

@@ -0,0 +1 @@
+Gitea is the Git source control server for the network.  For general information on Gitea, see [Gitea Official Website](https://about.gitea.com/)

services/immich/readme.md

@@ -0,0 +1 @@
+Immich is a photo backup solution.  For general information on Immich, see [Immich.app](https://immich.app//)

services/jellyfin/readme.md

@@ -0,0 +1 @@
+Jellyfin is the home network's media server.  For general information on Jellyfin, see [jellyfin.org](https://jellyfin.org/)

services/mc/readme.md

@@ -0,0 +1 @@
+mc provides a Docker-hosted implementation of the JRiver Media Center application.

services/nextcloud/readme.md

@@ -0,0 +1,4 @@
+Nextcloud provides file sharing, calendaring, contact management, and other services (depending on the Nextcloud apps installed and enabled).
+
+See https://nextcloud.com/ for general information on Nextcloud.
+

services/nextcloud/upgrading.md

@@ -0,0 +1,16 @@
+Steps to upgrade Nextcloud from one version to another.
+
+1.  Put the Nextcloud instance into maintenance mode
+    docker exec --user www-data nextcloud-app-1 php occ maintenance:mode --on
+
+    Note that 'docker exec' is used to run commands within the Nextcloud docker container; and '--user www-data' is used to run as the user that owns all of the Nextcloud files.
+
+2.  Back up the Nextcloud container's files to a location outside the container's mounted volume.  'rsync' is recommended:
+
+    rsync -Aavx /mnt/storage/appdata/nextcloud/www/ <backup-target-dir>/
+
+    rsync should be run as root.  rsync with these options should preserve file ownership & permissions
+
+3.  Back up MariaDB database:
+
+        docker exec nextcloud-db-container-name mysqldump --single-transaction -h localhost -u nextcloud_user -pnextcloud_password nextcloud_db_name > nextcloud-sqlbkp_$(date +"%Y%m%d").bak

services/portainer/readme.md

@@ -0,0 +1 @@
+Portainer is a web-based management application for Docker containers.  For general information on Portainer, see [Portainer](https://www.portainer.io/)

services/readme.md

@@ -1 +1,2 @@
-This directory documents the services provided by various devices on the network.  There is one subdirectory per service provided.
+This directory documents the services provided by various devices on the network.  There is one subdirectory per service provided.
+

services/restic-backup/readme.md

@@ -0,0 +1,3 @@
+restic-backup is a systemd service to invoke restic to back up selected directories on teal to cygnus (our Synology NAS).  It is based on [restic-automic-backup-scheduler](https://github.com/erikw/restic-automatic-backup-scheduler).
+
+The systemd unit invokes the script /bin/restic_backup.sh.  The specifics of the backup source and target are defined in scripts at /etc/restic.

services/rustdesk/readme.md

@@ -0,0 +1 @@
+systemd service to enable RustDesk for remote access to teal's Gnome desktop.  Installed with the RustDesk package; configuration (if any) is done through the RustDesk UI.

services/sanoid/readme.md

@@ -0,0 +1,3 @@
+Sanoid is a policy-driven snapshot management tool for ZFS filesystems.  It is configured using the TOML file at /etc/sanoid/sanoid.conf.
+
+The sanoid service is currently configured to manage snapshots for the ZFS filesystem at /mnt/storage.

services/tailscale/readme.md

@@ -0,0 +1,3 @@
+The tailscaled service runs the Tailscale Node Agent, which enables the Tailscale VPN.
+
+Configuration of Tailscale is done either through the Tailscale Admin Console or the Tailscale CLI.