jet/crates/squadron-api/README.md

29 lines
988 B
Markdown
Raw Permalink Normal View History

2024-01-23 12:29:19 +01:00
## Environment:
* `JET_API_HOST` - application host, example `jet.example.com`
* `JET_API_SCHEMA` - application protocol, example `http`
* `JET_API_ADDR` - default `0.0.0.0:7865`
* `REDIS_ADDR` - default: `0.0.0.0`
* `REDIS_PORT` - default: `6379`
### Application config
* `GOOGLE_CLIENT_ID` -
* `GITHUB_CLIENT_ID` -
* `GITHUB_APP_NAME` -
2024-01-27 22:15:03 +01:00
* `MAGIC_LOGIN` - allow to log-in withuot password, using link send to email address
2024-01-23 12:29:19 +01:00
* `EMAIL_PASSWORD_LOGIN` -
* `SLACK_CLIENT_ID` -
* `POSTHOG_API_KEY` -
* `POSTHOG_HOST` -
* `HAS_UNSPLASH_CONFIGURED` -
2024-01-27 22:15:03 +01:00
* `HAS_OPENAI_CONFIGURED` - added for compatibility but not supported
* `FILE_SIZE_LIMIT` - maximum file size
* `IS_SELF_MANAGED` - always `true` but added for compatibility with `plane`
2024-02-08 10:14:00 +01:00
* `PASSWORD_RESET_SECRET` - mandatory secret to encrypt password reset token
* `PASSWORD_RESET_TIMEOUT` - mandatory duration for password reset token, example: "12h 5min 2ns"
2024-01-27 22:15:03 +01:00
### Optional Environment
* `SENTRY_DSN` - sentry endpoint for events