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

Commit bd56d18

Browse files
committed
docs: rename config links
1 parent 98111ab commit bd56d18

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/content/configuration.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,26 +45,26 @@ YAML/JSON name|environment name|required|default value|type|description
4545
`meta.description`|`RCTF_META_DESCRIPTION`|yes|`''`|string|OpenGraph and Twitter embed description
4646
`meta.imageUrl`|`RCTF_IMAGE_URL`|yes|`''`|string|OpenGraph and Twitter embed image URL
4747
`origin`|`RCTF_ORIGIN`|yes|_(none)_|string|public URL of the rCTF instance
48-
`homeContent`|`RCTF_HOME_CONTENT`|yes|`''`|string|markdown content for the homepage of the CTF. [See home doc](management/home.md)
48+
`homeContent`|`RCTF_HOME_CONTENT`|yes|`''`|string|markdown content for the homepage of the CTF. [documentation](management/home.md)
4949
`startTime`|`RCTF_START_TIME`|yes|_(none)_|integer|time at which the CTF starts, in milliseconds since the epoch
5050
`endTime`|`RCTF_END_TIME`|yes|_(none)_|integer|time at which the CTF ends, in milliseconds since the epoch
51-
`divisions`|_(none)_|yes|_(none)_|object|division IDs and their respective names. [See division doc](management/divisions.md)
52-
`defaultDivision`|_(none)_|no|_(none)_|string|default division ID. [See division doc](management/divisions.md)
53-
`divisionACLs`|_(none)_|no|_(none)_|array|ACLs for restricting division access. [See division doc](management/divisions.md)
51+
`divisions`|_(none)_|yes|_(none)_|object|division IDs and their respective names. [documentation](management/divisions.md)
52+
`defaultDivision`|_(none)_|no|_(none)_|string|default division ID. [documentation](management/divisions.md)
53+
`divisionACLs`|_(none)_|no|_(none)_|array|ACLs for restricting division access. [documentation](management/divisions.md)
5454

5555
### Additional
5656

5757
Optional configuration to enable additional features.
5858

5959
YAML/JSON name|environment name|required|default value|type|description
6060
-|-|-|-|-|-
61-
`sponsors`|_(none)_|yes|`[]`|array|list of CTF sponsors. [See home doc](management/home.md)
61+
`sponsors`|_(none)_|yes|`[]`|array|list of CTF sponsors. [documentation](management/home.md)
6262
`globalSiteTag`|`RCTF_GLOBAL_SITE_TAG`|no|_(none)_|string|Google Analytics site tag
6363
`logoUrl`|`RCTF_LOGO_URL`|no|_(none)_|string|URL to raster image of the CTF's logo. used in emails
64-
`email.provider`|_(none)_|no|_(none)_|provider|provider for email sending. [See email doc](providers/emails/index.md)
65-
`email.from`|_(none)_|no|_(none)_|provider|`from:` address when sending email. [See email doc](providers/emails/index.md)
66-
`ctftime.clientId`|`RCTF_CTFTIME_CLIENT_ID`|no|_(none)_|string|CTFtime OAuth client ID. [See CTFtime doc](integrations/ctftime.md)
67-
`ctftime.clientSecret`|`RCTF_CTFTIME_CLIENT_SECRET`|no|_(none)_|string|CTFtime OAuth client secret. [See CTFtime doc](integrations/ctftime.md)
64+
`email.provider`|_(none)_|no|_(none)_|provider|provider for email sending. [documentation](providers/emails/index.md)
65+
`email.from`|_(none)_|no|_(none)_|provider|`from:` address when sending email. [documentation](providers/emails/index.md)
66+
`ctftime.clientId`|`RCTF_CTFTIME_CLIENT_ID`|no|_(none)_|string|CTFtime OAuth client ID. [documentation](integrations/ctftime.md)
67+
`ctftime.clientSecret`|`RCTF_CTFTIME_CLIENT_SECRET`|no|_(none)_|string|CTFtime OAuth client secret. [documentation](integrations/ctftime.md)
6868

6969
### Advanced
7070

@@ -75,10 +75,10 @@ YAML/JSON name|environment name|required|default value|type|description
7575
`tokenKey`|`RCTF_TOKEN_KEY`|yes|_(none)_|string|base64 encoded 32 byte key used for encrypting tokens
7676
`loginTimeout`|`RCTF_LOGIN_TIMEOUT`|yes|3600000|integer|lifetime of registration, email update, and recovery links, in milliseconds
7777
`userMembers`|`RCTF_USER_MEMBERS`|yes|`true`|boolean|whether to allow a user to provide emails for individual members
78-
`database.migrate`|`RCTF_DATABASE_MIGRATE`|yes|`never`|`before | only | never`|how to run postgreSQL migrations. [See migration doc](management/migration.md)
79-
`instanceType`|`RCTF_INSTANCE_TYPE`|yes|`all`|`all | frontend | leaderboard`|what type of instance to run. [See scaling doc](management/scaling.md)
80-
`challengeProvider`|_(none)_|yes|`database`|provider|provider for challenges. [See challenge provider doc](providers/challenges/index.md)
81-
`uploadProvider`|_(none)_|yes|`local`|provider|provider for challenge file uploads. [See upload provider doc](providers/uploads/index.md)
78+
`database.migrate`|`RCTF_DATABASE_MIGRATE`|yes|`never`|`before | only | never`|how to run postgreSQL migrations. [documentation](management/migration.md)
79+
`instanceType`|`RCTF_INSTANCE_TYPE`|yes|`all`|`all | frontend | leaderboard`|what type of instance to run. [documentation](management/scaling.md)
80+
`challengeProvider`|_(none)_|yes|`database`|provider|provider for challenges. [documentation](providers/challenges/index.md)
81+
`uploadProvider`|_(none)_|yes|`local`|provider|provider for challenge file uploads. [documentation](providers/uploads/index.md)
8282
`database.sql`|`RCTF_DATABASE_URL`|either `database.sql` or `database.sql.*`|_(none)_|string|`postgres://` connection URI
8383
`database.sql.host`|`RCTF_DATABASE_HOST`|either `database.sql` or `database.sql.*`|_(none)_|string|hostname of a postgreSQL server
8484
`database.sql.port`|`RCTF_DATABASE_PORT`|either `database.sql` or `database.sql.*`|_(none)_|string|port number that postgreSQL is running on

0 commit comments

Comments
 (0)