From 369c103c58ada110e0f48ae864d2cec9a6e435f4 Mon Sep 17 00:00:00 2001 From: Niall Sheridan Date: Sat, 28 May 2016 19:59:04 +0100 Subject: Use a simple config file for configuring the client. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 29729b7..0eab987 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 a [HCL](https://github.com/hashicorp/hcl) configuration file - [example](example-client.cfg). +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 -- cgit v1.2.3 From 4dfb29f2e07fe6fb90544ba66cf0a3df187072d9 Mon Sep 17 00:00:00 2001 From: Niall Sheridan Date: Sat, 28 May 2016 22:30:42 +0100 Subject: Use flags as defaults, allow them to override config file --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0eab987..e35cdf0 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ 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 a [HCL](https://github.com/hashicorp/hcl) configuration file - [example](example-client.cfg). +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: -- cgit v1.2.3