From 75f0fd91892b79fc5a9f4155d6e6aa4bc02fffd6 Mon Sep 17 00:00:00 2001 From: Jarek Kowalski Date: Mon, 13 Jun 2016 20:28:07 -0700 Subject: [PATCH] added godoc badge, cleaned up inaccurate data --- README.md | 1 + doc/quickstart.md | 1 - doc/tutorial.md | 71 ----------------------------------------------- 3 files changed, 1 insertion(+), 72 deletions(-) delete mode 100644 doc/tutorial.md diff --git a/README.md b/README.md index 7327fa5ec..318f7dff9 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ Kopia ===== [![Build Status](https://travis-ci.org/kopia/kopia.svg?branch=master)](https://travis-ci.org/kopia/kopia) +[![GoDoc](https://godoc.org/github.com/kopia/kopia?status.svg)](https://godoc.org/github.com/kopia/kopia) > _n. thing exactly replicated from the original (Polish)_ diff --git a/doc/quickstart.md b/doc/quickstart.md index 5dee80de1..bced31d6d 100644 --- a/doc/quickstart.md +++ b/doc/quickstart.md @@ -27,7 +27,6 @@ Key Concepts Supported backends include: - [Google Cloud Storage](https://cloud.google.com/storage/) (GCS) - - [Amazon Simple Storage Service](https://aws.amazon.com/s3/) (S3) - Local or remote filesystem Object IDs diff --git a/doc/tutorial.md b/doc/tutorial.md deleted file mode 100644 index acf2f32b5..000000000 --- a/doc/tutorial.md +++ /dev/null @@ -1,71 +0,0 @@ -Tutorial -=== - -Kopia is a simple, cross-platform tool for managing encrypted backups in the cloud. It provides fast incremental backups, data deduplication and client-side encryption. - -The main difference from other backup solutions is that as a user, you are in full control of backup storage - in fact you are responsible for purchasing one of the cloud storage products available (such as Google Cloud Storage), which offer great durability and availability for your data. - -## Installation - -### Binary Releases - -You can download pre-built `kopia` binary from http://kopia.github.io/download. Once downloaded, it's best to put it in a directory that's in system PATH, such as `/usr/local/bin`. - -### Installation From Source - -To build Kopia from source you need the latest version of [Go](https://golang.org/dl/) and run the following commands: - -``` -mkdir $HOME/kopia -export GOPATH=$HOME/kopia -go get github.com/kopia/kopia -go install github.com/kopia/kopia/cmd/kopia -``` - -This will automatically download and build kopia and put the resulting binary in `$HOME/kopia/bin`. For convenience it's best to add this directory to system `PATH` or copy/symlink it to a directory already in the path, such as `/usr/local/bin`. - -## Getting Started - -To use Kopia, you need to set up two storage locations: - -- **Repository** - which will store the bulk of encrypted data -- **Vault** - which stores the backup metadata and their encryption keys - -The **Repository** can be shared between multiple computers or users because without the encryption keys stored in the **Vault** its data is unaccessible. - -The metadata stored in the *Vault* is very small and will typically fit on even smallest of USB drives for safekeeping. You have a choice of using Vault in the cloud or keeping it on a removable storage device in your possession. - -### Setting Up Vault - -To create new vault in Google Cloud Storage, first create the bucket bucket using https://console.cloud.google.com/storage/ then run: - -``` -kopia vault create gcs BUCKET -``` - -To create new vault in the local filesystem, use: - -``` -mkdir /path/to/vault -kopia vault create filesystem /path/to/vault -``` - -You will be prompted for the password to protect the data in the vault. **Don't forget your password, as there is absolutely no way to recover data in the vault if you do so.** - -To later connect to an existing vault, simply replace `vault create` with `vault connect`. - -To disconnect from a vault, run: -``` -kopia vault disconnect -``` - -### Setting Up Repository - -After creating the vault, we now need to create a repository. This is very similar way to creating a vault, just replace `vault` with `repository`. For example to create GCS-backed repository, use: - -``` -kopia repository create gcs BUCKET -``` - - -