heckyel/wg-easy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rebrand documentation

Browse Source
This commit is contained in:
Astound 2024-08-11 05:24:57 +08:00
parent 820a9db6b2
commit 6182bc3e03
Signed by: kaiser
GPG Key ID: 97504AF0027B1A56
3 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
How_to_generate_an_bcrypt_hash.md
View File

@ -12,7 +12,7 @@
To generate a bcrypt password hash using docker, run the following command : To generate a bcrypt password hash using docker, run the following command :
```sh ```sh
docker run ghcr.io/wg-easy/wg-easy wgpw YOUR_PASSWORD docker run docker.io/rusian/wg-easy wgpw YOUR_PASSWORD
PASSWORD_HASH='$2b$12$coPqCsPtcFO.Ab99xylBNOW4.Iu7OOA2/ZIboHN6/oyxca3MWo7fW' // literally YOUR_PASSWORD PASSWORD_HASH='$2b$12$coPqCsPtcFO.Ab99xylBNOW4.Iu7OOA2/ZIboHN6/oyxca3MWo7fW' // literally YOUR_PASSWORD
``` ```

12
README.md
View File

@ -37,10 +37,10 @@ For **stable** versions instead of nightly or development please read **README**
| tag | Branch | Example | Description | | tag | Branch | Example | Description |
| - | - | - | - | | - | - | - | - |
| `latest` | production | `ghcr.io/wg-easy/wg-easy:latest` or `ghcr.io/wg-easy/wg-easy` | stable as possbile get bug fixes quickly when needed, deployed against `production`. | | `latest` | production | `docker.io/rusian/wg-easy:latest` or `docker.io/rusian/wg-easy` | stable as possbile get bug fixes quickly when needed, deployed against `production`. |
| `13` | production | `ghcr.io/wg-easy/wg-easy:13` | same as latest, stick to a version tag. | | `13` | production | `docker.io/rusian/wg-easy:13` | same as latest, stick to a version tag. |
| `nightly` | master | `ghcr.io/wg-easy/wg-easy:nightly` | mostly unstable gets frequent package and code updates, deployed against `master`. | | `nightly` | master | `docker.io/rusian/wg-easy:nightly` | mostly unstable gets frequent package and code updates, deployed against `master`. |
| `development` | pull requests | `ghcr.io/wg-easy/wg-easy:development` | used for development, testing code from PRs before landing into `master`. | | `development` | pull requests | `docker.io/rusian/wg-easy:development` | used for development, testing code from PRs before landing into `master`. |
## Installation ## Installation
@ -77,7 +77,7 @@ To automatically install & run wg-easy, simply run:
--sysctl="net.ipv4.conf.all.src_valid_mark=1" \ --sysctl="net.ipv4.conf.all.src_valid_mark=1" \
--sysctl="net.ipv4.ip_forward=1" \ --sysctl="net.ipv4.ip_forward=1" \
--restart unless-stopped \ --restart unless-stopped \
ghcr.io/wg-easy/wg-easy docker.io/rusian/wg-easy
``` ```
> 💡 Replace `YOUR_SERVER_IP` with your WAN IP, or a Dynamic DNS hostname. > 💡 Replace `YOUR_SERVER_IP` with your WAN IP, or a Dynamic DNS hostname.
@ -134,7 +134,7 @@ To update to the latest version, simply run:
```bash ```bash
docker stop wg-easy docker stop wg-easy
docker rm wg-easy docker rm wg-easy
docker pull ghcr.io/wg-easy/wg-easy docker pull docker.io/rusian/wg-easy
``` ```
And then run the `docker run -d \ ...` command above again. And then run the `docker run -d \ ...` command above again.

2
docker-compose.yml
View File

@ -31,7 +31,7 @@ services:
# - UI_TRAFFIC_STATS=true # - UI_TRAFFIC_STATS=true
# - UI_CHART_TYPE=0 # (0 Charts disabled, 1 # Line chart, 2 # Area chart, 3 # Bar chart) # - UI_CHART_TYPE=0 # (0 Charts disabled, 1 # Line chart, 2 # Area chart, 3 # Bar chart)
image: ghcr.io/wg-easy/wg-easy image: docker.io/rusian/wg-easy
container_name: wg-easy container_name: wg-easy
networks: networks:
wg: wg: