Skip to content

Commit

Permalink
Adding instruction on how to run Orion
Browse files Browse the repository at this point in the history
  • Loading branch information
lucassaldanha authored Aug 2, 2018
1 parent ec5a10d commit cf31326
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions documentation/install/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ Usage: `orion [options] [config file]`
### Config file
See [configuring Orion](configure.md).


### Generating keys
If you want to generate a pair of public/private keys:
```
Expand All @@ -55,9 +54,15 @@ This will generate a `foo.key` (private key) and `foo.pub` (public key) in the c
You will be prompted to enter a password to protect the private key. This is optional: however if
you do enter a password, you need to put this into the [config file](configure.md).

### Running
After generating your keys and creating the config file, the following command will start Orion:
```
orion <config_filename>
```

### Upcheck
**To check that Orion is up and running:**
```
$ curl -X GET http://localhost:8080/upcheck
> I'm up!
```
```

0 comments on commit cf31326

Please sign in to comment.