Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.37 KB

development.md

File metadata and controls

42 lines (28 loc) · 1.37 KB

Development

Before you begin development, please be sure to read the architecture and deployment documentation.

Quick Development Setup

To quickly set up a development environment, use the following commands, which will build the dojo image and run it in a self-contained container:

BRANCH="master"  # or PR with "pull/N/head"

TAG="dev-$(printf '%s' "$BRANCH" | tr '/' '-' | tr -c '[:alnum:]' '-')"

docker build --build-arg BUILDKIT_CONTEXT_KEEP_GIT_DIR=1 -t "pwncollege/dojo:$TAG" "https://github.com/pwncollege/dojo.git#$BRANCH"

docker run --privileged --name "dojo-$TAG" -d "pwncollege/dojo:$TAG"

Start a VSCode tunnel (authenticated with your GitHub account) to this container using the following command:

docker exec -i "dojo-$TAG" dojo vscode

Testing

You can run the dojo CI testcases locally using ./deploy.sh -t. If you want to recreate the exact(ish) environment of our CI, do:

apt install gh # github CLI
gh auth login # login to your github
gh extension install nektos/gh-act # a github extension to simulate github actions
gh act # run the CI

Adding a config entry

  1. Add it with a reasonable default in dojo/dojo-init
  2. Propagate it to the relevant containers (typically ctfd) in docker-compose.sh
  3. Load it into a global in dojo_plugin/config.py
  4. Import it appropriately