From d786d91331941b8782e17d5d15e0e4f72de7f509 Mon Sep 17 00:00:00 2001 From: elpatron Date: Mon, 12 Jan 2026 21:19:37 +0100 Subject: [PATCH] Update README with correct Docker volume paths --- README.md | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a53bdcd..6db3d5d 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,31 @@ Telegram doesn't support simple Webhooks natively for users. The easiest way is *Note: The app sends notifications automatically whenever a booking is deleted.* +## 🐳 Deployment (Docker) -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +The easiest way to host the Cat Sitting Planner is via Docker. -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +### 1. Build & Run +```bash +docker-compose up -d --build +``` -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. +### 2. Persist Data +The database is stored in `/app/data/dev.db` inside the container. To persist your plans and bookings, map a volume to `/app/data`: + +**Example `docker-compose.yml` volume:** +```yaml +volumes: + - ./data:/app/data +``` + +If you are using Unraid or a custom path: +```yaml +volumes: + - /mnt/user/appdata/csp:/app/data +``` + +--- ## Learn More @@ -34,9 +53,3 @@ To learn more about Next.js, take a look at the following resources: - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.