Skip to content

Commit 9b1321b

Browse files
committed
DEPLOYMENT.md updates with env vars
1 parent cfac812 commit 9b1321b

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

DEPLOYMENT.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,22 @@ The deployment configuration is defined in the `lttle` directory, which contains
1111
3. Authentication to the container registry where the Docker images are stored.
1212
4. Authentication to the `lttle` CLI with the appropriate credentials.
1313

14+
## Environment Variables
15+
16+
For local development, you can create a `.env` file in the root of the project to define the necessary environment variables. Here's an example of the variables you might need:
17+
18+
```sh
19+
TYPESENSE_API_KEY=some-api-key
20+
```
21+
22+
For production deployment there are multiple variables needed because we use them to deploy the services on both the production and for preview deployments.
23+
24+
```sh
25+
DOCS_URL=https://path.to.docs.url
26+
TYPESENSE_URL=https://path.to.typesense.url
27+
TYPESENSE_API_KEY=some-api-key
28+
```
29+
1430
## Deployment Steps
1531

1632
1. **Build the Docker Images**: Ensure that the Docker images for the documentation website and the TypeSense scraper are built and pushed to a container registry. You can use the following commands:

0 commit comments

Comments
 (0)