Skip to content

Commit

Permalink
Update readme and add config samples
Browse files Browse the repository at this point in the history
  • Loading branch information
dpogorzelski committed May 9, 2022
1 parent 19690dc commit 3dd0fda
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ On your machine:

```bash
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/serviceaccount.json
speedrun init
speedrun run whoami --insecure
```

Expand Down Expand Up @@ -107,7 +106,7 @@ speedrun run whoami -c /path/to/config.toml
```

## Configuration
Default config file is located at `~/.speedrun/config.toml` and default settings can be generated via `speedrun init --print`.
Config samples are located under [conf](conf/).

#### Run Portal as a systemd service
Find a sample unit [here](init/portal.service)
Expand Down
12 changes: 12 additions & 0 deletions conf/portal.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
address = "0.0.0.0" # address to which to bind
port = 1337 # port on which to listen for incoming connections

[logging]
json = false # output logs in json format
loglevel = "info" # how much log output to spam

[tls]
ca = "ca.crt" # certificate authority cert/bundle
cert = "portal.crt" # client certificate used during mTLS
key = "portal.key" # client key used during mTLS
insecure = false # setting this to true will make speedrun skip portal's certificate validation step
15 changes: 15 additions & 0 deletions conf/speedrun.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[gcp]
projectid = "yourproject" # GCP project ID

[logging]
json = false # output logs in json format
loglevel = "info" # how much log output to spam

[portal]
use-private-ip = false # try to connect to private IP of the instances rather than to the public

[tls]
ca = "ca.crt" # certificate authority cert/bundle
cert = "speedrun.crt" # client certificate used during mTLS
key = "speedrun.key" # client key used during mTLS
insecure = false # setting this to true will make speedrun skip portal's certificate validation step

0 comments on commit 3dd0fda

Please sign in to comment.