You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-3Lines changed: 15 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,12 +44,10 @@ mode: users
44
44
```
45
45
46
46
**We encourage you to version this file** such that re-deployment is easy (e.g., for test purposes, or in case of a catastrophic failure of the infra during the event).
47
-
Nevertheless, please do not commit the admin credentials ! Use the corresponding environment variables and provide their value from a safe secret store.
47
+
Nevertheless, please do not commit the admin credentials ! Use `from_env` objects instead (refer to [the YAML Schema](#schema) for more info).
48
48
49
49
For further configuration, please refer to the binary's specific API through `ctfd-setup --help`.
50
50
51
-
If you are using it as part of Infra as Code provisionning, you can map the values of this configuration file to environment variables (which could ease your job).
52
-
53
51
### GitHub Actions
54
52
55
53
To improve our own workflows and share knownledges and tooling, we built a GitHub Action: `ctfer-io/ctfd-setup`.
@@ -71,6 +69,8 @@ jobs:
71
69
uses: 'ctfer-io/ctfd-setup@v1.4.4'
72
70
with:
73
71
url: ${{ secrets.CTFD_URL }}
72
+
file: '.ctfd.yaml'
73
+
# or directly attributes
74
74
appearance_name: 'My CTF'
75
75
appearance_description: 'My CTF description'
76
76
admin_name: ${{ secrets.ADMIN_USERNAME }}
@@ -102,6 +102,8 @@ steps:
102
102
settings:
103
103
url:
104
104
from_secret: CTFD_URL
105
+
file: '.ctfd.yaml'
106
+
# or directly attributes
105
107
appearance_name: 'My CTF'
106
108
appearance_description: 'My CTF description'
107
109
admin_name:
@@ -113,6 +115,16 @@ steps:
113
115
# ... and so on (non-mandatory attributes)
114
116
```
115
117
118
+
## Schema
119
+
120
+
For ease of use, you can generate and use the `ctfd-setup` YAML schema using `ctfd-setup schema`.
121
+
122
+
In your `.ctfd.yaml` file you could then prepend `# yaml-language-server: $schema=file:///path/to/schema.json`.
0 commit comments