chore: update self hosting docs in readme
This commit is contained in:
12
README.md
12
README.md
@@ -45,6 +45,16 @@ See our [roadmap](https://kan.bn/kan/roadmap) for upcoming features.
|
|||||||
- [Drizzle ORM](https://orm.drizzle.team/?ref=kan.bn)
|
- [Drizzle ORM](https://orm.drizzle.team/?ref=kan.bn)
|
||||||
- [React Email](https://react.email/?ref=kan.bn)
|
- [React Email](https://react.email/?ref=kan.bn)
|
||||||
|
|
||||||
|
## Self Hosting (under construction) 🐳
|
||||||
|
|
||||||
|
Deploy Kan with Docker using our pre-built image:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker pull ghcr.io/kanbn/kan:latest && docker run -it -p 3000:3000 --env-file .env ghcr.io/kanbn/kan:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
Make sure to create a `.env` file with the required environment variables (see the Environment Variables section below).
|
||||||
|
|
||||||
## Local Development 🧑💻
|
## Local Development 🧑💻
|
||||||
|
|
||||||
1. Clone the repository (or fork)
|
1. Clone the repository (or fork)
|
||||||
@@ -75,7 +85,7 @@ pnpm dev
|
|||||||
## Environment Variables 🔐
|
## Environment Variables 🔐
|
||||||
|
|
||||||
| Variable | Description | Required | Example |
|
| Variable | Description | Required | Example |
|
||||||
| -------------------------------- | ----------------------------- | ---------------- | --------------------------------------------- |
|
| -------------------------------- | ----------------------------- | ----------------- | --------------------------------------------- |
|
||||||
| `POSTGRES_URL` | PostgreSQL connection URL | Yes | `postgres://user:pass@localhost:5432/db` |
|
| `POSTGRES_URL` | PostgreSQL connection URL | Yes | `postgres://user:pass@localhost:5432/db` |
|
||||||
| `EMAIL_FROM` | Sender email address | Yes | `"Kan <hello@mail.kan.bn>"` |
|
| `EMAIL_FROM` | Sender email address | Yes | `"Kan <hello@mail.kan.bn>"` |
|
||||||
| `SMTP_HOST` | SMTP server hostname | Yes | `smtp.resend.com` |
|
| `SMTP_HOST` | SMTP server hostname | Yes | `smtp.resend.com` |
|
||||||
|
|||||||
Reference in New Issue
Block a user