Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-02-17 22:04:19 -05:00
Code Issues Activity

docs: update content (#769)

Browse source
This commit is contained in:
Gao Sun 2022-05-09 20:50:08 +08:00 • committed by GitHub
parent dd8b767130
commit 24e7b94f08
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
packages/docs/docs/tutorial/README.md
View file

@ -4,7 +4,9 @@ sidebar_position: 1
# Introduction
🤘 Logto helps you quickly focus on everything after signing in with the following components:
🤘 Logto helps you quickly focus on everything after signing in.
Main features:
- All-platform user sign-in / sign-up experience with SDK support (SPA, iOS and Android)
- Passwordless (SMS / Email) support

32
packages/docs/docs/tutorial/configuration.md
View file

@ -33,23 +33,27 @@ The `--no-inquiry` parameter is appended by default in the Docker image.
### General
| Key | Default Value | Type | Description |
| ------------------ | ------------------------ | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| NODE_ENV | `undefined` | <code>'production' &#124; 'test' &#124; undefined</code> | What kind of environment that Logto runs in. If you run Logto via `npm start`, the value will always be `production`. |
| PORT | `3001` | `number` | The local port that Logto listens. |
| DB_URL | N/A | `string` | The [Postgres DSN](https://www.postgresql.org/docs/14/libpq-connect.html#id-1.7.3.8.3.6) for Logto database. |
| HTTPS_CERT_PATH | `undefined` | <code>string &#124; undefined</code> | See [Enabling HTTPS](#enabling-https) for details. |
| HTTPS_KEY_PATH | `undefined` | <code>string &#124; undefined</code> | Ditto. |
| TRUST_PROXY_HEADER | `false` | `boolean` | Ditto. |
| ADMIN_RESOURCE | `'https://api.logto.io'` | `string` | The resource indicator for Logto management APIs. |
:::caution
If you run Logto via `npm start`, `NODE_ENV` will always be `production`.
:::
| Key | Default Value | Type | Description |
| ------------------ | ------------------------ | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| NODE_ENV | `undefined` | <code>'production' &#124; 'test' &#124; undefined</code> | What kind of environment that Logto runs in. |
| PORT | `3001` | `number` | The local port that Logto listens. |
| DB_URL | N/A | `string` | The [Postgres DSN](https://www.postgresql.org/docs/14/libpq-connect.html#id-1.7.3.8.3.6) for Logto database. |
| HTTPS_CERT_PATH | `undefined` | <code>string &#124; undefined</code> | See [Enabling HTTPS](#enabling-https) for details. |
| HTTPS_KEY_PATH | `undefined` | <code>string &#124; undefined</code> | Ditto. |
| TRUST_PROXY_HEADER | `false` | `boolean` | Ditto. |
| ADMIN_RESOURCE | `'https://api.logto.io'` | `string` | The resource indicator for Logto management APIs. |
### OIDC
| Key | Default Value | Type | Description |
| --------------------- | ------------------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OIDC_PRIVATE_KEY | N/A | <code>string &#124; undefined</code> | The content of private key for [OIDC JWT signing](https://openid.net/specs/openid-connect-core-1_0.html#Signing). <br/> If you'd like to set this in `.env`, you can leverage [multiline values](https://github.com/motdotla/dotenv#multiline-values) support. |
| OIDC_PRIVATE_KEY_PATH | `'./oidc-private-key.pem'` | <code>string &#124; undefined</code> | The path to the private key file for [OIDC JWT signing](https://openid.net/specs/openid-connect-core-1_0.html#Signing). <br/> Note Logto will *ignore* this value if `OIDC_PRIVATE_KEY` is not empty. |
| OIDC_ISSUER | `'http://localhost:$PORT/oidc'` | `string` | The [issuer identifier](https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier) for OIDC. Usually it's the URL to your OIDC provider. |
| Key | Default Value | Type | Description |
| --------------------- | ------------------------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OIDC_PRIVATE_KEY | N/A | <code>string &#124; undefined</code> | The content of private key for [OIDC JWT signing](https://openid.net/specs/openid-connect-core-1_0.html#Signing). <br/> If you'd like to set this in `.env`, you can leverage [multiline values](https://github.com/motdotla/dotenv#multiline-values) support. |
| OIDC_PRIVATE_KEY_PATH | `'./oidc-private-key.pem'` | <code>string &#124; undefined</code> | The path to the private key file for [OIDC JWT signing](https://openid.net/specs/openid-connect-core-1_0.html#Signing). <br/> Note Logto will *ignore* this value if `OIDC_PRIVATE_KEY` is not empty. |
| OIDC_ISSUER | `'http://localhost:$PORT/oidc'` | `string` | The [issuer identifier](https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier) for OIDC. Usually it's the URL to your OIDC provider. |
#### Supported Key Types