Skip to content

RGBsec/rgbctf-backend

Repository files navigation

Welcome to rgbCTF 👋

Version Issues Documentation Maintenance License: MIT

MERN-based CTF platform

Prerequisites

  • yarn >=1.22.0
  • node >=10.20.1

Install

yarn install

Usage

Create a .env file in the local directory with these values:

  • MONGODB: Required. This is a MongoDB connection string used to connect to the backend database. If authentication or SSL is enabled, you must specify that in the connection string via the respective fields.
  • COOKIESECRET: Required. This is the secret used for express-session. This is used to sign the session ID cookie. It is recommended that this value is randomly generated.
  • PORT: Optional. This is the port used for this application. It defaults to 3000 if not specified.
  • DEBUG: Optional. Setting it to "rgbctf-backend" will cause debug messages to be logged.
  • REDISPORT: Optional. The port for the Redis instance. Defaults to 6379.
  • REDISHOST: Optional. The host for the Redis instance. Defaults to 127.0.0.1.
  • ALLOWCORS: Optional. If present with any non-empty string, CORS will be enabled with an origin of http://localhost:3000. This is mainly used for testing the frontend with the API.

Then, to start the application, run:

yarn start

Author

👤 RGBsec

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 RGBsec.
This project is MIT licensed.

About

A MERN stack based CTF platform

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •