Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
giftkugel committed Sep 9, 2024
1 parent b8ca75c commit 1beb2a6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
13 changes: 13 additions & 0 deletions website/docs/advanced/cmd.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,17 @@ The result can be used in the configuration file for client secret and user pass
The password and salt will be asked and shown using `stdin` and `stdout`,
someone standing next to you can see them in your terminal application!

:::

:::info

When not using an additional salt value, a SHA 512 hash is used as user password or client secret. This value can also be created with other tools.

To create the hash value for the password `bar` for example, the following command can be used

```bash
echo -n bar | shasum -a 512
d82c4eb5261cb9c8aa9855edd67d1bd10482f41529858d925094d173fa662aa91ff39bc5b188615273484021dfb16fd8284cf684ccf0fc795be3aa2fc1e6c181 -
```

:::
4 changes: 3 additions & 1 deletion website/docs/introduction/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,9 @@ users:
### Development configuration
The shown `config.yml` is used during development and can be
found [here](https://github.com/webishdev/stopnik/blob/main/config.yml) in the repository.
found in the repository.

https://github.com/webishdev/stopnik/blob/main/config.yml

This configuration uses self-singed TLS certificates, keys and a privates key located in the `.test_files` folder.

Expand Down

0 comments on commit 1beb2a6

Please sign in to comment.