Skip to content
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

Jump to bottom

docs: #603 Add missing SB_DOMAIN_FLOWER env documentation #605

Merged
merged 1 commit into from
Aug 2, 2024
Merged

docs: #603 Add missing SB_DOMAIN_FLOWER env documentation #605

Show file tree
Hide file tree
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
3 changes: 2 additions & 1 deletion packages/internal/docs/docs/api-reference/env-files.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,15 @@ CNAME DNS records pointing to CloudFront distribution and Load Balancer need to
:::

| Name | Description | Example |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| `PROJECT_NAME` | The name of your project (best if 3-5 characters to avoid AWS names being to long) | `saas` |
| `AWS_DEFAULT_REGION` | Default AWS region for you application | `eu-west-1` |
| `COMPOSE_PATH_SEPARATOR` | Check official `docker-compose` [documentation](https://docs.docker.com/compose/environment-variables/envvars/#compose_path_separator) | `:` |
| `COMPOSE_FILE` | Check official `docker-compose` [documentation](https://docs.docker.com/compose/environment-variables/envvars/#compose_file) | `docker-compose.yml:docker-compose.local.yml` |
| `SB_HOSTED_ZONE_ID` | Id of a AWS Route53 hosted zone of a domain used to host services of this environment | `` |
| `SB_HOSTED_ZONE_NAME` | Name of a AWS Route53 hosted zone of a domain used to host services of this environment | `example.com` |
| `SB_DOMAIN_ADMIN_PANEL` | A domain used to host an admin panel service | `admin.example.com` |
| `SB_DOMAIN_FLOWER` | A domain used to host the Flower panel | `flower.example.com` |
| `SB_DOMAIN_API` | A domain used to host an API backend service | `api.example.com` |
| `SB_DOMAIN_WEB_APP` | A domain used to host the web application | `app.example.com` |
| `SB_DOMAIN_DOCS` | A domain used to host the documentation | `docs.example.com` |
Expand Down
1 change: 1 addition & 0 deletions packages/internal/docs/docs/aws/deploy-to-aws/create-env-stage-in-repo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ For this step you'll need the hosted zone parameters that you acquired in the pr
pnpm saas aws set-var SB_HOSTED_ZONE_ID XYZ
pnpm saas aws set-var SB_HOSTED_ZONE_NAME example.com
pnpm saas aws set-var SB_DOMAIN_ADMIN_PANEL admin.qa.example.com
pnpm saas aws set-var SB_DOMAIN_FLOWER flower.qa.example.com
pnpm saas aws set-var SB_DOMAIN_API api.qa.example.com
pnpm saas aws set-var SB_DOMAIN_CDN cdn.qa.example.com
pnpm saas aws set-var SB_DOMAIN_DOCS docs.qa.example.com
Expand Down
Loading