# GZ::CTF

> GZ::CTF Project Documentation

## 指南

- [简介](/zh/guide/start/introduction.md): GZ::CTF 是一个基于 ASP.NET Core 的开源 CTF 平台，采用 Docker 或 K8s 作为容器部署后端，提供了可自定义的题目类型、动态容器和动态分值功能。 GZ::CTF 采用双许可证：核心代码基于 AGPLv3 协议开源，部分受限组件采用独立的许可证。使用和修改均需遵守对应的许可证协议。开始部署请参考 快速上手。 本项目缘起于作者认为 CTFd 的实现不优雅，动态容器配置需要采用插件的方式，且前端不好看，同时为了办校赛和帮助其他学校的同学办赛，于是自己动手写了一个。
- [快速上手](/zh/guide/start/quick-start.md): GZCTF 通过 Docker 镜像的方式提供，你可以通过 docker-compose 的方式快速部署一个功能完善的 CTF 平台。请注意，这并不是唯一的部署方式，我们更推荐使用 Kubernetes 的方式部署。
- [动态 flag](/zh/guide/features/dynamic-flag.md): GZCTF 自带对于动态 flag 分发的支持，将会在容器启用时采用 GZCTF_FLAG 环境变量进行注入。
- [平台代理](/zh/guide/features/platform-proxy.md): GZCTF 自带对于流量的 WebSocket-TCP 转发功能和对应的流量记录能力，可以通过相关配置项进行开启。
- [选择部署方式](/zh/guide/deployment/options.md): GZCTF 提供多种可行的部署方式，按照推荐度排序如下所示：
- [使用 Docker 和 K8s](/zh/guide/deployment/docker-k8s.md): 本文中以轻量化部署的 K3s 为例，若您已经部署了 K8s 集群，可以参考本文后续配置进行类似的设置。
- [仅 K8s 部署](/zh/guide/deployment/k8s-only.md)
- [端口范围设置](/zh/guide/issues/port-range.md): 以下方式均为经验做法，可能因不同的系统环境有所出入，如不能正常生效，请自行查找相关资料及解决方案。
- [Q&A](/zh/guide/issues/qa.md)
- [破坏性变更](/zh/guide/break-changes.md)
- [致谢](/zh/guide/thanks.md)

## 配置

- [appsettings.json 配置](/zh/config/appsettings.md): appsettings.json 文件是 GZCTF 的核心配置文件，通过将文件挂载到容器内的方式进行配置。本篇将介绍配置文件的各个字段的含义。