docs: update README, AGENT, ARQUITECTURE for 555xx ports, Portainer deploy, absolute paths
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# MC Cars – Dockerized Supabase CRM
|
||||
|
||||
Self-hosted Supabase stack + bilingual (DE/EN) public website + lead-management admin panel. Everything lives under this folder. Copying the folder to another machine and running `docker compose up -d` reproduces the stack bit-for-bit — all runtime state is under `./data/` bind mounts, no named volumes.
|
||||
Self-hosted Supabase stack + bilingual (DE/EN) public website + lead-management admin panel. Designed for Portainer deployment — no `build:` steps, all services use pre-built images with bind mounts. The host deployment root is `/mnt/user/appdata/mc-cars`.
|
||||
|
||||
## What's inside
|
||||
|
||||
@@ -14,19 +14,28 @@ Self-hosted Supabase stack + bilingual (DE/EN) public website + lead-management
|
||||
| `realtime` | `supabase/realtime:v2.30.23` | Live `postgres_changes` subscriptions |
|
||||
| `meta` | `supabase/postgres-meta:v0.84.2` | Schema introspection for Studio |
|
||||
| `post-init` | `postgres:15-alpine` | Idempotent bootstrap: seed admin + migrations |
|
||||
| `kong` | `kong:2.8.1` | Single API gateway at `:54321` |
|
||||
| `studio` | `supabase/studio` | Supabase dashboard (`:3000`) |
|
||||
| `web` | local `nginx:alpine` build | Public site + admin panel (`:8080`) |
|
||||
| `kong` | `kong:2.8.1` | Single API gateway at `:55521` |
|
||||
| `studio` | `supabase/studio` | Supabase dashboard (`:55530`) |
|
||||
| `web` | `nginx:1.27-alpine` | Public site + admin panel (`:55580`) |
|
||||
|
||||
## Requirements
|
||||
|
||||
- Docker Desktop / Docker Engine with Compose v2
|
||||
- Free ports: `3000`, `5432`, `8080`, `54321`, `54443`
|
||||
- Docker Engine with Compose v2 (or Portainer with Stacks)
|
||||
- Free ports: `55521`, `55530`, `55532`, `55543`, `55580`
|
||||
|
||||
## Run
|
||||
|
||||
```powershell
|
||||
cd 'c:\Coding\MC Cars GmbH'
|
||||
### Via Portainer (recommended)
|
||||
|
||||
1. Clone the repo onto the host: `git clone <repo> /mnt/user/appdata/mc-cars`
|
||||
2. `chmod +x /mnt/user/appdata/mc-cars/frontend/99-config.sh /mnt/user/appdata/mc-cars/supabase/migrations/00-run-init.sh`
|
||||
3. `mkdir -p /mnt/user/appdata/mc-cars/data/{db,storage}`
|
||||
4. Portainer → Stacks → Add stack → paste `docker-compose.yml` → paste `.env` into Environment variables → Deploy.
|
||||
|
||||
### Via CLI
|
||||
|
||||
```bash
|
||||
cd /mnt/user/appdata/mc-cars
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
@@ -34,21 +43,20 @@ First boot pulls ~1.5 GB of images and runs migrations (`01-init.sql`, `post-boo
|
||||
|
||||
### Stop / reset
|
||||
|
||||
```powershell
|
||||
docker compose down # stop, keep data
|
||||
docker compose down -v # stop + delete named volumes (there are none anymore)
|
||||
Remove-Item -Recurse -Force .\data # FULL wipe (needed to re-run first-boot migrations)
|
||||
```bash
|
||||
docker compose down # stop, keep data
|
||||
rm -rf /mnt/user/appdata/mc-cars/data/db # FULL DB wipe (re-runs first-boot migrations)
|
||||
```
|
||||
|
||||
## URLs
|
||||
|
||||
| Purpose | URL |
|
||||
| ------------------------------- | -------------------------------- |
|
||||
| Public website | http://localhost:8080 |
|
||||
| Admin panel | http://localhost:8080/admin.html |
|
||||
| Supabase Studio | http://localhost:3000 |
|
||||
| API gateway (Kong) | http://localhost:54321 |
|
||||
| Postgres | `localhost:5432` |
|
||||
| Purpose | URL |
|
||||
| ------------------------------- | --------------------------------- |
|
||||
| Public website | http://\<host\>:55580 |
|
||||
| Admin panel | http://\<host\>:55580/admin.html |
|
||||
| Supabase Studio | http://\<host\>:55530 |
|
||||
| API gateway (Kong) | http://\<host\>:55521 |
|
||||
| Postgres | `<host>:55532` |
|
||||
|
||||
> Admin access is deliberately **not** linked from the public site. Bookmark it.
|
||||
|
||||
@@ -69,9 +77,9 @@ The admin is seeded with `must_change_password = true` in `raw_user_meta_data`.
|
||||
- RPCs: `qualify_lead(uuid, text)`, `disqualify_lead(uuid, text)`, `reopen_lead(uuid)` — transactional, `SECURITY INVOKER`, `authenticated` only.
|
||||
- Realtime: `supabase_realtime` publication broadcasts inserts/updates on leads, customers, vehicles.
|
||||
|
||||
## Portability
|
||||
## Deployment & portability
|
||||
|
||||
Runtime state under `./data/`:
|
||||
Runtime state under `/mnt/user/appdata/mc-cars/data/`:
|
||||
|
||||
```
|
||||
data/
|
||||
@@ -79,7 +87,13 @@ data/
|
||||
└── storage/ # vehicle-photos bucket content
|
||||
```
|
||||
|
||||
Everything else (config, migrations, frontend) is in the repo. Zip the folder, scp it, `docker compose up -d` — you have the same stack.
|
||||
All bind mounts in `docker-compose.yml` use absolute paths under `/mnt/user/appdata/mc-cars`. Clone the repo there, deploy as a Portainer stack, done. No `build:` steps — every service pulls a pre-built image.
|
||||
|
||||
To put behind **Nginx Proxy Manager** with a single public domain (`cars.yourdomain.com`):
|
||||
- Proxy `/` → `mccars-web:80` (or `<host>:55580`)
|
||||
- Custom locations `/auth/v1/`, `/rest/v1/`, `/realtime/v1/`, `/storage/v1/` → `mccars-kong:8000` (or `<host>:55521`)
|
||||
- Do **not** expose `/pg/` or Studio publicly.
|
||||
- Update `.env` URLs to `https://cars.yourdomain.com`.
|
||||
|
||||
## Project layout
|
||||
|
||||
@@ -96,17 +110,19 @@ MC Cars/
|
||||
│ ├── post-boot.sql # admin user (must_change_password) + bucket row
|
||||
│ └── 02-leads.sql # leads, customers, RPCs, realtime publication
|
||||
├── frontend/
|
||||
│ ├── Dockerfile # nginx + runtime anon-key injection
|
||||
│ ├── Dockerfile # (legacy, not used in Portainer deploy)
|
||||
│ ├── 99-config.sh # entrypoint: injects config.js with anon key
|
||||
│ ├── nginx.conf
|
||||
│ ├── index.html # public DE/EN site, booking form -> leads
|
||||
│ ├── admin.html # auth-gated CRM
|
||||
│ ├── app.js
|
||||
│ ├── admin.js # realtime + qualify/disqualify + password change
|
||||
│ ├── config.js # anon-only runtime config
|
||||
│ ├── config.js # anon-only runtime config (generated at boot)
|
||||
│ ├── i18n.js
|
||||
│ ├── styles.css
|
||||
│ ├── impressum.html
|
||||
│ └── datenschutz.html
|
||||
├── .gitattributes # enforces LF on .sh files
|
||||
├── AGENT.md # findings, conventions, traps
|
||||
└── ARQUITECTURE.md # architecture deep-dive
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user