Skip to content
This repository was archived by the owner on Feb 4, 2025. It is now read-only.

Commit 92e6436

Browse files
committed
docs: add challenge admin docs
1 parent 35c88ec commit 92e6436

File tree

8 files changed

+59
-6
lines changed

8 files changed

+59
-6
lines changed

docs/content/configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ YAML/JSON name|environment name|required|default value|type|description
6262
`meta.imageUrl`|`RCTF_IMAGE_URL`|yes|`''`|string|OpenGraph and Twitter embed image URL
6363
`logoUrl`|`RCTF_LOGO_URL`|no|_(none)_|string|URL to raster image of the CTF's logo. used in emails
6464
`globalSiteTag`|`RCTF_GLOBAL_SITE_TAG`|no|_(none)_|string|Google Analytics site tag
65-
`challengeProvider`|_(none)_|yes|`database`|provider|provider for challenges. [See challenge provider doc for more](../providers/challenges/index)
66-
`uploadProvider`|_(none)_|yes|`local`|provider|provider for challenge file uploads. [See upload provider doc for more](../providers/uploads/index)
67-
`email.provider`|_(none)_|no|_(none)_|provider|provider for email sending. [See email doc for more](../providers/emails/index)
68-
`email.from`|_(none)_|no|_(none)_|provider|`from:` address when sending email. [See email doc for more](../providers/emails/index)
65+
`challengeProvider`|_(none)_|yes|`database`|provider|provider for challenges. [See challenge provider doc for more](../providers/challenges)
66+
`uploadProvider`|_(none)_|yes|`local`|provider|provider for challenge file uploads. [See upload provider doc for more](../providers/uploads)
67+
`email.provider`|_(none)_|no|_(none)_|provider|provider for email sending. [See email doc for more](../providers/emails)
68+
`email.from`|_(none)_|no|_(none)_|provider|`from:` address when sending email. [See email doc for more](../providers/emails)
6969
`divisions`|_(none)_|yes|_(none)_|object|division IDs and their respective names. [See division doc for more](../management/divisions)
7070
`defaultDivision`|_(none)_|no|_(none)_|string|default division ID. [See division doc for more](../management/divisions)
7171
`divisionACLs`|_(none)_|no|_(none)_|array|ACLs for restricting division access. [See division doc for more](../management/divisions)

docs/content/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22

33
rCTF is redpwnCTF's CTF platform. It is developed and maintained by the
44
[redpwn](https://redpwn.net) CTF team.
5+
6+
To install rCTF, see [the installation doc](installation).

docs/content/installation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,11 @@ You can install rCTF in one command with [the installer script](https://get.rctf
55
```bash
66
curl https://get.rctf.redpwn.net | sh
77
```
8+
9+
## After installation
10+
11+
To configure rCTF, see [the configuration doc](../configuration).
12+
13+
To update the CTF's challenges, see [the admin doc](../management/admin).
14+
15+
To scale up rCTF, see the [migration](../management/migration) and [scaling](../management/scaling) docs.

docs/content/management/admin.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Challenge Admin
2+
3+
rCTF integrates with [rCDS](https://github.com/redpwn/rcds), which can automatically deploy challenges and sync them to rCTF.
4+
5+
To use rCTF without rCDS, create an admin user normally. Then, connect to postgreSQL and run:
6+
```sql
7+
UPDATE users SET perms=3 WHERE id='your user id';
8+
```
9+
10+
After running, you can manage the CTF's challenges using a web UI at:
11+
```
12+
https://your-rctf.example.com/admin/challs
13+
```

docs/content/providers/challenges/database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Database Challenge Provider
22

3-
The database challenge provider stores challenge details in the Postgresql database. To use it, specify `challenges/database` for the challenge provider name.
3+
The database challenge provider stores challenge details in the postgreSQL database. To use it, specify `challenges/database` for the challenge provider name.
44

55
## Configuration Example
66

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Email Provider Index
22

3-
Email providers send emails to competitors. In rCTF, Emails are used for registration, email updates, and recovery. At the moment, there are three email providers available:
3+
Email providers send emails to competitors. In rCTF, emails are used for registration, email updates, and recovery. At the moment, there are three email providers available:
4+
45
* [Mailgun](mailgun)
56
* [SES](ses)
67
* [SMTP](smtp)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Upload Provider Index
22

33
Upload providers store files for each challenge. At the moment, there are two upload providers available:
4+
45
* [Google Cloud Storage](gcs)
56
* [Local](local)

docs/mkdocs.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,34 @@ site_description: rCTF Documentation
33
site_author: redpwn
44
site_url: https://rctf.redpwn.net
55

6+
nav:
7+
- Home: index.md
8+
- Installation: installation.md
9+
- Configuration: configuration.md
10+
- Management:
11+
- Divisions: management/divisions.md
12+
- Home: management/home.md
13+
- Migration: management/migration.md
14+
- Scaling: management/scaling.md
15+
- Providers:
16+
- Index: providers/index.md
17+
- Challenges:
18+
- Index: providers/challenges/index.md
19+
- Database: providers/challenges/database.md
20+
- Emails:
21+
- Index: providers/emails/index.md
22+
- Mailgun: providers/emails/mailgun.md
23+
- SES: providers/emails/ses.md
24+
- SMTP: providers/emails/smtp.md
25+
- Uploads:
26+
- Index: providers/uploads/index.md
27+
- GCS: providers/uploads/gcs.md
28+
- Local: providers/uploads/local.md
29+
- Integrations:
30+
- CTFtime: integrations/ctftime.md
31+
- Development:
32+
- Manual installation: development/manual-installation.md
33+
634
repo_name: GitHub
735
repo_url: https://github.com/redpwn/rctf
836
edit_uri: blob/master/docs/content/

0 commit comments

Comments
 (0)