Simplify Quick Start: single docker compose up
- Dockerfile: auto-generate DUMPSTER_SECRET if not set - compose.yml: remove env_file requirement, use env vars with defaults, share web_assets volume with caddy - README: Quick Start is now 3 commands (clone, cd, docker compose up)
This commit is contained in:
@@ -7,29 +7,15 @@ Built for fun, maintained with pride, named with intent.
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Clone
|
||||
git clone ssh://git@git.dustin.coffee:2222/hobokenchicken/dumpsterChat.git
|
||||
cd dumpsterChat
|
||||
|
||||
# Copy and edit environment variables
|
||||
cp .env.example .env
|
||||
$EDITOR .env
|
||||
|
||||
# Start backing services
|
||||
docker compose -f docker/compose.yml up -d
|
||||
|
||||
# Run migrations
|
||||
go run ./cmd/migrate
|
||||
|
||||
# Start the server
|
||||
go run ./cmd/server
|
||||
|
||||
# In another terminal, start the web dev server
|
||||
cd web
|
||||
npm install
|
||||
npm run dev
|
||||
docker compose -f docker/compose.yml up
|
||||
```
|
||||
|
||||
That's it. Visit `http://localhost` to register and start chatting.
|
||||
|
||||
For optional features, copy `.env.example` to `.env` and set Giphy, MinIO, LiveKit, or VAPID keys.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
| Layer | Technology |
|
||||
@@ -126,8 +112,8 @@ See `.env.example` for the full list. Key variables:
|
||||
|----------|------------|----------|
|
||||
| `DUMPSTER_HOST` | Server bind address | No (default: localhost) |
|
||||
| `DUMPSTER_PORT` | Server port | No (default: 8080) |
|
||||
| `DUMPSTER_SECRET` | Session signing secret | Yes |
|
||||
| `POSTGRES_*` | Database connection | Yes |
|
||||
| `DUMPSTER_SECRET` | Session signing secret | No (auto-generated in Docker) |
|
||||
| `POSTGRES_*` | Database connection | No (defaults in compose) |
|
||||
| `LIVEKIT_*` | Voice/video server | No |
|
||||
| `GIPHY_API_KEY` | Giphy API key for GIF search | No |
|
||||
| `MINIO_*` | File upload storage | No |
|
||||
|
||||
Reference in New Issue
Block a user