Skip to content

Commit f8b8a0e

Browse files
committed
Adjust gettingstarted doc
1 parent 22d788d commit f8b8a0e

File tree

1 file changed

+7
-31
lines changed

1 file changed

+7
-31
lines changed

β€Ždocs/gettingstarted.md

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -93,41 +93,17 @@ SuperStack automatically:
9393
3. Launches PostgREST and Swagger UI
9494
4. Serves everything through Caddy
9595

96-
```mermaid
97-
flowchart TD
98-
Caddy["Caddy (API Gateway)"]
99-
Caddy --> Services["Services (PostgREST, Swagger UI + more)"]
100-
Services --> Postgres
101-
```
96+
## Change the Docker images to your own (Recommended)
10297

103-
> πŸ’‘ Only Caddy exposes a port – all services are routed through it.
98+
In `compose.yaml`, change the `explodinglabs` images to your own:
10499

105-
## Project Structure
100+
```yaml
101+
postgres:
102+
image: ghcr.io/youruser/myapp-postgres:0.1.0
106103

104+
caddy:
105+
image: ghcr.io/youruser/myapp-caddy:0.1.0
107106
```
108-
πŸ“ bin/ β†’ Helper scripts (e.g. wrappers for CLI tools)
109-
πŸ“ caddy/ β†’ Custom Caddy configuration and certificates
110-
πŸ“ docs/ β†’ Markdown files for SuperStack documentation
111-
πŸ“ postgres/ β†’ SQL migrations and configuration of the postgres container
112-
πŸ“„ compose.yaml β†’ Main Docker Compose config
113-
πŸ“„ compose.override.yaml β†’ Optional local overrides (development only)
114-
πŸ“„ example.env β†’ Example environment variables β€” copy to `.env`
115-
πŸ“„ LICENSE β†’ License file (MIT)
116-
πŸ“„ logo.png β†’ SuperStack logo for README/docs
117-
πŸ“„ mkdocs.yml β†’ MkDocs configuration for documentation site
118-
πŸ“„ README.md β†’ Overview and quick start for the repository
119-
```
120-
121-
## πŸ”„ Resetting
122-
123-
If you want to start fresh:
124-
125-
```sh
126-
docker compose down --volumes
127-
docker compose up -d
128-
```
129-
130-
This will wipe your database and re-run all migrations from scratch.
131107
132108
## βž• What's Next?
133109

0 commit comments

Comments
Β (0)