Skip to content

Commit 20242bb

Browse files
committed
Updated documentation
1 parent 0ebf760 commit 20242bb

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,25 @@ is a large "monolith" server which can be composed of many smaller
2525

2626
## Running the server
2727

28-
The easiest way to run an nginx reverse proxy server, with an API to
28+
The easiest way to run an nginx reverse proxy server, with an API to
2929
manage nginx configuration, is through docker:
3030

3131
```bash
32-
docker run -p 8080:80 ghcr.io/mutablelogic/go-server
32+
docker run -p 8080:80 -v /var/lib/go-server:/data ghcr.io/mutablelogic/go-server
3333
```
3434

35-
This will start a server on port 8080. Use API commands to manage the
36-
nginx configuration. Ultimately you'll want to develop your own plugins
37-
and can use this image as the base image for your own server.
35+
This will start a server on port 8080 and use `/var/lib/go-server` for persistent
36+
data. Use API commands to manage the nginx configuration. Ultimately you'll
37+
want to develop your own plugins and can use this image as the base image for your
38+
own server.
39+
40+
When you first run the server, a "root" API token is created which is used to
41+
authenticate API requests. You can find this token in the log output or by running
42+
the following command:
43+
44+
```bash
45+
docker exec <container-id> cat /data/tokenauth.json
46+
```
3847

3948
## Requirements and Building
4049

pkg/handler/tokenjar/config.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313
type Config struct {
1414
DataPath string `hcl:"datapath" description:"Path to persistent data"`
1515
WriteInterval time.Duration `hcl:"write-interval" description:"Interval to write data to disk"`
16+
// TODO Group so that we can set permissions to either 640 or 600
1617
}
1718

1819
// Check interfaces are satisfied

0 commit comments

Comments
 (0)