# GZ::CTF

> GZ::CTF Project Documentation

## Guide

- [Introduction](/guide/start/introduction.md): GZ::CTF is an open source CTF platform based on ASP.NET Core, using Docker or K8s as the container deployment backend, providing customizable challenge types, dynamic containers and dynamic scores. GZ::CTF is dual-licensed: the core code is open source under the AGPLv3 license, while a few restricted components are covered by a separate license. Use and modification are subject to the respective licenses. Please refer to Quick Start for deployment. This project originated from the author's idea that the implementation of CTFd is not elegant enough, the dynamic container configuration needs to be implemented by plug-ins, and the front-end is not good-looking. At the same time, in order to hold school CTF and help students from other schools to run their CTF, I wrote one by myself.
- [Quick Start](/guide/start/quick-start.md): GZCTF is distributed as a Docker image, you can deploy a fully functional CTF platform with docker-compose. Please note that this is not the only way to deploy GZCTF, we recommend using Kubernetes to deploy. Please refer to the deployment methods chapter for related deployment methods.
- [Dynamic Flag](/guide/features/dynamic-flag.md): GZCTF comes with built-in support for dynamic flag distribution, which will be injected using the GZCTF_FLAG environment variable when the container is started.
- [Platform Proxy](/guide/features/platform-proxy.md): GZCTF comes with built-in WebSocket-TCP forwarding functionality and corresponding traffic logging capability, which can be enabled through relevant configuration options.
- [Choose Deployment Method](/guide/deployment/options.md): GZCTF provides a variety of executable deployment methods, ranked in order of recommendation as follows:
- [Use Docker and K8s](/guide/deployment/docker-k8s.md): Here we use the lightweight K3s as an example. If you have already deployed a K8s cluster, you can refer to the subsequent configuration for similar settings.
- [Use K8s Only](/guide/deployment/k8s-only.md)
- [Port Range Configuration](/guide/issues/port-range.md): The following methods are common practices and may vary depending on the system environment. If they do not work as expected, please refer to relevant documentation and troubleshooting solutions.
- [Q&A](/guide/issues/qa.md)
- [Breaking Changes](/guide/break-changes.md)
- [Acknowledgements](/guide/thanks.md)

## Config

- [appsettings.json](/config/appsettings.md): appsettings.json is the core configuration file of GZCTF, which is configured by mounting into the container. This document will introduce the meaning of each field in the configuration file.