Updates for Documentation
This commit is contained in:
29
README.md
29
README.md
@@ -21,6 +21,16 @@ Reusable scaffold for Ignition SCADA + Docker projects, designed to work with Cl
|
||||
- Docker + Docker Compose installed on the host (Ubuntu 24 recommended)
|
||||
- Git repo cloned to the host machine
|
||||
|
||||
### Automated (recommended)
|
||||
|
||||
```bash
|
||||
bash scripts/setup.sh
|
||||
```
|
||||
|
||||
The script creates the `proxy` network, sets up `~/.config/ignition-dev/secrets.env`, symlinks `docker/.env` to it, and scaffolds the gateway password file. Edit those two files, then jump to step 4 below.
|
||||
|
||||
### Manual
|
||||
|
||||
### 1. Create the secrets file
|
||||
|
||||
```bash
|
||||
@@ -47,7 +57,17 @@ Key variables in `.env`:
|
||||
| `GATEWAY_HOSTNAME` | `ignition.localhost` | Public hostname (Traefik routing) |
|
||||
| `POSTGRES_PASSWORD` | `changeme` | PostgreSQL password |
|
||||
|
||||
### 3. Build and start the stack
|
||||
### 3. Create the external Docker network
|
||||
|
||||
The stack uses an external `proxy` network (shared across projects). Create it once per Docker host:
|
||||
|
||||
```bash
|
||||
docker network create proxy
|
||||
```
|
||||
|
||||
This is a no-op if it already exists.
|
||||
|
||||
### 4. Build and start the stack
|
||||
|
||||
```bash
|
||||
cd docker
|
||||
@@ -55,14 +75,14 @@ docker compose build # builds the custom Ignition image
|
||||
docker compose up -d # starts all services in background
|
||||
```
|
||||
|
||||
### 4. Verify services are healthy
|
||||
### 5. Verify services are healthy
|
||||
|
||||
```bash
|
||||
docker compose ps # all services should show "healthy" or "running"
|
||||
curl -s http://localhost:8088/StatusPing # should return "RUNNING"
|
||||
```
|
||||
|
||||
### 5. Open the gateway
|
||||
### 6. Open the gateway
|
||||
|
||||
- Ignition gateway: http://localhost:8088
|
||||
- Traefik dashboard: http://localhost:8080
|
||||
@@ -71,7 +91,7 @@ curl -s http://localhost:8088/StatusPing # should return "RUNNING"
|
||||
> **Note:** On first boot the gateway skips the setup wizard (`commissioning.json` pre-commissions it).
|
||||
> Log in with username `admin` and the password from `gw-secret/GATEWAY_ADMIN_PASSWORD`.
|
||||
|
||||
### 6. Connect Ignition Designer
|
||||
### 7. Connect Ignition Designer
|
||||
|
||||
Open Ignition Designer Launcher, add gateway at `http://<host-ip>:8088`, and open the **Framework** project. The project files in `ignition/project/` are live-mounted — changes saved in Designer write directly to Git-tracked files.
|
||||
|
||||
@@ -85,6 +105,7 @@ See [CLAUDE.md](CLAUDE.md) for project directives, canonical patterns, and direc
|
||||
|
||||
```
|
||||
├── CLAUDE.md ← root directives (Claude Code reads this automatically)
|
||||
├── scripts/ ← setup and utility scripts
|
||||
├── docker/ ← Docker Compose stack and configs
|
||||
├── ignition/ ← Ignition project (mounted into container)
|
||||
├── testing/ ← test scenarios, runner, results
|
||||
|
||||
Reference in New Issue
Block a user