diff --git a/cmd/restic/main.go b/cmd/restic/main.go index 64b75b43a..17b9c468d 100644 --- a/cmd/restic/main.go +++ b/cmd/restic/main.go @@ -25,6 +25,8 @@ var cmdRoot = &cobra.Command{ Long: ` restic is a backup program which allows saving multiple revisions of files and directories in an encrypted repository stored on different backends. + +The full documentation can be found at https://restic.readthedocs.io/ . `, SilenceErrors: true, SilenceUsage: true, diff --git a/doc/010_introduction.rst b/doc/010_introduction.rst index 5c213f6cd..e6bffdea1 100644 --- a/doc/010_introduction.rst +++ b/doc/010_introduction.rst @@ -17,3 +17,47 @@ Introduction Restic is a fast and secure backup program. In the following sections, we will present typical workflows, starting with installing, preparing a new repository, and making the first backup. + +Quickstart Guide +**************** + +To get started with a local repository, first define some environment variables: + +.. code-block:: console + + export RESTIC_REPOSITORY=/srv/restic-repo + export RESTIC_PASSWORD=some-strong-password + +Initialize the repository (first time only): + +.. code-block:: console + + restic init + +Create your first backup: + +.. code-block:: console + + restic backup ~/work + +You can list all the snapshots you created with: + +.. code-block:: console + + restic snapshots + +You can restore a backup by noting the snapshot ID you want and running: + +.. code-block:: console + + restic restore --target /tmp/restore-work your-snapshot-ID + +It is a good idea to periodically check your repository's metadata: + +.. code-block:: console + + restic check + # or full data: + restic check --read-data + +For more details continue reading the next sections.