chore: add postgres setup to docs

This commit is contained in:
Henry
2025-06-08 10:58:32 +01:00
parent 8aa4aa2a7c
commit 4066e6bba7

View File

@@ -45,7 +45,28 @@ See our [roadmap](https://kan.bn/kan/roadmap) for upcoming features.
- [Drizzle ORM](https://orm.drizzle.team/?ref=kan.bn)
- [React Email](https://react.email/?ref=kan.bn)
## Self Hosting (under construction) 🐳
## Self Hosting 🐳
### PostgreSQL Database Setup
Kan requires a PostgreSQL database. You can run one using the official PostgreSQL Docker image:
```bash
# Run PostgreSQL in a container using the official postgres image
docker run -d \
--name kan-db \
-e POSTGRES_DB=kan \
-e POSTGRES_USER=kan_user \
-e POSTGRES_PASSWORD=your_secure_password \
-p 5432:5432 \
-v kan_postgres_data:/var/lib/postgresql/data \
postgres:15
# Your POSTGRES_URL should be:
# postgres://kan_user:your_secure_password@your_host:5432/kan
```
### Kan Application Deployment
Deploy Kan with Docker using our pre-built image: