Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugsy/ctfhub
Where CTFs happen
https://github.com/hugsy/ctfhub
collaboration ctf ctf-tools ctfs ctftime django hedgedoc managing-ctfs python3
Last synced: about 2 months ago
JSON representation
Where CTFs happen
- Host: GitHub
- URL: https://github.com/hugsy/ctfhub
- Owner: hugsy
- Created: 2020-11-15T21:07:01.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-30T00:24:43.000Z (7 months ago)
- Last Synced: 2024-11-10T01:22:53.043Z (about 2 months ago)
- Topics: collaboration, ctf, ctf-tools, ctfs, ctftime, django, hedgedoc, managing-ctfs, python3
- Language: Python
- Homepage:
- Size: 3.59 MB
- Stars: 77
- Watchers: 6
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
CTFHub
Where CTFs happen
## What is it?
A collaborative environment for teams playing [CTFs](https://en.wikipedia.org/wiki/Wargame_(hacking)). It provides out-of-the-box everything to manage and collaborate on the CTFs and challenges you and your team are working on.
_Note_: If you're looking for a platform for hosting CTFs use [CTFd](https://github.com/ctfd/ctfd).
## Features
A non-exhaustive list of features:
- Django 4 running on Python 3.10, with a clean Bootstrap 5 interface
- Key-in-hands setup via [`docker-compose`](https://docs.docker.com/compose)
- Fully integrated around [HedgeDoc](https://github.com/hedgedoc/hedgedoc): smart markdown note mechanism, with [tons of features](https://demo.hedgedoc.org/features)
- Possibility to create and play private CTFs for one player only, making it easy to track your progress on learning platforms like [Root-Me](https://www.root-me.org/), [PicoCTF](https://picoctf.com/), [PentesterLab](https://pentesterlab.com/) and others.
- Add "guests" to specific CTFs, allowing non team members to have a limited view of the context
- View CTF stats, and track members' involment through a cool podium ranking
- CTFTime API integration: CTF information from CTFTime in one click
- CTFd/rCTF challenge(s) can optionally be pre-populated locally
- Basic search engine
- Easily export your challenge notes to create a blog post on Github Pages
- [Jitsi](https://meet.jit.si) integration: instantly jump on video chat with your team mate
- Public & Self-hosted [Excalidraw](https://github.com/excalidraw/excalidraw) integration: draw & share ideas with your team mates
- [Discord](https://discord.gg) notifications on events (CTF registration, challenge scoring, etc.)
- and of course, a Dark mode to save your eyes during those painful sleepless nights
## Build
For most people, this will suffice:
```bash
$ git clone https://github.com/hugsy/ctfhub && cd ctfhub
$ cp .env.example .env
### CHANGE THE CREDENTIALS IN .env ###
$ nano .env
### BUILD EXCALIDRAW USING .env VARIABLES ###
$ docker compose up -d --build
```
For more advanced building cases, refer to the [Build page](docs/build.md) in the documentation.
## Gallery
Check out the [docs](docs/gallery.md)
## Contribution
`CTFHub` was created and maintained by [`@_hugsy_`](https://twitter.com/_hugsy_), but kept fresh thanks to [all the contributors](https://github.com/hugsy/ctfhub/graphs/contributors).
[  ](https://github.com/hugsy/ctfhub/graphs/contributors)
If you just like the tool, consider dropping on Discord (or Twitter or other) a simple *"thanks"*, it is always very appreciated.
And if you can, consider [sponsoring me](https://github.com/hugsy/sponsors) - it really helps dedicating time and resources to the projects!
## Credits and Links
- The world flag images are downloaded from https://flagpedia.net/
- [CTFPad](https://github.com/StratumAuhuur/CTFPad): NodeJS project that is based on [`etherpad-lite`](https://yopad.eu) (no MarkDown support).