Skip to content

Update README with local deployment instructions #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkyberneees merged 1 commit into from
May 31, 2026
Merged

Update README with local deployment instructions #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,15 @@ This project allows Web browser and API clients to easily generate JWT signing/v
* For `HS*` keys, there is only private key (aka `secret`) and it is randomly generated using OpenSSL.
* All keys are expected to be generated on the backend using `OpenSSL` to increase security.

## Frontend
- Official Frontend URL: https://jwt-keys.21no.de/

## Backend API
- Official URL: `https://jwt-keys.21no.de/api/generate/ALGORITHM?bytes=BYTES&bits=BITS`
Run the service yourself (see [Run it using Docker](#run-it-using-docker) below) and call it locally:
- URL pattern: `http://localhost:3000/api/generate/ALGORITHM?bytes=BYTES&bits=BITS`

### Examples:
- Generate RS256 key pair: https://jwt-keys.21no.de/api/generate/RS256?bits=2048
- Generate PS256 key pair: https://jwt-keys.21no.de/api/generate/PS256?bits=2048
- Generate HS256 key pair: https://jwt-keys.21no.de/api/generate/HS256?bytes=32
- Generate ES512 key pair: https://jwt-keys.21no.de/api/generate/ES512
- Generate RS256 key pair: http://localhost:3000/api/generate/RS256?bits=2048
- Generate PS256 key pair: http://localhost:3000/api/generate/PS256?bits=2048
- Generate HS256 key pair: http://localhost:3000/api/generate/HS256?bytes=32
- Generate ES512 key pair: http://localhost:3000/api/generate/ES512

### Parameters
#### bytes (optional)
Expand Down
Loading