.env files
Below you can find a list of different .env files used in the project along with description of it's content.
Common values used in .env, .env.shared files:
SHIPFAST_HOSTED_ZONE_ID and SHIPFAST_HOSTED_ZONE_NAME can be skipped if you are using externally managed DNS. In that case,
certificates for CloudFront distribution and Load Balancer should be already generated, and their ARNs provided in
SHIPFAST_CLOUDFRONT_CERTIFICATE_ARN and SHIPFAST_LOAD_BALANCER_CERTIFICATE_ARN parameters. As the last step,
CNAME DNS records pointing to CloudFront distribution and Load Balancer need to be manually added.
| 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 | : |
COMPOSE_FILE | Check official docker-compose documentation | docker-compose.yml:docker-compose.local.yml |
SHIPFAST_HOSTED_ZONE_ID | Id of a AWS Route53 hosted zone of a domain used to host services of this environment | `` |
SHIPFAST_HOSTED_ZONE_NAME | Name of a AWS Route53 hosted zone of a domain used to host services of this environment | example.com |
SHIPFAST_DOMAIN_ADMIN_PANEL | A domain used to host an admin panel service | admin.example.com |
SHIPFAST_DOMAIN_API | A domain used to host an API backend service | api.example.com |
SHIPFAST_DOMAIN_WEB_APP | A domain used to host the web application | app.example.com |
SHIPFAST_DOMAIN_DOCS | A domain used to host the documentation | docs.example.com |
SHIPFAST_DOMAIN_CDN | A domain used to static assets delivery | cdn.example.com |
.env
This file should not be committed to the repository
Apart from the common values this file should contain following values:
| Name | Description | Example |
|---|
const dir = resolve(stdout, '..', '.shipfast');
| AWS_VAULT_PROFILE | Name of your AWS vault profile. Learn more about AWS vault here | shipfast |
| NX_BRANCH | | local |
.env.shared
Content of this file doesn't contain any additional values other than common values described above.
.env.test
Apart from the common values this file should contain following values:
| Name | Description | Example |
|---|---|---|
VERSION | test |