Expand README

This commit is contained in:
Gabriel Simmer 2022-07-15 17:20:21 +01:00
parent 1e8d2a7d3d
commit e833d63f9e
2 changed files with 39 additions and 0 deletions

View file

@ -0,0 +1,39 @@
Minecraft Server Invites [mc.gmem.ca](https://mc.gmem.ca)
===
**Generate Discord-like invites for your Minecraft server**
![Homepage screenshot](homepage.png)
_Looking for the frontend? See here: https://git.sr.ht/~gmem/minecraft-server-invites-frontend_
## Building
```shell
# Docker
docker build . -t whitelistmanager
# Non-docker
go build -o wlm -ldflags "-s -w"
```
## Running
This project aims to be as dependency free as possible. The SQLite database will be automatically
created on first run.
[You will need to generate the keys for the Microsoft OAuth flow by following this guide](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app).
The keys can then be saved to environment variables as follows:
```shell
AZURE_OAUTH_CLIENT_ID=<client id>
AZURE_OAUTH_CLIENT_SECRET=<client secret>
AZURE_OAUTH_CLIENT_SECRET_ID=<client secret id> # technically unused at the moment
```
```shell
# Docker
docker run whitelistmanager
# Non-docker
go run ./...
```

BIN
homepage.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 407 KiB