UniqueSoft/wireadmin
2
0
Fork 0
mirror of https://github.com/wireadmin/wireadmin synced 2025-01-22 20:15:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
37 Commits 2 Branches 9 Tags 6.9 MiB
Svelte 48%
TypeScript 43.9%
Shell 4.1%
Dockerfile 1.6%
CSS 1.3%
Other 1.1%
89b2f5ee7b
Go to file
Shahrad Elahi 89b2f5ee7b (chore): update README.md [skipci]
2023-10-15 19:10:32 +03:30
.github/workflows fix 2023-10-03 11:40:52 +03:30
assets updates docs 2023-09-29 09:25:40 +03:30
config fix 2023-09-27 10:31:52 +03:30
src removes unnecessary dependencies 2023-10-09 18:46:17 +03:30
.dockerignore Adds couple screenshots... 2023-09-26 03:07:19 +03:30
.gitignore feat(create-turbo): apply official-starter transform 2023-09-06 13:53:31 +03:30
docker-compose.dev.yml fix 2023-09-27 10:31:52 +03:30
docker-compose.yml fix 2023-09-27 05:30:23 +03:30
docker-entrypoint.sh Create a new field within WGServer that will monitor any modifications made to the wg configuration files. Furthermore, implement a health check for the container. 2023-10-08 12:24:39 +03:30
Dockerfile removes unnecessary dependencies 2023-10-09 18:46:17 +03:30
Dockerfile-Dev Create a new field within WGServer that will monitor any modifications made to the wg configuration files. Furthermore, implement a health check for the container. 2023-10-08 12:24:39 +03:30
LICENSE Updates dependencies and License from MIT to GPLv3 2023-10-08 11:47:00 +03:30
package.json Create a new field within WGServer that will monitor any modifications made to the wg configuration files. Furthermore, implement a health check for the container. 2023-10-08 12:24:39 +03:30
pnpm-lock.yaml feat(create-turbo): apply official-starter transform 2023-09-06 13:53:31 +03:30
README.md (chore): update README.md [skipci] 2023-10-15 19:10:32 +03:30

README.md

WireGuard GUI (Easy Admin UI)

Screenshot
screenshot screenshot

Features

  • Easy-to-use web-based admin UI
  • Support for multiple users and servers
  • Support for Tor to anonymize connections
  • List, create, delete, or modify any server or user
  • Scan QR codes or easily download the client configurations.

Requirements

  • A host with a kernel that supports WireGuard.
  • A host with Docker installed.

Installation

1. Install Docker

To install Docker, go to the official documentation and install a version that meets your environment's requirements.

2. Run WireAdmin

Install WireAdmin using the command line:

docker run -d \
 --name wireadmin \
 --restart unless-stopped \
 -e WG_HOST="🚨YOUR_SERVER_IP" \
 -e UI_PASSWORD="🔐OPTIONAL_ADMIN_PASSWORD" \
 -p "3000:3000/tcp" \
 -p "51820:51820/udp" \
 -v "~/wireadmin-data:/data" \
 --cap-add=NET_ADMIN \
 --cap-add=SYS_MODULE \
 --sysctl="net.ipv4.conf.all.src_valid_mark=1" \
 --sysctl="net.ipv4.ip_forward=1" \
  ghcr.io/shahradelahi/wireadmin

Please note that the port 3000 is for the UI and it is up to you to remove it after configuring the Servers/Peers.

IMPORTANT: When creating each server, ensure that you add the port exposure through Docker. (The port 51820 is added as an example.)

3. Enjoy

Please feel free to open an issue if you have any questions or suggestions.

Environment Options

These options can be configured by setting environment variables using -e KEY="VALUE" in the docker run command.

Option Description Default Optional
WG_HOST The public IP address of the WireGuard server. ""
UI_PASSWORD The password for the admin UI. "" ✔️
TOR_USE_BRIDGES Set this to true for quick setup of obfs4 Tor bridges. You have to mount the bridges file at /etc/tor/bridges. "" ✔️
TOR_* The Torrc proxy configuration. (e.g. SocksPort as TOR_SOCKSPORT="9050") "" ✔️

Support the Project

Seriously, this project is free and open-source, and all I ask for as support is for you to give a star to the repository.

License

This project is licensed under the GPL-3.0 license. See the LICENSE file for more info.