Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zcalusic committed Jun 25, 2017
1 parent 90b868d commit 0c22253
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,13 @@ Flags:
--tls turn on TLS support
```

Alternatively, you can compile and install it in your $GOBIN with a standard `go install`. But, beware, you won't have
version info built into binary, when compiled that way.
Alternatively, you can compile and install it in your $GOBIN with a standard `go install ./cmd/rest-server`. But,
beware, you won't have version info built into binary, when compiled that way.

#### Build Docker Image
### Building Docker Image

Run `docker/build.sh`, image name is `restic/rest-server:latest`.

### From Docker image

```
docker pull restic/rest-server:latest
```

## Getting started

### Using binary
Expand Down Expand Up @@ -98,7 +92,11 @@ manual](https://restic.readthedocs.io/en/latest/manual.html#rest-server).

### Using Docker image

By default, image use authentication. To turn it off, set environment variable `DISABLE_AUTHENTICATION` to any value.
```
docker pull restic/rest-server:latest
```

By default, image uses authentication. To turn it off, set environment variable `DISABLE_AUTHENTICATION` to any value.

Persistent data volume is located to `/data`

Expand All @@ -110,24 +108,24 @@ docker run --name myserver -v /my/data:/data restic/rest-server

It's suggested to set a name to more easily manage users (see next section).

#### Manager users
#### Manage users

##### Add user

```
docker exec -ti myserver create_user myuser
docker exec -it myserver create_user myuser
```

or

```
docker exec -ti myserver create_user myuser mypassword
docker exec -it myserver create_user myuser mypassword
```

##### Delete user

```
docker exec myserver delete_user myuser
docker exec -it myserver delete_user myuser
```

## Why use Rest Server?
Expand Down

0 comments on commit 0c22253

Please sign in to comment.