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

(docs): update

Browse Source
This commit is contained in:
Shahrad Elahi 2023-12-01 18:48:46 +03:30
parent 3335f2320d
commit d4727ef3e1
1 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -10,7 +10,7 @@
- Easy-to-use web-based admin UI
- Support for multiple users and servers
- Support for **Tor to anonymize connections**
- Support for **Tor for anonymized connections**
- List, create, delete, or modify any server or user
- Scan QR codes or easily download the client configurations.
@ -43,11 +43,9 @@ docker volume create wireadmin-data --driver local
Install WireAdmin using the command line:
```bash
docker run -d \
--name wireadmin \
--restart unless-stopped \
docker run --rm \
-e WG_HOST="🚨YOUR_SERVER_IP" \
-e UI_PASSWORD="🔐OPTIONAL_ADMIN_PASSWORD" \
-e UI_PASSWORD="🔐ADMIN_PASSWORD" \
-p "3000:3000/tcp" \
-p "51820:51820/udp" \
-v "wireadmin-data:/data" \
@ -55,10 +53,10 @@ docker run -d \
--cap-add=SYS_MODULE \
--sysctl="net.ipv4.conf.all.src_valid_mark=1" \
--sysctl="net.ipv4.ip_forward=1" \
ghcr.io/shahradelahi/wireadmin:latest
litehex/wireadmin:latest
```
Please note that the port `3000` is for the UI and it is up to you to remove it after configuring the Servers/Peers.
Please note that the port `3000` is for the WebUI, and it's 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.)
@ -71,13 +69,13 @@ Please feel free to open an issue if you have any questions or suggestions.
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. | `""` | ✔️ |
| `ORIGIN` | In case you want to access the web-admin remotely, you must set this to the host you are using, for example, `http://hostname:port`. | `""` | ✔️ |
| `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"`) | `""` | ✔️ |
| Option | Description | Optional |
|-------------------|--------------------------------------------------------------------------------------------------------------------------------------|----------|
| `WG_HOST` | The public IP address of the WireGuard server. | |
| `UI_PASSWORD` | The password for the admin UI. | |
| `ORIGIN` | In case you want to access the web-admin remotely, you must set this to the host you are using, for example, `http://hostname:port`. | ✔️ |
| `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
@ -86,4 +84,4 @@ repository.
## License
This project is licensed under the `GPL-3.0` license. See the [LICENSE](LICENSE) file for more info.
This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details