Configuration

1
ctfName: My CTF # CTF display name (required)
2
origin: https://ctf.example.com # Public origin URL (required)
3
tokenKey: <base64-32-byte-key> # Token encryption key (required)
4
instanceType: all # all | frontend | leaderboard
5
shutdownTimeout: 30000 # Graceful-shutdown cap in ms
6
idleTimeout: 65 # Idle connection timeout in seconds
7
maxRequestBodySize: 1073741824 # Maximum request body size in bytes

1
database:
2
  sql: postgres://user:password@localhost:5432/rctf
3
  redis: redis://localhost:6379
4
  migrate: never

1
database:
2
  sql:
3
    host: localhost
4
    port: 5432
5
    user: rctf
6
    password: secret
7
    database: rctf
8
    maxPoolSize: 100 # Default: 100
9
    idleTimeout: 30000 # Default: 30000 (ms)
10
    connectTimeout: 3000 # Default: 3000 (ms)

1
database:
2
  redis:
3
    host: localhost
4
    port: 6379
5
    password: secret # Optional
6
    database: 0 # Optional, default 0

1
startTime: 1735689600000 # January 1, 2025 00:00 UTC
2
endTime: 1735776000000 # January 2, 2025 00:00 UTC

1
divisions:
2
  open: Open
3
  student: Student
4
defaultDivision: open
5
divisionACLs:
6
  - match: domain
7
    value: example.edu
8
    divisions: [student, open]
9
  - match: any
10
    value: ''
11
    divisions: [open]

1
registrationsEnabled: true
2
userMembers: true
3
maxMembers: 50
4
loginTimeout: 3600000
5
ctftime:
6
  clientId: '12345'
7
  clientSecret: your-secret

1
uploadProvider:
2
  name: uploads/s3
3
  options:
4
    bucketName: my-bucket
5
    awsKeyId: AKIAIOSFODNN7EXAMPLE
6
    awsKeySecret: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
7
    awsRegion: us-east-1

1
scoreProvider:
2
  name: scores/classic

1
captcha:
2
  provider:
3
    name: captcha/turnstile
4
    options:
5
      siteKey: your-site-key
6
      secretKey: your-secret-key
7
  protectedEndpoints:
8
    - register
9
    - recover

1
instancers:
2
  docker:
3
    name: instancers/docker
4
    options:
5
      apiUrl: http://localhost:8000
6
      authToken: secret
7
  k8s:
8
    name: instancers/k8s
9
    options:
10
      apiUrl: https://k8s.example.com
11
      authToken: <service-account-token>
12
  k8s-arm:
13
    name: instancers/k8s
14
    options:
15
      apiUrl: https://k8s-arm.example.com
16
      authToken: <service-account-token>
17
defaultInstancer: k8s

1
adminBot:
2
  provider:
3
    name: admin-bots/rctf-ts
4
    options: {}
5
  maxLogsPerUserChallenge: 5

1
email:
2
  provider:
3
    name: emails/smtp
4
    options:
5
      smtpUrl: smtp://user:pass@mail.example.com:587
6
  from: noreply@example.com
7
  logoUrl: https://example.com/email-logo.png

1
homeContent: |
2
  Welcome to My CTF!
3

4
  **Markdown** is supported.
5
sponsors:
6
  - name: Sponsor Name
7
    iconLight: https://example.com/sponsor-light.png
8
    iconDark: https://example.com/sponsor-dark.png
9
    description: Sponsor description
10
    url: https://sponsor.com
11
meta:
12
  description: A cool CTF competition
13
  imageUrl: https://example.com/banner.png
14
faviconUrl: https://example.com/favicon.ico
15
logoLightUrl: https://example.com/logo-light.svg
16
logoDarkUrl: https://example.com/logo-dark.svg
17
flagFormatPlaceholder: 'flag{[\x20-\x7e]+}'

1
analytics:
2
  provider:
3
    name: analytics/google
4
    options:
5
      siteTag: G-XXXXXXXXX

1
maxAvatarSize: 1048576 # 1 MB
2
leaderboard:
3
  maxLimit: 100
4
  maxOffset: 4294967296
5
  updateInterval: 30000
6
  graphMaxTeams: 10
7
  graphSampleTime: 300000
8
  graphWithListLimit: 100

1
avatarsModeration:
2
  provider:
3
    name: moderation/openai
4
    options:
5
      apiKey: sk-...
6
  allowOnInternalError: true

1
proxy:
2
  cloudflare: true
3
  trust: 2

1
bloodBot:
2
  bloodsCount: 3
3
  destinations:
4
    - provider:
5
        name: messages/discord
6
        options:
7
          url: https://discord.com/api/webhooks/...
8
      bloodEmojis:
9
        - '<:rank1:1008801500736266261>'
10
        - '<:rank2:1008801501776449738>'
11
        - '<:rank3:1008801503080874056>'
12
      messageTemplate: '{{bloodEmoji}} {{bloodNumTitle}} solve for challenge "**{{challengeName}}**" goes to **{{teamName}}**!'
13
    - provider:
14
        name: messages/telegram
15
        options:
16
          botToken: '123456:ABC-DEF...'
17
          chatId: '-1001234567890'