Skip to content

Commit b0b6bd5

Browse files
committed
Updated documentation
1 parent 379fa77 commit b0b6bd5

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,33 @@ Standard plugins provided include:
1313
- [__nginx__](pkg/handler/nginx) to manage a running nginx reverse proxy
1414
instance;
1515
- [__static__](pkg/handler/static/) to serve static files;
16+
- [__auth__](pkg/handler/auth) to manage authentication and authorisation;
17+
- [__tokenjar__](pkg/handler/tokenjar) to manage persistence of authorisation
18+
tokens on disk;
1619
- [__certmanager__](pkg/handler/certmanager) to manage trust and certificates.
1720

1821
The motivation for this module is to provide a generic server which
1922
can be developed and scaled over time. Ultimately the running process
2023
is a large "monolith" server which can be composed of many smaller
2124
"plugins", which can be connected together loosely.
2225

26+
## Running the server
27+
28+
The easiest way to run an nginx reverse proxy server, with an API to
29+
manage nginx configuration, is through docker:
30+
31+
```bash
32+
docker run -p 8080:80 ghcr.io/mutablelogic/go-server
33+
```
34+
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.
38+
2339
## Requirements and Building
2440

2541
Any modern `go` compiler should be able to build the `server` command,
26-
1.22 and above. It has been tested on MacOS and Linux. To build the server
42+
1.21 and above. It has been tested on MacOS and Linux. To build the server
2743
and plugins, run:
2844

2945
```bash
@@ -44,7 +60,7 @@ other make targets:
4460

4561
You can run the server:
4662

47-
1. With a HTTP server over network: You can specify TSL key and certificate
63+
1. With a HTTP server over network: You can specify TLS key and certificate
4864
to serve requests over a secure connection;
4965
2. With a HTTP server with FastCGI over a unix socket: You would want to do
5066
this if the server is behind a reverse proxy such as nginx.

0 commit comments

Comments
 (0)