mirrors/amnezia-wg-easy
1
0
Fork 1
mirror of https://github.com/w0rng/amnezia-wg-easy.git synced 2025-04-25 12:50:06 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
amnezia-wg-easy/How_to_generate_an_bcrypt_hash.md
程越 a268422e9d fix(Doc): fix escaping issue for PASSWORD_HASH in docker-compose.yml 
For users using docker-compose.yml, please note that you should not wrap the generated hash password in single quotes. Instead, replace each `$` symbol with two `$$` symbols.

For example, for the password 'foobar123', use the following command to generate the hash:
`docker run ghcr.io/wg-easy/wg-easy wgpw foobar123`

The resulting hash should be used in docker-compose.yml like this:
``` yaml
- PASSWORD_HASH=$$2y$$10$$hBCoykrB95WSzuV4fafBzOHWKu9sbyVa34GJr8VV5R/pIelfEMYyG
```

Signed-off-by: cyicz123 <cyicz123@outlook.com>
2024-08-12 11:25:17 +08:00

1.3 KiB
Raw Blame History

wg-password

wg-password (wgpw) is a script that generates bcrypt password hashes for use with wg-easy, enhancing security by requiring passwords.

Features

  • Generate bcrypt password hashes.
  • Easily integrate with wg-easy to enforce password requirements.

Usage with Docker

To generate a bcrypt password hash using docker, run the following command :

docker run ghcr.io/wg-easy/wg-easy wgpw YOUR_PASSWORD
PASSWORD_HASH='$2b$12$coPqCsPtcFO.Ab99xylBNOW4.Iu7OOA2/ZIboHN6/oyxca3MWo7fW' // literally YOUR_PASSWORD

Important : make sure to enclose your password in single quotes when you run docker run command :

$ echo $2b$12$coPqCsPtcF <-- not correct
b2
$ echo "$2b$12$coPqCsPtcF" <-- not correct
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:

- 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 $ symbal.