Merge with origin/master

Author: chen-robert

.github/workflows/ci.yml

@@ -117,3 +117,8 @@ jobs:
         # TODO: handle tagging releases correctly
         tags: ${{ github.sha }}
         # TODO: add cache_froms once we have full releases
+    - name: Deploy installer
+      uses: netlify/actions/build@master
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        NETLIFY_SITE_ID: ${{ secrets.NETLIFY_INSTALL_SITE_ID }}

.gitignore

@@ -10,6 +10,7 @@ yarn-error.log*
 /conf.d/*
 !/conf.d/.keep
 /docs/site
+/install/build
 
 # Upload provider dir
 /uploads

.readthedocs.yml

@@ -2,7 +2,8 @@
 
 [![Build Status](https://github.com/redpwn/rCTF/workflows/CI/badge.svg?branch=master)](https://github.com/redpwn/rCTF/actions?query=workflow%3ACI+branch%3Amaster)
 [![Code Coverage](https://img.shields.io/codecov/c/github/redpwn/rctf.svg)](https://codecov.io/github/redpwn/rctf/)
-[![Docs](https://img.shields.io/readthedocs/rctf/latest)](https://rctf.redpwn.net/)
+[![Docs Status](https://img.shields.io/netlify/ae459ed6-1a84-43ff-b113-5561f3e4bd82.svg?label=docs)](https://rctf.redpwn.net)
+[![Install Status](https://img.shields.io/netlify/f528d484-6236-449c-8891-5ebfba3c178f.svg?label=install)](https://get.rctf.redpwn.net)
 
 rCTF is redpwnCTF's CTF platform. It is developed and maintained by the [redpwn](https://redpwn.net) CTF team.
 

README.md

@@ -1,7 +1,7 @@
 version: '2.2'
 services:
   rctf:
-    build: .
+    image: redpwn/rctf:${RCTF_GIT_COMMIT}
     restart: always
     ports:
       - '127.0.0.1:8080:80'
@@ -14,17 +14,17 @@ services:
       - RCTF_DATABASE_HOST=postgres
       - RCTF_DATABASE_DATABASE=rctf
       - RCTF_DATABASE_USERNAME=rctf
-      - RCTF_DATABASE_PASSWORD=${RCTF_DATABASE_PASSWORD}
-      - RCTF_REDIS_URL=redis://redis
+      - RCTF_REDIS_HOST=redis
       - RCTF_DATABASE_MIGRATE=before
     volumes:
-      - ./conf.d:/app/dist/conf.d
+      - ./conf.d:/app/conf.d
     depends_on:
       - redis
       - postgres
   redis:
-    image: redis:5.0.9
+    image: redis:6.0.6
     restart: always
+    command: ["redis-server", "--requirepass", "${RCTF_REDIS_PASSWORD}"]
     networks:
       - rctf
     volumes:

docker-compose.yml

@@ -0,0 +1 @@
+/* /install.txt 200!

install/.gitignore

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+mkdir -p build
+cp _redirects build
+sed -e "s/{{git_commit}}/$(git rev-parse HEAD)/" install.sh > build/install.txt

install/_redirects

@@ -1,157 +1,119 @@
 #!/bin/sh
 # rCTF installation script
-# Supports Debian-like distros and Arch Linux
 
 set -e
 
-# clear screen
-printf "\033c"
-
-
-# define functions
-
-
 fg_cyan="\033[36m"
 bold_fg_white="\033[1;37m"
 bg_red="\033[41m"
 reset="\033[0m"
 
 error() {
-    # shellcheck disable=SC2059
-    printf "${bg_red}${bold_fg_white}%s %s${reset}\n" "[-]" "$*" 1>&2
+  # shellcheck disable=SC2059
+  printf "${bg_red}${bold_fg_white}%s %s${reset}\n" "[-]" "$*" 1>&2
 }
 
 info() {
-    # shellcheck disable=SC2059
-    printf "${fg_cyan}%s %s${reset}\n" "[*]" "$*"
+  # shellcheck disable=SC2059
+  printf "${fg_cyan}%s %s${reset}\n" "[*]" "$*"
 }
 
+get_key() {
+  head -c 32 /dev/urandom | base64 -w 0
+}
 
-# shellcheck disable=SC2059
-printf "\033[1;36m....########......######.....########....########...
-....##.....##....##....##.......##.......##.........
-....##.....##....##.............##.......##.........
-....########.....##.............##.......######.....
-....##...##......##.............##.......##.........
-....##....##.....##....##.......##.......##.........
-....##.....##.....######........##.......##.........
-
-${reset}"
-
-
-# check environment
-
-
-info "Checking environment..."
+do_install() {
+  info "Installing rCTF..."
 
-if [ ! "$(id -u)" = 0 ]; then
+  if [ ! "$(id -u)" = 0 ]; then
     error "You must run this script as root."
     exit 1
-fi
-
-if [ -x "$(command -v apt-get)" ]; then
-    PACKAGE_MANAGER="apt-get"
-elif [ -x "$(command -v yum)" ]; then
-    error "Warning: Support for RHEL-like distros is experimental and things might break. Giving you 10 seconds to change your mind (by pressing Ctrl+C)..."
-    sleep 10
-
-    PACKAGE_MANAGER="yum"
-elif [ -x "$(command -v pacman)" ]; then
-    info "redpwn uses arch too btw"
-
-    PACKAGE_MANAGER="pacman"
-else
-    # XXX: should we stop the script here?
-    error "Unable to identify usable package manager, ignoring dependencies for now.";
-fi
-
-
-# setup variables
+  fi
 
-
-info "Configuring installation..."
-
-INSTALL_PATH="${INSTALL_PATH:-"/opt/rctf"}"
-
-if [ ! -d "$(dirname "$INSTALL_PATH")" ]; then
-    error "The parent of \$INSTALL_PATH ($(dirname "$INSTALL_PATH")) does not exist."
+  if [ ! -x "$(command -v curl)" ]; then
+    error "curl is not available. You must have curl to install rCTF."
     exit 1
-fi
-
-if [ -d "$INSTALL_PATH" ]; then
-    error "rCTF appears to already be installed in ${INSTALL_PATH}"
+  fi
 
-    info "... If you're trying to start rCTF, run 'docker-compose up -d --project-directory $INSTALL_PATH'."
-    info "... If you're trying to reinstall rCTF, 'rm -rf $INSTALL_PATH' then re-run this script."
+  RCTF_INSTALL_PATH="${RCTF_INSTALL_PATH:-"/opt/rctf"}"
 
+  if [ ! -d "$(dirname "$RCTF_INSTALL_PATH")" ]; then
+    error "The parent of \$RCTF_INSTALL_PATH ($(dirname "$RCTF_INSTALL_PATH")) does not exist."
     exit 1
-fi
-
-REPOSITORY_URL="${REPOSITORY_URL:-"https://github.com/redpwn/rCTF.git"}"
-REPOSITORY_BRANCH="${REPOSITORY_BRANCH:-"master"}"
-
-
-# install dependencies
-
+  fi
 
-info "Installing dependencies..."
+  if [ -d "$RCTF_INSTALL_PATH" ]; then
+    error "rCTF appears to already be installed in ${RCTF_INSTALL_PATH}"
 
-if [ "$PACKAGE_MANAGER" = "apt-get" ]; then
-    apt-get update
-    apt-get install --yes docker.io docker-compose git
-elif [ "$PACKAGE_MANAGER" = "yum" ]; then
-    info "We are about to install docker via https://get.docker.com/. Please follow along the steps to ensure it is configured properly."
-
-    # pass Ctrl+C / SIGINT to inside script
-    sh -c '
-        trap break INT
-        curl -fsSL https://get.docker.com/ | sh
-    '
-
-    yum install git
-elif [ "$PACKAGE_MANAGER" = "pacman" ]; then
-    pacman -Sy --noconfirm --needed docker docker-compose git
-fi
-
-info "Enabling docker..."
-
-(systemctl enable docker || true) 2>/dev/null # XXX: Debian "masks" docker.service
-(systemctl start docker || true) 2>/dev/null
+    info "... If you're trying to start rCTF, run 'docker-compose up -d'."
+    info "... If you're trying to reinstall rCTF, 'rm -rf $RCTF_INSTALL_PATH' then re-run this script."
 
+    exit 1
+  fi
 
-# clone repository
+  mkdir "$RCTF_INSTALL_PATH"
+  cd "$RCTF_INSTALL_PATH"
 
+  info "Installing dependencies..."
 
-info "Cloning repository to ${INSTALL_PATH} from repository ${REPOSITORY_URL} branch ${REPOSITORY_BRANCH}..."
+  if [ ! -x "$(command -v docker)" ]; then
+    curl -fsS https://get.docker.com | sh
+  fi
 
-git clone "$REPOSITORY_URL" "$INSTALL_PATH"
-cd "$INSTALL_PATH"
-git checkout "$REPOSITORY_BRANCH"
+  if [ ! -x "$(command -v docker-compose)" ]; then
+    curl -fsSLo /usr/local/bin/docker-compose "https://github.com/docker/compose/releases/download/1.26.2/docker-compose-$(uname -s)-$(uname -m)"
+    chmod +x /usr/local/bin/docker-compose
+  fi
 
+  info "Configuring rCTF..."
 
-# configure rctf
+  RCTF_GIT_COMMIT="${RCTF_GIT_COMMIT:-"{{git_commit}}"}"
 
+  mkdir -p conf.d data/rctf-postgres data/rctf-redis
 
-info "Configuring rCTF..."
+  printf "%s\n" \
+  "RCTF_DATABASE_PASSWORD=$(get_key)" \
+  "RCTF_REDIS_PASSWORD=$(get_key)" \
+  "RCTF_GIT_COMMIT=$RCTF_GIT_COMMIT" \
+  > .env
 
-./install/config.sh
+  printf "%s\n" \
+  "ctfName: rCTF" \
+  "meta:" \
+  "  description: 'A description of your CTF'" \
+  "  imageUrl: 'https://example.com'" \
+  "homeContent: 'A description of your CTF. Markdown supported.'" \
+  > conf.d/01-ui.yaml
 
+  printf "%s\n" \
+  "origin: http://127.0.0.1:8080" \
+  "divisions:" \
+  "  open: Open" \
+  "tokenKey: '$(get_key)'" \
+  "startTime: $(date +%s)000" \
+  "endTime: $(date -d +1week +%s)000" \
+  > conf.d/02-ctf.yaml
 
-# start docker
+  info "Downloading rCTF..."
 
+  curl -fsSO "https://raw.githubusercontent.com/redpwn/rctf/$RCTF_GIT_COMMIT/docker-compose.yml"
+  docker-compose pull
 
-info "Finished installation to ${INSTALL_PATH}."
+  info "Finished installation to ${RCTF_INSTALL_PATH}."
 
-printf "Would you like to start rCTF now (y/N)? "
+  printf "Would you like to start rCTF now (y/N)? "
 
-read -r result </dev/tty
+  read -r result </dev/tty
 
-if [ "$result" = "y" ]; then
+  if [ "$result" = "y" ]; then
     info "Running 'docker-compose up -d'..."
     docker-compose up -d
     info "rCTF is now running at 127.0.0.1:8080."
     exit 0
-else
-    info "If you would like to start rCTF, run 'docker-compose up -d' in $INSTALL_PATH."
+  else
+    info "If you would like to start rCTF, run 'docker-compose up -d' in $RCTF_INSTALL_PATH."
     exit 0
-fi
+  fi
+}
+
+do_install