groove/Part-DB-server
1
0
Fork 0
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2026-01-19 00:29:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Add INITIAL_ADMIN_API_KEY documentation

Browse source 
- Document environment variable in configuration.md
- Add section to API authentication documentation
- Include examples in Docker installation guide for both SQLite and MySQL setups
- Provide usage instructions for CI/CD and automated deployments
This commit is contained in:
Ryan Malloy 2025-09-07 08:42:17 -06:00
parent c498803859
commit 99cd18096b
3 changed files with 23 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/api/authentication.md
View file

@ -32,6 +32,14 @@ tokens as you want and also delete them again.
When deleting a token, it is immediately invalidated and can not be used anymore, which means that the application can
not access the API anymore with this token.
### Initial Admin API Token
For automated deployments and CI/CD pipelines, Part-DB supports automatically creating an initial admin API token
during database setup. Set the `INITIAL_ADMIN_API_KEY` environment variable to a 64-character random string
(generate with `openssl rand -hex 32`) before running database migrations. Part-DB will create an API token named
"Initial Admin Token" with FULL scope that expires after 1 year. The token can be used immediately with the format
`Bearer tcp_<your-64-char-key>` in the Authorization header.
### Token permissions and scopes
API tokens are ultimately limited by the permissions of the user, which belongs to the token. That means that the token