|
|
@ -33,11 +33,12 @@ The features of wg-manager includes: |
|
|
|
wireguard: |
|
|
|
container_name: wg-manager |
|
|
|
image: perara/wg-manager |
|
|
|
restart: always |
|
|
|
cap_add: |
|
|
|
- NET_ADMIN |
|
|
|
#network_mode: host # Alternatively |
|
|
|
ports: |
|
|
|
- 51800:51900/udp |
|
|
|
- 51800-51900:51800-51900/udp |
|
|
|
- 8888:8888 |
|
|
|
volumes: |
|
|
|
- ./wg-manager:/config |
|
|
@ -53,6 +54,14 @@ or [plain docker here](./docs/guides/docker_configuration.md) |
|
|
|
# Method #2: Bare Metal |
|
|
|
- [Installation on Debian/Ubuntu/RPI4](./docs/install.md) |
|
|
|
|
|
|
|
# Using the development branch |
|
|
|
As there is no builds for the development branch, you have to do the following: |
|
|
|
Change `image: perara/wg-manager` to |
|
|
|
``` |
|
|
|
build: |
|
|
|
context: https://github.com/perara/wg-manager.git#dev |
|
|
|
``` |
|
|
|
|
|
|
|
# Guides |
|
|
|
- [Importing Existing configuration](./docs/guides/import_existing_server.md) |
|
|
|
- [Reverse Proxy](./docs/guides/reverse_proxy.md) |
|
|
@ -62,16 +71,16 @@ When docker container/server has started, go to http://localhost:8888 |
|
|
|
|
|
|
|
|
|
|
|
# Environment variables |
|
|
|
| Environment | Description | Recommended | |
|
|
|
|------------------|--------------------------------------------------------------------------|-------------| |
|
|
|
| GUNICORN_CONF | Location of custom gunicorn configuration | default | |
|
|
|
| WORKERS_PER_CORE | How many concurrent workers should there be per available core (Gunicorn | default | |
|
|
|
| WEB_CONCURRENCY | The number of worker processes for handling requests. (Gunicorn) | 1 | |
|
|
|
| HOST | 0.0.0.0 or unix:/tmp/gunicorn.sock if reverse proxy. Remember to mount | 0.0.0.0 | |
|
|
|
| PORT | The port to use if running with IP host bind | 80 | |
|
|
|
| LOG_LEVEL | Logging level of gunicorn/python | info | |
|
|
|
| ADMIN_USERNAME | Default admin username on database creation | admin | |
|
|
|
| ADMIN_PASSWORD | Default admin password on database creation | admin | |
|
|
|
| Environment | Description | Recommended | |
|
|
|
|------------------|---------------------------------------------------------------------------|-------------| |
|
|
|
| GUNICORN_CONF | Location of custom gunicorn configuration | default | |
|
|
|
| WORKERS_PER_CORE | How many concurrent workers should there be per available core (Gunicorn) | default | |
|
|
|
| WEB_CONCURRENCY | The number of worker processes for handling requests. (Gunicorn) | 1 | |
|
|
|
| HOST | 0.0.0.0 or unix:/tmp/gunicorn.sock if reverse proxy. Remember to mount | 0.0.0.0 | |
|
|
|
| PORT | The port to use if running with IP host bind | 80 | |
|
|
|
| LOG_LEVEL | Logging level of gunicorn/python | info | |
|
|
|
| ADMIN_USERNAME | Default admin username on database creation | admin | |
|
|
|
| ADMIN_PASSWORD | Default admin password on database creation | admin | |
|
|
|
|
|
|
|
# Showcase |
|
|
|
![Illustration](docs/images/0.png) |
|
|
|