1
0
mirror of https://github.com/donaldzou/WGDashboard.git synced 2024-11-06 07:50:13 +01:00

Changed readme and compose for templating.

This commit is contained in:
Dselen 2024-08-20 14:48:36 -05:00
parent 68d0ae4002
commit bd3aa28523
2 changed files with 7 additions and 6 deletions

View File

@ -23,8 +23,8 @@ An example of a simple command to get the container running is show below:<br>
docker run -d \ docker run -d \
--name wireguard-dashboard \ --name wireguard-dashboard \
--restart unless-stopped \ --restart unless-stopped \
-e enable_wg0=true \ -e enable=wg0 \
-e isolated_peers=true \ -e isolate=wg0 \
-p 10086:10086/tcp \ -p 10086:10086/tcp \
-p 51820:51820/udp \ -p 51820:51820/udp \
--cap-add NET_ADMIN \ --cap-add NET_ADMIN \
@ -89,10 +89,11 @@ To build the image yourself, you need to do a couple things:<br>
1. Navigate into the docker directory. 1. Navigate into the docker directory.
1. (Make sure you have Docker correctly installed, if not: [Click here](https://docs.docker.com/engine/install/)) and run: `docker build . -t <Image name>:<Image tag>` as an example: `docker build . -t dselen/wgdashboard:latest`.<br>This will make Docker compile the image from the resources in the directory you mention, in this case the current one. Let it compile, it takes about a minute or maximally two. 1. (Make sure you have Docker correctly installed, if not: [Click here](https://docs.docker.com/engine/install/)) and run: `docker build . -t <Image name>:<Image tag>` as an example: `docker build . -t dselen/wgdashboard:latest`.<br>This will make Docker compile the image from the resources in the directory you mention, in this case the current one. Let it compile, it takes about a minute or maximally two.
1. If all went well, see your image with `docker images`. Example below: 1. If all went well, see your image with `docker images`. Example below:
```
```shell
dselen@dev-mach:~/development/WGDashboard/docker$ docker images dselen@dev-mach:~/development/WGDashboard/docker$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE REPOSITORY TAG IMAGE ID CREATED SIZE
dselen/wgdashboard dev c96fd96ee3b3 42 minutes ago 314MB dselen/wgdashboard latest c96fd96ee3b3 42 minutes ago 314MB
``` ```
## Closing remarks: ## Closing remarks:

View File

@ -1,6 +1,6 @@
services: services:
wireguard-dashboard: wireguard-dashboard:
image: dselen/wgdashboard:dev image: dselen/wgdashboard:latest
restart: unless-stopped restart: unless-stopped
container_name: wire-dash container_name: wire-dash
environment: environment:
@ -11,7 +11,7 @@ services:
#- public_ip= # <--- Set public IP to ensure the correct one is chosen, defaulting to the IP give by ifconfig.me. #- public_ip= # <--- Set public IP to ensure the correct one is chosen, defaulting to the IP give by ifconfig.me.
ports: ports:
- 10086:10086/tcp - 10086:10086/tcp
- 51820:51820/udp - 51830:51820/udp
volumes: volumes:
- conf:/etc/wireguard - conf:/etc/wireguard
- app:/opt/wireguarddashboard - app:/opt/wireguarddashboard