Skip to content

Commit

Permalink
Merge pull request #96 from terrateamio/pro-619-readme-first-deployme…
Browse files Browse the repository at this point in the history
…nt-update

PRO-619 ADD Create instructions for first run
  • Loading branch information
bender2352 authored Nov 22, 2024
2 parents 2f4e6c0 + f7c6b30 commit 75fce74
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ Before you begin, ensure you have the following:

> ⚠️ **Important:** Do not install your private Terrateam GitHub application until you complete the steps below.

4. **Save your `.env` file** next to the `docker-compose.yml` file in the `terrateam/docker/terrat` directory.
4. **Save the generated GitHub application settings**
Create a `.env` file in the `terrateam/docker/terrat` directory, next to the `docker-compose.yml` file, and save the settings there.

5. **Stop the Terrateam setup container** by pressing `Ctrl+C` in the terminal to stop the container.

Expand All @@ -74,6 +75,13 @@ Before you begin, ensure you have the following:

> ⚠️ **Important:** Ensure the Terrateam Server is running (see step 7) before installing the GitHub application.

9. **Add the Terrateam GitHub Actions Workflow**
Download [terrateam.yml](https://raw.githubusercontent.com/terrateamio/terrateam-example/main/github/actions/workflows/default/terrateam.yml) and
save it in your repository under `.github/workflows/terrateam.yml`. The Terrateam GitHub Actions workflow file must reside in the default branch of your Terraform repository, typically named `main` or `master`.

10. **Start Using Terrateam**
Create a pull request with a Terraform code change to automatically trigger a Terraform `Plan` operation. For detailed instructions on your first Terrateam deployment, refer to the [Quickstart Guide](https://docs.terrateam.io/quickstart-guide#your-first-terrateam-deployment).

For non-local setup instructions, including manual setup and Kubernetes deployment options, follow our [Self-Hosted Guide](https://docs.terrateam.io/self-hosted/overview) to get up and running.

---
Expand Down

0 comments on commit 75fce74

Please sign in to comment.