diff --git a/README.md b/README.md index 514fe9d7..d579232f 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,13 @@ [](https://discord.gg/XjgVyXrcEH) > [!WARNING] -> Zerobyte is still in version 0.x.x and is subject to major changes from version to version. I am developing the core features and collecting feedbacks. Please open issues for bugs or feature requests +> Zerobyte is still in version 0.x.x and is subject to major changes from version to version. I am developing the core features and collecting feedback. Please open issues for bugs or feature requests.
-## Intro +## Introduction Zerobyte is a backup automation tool that helps you save your data across multiple storage backends. Built on top of Restic, it provides an modern web interface to schedule, manage, and monitor encrypted backups of your remote storage. @@ -38,10 +38,10 @@ It contains up-to-date setup guides, configuration reference, and usage document ### Features -- **Automated backups** with encryption, compression and retention policies powered by Restic -- **Flexible scheduling** For automated backup jobs with fine-grained retention policies -- **End-to-end encryption** ensuring your data is always protected -- **Multi-protocol support**: Backup from NFS, SMB, WebDAV, SFTP, or local directories +- **Automated backups** with encryption, compression, and retention policies, powered by Restic +- **Flexible scheduling** for automated backup jobs with fine-grained retention policies +- **End-to-end encryption** will ensure your data is always protected +- **Multi-protocol support** for backup from NFS, SMB, WebDAV, SFTP, or local directories ## Installation @@ -69,10 +69,10 @@ services: ``` > [!WARNING] -> It is highly discouraged to run Zerobyte on a server that is accessible from the internet (VPS or home server with port forwarding) If you do, make sure to change the port mapping to "127.0.0.1:4096:4096" and use a secure tunnel (SSH tunnel, Cloudflare Tunnel, etc.) with authentication. +> It is highly discouraged to run Zerobyte on a server that is accessible from the internet (VPS or home server with port forwarding). If you do, make sure to change the port mapping to "127.0.0.1:4096:4096" and use a secure tunnel (SSH tunnel, Cloudflare Tunnel, etc.) with authentication. > [!WARNING] -> Do not try to point `/var/lib/zerobyte` on a network share. You will face permission issues and strong performance degradation. +> Do not try to point `/var/lib/zerobyte` to a network share. You will face permission issues and strong performance degradation. > [!NOTE] > **TrueNAS Users:** The host path `/var/lib` is ephemeral on TrueNAS and will be reset during system upgrades. Instead of using `/var/lib/zerobyte:/var/lib/zerobyte`, create a dedicated ZFS dataset (e.g., `tank/docker/zerobyte`) and mount it instead: @@ -97,7 +97,7 @@ Once the container is running, you can access the web interface at `http://