From 4066e6bba70812958047015cc813c0ab9cbdf758 Mon Sep 17 00:00:00 2001 From: Henry Date: Sun, 8 Jun 2025 10:58:32 +0100 Subject: [PATCH] chore: add postgres setup to docs --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5cba28a4..0913b8a9 100644 --- a/README.md +++ b/README.md @@ -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: