Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

fix(docs): resolves bug 1346 (#1350)

(justin)randoneering709453fd87a2
diff --git a/README.md b/README.md
index 2386338b0..f5a3566ae 100644
--- a/README.md
+++ b/README.md
@@ -101,7 +101,7 @@ volumes:
postgres_data:
```
-Save this as `compose.yml`, create a `.env` file with `KANEO_CLIENT_URL=http://localhost:5173`, `POSTGRES_PASSWORD=<password>`, and `AUTH_SECRET=<output of openssl rand -hex 32>`, run `docker compose up -d`, and open [http://localhost:5173](http://localhost:5173).
+Save this as `compose.yml`, copy `.env.sample` to `.env`, uncomment `KANEO_CLIENT_URL=http://localhost:5173`, and set `POSTGRES_PASSWORD=<password>` and `AUTH_SECRET=<output of openssl rand -hex 32>`, run `docker compose up -d`, and open [http://localhost:5173](http://localhost:5173).
In Docker Compose, the bundled Kaneo container reaches PostgreSQL at the service hostname `postgres`.
If you run the API on your host instead of inside Compose, use `localhost` or set `DATABASE_URL` explicitly.
diff --git a/apps/docs/core/installation/docker-compose.mdx b/apps/docs/core/installation/docker-compose.mdx
index d819d906e..fc2c9a1fa 100644
--- a/apps/docs/core/installation/docker-compose.mdx
+++ b/apps/docs/core/installation/docker-compose.mdx
@@ -58,15 +58,17 @@ Additionally, the following volumes are used:
## Required URL configuration
-For the combined image, only `KANEO_CLIENT_URL` is required — `KANEO_API_URL` is derived automatically as `KANEO_CLIENT_URL/api`:
+Copy `.env.sample` to `.env` and uncomment or set these values:
```env
KANEO_CLIENT_URL=http://localhost:5173
+POSTGRES_DB=kaneo
+POSTGRES_USER=kaneo
POSTGRES_PASSWORD=changeme
AUTH_SECRET= # generate: openssl rand -hex 32
```
-Set `KANEO_API_URL` explicitly only if you need to override the default (e.g. a reverse proxy changes the path).
+`KANEO_API_URL` defaults to `KANEO_CLIENT_URL/api` — set it explicitly only if you need to override the default (e.g. a reverse proxy changes the path).
This keeps the browser on one origin while the container proxies `/api` requests to the internal API process.