mirror of
https://github.com/boostorg/website-v2.git
synced 2026-02-27 17:42:08 +00:00
38 lines
2.1 KiB
Markdown
38 lines
2.1 KiB
Markdown
# Environment Variables
|
|
|
|
This project uses environment variables to configure certain aspects of the application.
|
|
|
|
## `GITHUB_TOKEN`
|
|
|
|
- Used to authenticate with the GitHub API when making requests.
|
|
- For **local development**, you should set this variable to a valid personal access token that has the necessary permissions to access the relevant repositories. [Generate a new personal access token](https://github.com/settings/tokens) and replace the value for `GITHUB_TOKEN` in your `.env` file in order to connect to certain parts of the GitHub API.
|
|
- In **deployed environments**, this should be set to a valid access token associated with the GitHub organization. Edit `kube/boost/values.yaml` (or the environment-specific yaml file) to change this value.
|
|
|
|
|
|
## `ENVIRONMENT_NAME`
|
|
|
|
- Used to indicate the name of the environment where the application is running.
|
|
- For **local development**, set this to whatever you want.
|
|
- In **deployed environments**, change the value by editing `kube/boost/values.yaml` (or the environment-specific yaml file).
|
|
|
|
|
|
## `STATIC_CONTENT_AWS_ACCESS_KEY_ID`
|
|
|
|
- Used to authenticate with the Amazon Web Services (AWS) API when accessing static content from a specified bucket.
|
|
- For **local development**, obtain valid value from the Boost team.
|
|
- In **deployed environments**, the valid value is set as a kube secret and is defined in `kube/boost/values.yaml` (or the environment-specific yaml file).
|
|
|
|
|
|
## `STATIC_CONTENT_AWS_SECRET_ACCESS_KEY`
|
|
|
|
- Used to authenticate with the Amazon Web Services (AWS) API when accessing static content from a specified bucket.
|
|
- For **local development**, obtain valid value from the Boost team.
|
|
- In **deployed environments**, the valid value is set as a kube secret and is defined in `kube/boost/values.yaml` (or the environment-specific yaml file).
|
|
|
|
|
|
## `STATIC_CONTENT_BUCKET_NAME`
|
|
|
|
- Specifies the name of the Amazon S3 bucket where static content is stored
|
|
- For **local development**, obtain valid value from the Boost team.
|
|
- In **deployed environments**, the valid value is set in `kube/boost/values.yaml` (or the environment-specific yaml file).
|