https://github.com/mutablelogic/go-server
General HTTP Server for golang with a plugin architecture
https://github.com/mutablelogic/go-server
golang http-server plugin-architecture
Last synced: 18 days ago
JSON representation
General HTTP Server for golang with a plugin architecture
- Host: GitHub
- URL: https://github.com/mutablelogic/go-server
- Owner: mutablelogic
- License: apache-2.0
- Created: 2021-05-08T10:06:19.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2026-02-10T13:01:12.000Z (about 2 months ago)
- Last Synced: 2026-02-10T16:00:17.408Z (about 2 months ago)
- Topics: golang, http-server, plugin-architecture
- Language: Go
- Homepage: https://pkg.go.dev/github.com/mutablelogic/go-server
- Size: 19.2 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-server
This is an opinionated HTTP server which is designed to be used as a base for building
API and web applications. It is designed to be extensible and modular, allowing you to add
new features and functionality as needed. By default the server includes the following
features:
* Anthentication of users using Cognito, Google and LDAP
* Authorization of users using JWT tokens and API keys
* Task queues for running background jobs
* Connection to PostgreSQL databases
* Ability to manage the PostgreSQL database roles, databases, schemas and connections
* Prometheus metrics support
The idea is that you can use this server as a base for your own applications, and add your own
features and functionality as needed. More documentation soon on how to do that.
## Running
The binary includes both the *server*-side application and the *client*-side
command-line tools. Both can be run as docker containers.
To run the latest released version as a docker container:
```bash
docker run ghcr.io/mutablelogic/go-server:latest
```
This will print out the help message and provide insight into running both the server application
and interacting with the server through commands. To run the server, you'll need a PostgreSQL
database, and you can set the environment variables `PG_HOST`, `PG_DATABASE`, `PG_USER` and `PG_PASS`.
### Bootstrapping the database server and roles
More information about setting up the databses TODO
### Creating a new database
Information about setting up a new database
## Building
### Download and build
```bash
git clone github.com/mutablelogic/go-server
cd go-server
make
```
The plugins and the `server` binary will be built in the `build` directory.
### Build requirements
You need the following three tools installed to build the server:
* [Go](https://golang.org/doc/install/source) (1.23 or later, not required for docker builds)
* [Make](https://www.gnu.org/software/make/)
* [Docker](https://docs.docker.com/get-docker/)
* [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
### Makefile targets
Binaries are placed in the `build` directory.
| Target | Description |
|--------|-------------|
| `make all` | Build all plugins and the server |
| `make cmd/server` | Build the server binary |
| `make plugins` | Build the server binary |
| `make docker` | Build the docker container |
| `make docker-push` | Push the docker container to remote repository, assuming logged in |
| `make docker-version` | Prints out the docker container tag |
| `make test` | Runs unit amd coverage tests |
| `make unit-test` | Runs unit tests |
| `VERBOSE=1 make unit-test` | Runs unit tests with verbose output |
| `make coverage-test` | Reports code coverage |
| `make tidy` | Runs go mod tidy |
| `make clean` | Removes binaries and distribution files |
You can also affect the build by setting the following environment variables. For example,
```bash
OS=linux ARCH=amd64 make
```
| Variable | Description |
|----------|-------------|
| `OS` | The target operating system for the build |
| `ARCH` | The target architecture for the build |
| `BUILD_DIR` | The target architecture for the build |
| `VERBOSE` | Setting this flag will provide verbose output for unit tests |
| `VERSION` | Explicitly set the version |
| `DOCKER_REPO` | The docker repository to push to. Defaults to `ghcr.io/mutablelogic/go-server` |