Cyber Competition Scoring Platform
Need something else? Build you own with Check Template
git clone https://github.com/compscore/compscore.git
cd compscore# Generate neccesary code base on your configuration
make generate
# Install `compscore` binary onto your system to use
make installConfiguring Compscore is super easy! There are to two files you will need to edit config.yml, which is used for configuring Compscore itself, and .env, which configured how compscore is deployed.
config.yml is used to configure Compscore itself, there are a couple sections you will need to edit:
This section does not do anything, it just so you can name your configuration.
Use the following format to define new user:
users:
- username: username_1
password: password_1
- username: username_1
password: password_1
...Use the following format for team creation:
teams:
# amount of teams to create
amount: 15
# Name of users to create for compeitors
# This example use `Team XX` format (`Team 01` - `Team 15`)
nameFormat: Team { .Team }
# Default password of all competition teams
password: changeme123!Use the following format:
scoring:
# length of scoring rounds in seconds
interval: 30This section defines engine configuration, more than likely you will never have to edit this.
engine:
# file location of unix socket for interacting with compscore
socket: /tmp/compscore.sock
# grpc timeout in seconds for server running over unix socket
timeout: 5This section is for defining all checks to be ran in Compscore, it is a list of configurations as defined by these check's repositories.
Check out the check here: # Scorechecks
.env is an environment variable file which is injected into all container during a production deploy and is pulled locally during a development deploy in order to standardize options across all components on Compscore.
The options for the .env and what they do are as follows:
| variable | options | decription |
|---|---|---|
DEPLOY |
PRODUCTION, PROD, DEVELOPMENT, DEV |
type of deploy |
DOMAIN |
exmaple.com, http://10.0.0.0 |
domain/ip that Compscore is hosted from. IMPORTANT: Compscore uses ACME for domains that do not start with "http://", if your deploy is not public or does not have a domain use "https://[IP]" |
PORT |
default:8080, <any valid port> |
port for Compscore API to run on, this is tunneled via reverse proxy in production deploys to 80/443 |
JWT_SECRET |
<string password> |
secret to use when signing JWT keys (can be any string) |
TIMEOUT |
default:6, <any positive integers> |
expiration offset for frontend Compscore sessions in hours |
RELEASE |
default:false,true |
run web API in "release" (API debug printing disabled) |
POSTGRES_HOST |
default:db |
container name of database (do not change without also editing "docker-compose.yml) |
POSTGRES_USER |
default:compscore, <any string> |
user for Compscore to use to access database |
POSTGRES_PASSWORD |
<strong password> |
password for Compscore to authenticate to database with |
POSTGRES_PORT |
default:5432, <any valid port> |
port for postgres to listen on |
POSTGRES_DATABASE |
default:compscore, <any string> |
postgres database for Compscore to use |
REDIS_URL |
default: redis:6379 |
port for redis to listen on (do not change without editting "docker-compose.yml") |
REDIS_
66DD
PASSWORD |
<strong password> |
password Compscore to authenticate to redis with |
| subcommands | description |
|---|---|
generate |
generate all nessesary code based on configured checks |
server |
start compscore server interactively |
version |
provide all current verstion information of compscore install |
engine |
interact with scoring engine |
engine status |
get current status of scoring engine |
engine start |
spawn a daemon verions of server; if already exists, will start scoring on the engine |
engine pause |
pause scoring engine once round round complete |
engine kill |
kill scoring engine process safely |