chore: minor changes to the github actions

This commit is contained in:
Ferdinand Mütsch 2020-05-31 09:52:13 +02:00
parent 274be6caf8
commit 05b740c87d
3 changed files with 7 additions and 3 deletions

View File

@ -1,4 +1,4 @@
name: Build WakAPI on Linux
name: Build Wakapi on Linux
on:
release:
@ -39,5 +39,5 @@ jobs:
with:
upload_url: ${{ github.event.release.upload_url }}
asset_path: release.zip
asset_name: wakapi_linux.zip
asset_name: wakapi_linux_amd64.zip
asset_content_type: application/gzip

View File

@ -1,4 +1,4 @@
name: Build WakAPI on Windows
name: Build Wakapi on Windows
on:
release:

View File

@ -40,6 +40,10 @@ To use the demo version set `api_url = https://apps.muetsch.io/wakapi/api/heartb
1. Build executable: `GO111MODULE=on go build`
1. Run server: `./wakapi`
**As an alternative** to building from source you can also grab a pre-built [release](https://github.com/muety/wakapi/releases). Steps 2, 3 and 5 apply analogously.
**Note:** By default, the application is running in dev mode. However, it is recommended to set `ENV=production` in `.env` for enhanced performance and security. To still be able to log in when using production mode, you either have to run Wakapi behind a reverse proxy, that enables for HTTPS encryption (see [best practices](i#best-practices)) or set `insecure_cookies = true` in `config.ini`.
### Run with Docker
```
docker run -d -p 3000:3000 --name wakapi n1try/wakapi