Skip to content

The only tool you need to know what is happening and how to fix it.

updated docs to include APP_BASE_URL

dduxfac9e47523c4
diff --git a/docs/pages/server/all-in-one.mdx b/docs/pages/server/all-in-one.mdx
index d363d681..3462ba84 100644
--- a/docs/pages/server/all-in-one.mdx
+++ b/docs/pages/server/all-in-one.mdx
@@ -39,6 +39,7 @@ All environment variables have working defaults, no configuration required. Over
| `POSTGRES_SSLMODE` | `disable` | PostgreSQL SSL mode |
| `JWT_SECRET` | *(built-in default)* | JWT signing secret (min 32 chars) |
| `GIN_MODE` | `release` | Gin framework mode |
+| `APP_BASE_URL` | *(none)* | Public URL of your Traceway instance (e.g. `https://traceway.example.com`). Used for SDK setup instructions and email links. |
## Access Points
diff --git a/docs/pages/server/docker-compose.mdx b/docs/pages/server/docker-compose.mdx
index 459e9a2f..8f2a705e 100644
--- a/docs/pages/server/docker-compose.mdx
+++ b/docs/pages/server/docker-compose.mdx
@@ -32,6 +32,7 @@ The `docker-compose.yml` in the repository root is ready to use out of the box.
| `POSTGRES_PASSWORD` | `traceway` | PostgreSQL password |
| `POSTGRES_SSLMODE` | `disable` | PostgreSQL SSL mode |
| `JWT_SECRET` | `change-this-to-a-secure-secret-at-least-32-chars` | JWT signing secret (min 32 chars) |
+| `APP_BASE_URL` | *(none)* | Public URL of your Traceway instance (e.g. `https://traceway.example.com`). Used for SDK setup instructions and email links. |
## Access Points
diff --git a/docs/pages/server/local-setup.mdx b/docs/pages/server/local-setup.mdx
index 51308112..1f15de2e 100644
--- a/docs/pages/server/local-setup.mdx
+++ b/docs/pages/server/local-setup.mdx
@@ -73,6 +73,7 @@ POSTGRES_SSLMODE=disable
| `POSTGRES_USERNAME` | PostgreSQL username |
| `POSTGRES_PASSWORD` | PostgreSQL password |
| `POSTGRES_SSLMODE` | PostgreSQL SSL mode (`disable`, `require`, etc.) |
+| `APP_BASE_URL` | Public URL of your Traceway instance. Used for SDK connection instructions and email links. Not needed for local development. |
3. Run the backend:
```bash
diff --git a/docs/pages/server/minimal.mdx b/docs/pages/server/minimal.mdx
index d6d88dcd..768a4bf4 100644
--- a/docs/pages/server/minimal.mdx
+++ b/docs/pages/server/minimal.mdx
@@ -24,6 +24,7 @@ docker run -d --name traceway \
-e POSTGRES_PASSWORD="your-password" \
-e POSTGRES_SSLMODE="disable" \
-e JWT_SECRET="your-jwt-secret-min-32-characters-long" \
+ -e APP_BASE_URL="https://traceway.example.com" \
traceway:minimal
```
@@ -45,6 +46,7 @@ After starting, open `http://localhost/register` to create your first account.
| `POSTGRES_PASSWORD` | PostgreSQL password | `password` |
| `POSTGRES_SSLMODE` | PostgreSQL SSL mode | `disable` |
| `JWT_SECRET` | JWT signing secret (min 32 chars) | `your-secret-here` |
+| `APP_BASE_URL` | Public URL of your instance. Used for SDK setup instructions and email links. | `https://traceway.example.com` |
## Access Points