aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNiall Sheridan <nsheridan@gmail.com>2016-05-29 13:56:01 +0100
committerNiall Sheridan <nsheridan@gmail.com>2016-05-29 13:56:01 +0100
commit5cbf84c566f648dd7e54a2fdea1b645ef96627b1 (patch)
treef0487d4a57205c37532dd7104f293ba14fe410d8 /README.md
parenta4fa16ca0ffc242bdbace084b53d2a9c859b57c2 (diff)
parent4dfb29f2e07fe6fb90544ba66cf0a3df187072d9 (diff)
Merge pull request #7 from nsheridan/client_config
client: use a config file in addition to command-line flags
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index e0276f5..48be3a3 100644
--- a/README.md
+++ b/README.md
@@ -37,8 +37,8 @@ The user can now ssh to the production machine, and continue to ssh to any machi
# Usage
Cashier comes in two parts, a [cli](cmd/cashier) and a [server](cmd/cashierd).
-The client is configured using command-line flags.
-The server is configured using a JSON configuration file - [example](exampleconfig.json).
+The client is configured using either a [HCL](https://github.com/hashicorp/hcl) configuration file - [example](example-client.cfg) - or command-line flags.
+The server is configured using a JSON configuration file - [example](example-server.json).
For the server you need the following:
- A new ssh private key. Generate one in the usual way using `ssh-keygen -f ssh_ca` - this is your CA signing key. At this time Cashier supports RSA, ECDSA and Ed25519 keys. *Important* This key should be kept safe - *ANY* ssh key signed with this key will be able to access your machines.
@@ -50,11 +50,11 @@ For the server you need the following:
```
go get github.com/cashier/cmd/...
```
-2. Create a signing key with `ssh-keygen` and a [config.json](exampleconfig.json)
+2. Create a signing key with `ssh-keygen` and a [config.json](example-server.json)
3. Run the cashier server with `cashierd` and the cli with `cashier`.
## Using docker
-1. Create a signing key with `ssh-keygen` and a [config.json](exampleconfig.json)
+1. Create a signing key with `ssh-keygen` and a [config.json](example-server.json)
2. Run
```
docker run -it --rm -p 10000:10000 --name cashier -v $(pwd):/cashier nsheridan/cashier