KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #claude-code #codex #dsh #dsh-plugin #ai-agent #ai-agents #deepseek-harness #agent-skills #macos #cli

rctf

★ 105 Open GitHub ↗

rCTF is a platform for hosting cybersecurity capture-the-flag competitions.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# <picture><source media="(prefers-color-scheme: dark)" srcset="apps/docs/public/static/banner-dark.svg" /><img alt="rCTF" src="apps/docs/public/static/banner-light.svg" /></picture>

[![Docs][Docs Badge]][Docs]
[![CI][CI Badge]][CI]
[![Release][Release Badge]][Releases]
[![Container][Container Badge]][Container]

</div>

rCTF is a platform for hosting cybersecurity [capture-the-flag](<https://en.wikipedia.org/wiki/Capture_the_flag_(cybersecurity)>) competitions.

rCTF keeps deployment simple without locking organizers into one set of services. The platform runs as a single bundle, and its major integrations use replaceable providers with a common configuration format. An event can use only what it needs and change providers later without rewriting the platform.

To get started with rCTF, visit the [documentation](https://rctf.osec.io). A [live demo](https://demo.rctf.osec.io) is also available for viewing. If you need help with rCTF, [start a discussion](https://github.com/otter-sec/rctf/discussions).

---

| <picture><source media="(prefers-color-scheme: dark)" srcset="apps/docs/public/static/preview-01-dark.png" /><img alt="Preview 1" src="apps/docs/public/static/preview-01-light.png" /></picture> | <picture><source media="(prefers-color-scheme: dark)" srcset="apps/docs/public/static/preview-02-dark.png" /><img alt="Preview 2" src="apps/docs/public/static/preview-02-light.png" /></picture> |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <picture><source media="(prefers-color-scheme: dark)" srcset="apps/docs/public/static/preview-03-dark.png" /><img alt="Preview 3" src="apps/docs/public/static/preview-03-light.png" /></picture> | <picture><source media="(prefers-color-scheme: dark)" srcset="apps/docs/public/static/preview-04-dark.png" /><img alt="Preview 4" src="apps/docs/public/static/preview-04-light.png" /></picture> |

---

## Development

rCTF requires [Bun v1.0+](https://bun.sh/).

1. Install dependencies:

```sh
   bun i
   ```

2. Start the development containers:

```sh
   docker compose -f compose.dev.yml up -d
   ```

3. Create `rctf.d/00-development.yaml` and enter the following configuration:

```yml
   ctfName: rCTF Development
   meta:
     description: 'Example rCTF instance'
     imageUrl: 'https://example.com'
   homeContent: "A description of your CTF. Markdown supported.\n\n<timer></timer>"

origin: http://127.0.0.1:5173
   divisions:
     open: Open
   tokenKey: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=
   startTime: 0
   endTime: 99999999999999

database:
     sql:
       host: 127.0.0.1
       port: 5432
       # host: postgres
       user: rctf
       password: DO_NOT_USE_ME
       database: rctf
     redis:
       host: 127.0.0.1
       port: 6379
       # host: redis
       password: DO_NOT_USE_ME
     migrate: before

# email:
   #   from: es3n1n@es3n1n.eu
   #   provider:
   #     name: 'emails/smtp'
   #     options:
   #       smtpUrl: 'smtp://es3n1n%es3n1n.eu:password@server.com:587'

# ctftime:
   #   clientId: 2288
   #   clientSecret: secret

# instancers:
   #   docker:
   #     name: 'instancers/docker'
   #     options:
   #       authToken: 'changeme!'
   #       apiUrl: 'http://tiny-instancer:1337'
   # defaultInstancer: docker

# captcha:
   #   provider:
   #     name: 'captcha/hcaptcha'
   #     options:
   #       siteKey: 'key'
   #       secretKey: 'secret'
   #   protectedEndpoints:
   #     - register
   #     - recover
   #     - setEmail
   #     - instancerStart
   #     - instancerExtend
   #     - avatarUpload
   #     - adminBotSubmit

# bloodBot:
   #   bloodsCount: 1
   #   destinations:
   #     - provider:
   #         name: 'messages/discord'
   #         options:
   #           url: 'webhook-url'
   #     - provider:
   #         name: 'messages/telegram'
   #         options:
   #           botToken: 'bot-token'
   #           chatId: 1337

# adminBot:
   #   provider:
   #     name: 'admin-bots/rctf-ts'
   #     options:
   #       secretKey: beans
   #       endpoint: 'http://admin-bot:21337'

# avatarsModeration:
   #   provider:
   #     name: 'moderation/openai'
   #     options:
   #         apiKey: 'key'

# globalSiteTag: 'G-1337'

# uploadProvider:
   #   name: 'uploads/gcs'
   #   options:
   #     projectId: project-id
   #     bucketName: bucket-name
   #     credentials:
   #       private_key: |-
   #         key
   #       client_email: me@me.iam.gserviceaccount.com
   ```

</details>

4. Start the development server:

```sh
   bun dev
   ```

For frontend work, run `bun dev:mock` to seed the database with a reproducible set of mock teams, challenges, and solves.

[Docs]: https://rctf.osec.io
[Docs Badge]: https://img.shields.io/badge/docs-rctf.osec.io-ca3c41?style=flat-square
[CI]: https://github.com/otter-sec/rctf/actions/workflows/ci.yml
[CI Badge]: https://img.shields.io/github/actions/workflow/status/otter-sec/rctf/ci.yml?branch=main&label=ci&logo=github&color=404040&style=flat-square
[Releases]: https://github.com/otter-sec/rctf/releases
[Release Badge]: https://img.shields.io/github/v/release/otter-sec/rctf?label=release&logo=github&color=a1a1a1&style=flat-square
[Container]: https://github.com/otter-sec/rctf/pkgs/container/rctf
[Container Badge]: https://img.shields.io/badge/ghcr.io-otter--sec%2Frctf-e5e5e5?logo=docker&logoColor=white&style=flat-square

rctf

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README