mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
933c60dc8a
<!--
Make sure you've read the CONTRIBUTING.md guidelines:
https://github.com/stack-auth/stack-auth/blob/dev/CONTRIBUTING.md
-->
<!-- ELLIPSIS_HIDDEN -->
----
> [!IMPORTANT]
> Add `STACK_FREESTYLE_API_KEY` to environment variables and update
documentation for email functionality.
>
> - **Environment Variables**:
> - Add `STACK_FREESTYLE_API_KEY` to `docker/server/.env.example`.
> - **Documentation**:
> - Update `self-host.mdx` to require `STACK_FREESTYLE_API_KEY` for
email functionality.
>
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=stack-auth%2Fstack-auth&utm_source=github&utm_medium=referral)<sup>
for d39713a7c5. You can
[customize](https://app.ellipsis.dev/stack-auth/settings/summaries) this
summary. It will automatically update as commits are pushed.</sup>
<!-- ELLIPSIS_HIDDEN -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Updated self-hosting instructions to mention the required
`STACK_FREESTYLE_API_KEY` environment variable for email functionality.
* **Chores**
* Added `STACK_FREESTYLE_API_KEY` to environment configuration files as
a placeholder for the necessary API key.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Co-authored-by: Konsti Wohlwend <n2d4xc@gmail.com>
43 lines
2.2 KiB
Bash
43 lines
2.2 KiB
Bash
NEXT_PUBLIC_STACK_API_URL=# https://your-backend-domain.com
|
|
NEXT_PUBLIC_STACK_DASHBOARD_URL=# https://your-dashboard-domain.com, this will be added as a trusted domain by the seed script
|
|
|
|
STACK_DATABASE_CONNECTION_STRING=# postgres connection string with pooler
|
|
STACK_DIRECT_DATABASE_CONNECTION_STRING=# postgres direct connection string
|
|
|
|
STACK_SERVER_SECRET=# a 32 bytes base64url encoded random string, used for JWT encryption. can be generated with `pnpm generate-keys`
|
|
|
|
# seed script settings
|
|
STACK_SEED_INTERNAL_PROJECT_SIGN_UP_ENABLED=# true to enable user sign up to the dashboard when seeding
|
|
STACK_SEED_INTERNAL_PROJECT_OTP_ENABLED=# true to add OTP auth to the dashboard when seeding
|
|
STACK_SEED_INTERNAL_PROJECT_ALLOW_LOCALHOST=# true to allow running dashboard on the localhost, set this to true only in development
|
|
STACK_SEED_INTERNAL_PROJECT_OAUTH_PROVIDERS=# list of oauth providers to add to the dashboard when seeding, separated by comma, for example "github,google,facebook"
|
|
STACK_SEED_INTERNAL_PROJECT_USER_EMAIL=# default user added to the dashboard
|
|
STACK_SEED_INTERNAL_PROJECT_USER_PASSWORD=# default user's password, paired with STACK_SEED_INTERNAL_PROJECT_USER_EMAIL
|
|
STACK_SEED_INTERNAL_PROJECT_USER_INTERNAL_ACCESS=# if the default user has access to the internal dashboard project
|
|
STACK_SEED_INTERNAL_PROJECT_USER_GITHUB_ID=# add github oauth id to the default user
|
|
|
|
# Set these if you want to use any email functionality
|
|
STACK_EMAIL_HOST=
|
|
STACK_EMAIL_PORT=
|
|
STACK_EMAIL_USERNAME=
|
|
STACK_EMAIL_PASSWORD=
|
|
STACK_EMAIL_SENDER=
|
|
STACK_EMAILABLE_API_KEY=
|
|
|
|
# Set these if you want to use webhooks
|
|
STACK_SVIX_SERVER_URL=# this is only needed if you self-host the Svix service
|
|
NEXT_PUBLIC_STACK_SVIX_SERVER_URL=# this is only needed if you are using docker compose and the external and internal urls are different. This is the external url for the Svix service.
|
|
STACK_SVIX_API_KEY=
|
|
|
|
STACK_OPENAI_API_KEY=# enter your openai api key if you want to use the openai related features
|
|
|
|
STACK_SKIP_SEED_SCRIPT=# true to skip the seed script
|
|
|
|
STACK_S3_ENDPOINT=
|
|
STACK_S3_REGION=
|
|
STACK_S3_ACCESS_KEY_ID=
|
|
STACK_S3_SECRET_ACCESS_KEY=
|
|
STACK_S3_BUCKET=
|
|
|
|
STACK_FREESTYLE_API_KEY=# enter your freestyle.sh api key
|