From 2fb1957ca4a8424b1052c964ad636c88a40f54b2 Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Tue, 3 Nov 2020 09:20:09 +0100 Subject: [PATCH] Rewrite README as Markdown --- README.md | 114 +++++++++++++++++++++++++++++++++++++++++++++ README.rst | 133 ----------------------------------------------------- 2 files changed, 114 insertions(+), 133 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 000000000..47ffdb499 --- /dev/null +++ b/README.md @@ -0,0 +1,114 @@ +[![Documentation](https://readthedocs.org/projects/restic/badge/?version=latest)](https://restic.readthedocs.io/en/latest/?badge=latest) +[![Build Status Travis](https://travis-ci.com/restic/restic.svg?branch=master)](https://travis-ci.com/restic/restic) +[![Build Status AppVeyor](https://ci.appveyor.com/api/projects/status/nuy4lfbgfbytw92q/branch/master?svg=true)](https://ci.appveyor.com/project/fd0/restic/branch/master) +[![Go Report Card](https://goreportcard.com/badge/github.com/restic/restic)](https://goreportcard.com/report/github.com/restic/restic) + +# Introduction + +restic is a backup program that is fast, efficient and secure. It supports the three major operating systems (Linux, macOS, Windows) and a few smaller ones (FreeBSD, OpenBSD). + +For detailed usage and installation instructions check out the [documentation](https://restic.readthedocs.io/en/latest). + +You can ask questions in our [Discourse forum](https://forum.restic.net>). + +Quick start +----------- + +Once you've [installed](https://restic.readthedocs.io/en/latest/020_installation.html) restic, start +off with creating a repository for your backups: + + $ restic init --repo /tmp/backup + enter password for new backend: + enter password again: + created restic backend 085b3c76b9 at /tmp/backup + Please note that knowledge of your password is required to access the repository. + Losing your password means that your data is irrecoverably lost. + +and add some data: + + $ restic --repo /tmp/backup backup ~/work + enter password for repository: + scan [/home/user/work] + scanned 764 directories, 1816 files in 0:00 + [0:29] 100.00% 54.732 MiB/s 1.582 GiB / 1.582 GiB 2580 / 2580 items 0 errors ETA 0:00 + duration: 0:29, 54.47MiB/s + snapshot 40dc1520 saved + +Next you can either use `restic restore` to restore files or use `restic +mount` to mount the repository via fuse and browse the files from previous +snapshots. + +For more options check out the [online documentation](https://restic.readthedocs.io/en/latest/). + +# Backends + +Saving a backup on the same machine is nice but not a real backup strategy. +Therefore, restic supports the following backends for storing backups natively: + +- [Local directory](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#local) +- [sftp server (via SSH)](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#sftp) +- [HTTP REST server](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server) ([protocol](doc/100_references.rst#rest-backend), [rest-server](https://github.com/restic/rest-server)) +- [AWS S3](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#amazon-s3) (either from Amazon or using the [Minio](https://minio.io) server) +- [OpenStack Swift](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#openstack-swift) +- [BackBlaze B2](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#backblaze-b2) +- [Microsoft Azure Blob Storage](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#microsoft-azure-blob-storage) +- [Google Cloud Storage](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#google-cloud-storage) +- And many other services via the [rclone](https://rclone.org) [Backend](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#other-services-via-rclone) + +# Design Principles + +Restic is a program that does backups right and was designed with the +following principles in mind: + +- **Easy:** Doing backups should be a frictionless process, otherwise + you might be tempted to skip it. Restic should be easy to configure + and use, so that, in the event of a data loss, you can just restore + it. Likewise, restoring data should not be complicated. + +- **Fast**: Backing up your data with restic should only be limited by + your network or hard disk bandwidth so that you can backup your files + every day. Nobody does backups if it takes too much time. Restoring + backups should only transfer data that is needed for the files that + are to be restored, so that this process is also fast. + +- **Verifiable**: Much more important than backup is restore, so restic + enables you to easily verify that all data can be restored. + +- **Secure**: Restic uses cryptography to guarantee confidentiality and + integrity of your data. The location the backup data is stored is + assumed not to be a trusted environment (e.g. a shared space where + others like system administrators are able to access your backups). + Restic is built to secure your data against such attackers. + +- **Efficient**: With the growth of data, additional snapshots should + only take the storage of the actual increment. Even more, duplicate + data should be de-duplicated before it is actually written to the + storage back end to save precious backup space. + +# Reproducible Builds + +The binaries released with each restic version starting at 0.6.1 are +[reproducible](https://reproducible-builds.org/), which means that you can +reproduce a byte identical version from the source code for that +release. Instructions on how to do that are contained in the +[builder repository](https://github.com/restic/builder). + +News +---- + +You can follow the restic project on Twitter [@resticbackup](https://twitter.com/resticbackup) or by subscribing to +the [project blog](https://restic.net/blog/). + +License +------- + +Restic is licensed under [BSD 2-Clause License](https://opensource.org/licenses/BSD-2-Clause). You can find the +complete text in [``LICENSE``](LICENSE). + +Sponsorship +----------- + +Backend integration tests for Google Cloud Storage and Microsoft Azure Blob +Storage are sponsored by [AppsCode](https://appscode.com)! + +[![Sponsored by AppsCode](https://cdn.appscode.com/images/logo/appscode/ac-logo-color.png)](https://appscode.com) diff --git a/README.rst b/README.rst deleted file mode 100644 index 5b6b6e397..000000000 --- a/README.rst +++ /dev/null @@ -1,133 +0,0 @@ -|Documentation| |Build Status| |Build status| |Report Card| |Reviewed by Hound| - -Introduction ------------- - -restic is a backup program that is fast, efficient and secure. It supports the three major operating systems (Linux, macOS, Windows) and a few smaller ones (FreeBSD, OpenBSD). - -For detailed usage and installation instructions check out the `documentation `__. - -You can ask questions in our `Discourse forum `__. - -Quick start ------------ - -Once you've `installed -`__ restic, start -off with creating a repository for your backups: - -.. code-block:: console - - $ restic init --repo /tmp/backup - enter password for new backend: - enter password again: - created restic backend 085b3c76b9 at /tmp/backup - Please note that knowledge of your password is required to access the repository. - Losing your password means that your data is irrecoverably lost. - -and add some data: - -.. code-block:: console - - $ restic --repo /tmp/backup backup ~/work - enter password for repository: - scan [/home/user/work] - scanned 764 directories, 1816 files in 0:00 - [0:29] 100.00% 54.732 MiB/s 1.582 GiB / 1.582 GiB 2580 / 2580 items 0 errors ETA 0:00 - duration: 0:29, 54.47MiB/s - snapshot 40dc1520 saved - -Next you can either use ``restic restore`` to restore files or use ``restic -mount`` to mount the repository via fuse and browse the files from previous -snapshots. - -For more options check out the `online documentation `__. - -Backends --------- - -Saving a backup on the same machine is nice but not a real backup strategy. -Therefore, restic supports the following backends for storing backups natively: - -- `Local directory `__ -- `sftp server (via SSH) `__ -- `HTTP REST server `__ (`protocol `__ `rest-server `__) -- `AWS S3 `__ (either from Amazon or using the `Minio `__ server) -- `OpenStack Swift `__ -- `BackBlaze B2 `__ -- `Microsoft Azure Blob Storage `__ -- `Google Cloud Storage `__ -- And many other services via the `rclone `__ `Backend `__ - -Design Principles ------------------ - -Restic is a program that does backups right and was designed with the -following principles in mind: - -- **Easy:** Doing backups should be a frictionless process, otherwise - you might be tempted to skip it. Restic should be easy to configure - and use, so that, in the event of a data loss, you can just restore - it. Likewise, restoring data should not be complicated. - -- **Fast**: Backing up your data with restic should only be limited by - your network or hard disk bandwidth so that you can backup your files - every day. Nobody does backups if it takes too much time. Restoring - backups should only transfer data that is needed for the files that - are to be restored, so that this process is also fast. - -- **Verifiable**: Much more important than backup is restore, so restic - enables you to easily verify that all data can be restored. - -- **Secure**: Restic uses cryptography to guarantee confidentiality and - integrity of your data. The location the backup data is stored is - assumed not to be a trusted environment (e.g. a shared space where - others like system administrators are able to access your backups). - Restic is built to secure your data against such attackers. - -- **Efficient**: With the growth of data, additional snapshots should - only take the storage of the actual increment. Even more, duplicate - data should be de-duplicated before it is actually written to the - storage back end to save precious backup space. - -Reproducible Builds -------------------- - -The binaries released with each restic version starting at 0.6.1 are -`reproducible `__, which means that you can -easily reproduce a byte identical version from the source code for that -release. Instructions on how to do that are contained in the -`builder repository `__. - -News ----- - -You can follow the restic project on Twitter `@resticbackup `__ or by subscribing to -the `development blog `__. - -License -------- - -Restic is licensed under `BSD 2-Clause License `__. You can find the -complete text in ``LICENSE``. - -Sponsorship ------------ - -Backend integration tests for Google Cloud Storage and Microsoft Azure Blob -Storage are sponsored by `AppsCode `__! - -|AppsCode| - -.. |Documentation| image:: https://readthedocs.org/projects/restic/badge/?version=latest - :target: https://restic.readthedocs.io/en/latest/?badge=latest -.. |Build Status| image:: https://travis-ci.com/restic/restic.svg?branch=master - :target: https://travis-ci.com/restic/restic -.. |Build status| image:: https://ci.appveyor.com/api/projects/status/nuy4lfbgfbytw92q/branch/master?svg=true - :target: https://ci.appveyor.com/project/fd0/restic/branch/master -.. |Report Card| image:: https://goreportcard.com/badge/github.com/restic/restic - :target: https://goreportcard.com/report/github.com/restic/restic -.. |AppsCode| image:: https://cdn.appscode.com/images/logo/appscode/ac-logo-color.png - :target: https://appscode.com -.. |Reviewed by Hound| image:: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg - :target: https://houndci.com