Skip to content

Commit bfdee4e

Browse files
committed
docs: add pages in YAML configuration file and files as sources
1 parent 90013b3 commit bfdee4e

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,23 @@ mode: users
4646
**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).
4747
Nevertheless, please do not commit the admin credentials ! Use `from_env` objects instead (refer to [the YAML Schema](#schema) for more info).
4848

49+
It could also deploy custom pages (like the index) as follows.
50+
This feature is not available in CLI, [GitHub Actions](#github-actions) and [Drone CI](#drone-ci).
51+
52+
```yaml
53+
# ... other configuration attributes
54+
55+
pages:
56+
additional:
57+
- title: CTFer.io example index
58+
route: index
59+
format: markdown
60+
content: |
61+
<div>
62+
<p>Some index page content</p>
63+
</div>
64+
```
65+
4966
For further configuration, please refer to the binary's specific API through `ctfd-setup --help`.
5067

5168
### GitHub Actions

res/how-to-use.excalidraw.png

-2.78 KB
Loading

0 commit comments

Comments
 (0)