diff --git a/README.md b/README.md index 6721317..fe8b797 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,33 @@ -# ctfd_deploy_scripts -Bash Script to deploy CTFd with SSL and Auto Renew +# Welcome to CTFd Deploy Script 👋 +![Version](https://img.shields.io/badge/version-1.1-blue.svg?cacheSeconds=2592000) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](#) +[![Twitter: michaelsantosti](https://img.shields.io/twitter/follow/michaelsantosti.svg?style=social)](https://twitter.com/michaelsantosti) -Run the following command to execute this script: +> Ready-to-use CTFd Docker Deployment (with themes) -``` +## Install + +CTFd with SSL: + +```sh sudo git clone https://github.com/michaelsantosti/ctfd_deploy_scripts.git && sudo mv ctfd_deploy_scripts/* . && sudo rm -r ctfd_deploy_scripts && sudo sh setup.sh ``` + +CTFd without SSL: + +```sh +sudo git clone https://github.com/michaelsantosti/ctfd_deploy_scripts.git && sudo mv ctfd_deploy_scripts/* . && sudo rm -r ctfd_deploy_scripts && sudo sh setup-nossl.sh +``` + +## Author + +👤 **Michael Santosti** + +* Website: www.santosti.com +* Twitter: [@michaelsantosti](https://twitter.com/michaelsantosti) +* Github: [@michaelsantosti](https://github.com/michaelsantosti) +* LinkedIn: [@michaelsantosti](https://linkedin.com/in/michaelsantosti) + +## Show your support + +Give a ⭐️ if this project helped you!