@rmdes/indiekit-endpoint-auth
v1.0.0-beta.43
Published
IndieAuth authentication and authorization endpoint for Indiekit with profile scope support. Grants and verifies access tokens and authenticates users.
Maintainers
Readme
@indiekit/endpoint-auth
IndieAuth authentication and authorization endpoint for Indiekit. Grants and verifies access tokens and authenticates users.
Installation
npm install @indiekit/endpoint-auth
[!NOTE] This package is installed alongside
@indiekit/indiekit
Usage
To customise the behaviour of this plug-in, add @indiekit/endpoint-auth to your configuration, specifying options as required:
{
"@indiekit/endpoint-auth": {
"mountPath": "/authorize",
},
}You will also need to set the following environment variables:
SECRET- used to sign and verify tokens and salt passwordPASSWORD_SECRET- hashed and salted password used when signing in. You can generate this value by visiting/auth/new-password
Options
| Option | Type | Description |
| :---------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| mountPath | string | Path to authorization endpoint. Optional, defaults to /auth. |
| profile | object | Profile information (name, url, photo) returned to clients granted the profile scope. Optional; anything not configured is discovered from the h-card on your website. |
