https://github.com/ctfer-io/ctfd-setup

Utility to version your CTFd setup configuration.
https://github.com/ctfer-io/ctfd-setup

action ctfd docker golang utility versionning

Last synced: 24 days ago
JSON representation

Utility to version your CTFd setup configuration.

• Host: GitHub
• URL: https://github.com/ctfer-io/ctfd-setup
• Owner: ctfer-io
• License: apache-2.0
• Created: 2024-04-07T20:10:30.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-09-30T05:45:07.000Z (about 1 month ago)
• Last Synced: 2024-09-30T23:40:54.624Z (about 1 month ago)
• Topics: action, ctfd, docker, golang, utility, versionning
• Language: Go
• Homepage:
• Size: 457 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  
CTFd-Setup

  
Version your CTFd setup configuration.



  

  

  

	


	

    





CTFd does not have the concept of **configuration file**, leading to **deployment complications** and the **impossibility to version configurations**.

This is problematic for reproducibility or sharing configuration for debugging or replicating a CTF infrastructure.

Moreover, the setup API does not exist, so we had to map it to what the frontend calls in [go-ctfd](https://github.com/ctfer-io/go-ctfd/blob/main/api/setup.go).

To fit those gaps, we built `ctfd-setup` on top of the CTFd API. This utility helps setup a CTFd instance from a YAML configuration file, CLI flags and environment variables.

Thanks to this, you can integrate it using **GitHub Actions**, **Drone CI** or even as part of your **IaC provisionning**.

## How to use



    



For the CLI configuration, please refer to the binary's specific API through `ctfd-setup --help`.

In use of IaC provisionning scenario, the corresponding environment variables are also mapped to the output, so please refer to it.

### GitHub Actions

To improve our own workflows and share knownledges and tooling, we built a GitHub Action: `ctfer-io/ctfd-setup`.

You can use it given the following example.

```yaml

name: 'My workflow'

on:

  push:

    branches:

      - 'main'

jobs:

  my-job:

    runs-on: 'ubuntu-latest'

    steps:

      - name: 'Setup CTFd'

        uses: 'ctfer-io/[email protected]'

        with:

          url: ${{ secrets.CTFD_URL }}

          appearance_name: 'My CTF'

          appearance_description: 'My CTF description'

          admin_name: ${{ secrets.ADMIN_USERNAME }}

          admin_email: ${{ secrets.ADMIN_EMAIL }}

          admin_password: ${{ secrets.ADMIN_PASSWORD }}

          # ... and so on (non-mandatory attributes)

```

### Drone CI

This could also be used as part of a Drone CI use `ctferio/ctfd-setup`.

```yaml

kind: pipeline

type: docker

name: 'My pipeline'

trigger:

  branch:

  - main

  event:

  - push

steps:

  # ...

  - name: 'Setup CTFd'

    image: 'ctferio/[email protected]'

    settings:

      url:

        from_secret: CTFD_URL

      appearance_name: 'My CTF'

      appearance_description: 'My CTF description'

      admin_name:

        from_secret: ADMIN_USERNAME

      admin_email:

        from_secret: ADMIN_EMAIL

      admin_password:

        from_secret: ADMIN_PASSWORD

      # ... and so on (non-mandatory attributes)

```