Merge remote-tracking branch 'wg/master'

# Conflicts:
#	.github/CODEOWNERS
#	.github/PULL_REQUEST_TEMPLATE.md
#	.github/dependabot.yml
#	.github/workflows/deploy-development.yml
#	.github/workflows/deploy-nightly.yml
#	.github/workflows/deploy-pr.yml
#	.github/workflows/lint.yml
#	Dockerfile
#	How_to_generate_an_bcrypt_hash.md
#	README.md
#	docker-compose.dev.yml
#	docker-compose.yml
#	src/config.js
#	src/lib/Server.js
#	src/lib/WireGuard.js
#	src/www/js/api.js
#	src/www/js/app.js
This commit is contained in:
w0rng 2024-09-07 07:36:58 +07:00
commit 7b1e606bc2
17 changed files with 807 additions and 132 deletions

View file

@ -12,11 +12,17 @@
To generate a bcrypt password hash using docker, run the following command :
```sh
docker run ghcr.io/w0rng/amnezia-wg-easy wgpw YOUR_PASSWORD
docker run -it ghcr.io/w0rng/amnezia-wg-easy wgpw YOUR_PASSWORD
PASSWORD_HASH='$2b$12$coPqCsPtcFO.Ab99xylBNOW4.Iu7OOA2/ZIboHN6/oyxca3MWo7fW' // literally YOUR_PASSWORD
```
If a password is not provided, the tool will prompt you for one :
```sh
docker run -it ghcr.io/wg-easy/wg-easy wgpw
Enter your password: // hidden prompt, type in your password
PASSWORD_HASH='$2b$12$coPqCsPtcFO.Ab99xylBNOW4.Iu7OOA2/ZIboHN6/oyxca3MWo7fW'
```
*Important* : make sure to enclose your password in **single quotes** when you run `docker run` command :
**Important** : make sure to enclose your password in **single quotes** when you run `docker run` command :
```bash
$ echo $2b$12$coPqCsPtcF <-- not correct
@ -26,3 +32,11 @@ b2
$ echo '$2b$12$coPqCsPtcF' <-- correct
$2b$12$coPqCsPtcF
```
**Important** : Please note: don't wrap the generated hash password in single quotes when you use `docker-compose.yml`. Instead, replace each `$` symbol with two `$$` symbols. For example:
``` yaml
- PASSWORD_HASH=$$2y$$10$$hBCoykrB95WSzuV4fafBzOHWKu9sbyVa34GJr8VV5R/pIelfEMYyG
```
This hash is for the password 'foobar123', obtained using the command `docker run ghcr.io/wg-easy/wg-easy wgpw foobar123` and then inserted an additional `$` before each existing `$` symbol.