diff --git a/README.md b/README.md index 1b7b704..26e52f4 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Configuration can be done through config file or environment variables | AUTH | Enable Session-Cookie authentication | false | | AUTH_EXPIRE | Session expiration time. A number and suffix: **m, h, d** or **M**. | 7d | | AUTH_USER | Username | "" | -| AUTH_PASSWORD | Encrypted password (bcrypt) | "" | +| AUTH_PASSWORD | Encrypted password (bcrypt). [How to encrypt password with bcrypt?](docs/BCRYPT.md) | "" | | COLOR | Background color: light or dark | light | | DBPATH | Path to Database | /data/db.sqlite | | GUIIP | Address for web GUI | localhost (127.0.0.1) | diff --git a/docs/BCRYPT.md b/docs/BCRYPT.md new file mode 100644 index 0000000..98285aa --- /dev/null +++ b/docs/BCRYPT.md @@ -0,0 +1,15 @@ +# How to encrypt password with bcrypt? + +It is not safe to store password unencrypted, so this app uses `bcrypt` encryption. There are several ways to encrypt your password. + +## 1. Set password through web GUI +Then the app will encrypt it for you. + +## 2. Encrypt password yourself +On Linux encryption can be done with `htpasswd` command: +```sh +htpasswd -nbBC 10 USER YourSecretPassword | sed 's/USER://' +``` + +## 3. Encrypt password online +There are online tools for `bcrypt` encryption. \ No newline at end of file