Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.74 KB

README.md

File metadata and controls

46 lines (30 loc) · 1.74 KB
Raw

CTFd Helm Chart

Artifact Hub

CTFd is a Capture The Flag framework focusing on ease of use and customizability. It comes with everything you need to run a CTF and it's easy to customize with plugins and themes.

Chart Details

This chart will install an instance of CTFd, with the possibility of persisting uploads using a PersistentVolumeClaim, and persisting CTF data through an included (or optionally external) database and Redis for cache.

Installing the Chart

To install the chart with the release name my-release:

$ export HELM_EXPERIMENTAL_OCI=1
$ helm -n ctfd install my-release oci://ghcr.io/bman46/ctfd/ctfd

If you get an authentication required error, you may need to specify the version of the chart using the --version flag. See issue #4 for more information.

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm uninstall my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

Check the values.yaml file for configuration details.

Specify each parameter using the --set key=value[,key=value] argument to helm install.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ export HELM_EXPERIMENTAL_OCI=1
$ helm -n ctfd install my-release oci://ghcr.io/bman46/ctfd/ctfd

Note
You can override the default values.yaml file using the --values=path/to/overrides/file flag.