kamp/Stirling-PDF
1
0
Fork 0
mirror of https://github.com/Stirling-Tools/Stirling-PDF.git synced 2024-11-16 20:30:11 +01:00
Code

security

Browse Source
This commit is contained in:
Anthony Stirling 2023-08-17 22:19:11 +01:00
parent 91cc3d77d4
commit 73156012e9
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -186,15 +186,19 @@ For those wanting to use Stirling-PDFs backend API to link with their own custom
## Login authentication (CURRENTLY ALPHA TAG ONLY) ## Login authentication (CURRENTLY ALPHA TAG ONLY)
###Prerequisites: ### Prerequisites:
- User must have the folder ./configs volumed within docker so that it is retained during updates. - User must have the folder ./configs volumed within docker so that it is retained during updates.
- The environment variable 'login.enabled' must be set to true - The environment variable 'login.enabled' must be set to true
- The environment variables "INITIAL_USERNAME" and "INITIAL_PASSWORD" must also be populated (only required on first boot to create initial user, ignored after.) - The environment variables "INITIAL_USERNAME" and "INITIAL_PASSWORD" must also be populated (only required on first boot to create initial user, ignored after.)
One the above has been done on restart a new stirling-pdf-DB.mv.db will show if everything worked. One the above has been done on restart a new stirling-pdf-DB.mv.db will show if everything worked.
When you login to stirling PDF you will be redirected to /login page to login. After that everything should function as normal When you login to stirling PDF you will be redirected to /login page to login. After that everything should function as normal
To access login settings go to Account settings in the settings cog (top right in navbar) this is also where you find your API key. To access login settings go to Account settings in the settings cog (top right in navbar) this is also where you find your API key.
To add new users go to bottom of Account settings and hit 'Admin Settings', here you can add new users.
To add new users go to bottom of Account settings and hit 'Admin Settings', here you can add new users. The different roles mentioned within this are for rate limiting. This is a Work in progress which will be expanding on more in future
For API usage you must provide a header with 'X-API-Key' and the associated API key for that user. For API usage you must provide a header with 'X-API-Key' and the associated API key for that user.