Skip to content

Commit

Permalink
docs: Bump latest version in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
daryllimyt committed Jan 30, 2025
1 parent 6a0aaf0 commit b5b0fad
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 20 deletions.
39 changes: 22 additions & 17 deletions docs/self-hosting/deployment-options/docker-compose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ description: Deploy Tracecat using a Docker Compose template.
This deployment has been tested on macOS with Docker Desktop, Ubuntu (22.04 LTS and 24.04 LTS) and RHEL with Docker Compose.
For help with other operating systems, please find us on [Discord](https://discord.gg/n3GF4qxFU8) for support.

It you have SELinux installed, you'll also need to add the `:z` suffix to the Caddy volume mount:
`./Caddyfile:/etc/caddy/Caddyfile:z` in the Docker Compose file.
It you have SELinux installed, you'll also need to add the `:z` suffix to the Caddy volume mount:
`./Caddyfile:/etc/caddy/Caddyfile:z` in the Docker Compose file.

</Note>

## Prerequisites
Expand All @@ -35,10 +36,11 @@ docker compose
If you're deploying Tracecat into an external instance (e.g. AWS EC2, GCP Compute Engine, Azure VM),
please note that you'll have to set `PUBLIC_APP_URL` and `PUBLIC_API_URL` in the `.env` file to the IP address or host you are accessing Tracecat from.

For example, if you are port forwarding Tracecat from `http://localhost` (port 80) inside AWS EC2 to `http://localhost:8080` on your local machine,
you must set `PUBLIC_APP_URL` to `http://localhost:8080` and `PUBLIC_API_URL` to `http://localhost:8080/api/`.
For example, if you are port forwarding Tracecat from `http://localhost` (port 80) inside AWS EC2 to `http://localhost:8080` on your local machine,
you must set `PUBLIC_APP_URL` to `http://localhost:8080` and `PUBLIC_API_URL` to `http://localhost:8080/api/`.

You can set these options when running the `env.sh` configuration script.

You can set these options when running the `env.sh` configuration script.
</Note>

Tracecat requires a set of environment variables and credentials stored in `.env` file to run.
Expand All @@ -48,10 +50,10 @@ Use the commands listed below to download the required configuration files

```bash
# 1. Download the env.sh installation script
curl -o env.sh https://raw.githubusercontent.com/TracecatHQ/tracecat/0.21.9/env.sh
curl -o env.sh https://raw.githubusercontent.com/TracecatHQ/tracecat/0.22.0/env.sh

# 2. Download the .env.example template file (env.sh needs this to generate your .env file)
curl -o .env.example https://raw.githubusercontent.com/TracecatHQ/tracecat/0.21.9/.env.example
curl -o .env.example https://raw.githubusercontent.com/TracecatHQ/tracecat/0.22.0/.env.example

# 3. Make the env.sh script executable and run it
chmod +x env.sh && ./env.sh
Expand All @@ -65,18 +67,20 @@ You'll be prompted to input the following:
- `localhost` (default host)
- `n` (no to postgres SSL mode).

Otherwise, if you're deploying Tracecat into an external / Cloud VM, input:
- `y` (yes to production mode)
- `<host-where-tracecat-is-exposed>` (e.g. `localhost:8080`)
- `n` (no to postgres SSL mode).
</Info>
Otherwise, if you're deploying Tracecat into an external / Cloud VM, input:

- `y` (yes to production mode)
- `<host-where-tracecat-is-exposed>` (e.g. `localhost:8080`)
- `n` (no to postgres SSL mode).
</Info>

<Note>
Setting production mode to `n` changes where Tracecat's remote repository is installed.
Do not set production mode to `n` unless you are a Tracecat developer.

By default, Tracecat will install the remote repository to the user's home directory at `~/.local/lib/python3.12/site-packages/`.
Setting production mode to `y` will install the remote repository to the `PYTHONUSERBASE` directory specified in enviroment variables.
By default, Tracecat will install the remote repository to the user's home directory at `~/.local/lib/python3.12/site-packages/`.
Setting production mode to `y` will install the remote repository to the `PYTHONUSERBASE` directory specified in enviroment variables.

</Note>

![env.sh](/img/self-hosting/env-script.png)
Expand All @@ -87,13 +91,13 @@ Tracecat uses Caddy as a reverse proxy.
You'll need to download the following `Caddyfile` to configure this service.

```bash
curl -o Caddyfile https://raw.githubusercontent.com/TracecatHQ/tracecat/0.21.9/Caddyfile
curl -o Caddyfile https://raw.githubusercontent.com/TracecatHQ/tracecat/0.22.0/Caddyfile
```

## Download Docker Compose File

```bash
curl -o docker-compose.yml https://raw.githubusercontent.com/TracecatHQ/tracecat/0.21.9/docker-compose.yml
curl -o docker-compose.yml https://raw.githubusercontent.com/TracecatHQ/tracecat/0.22.0/docker-compose.yml
```

## Start Tracecat
Expand All @@ -118,7 +122,8 @@ To access the Tracecat GUI, visit `http://localhost`.
## Login

<Note>
Find out how to configure authentication in Tracecat. [View docs](/self-hosting/authentication/introduction).
Find out how to configure authentication in Tracecat. [View
docs](/self-hosting/authentication/introduction).
</Note>

For each new Tracecat deployment, the admin superuser role is assigned to the first user who logs into the Tracecat instance.
Expand Down
9 changes: 6 additions & 3 deletions docs/tutorials/updating.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ description: Learn how to safely update versions and run data migrations.
version.

```
curl -o env-migration.sh https://raw.githubusercontent.com/TracecatHQ/tracecat/0.21.9/env-migration.sh
curl -o .env.example https://raw.githubusercontent.com/TracecatHQ/tracecat/0.21.9/.env.example
curl -o env-migration.sh https://raw.githubusercontent.com/TracecatHQ/tracecat/0.22.0/env-migration.sh
curl -o .env.example https://raw.githubusercontent.com/TracecatHQ/tracecat/0.22.0/.env.example
```

</Step>
<Step title="Execute environment variables migration">
Run the environment variables migration script to update your existing
Expand All @@ -34,13 +35,15 @@ description: Learn how to safely update versions and run data migrations.
```
chmod +x env-migration.sh && ./env-migration.sh
```

</Step>
<Step title="Update Docker Compose Configuration">
Download the latest Docker Compose file.

```
curl -o docker-compose.yml https://raw.githubusercontent.com/TracecatHQ/tracecat/0.21.9/docker-compose.yml
curl -o docker-compose.yml https://raw.githubusercontent.com/TracecatHQ/tracecat/0.22.0/docker-compose.yml
```

</Step>
<Step title="Restart Tracecat">
Run `docker compose up` using the new Docker Compose and `.env` files.
Expand Down

0 comments on commit b5b0fad

Please sign in to comment.