diff --git a/README.rst b/README.rst index 2600cf222..f0930da3f 100644 --- a/README.rst +++ b/README.rst @@ -18,7 +18,7 @@ See the `installation manual`_ or, if you have already downloaded Borg, ``docs/installation.rst`` to get started with Borg. There is also an `offline documentation`_ available, in multiple formats. -.. _installation manual: https://borgbackup.readthedocs.org/en/stable/installation.html +.. _installation manual: https://borgbackup.readthedocs.io/en/stable/installation.html .. _offline documentation: https://readthedocs.org/projects/borgbackup/downloads Main features @@ -57,10 +57,10 @@ Main features **Data encryption** All data can be protected using 256-bit AES encryption, data integrity and - authenticity is verified using HMAC-SHA256. Data is encrypted clientside. + authenticity is verified using HMAC-SHA256. Data is encrypted client-side. **Obfuscation** - Optionally, borg can actively obfuscate e.g. the size of files / chunks to + Optionally, Borg can actively obfuscate, e.g., the size of files/chunks to make fingerprinting attacks more difficult. **Compression** @@ -73,24 +73,24 @@ Main features * lzma (low speed, high compression) **Off-site backups** - Borg can store data on any remote host accessible over SSH. If Borg is - installed on the remote host, big performance gains can be achieved - compared to using a network filesystem (sshfs, nfs, ...). + Borg can store data on any remote host accessible over SSH. If Borg is + installed on the remote host, significant performance gains can be achieved + compared to using a network file system (sshfs, NFS, ...). -**Backups mountable as filesystems** - Backup archives are mountable as userspace filesystems for easy interactive - backup examination and restores (e.g. by using a regular file manager). +**Backups mountable as file systems** + Backup archives are mountable as user-space file systems for easy interactive + backup examination and restores (e.g., by using a regular file manager). **Easy installation on multiple platforms** We offer single-file binaries that do not require installing anything - you can just run them on these platforms: * Linux - * Mac OS X + * macOS * FreeBSD * OpenBSD and NetBSD (no xattrs/ACLs support or binaries yet) * Cygwin (experimental, no binaries yet) - * Linux Subsystem of Windows 10 (experimental) + * Windows Subsystem for Linux (WSL) on Windows 10 (experimental) **Free and Open Source Software** * security and functionality can be audited independently @@ -128,9 +128,9 @@ Now doing another backup, just to show off the great deduplication:: ----------------------------------------------------------------------------- -For a graphical frontend refer to our complementary project `BorgWeb `_. +For a graphical frontend, refer to our complementary project `BorgWeb `_. -Helping, Donations and Bounties, becoming a Patron +Helping, donations and bounties, becoming a Patron -------------------------------------------------- Your help is always welcome! @@ -144,17 +144,17 @@ https://www.borgbackup.org/support/fund.html Links ----- -* `Main Web Site `_ +* `Main website `_ * `Releases `_, `PyPI packages `_ and - `ChangeLog `_ -* `Offline Documentation `_ + `Changelog `_ +* `Offline documentation `_ * `GitHub `_ and - `Issue Tracker `_. -* `Web-Chat (IRC) `_ and - `Mailing List `_ -* `License `_ -* `Security contact `_ + `Issue tracker `_. +* `Web chat (IRC) `_ and + `Mailing list `_ +* `License `_ +* `Security contact `_ Compatibility notes ------------------- @@ -175,15 +175,15 @@ see ``docs/support.rst`` in the source distribution). .. |doc| image:: https://readthedocs.org/projects/borgbackup/badge/?version=stable :alt: Documentation - :target: https://borgbackup.readthedocs.org/en/stable/ + :target: https://borgbackup.readthedocs.io/en/stable/ -.. |build| image:: https://github.com/borgbackup/borg/workflows/CI/badge.svg?branch=master - :alt: Build Status (master) +.. |build| image:: https://github.com/borgbackup/borg/workflows/CI/badge.svg?branch=1.4-maint + :alt: Build Status (1.4-maint) :target: https://github.com/borgbackup/borg/actions -.. |coverage| image:: https://codecov.io/github/borgbackup/borg/coverage.svg?branch=master +.. |coverage| image:: https://codecov.io/github/borgbackup/borg/coverage.svg?branch=1.4-maint :alt: Test Coverage - :target: https://codecov.io/github/borgbackup/borg?branch=master + :target: https://codecov.io/github/borgbackup/borg?branch=1.4-maint .. |screencast_basic| image:: https://asciinema.org/a/133292.png :alt: BorgBackup Basic Usage diff --git a/README_WINDOWS.rst b/README_WINDOWS.rst index 520bf47c9..a61324687 100644 --- a/README_WINDOWS.rst +++ b/README_WINDOWS.rst @@ -1,48 +1,48 @@ -Borg Native on Windows +Borg native on Windows ====================== -Running borg natively on windows is in a early alpha stage. Expect many things to fail. -Do not use the native windows build on any data which you do not want to lose! +Running Borg natively on Windows is in an early alpha stage. Expect many things to fail. +Do not use the native Windows build on any data that you do not want to lose! Build Requirements ------------------ - VC 14.0 Compiler -- OpenSSL Library v1.1.1c, 64bit (available at https://github.com/python/cpython-bin-deps) - Please use the `win-download-openssl.ps1` script to download and extract the library to +- OpenSSL Library v1.1.1c, 64-bit (available at https://github.com/python/cpython-bin-deps) + Use the `win-download-openssl.ps1` script to download and extract the library to the correct location. See also the OpenSSL section below. -- Patience and a lot of coffee / beer +- Patience and a lot of coffee/beer What's working -------------- .. note:: The following examples assume that the `BORG_REPO` and `BORG_PASSPHRASE` environment variables are set - if the repo or passphrase is not explicitly given. + when the repository or passphrase is not explicitly provided. - Borg does not crash if called with ``borg`` -- ``borg init --encryption repokey-blake2 ./demoRepo`` runs without an error/warning. - Note that absolute paths only work if the protocol is explicitly set to file:// +- ``borg init --encryption repokey-blake2 ./demoRepo`` runs without errors or warnings. + Note that absolute paths only work if the protocol is explicitly set to ``file://`` - ``borg create ::backup-{now} D:\DemoData`` works as expected. - ``borg list`` works as expected. -- ``borg extract --strip-components 1 ::backup-XXXX`` works. - If absolute paths are extracted, it's important to pass ``--strip-components 1`` as +- ``borg extract --strip-components 1 ::backup-XXXX`` works. + If absolute paths are extracted, it is important to pass ``--strip-components 1``, otherwise the data is restored to the original location! What's NOT working ------------------ -- Extracting a backup which was created on windows machine on a non windows machine will fail. -- And many things more. +- Extracting a backup created on a Windows machine on a non-Windows machine will fail. +- Many other things. OpenSSL, Windows and Python --------------------------- Windows does not ship OpenSSL by default, so we need to get the library from somewhere else. -However, a default python installation does include `libcrypto` which is required by borg. -The only things which are missing to build borg are the header and `*.lib` files. -Luckily the python developers provide all required files in a separate repository. +However, a default Python installation does include `libcrypto`, which is required by Borg. +The only things missing to build Borg are the header and `*.lib` files. +Luckily, the Python developers provide all required files in a separate repository. The `win-download-openssl.ps1` script can be used to download the package from https://github.com/python/cpython-bin-deps and extract the files to the correct location. -For Anaconda, the required libraries can be installed with `conda install -c anaconda openssl`. +For Anaconda, the required libraries can be installed with ``conda install -c anaconda openssl``.