BoilerWorks
|
1
|
# Configuration |
|
2
|
|
|
3
|
## boilerworks.yaml |
|
4
|
|
|
5
|
The manifest file that drives `boilerworks init`. Created by `boilerworks setup`, or write it by hand. |
|
6
|
|
|
7
|
```yaml |
|
8
|
project: my-app |
|
9
|
family: django-nextjs |
|
10
|
size: full |
|
11
|
topology: standard |
|
12
|
cloud: aws |
|
13
|
ops: true |
|
14
|
region: us-east-1 |
|
15
|
domain: myapp.com |
|
16
|
mobile: false |
|
17
|
web_presence: false |
|
18
|
compliance: |
|
19
|
- soc2 |
|
20
|
services: |
|
21
|
email: ses |
|
22
|
storage: null |
|
23
|
search: null |
|
24
|
cache: redis |
|
25
|
data: |
|
26
|
database: postgres |
|
27
|
migrations: true |
|
28
|
seed_data: true |
|
29
|
testing: |
|
30
|
e2e: playwright |
|
31
|
unit: true |
|
32
|
integration: true |
|
33
|
template_versions: {} |
|
34
|
``` |
|
35
|
|
|
36
|
## Fields |
|
37
|
|
|
38
|
| Field | Type | Description | |
|
39
|
|-------|------|-------------| |
|
40
|
| `project` | string | Slug — lowercase, letters/digits/hyphens | |
|
41
|
| `family` | string | Template name from `boilerworks list` | |
|
42
|
| `size` | `full` \| `micro` \| `edge` | Template size | |
|
43
|
| `topology` | `standard` \| `omni` \| `api-only` | Project structure | |
|
44
|
| `cloud` | `aws` \| `gcp` \| `azure` \| null | Cloud provider for infra | |
|
45
|
| `ops` | bool | Include boilerworks-opscode | |
|
46
|
| `region` | string | Cloud region | |
|
47
|
| `domain` | string | App domain | |
|
48
|
| `mobile` | bool | Include mobile template (Full only) | |
|
49
|
| `web_presence` | bool | Include marketing site (Full only) | |
|
50
|
| `compliance` | list | `soc2`, `hipaa`, `pci-dss`, `gdpr` | |
|
51
|
|
|
52
|
## Topologies |
|
53
|
|
|
54
|
**Standard** (default) — separate directories: |
|
55
|
``` |
|
56
|
my-app/ ← app repo (git init'd) |
|
57
|
my-app-ops/ ← Terraform repo (git init'd, if ops=true) |
|
58
|
``` |
|
59
|
|
|
60
|
**Omni** — single repo: |
|
61
|
``` |
|
62
|
my-app/ |
|
63
|
...app files... |
|
64
|
ops/ ← Terraform lives here |
|
65
|
``` |
|
66
|
|
|
67
|
**API-only** — no frontend: |
|
68
|
``` |
|
69
|
my-app/ ← backend only |
|
70
|
``` |
|
71
|
|
|
72
|
## annotated example |
|
73
|
|
|
74
|
See [`boilerworks.yaml.example`](https://github.com/ConflictHQ/boilerworks/blob/main/boilerworks.yaml.example) in the repo for a fully annotated manifest with all fields and their defaults. |
|
75
|
|