This is a template for creating a continuously delivered nodecg dashboard for speedrun marathons.
- Create your own repository from this template. Make it a private repository if you plan to have any sensitive info stored.
- Edit
config/values.yaml
with your domain info. For the most basic setup you only need to fill in thedashboard
info. - Edit the env vars at the top of
.github/workflow/publish-to-ecr.yml
to match where you wish to publish stuff and what you want to call it. - Create an access token for DigitalOcean. Name it
DIGITALOCEAN_ACCESS_TOKEN
- You can modify this repo to use other cloud providers or run locally, but it'll take more effort.
- Drop any bundles you want into
nodecg/bundles
. These are included in the container. They must be fully built and ready to run. - Modify and add any configs in the
nodecg/templates
folder. These are run through jinja2 using theconfig_generator.py
script to include secrets from a secret calledENV_FILE
. The expected secrets for some basic marathon things is inexample.env
.- You might have to modify
config_generator.py
to have it run nicely if you add/remove secrets.
- You might have to modify
- Push your changes to your repo, if all goes well it should automatically build and deploy the changes.