Skip to content
This repository has been archived by the owner on Apr 25, 2023. It is now read-only.

Document configuration #50

Merged
merged 2 commits into from
Apr 14, 2020
Merged

Document configuration #50

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
195ff19
Document configuration
Sohalt Apr 13, 2020
a22cdf6
change wireguard-ui to wg-ui
suom1 Apr 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,23 @@ The easiest way to run wireguard-ui is using the container image. To test it, ru

When running in production, we recommend using the latest release as opposed to `latest`.

### Configuration

You can configure wireguard-ui using commandline flags or environment variables.
To see all available flags run:

```docker run --rm -it embarkstudios/wireguard-ui:latest -h```

You can alternatively specify each flag through an environment variable of the form `WIREGUARD_UI_<FLAG_NAME>`, where `<FLAG_NAME>` is replaced with the flag name transformed to `CONSTANT_CASE`, e.g.

```docker run --rm -it embarkstudios/wireguard-ui:latest --log-level=debug```

and

```docker run --rm -it -e WIREGUARD_UI_LOG_LEVEL=debug embarkstudios/wireguard-ui:latest```

are the same.

## Developing

### Start frontend server
Expand Down