Skip to content

Commit

Permalink
Update some of the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
f1rehaz4rd committed Feb 13, 2023
1 parent 9a51009 commit 9c0caba
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Script Challenges Plugin

A CTFd plugin that allows competitors to upload scripts. The scripts are queued through RabbitMQ to be handled be a runner.
A CTFd plugin that allows competitors to upload scripts. The scripts are queued through RabbitMQ to be handled by a runner.

![](./img/solve.gif)

Expand All @@ -14,14 +14,14 @@ If you would like a very simple deployment, and the fastest way to get up and ru
|`EXECUTION_TIMEOUT`|`120` seconds |Timeout (in seconds) for submissions to become invalid.|
|`ALLOWED_EXTENSIONS`|`.py;.java;.txt`|File extension list the the competitors are allowed to upload.|

By modifying these settings a basic deployment will be set up that passes upload scripts to the [example consumer](./consumer/README.md).
By modifying these settings a basic deployment will be set up that passes upload scripts to the [example consumer](./consumer).

## Advanced Configuration
For more advanced deployment types, you will want to modify [./ctfd_script_challenges/config.py](). You can override all the settings mentioned above, as well as the `validate_file` function and the JSON data that is passed into RabbitMQ.
For more advanced deployment types, you will want to modify [./ctfd_script_challenges/config.py](./ctfd_script_challenges/config.py). You can override all the settings mentioned above, as well as the `validate_file` function and the JSON data that is passed into RabbitMQ.

## Consumer

The consumer takes the script from RabbitMQ, and basic information about the challenge and user who sumbitted, and returns the results back to CTFd.
The consumer takes the script from RabbitMQ, basic information about the challenge and user who sumbitted, and returns the results back to CTFd.

An example consumer has been provided in this repo for testing, for the actual consumer used in GhidraGolf, see [gg-consumer](https://github.com/ghidragolf/gg-consumer)

Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
pika
pika==1.3.1

0 comments on commit 9c0caba

Please sign in to comment.