rmanach/simple-auth
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases 5 Wiki Activity

feat: #11 update README

Browse Source
This commit is contained in:
landrigun 2022-10-12 15:47:57 +00:00
parent 075ffa6e3f
commit 83791850ff
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -23,7 +23,7 @@ The server uses **RS384** signature algorithm (asymmetric). You have to create a
openssl genrsa -out priv.pem 2048 openssl genrsa -out priv.pem 2048
openssl rsa -in priv.pem -outform PEM -pubout -out pub.pem openssl rsa -in priv.pem -outform PEM -pubout -out pub.pem
``` ```
**WARN**: those files must be readable be the server user **WARN**: those files must be readable be the server user.
### INI file ### INI file
To start the server correctly, you need to create an `.ini` file as below: To start the server correctly, you need to create an `.ini` file as below:
@ -44,6 +44,10 @@ expiration_time = 2 # in hours
## Run ## Run
```bash ```bash
./simple-auth <ini_path> ./simple-auth <ini_path>
curl http://<ip>:<port>/get/ -d '{"username":"<user>", "password":"<password>"}'
# should returned
{"token":"<header>.<payload>.<signature>"}
``` ```
## Test ## Test