⚠️ Project renaming to ctfhub ⚠️ (#83)

* complete project renaming -> ctfhub

* cleaned last reference to ctfpad

* And migration steps in readme

Author: hugsy

.env.example

@@ -1,55 +1,55 @@
 #
-# CTFPad
+# CTFHub
 #
-CTFPAD_DEBUG=1                                            # Change here to disable debug mode
-CTFPAD_DOMAIN=localhost                                   # Change here to your server public IP / FQDN
-CTFPAD_PORT=8000                                          # Change here to your server public port for CTFPad
-CTFPAD_PROTOCOL=http                                      # Change here to 1 if your public server uses https
-CTFPAD_SECRET_KEY=74320c04549af3a5f9fd9bc007b2e20ced8     # Change here
-CTFPAD_URL=${CTFPAD_PROTOCOL}://${CTFPAD_DOMAIN}:${CTFPAD_PORT}
+CTFHUB_DEBUG=1                                            # Change here to disable debug mode
+CTFHUB_DOMAIN=localhost                                   # Change here to your server public IP / FQDN
+CTFHUB_PORT=8000                                          # Change here to your server public port for CTFHub
+CTFHUB_PROTOCOL=http                                      # Change here to 1 if your public server uses https
+CTFHUB_SECRET_KEY=74320c04549af3a5f9fd9bc007b2e20ced8     # Change here
+CTFHUB_URL=${CTFHUB_PROTOCOL}://${CTFHUB_DOMAIN}:${CTFHUB_PORT}
 
 
 #
-# CTFPad Database
+# CTFHub Database
 #
-CTFPAD_DB_HOST=db
-CTFPAD_DB_PORT=5432
-CTFPAD_DB_NAME=ctfpad                                          # Change here
-CTFPAD_DB_USER=ctfpad                                          # Change here
-CTFPAD_DB_PASSWORD=1358127ce28271330b266cbf2ff556af13653fb5    # Change here
+CTFHUB_DB_HOST=db
+CTFHUB_DB_PORT=5432
+CTFHUB_DB_NAME=ctfhub                                          # Change here
+CTFHUB_DB_USER=ctfhub                                          # Change here
+CTFHUB_DB_PASSWORD=1358127ce28271330b266cbf2ff556af13653fb5    # Change here
 
 
 #
 # Hedgedoc settings
 #
-CTFPAD_HEDGEDOC_PROTOCOL=http
-CTFPAD_HEDGEDOC_DOMAIN=localhost
-CTFPAD_HEDGEDOC_PORT=3000
-CTFPAD_HEDGEDOC_IS_INTERNAL=1
-CTFPAD_HEDGEDOC_URL=${CTFPAD_HEDGEDOC_PROTOCOL}://${CTFPAD_HEDGEDOC_DOMAIN}:${CTFPAD_HEDGEDOC_PORT}
+CTFHUB_HEDGEDOC_PROTOCOL=http
+CTFHUB_HEDGEDOC_DOMAIN=localhost
+CTFHUB_HEDGEDOC_PORT=3000
+CTFHUB_HEDGEDOC_IS_INTERNAL=1
+CTFHUB_HEDGEDOC_URL=${CTFHUB_HEDGEDOC_PROTOCOL}://${CTFHUB_HEDGEDOC_DOMAIN}:${CTFHUB_HEDGEDOC_PORT}
 
 
 #
-# CTFPad Email recovery feature
+# CTFHub Email recovery feature
 #
 # Leave blank or customize below to enable the password recovery feature by email
-CTFPAD_EMAIL_SERVER_HOST=''                                 # smtp.gmail.com or mailgun, or sendgrid etc.
-CTFPAD_EMAIL_SERVER_PORT=0
-CTFPAD_EMAIL_USERNAME=''
-CTFPAD_EMAIL_PASSWORD=''
+CTFHUB_EMAIL_SERVER_HOST=''                                 # smtp.gmail.com or mailgun, or sendgrid etc.
+CTFHUB_EMAIL_SERVER_PORT=0
+CTFHUB_EMAIL_USERNAME=''
+CTFHUB_EMAIL_PASSWORD=''
 
 
 #
 # Notification webhook URLs
 # Leave blank or customize below to disable
 #
-CTFPAD_DISCORD_WEBHOOK_URL=
+CTFHUB_DISCORD_WEBHOOK_URL=
 
 
 #
 # Jitsi settings
 #
-CTFPAD_JITSI_URL=https://meet.jit.si
+CTFHUB_JITSI_URL=https://meet.jit.si
 
 
 #
@@ -58,4 +58,4 @@ CTFPAD_JITSI_URL=https://meet.jit.si
 # By default, use the public instance at excalidraw.com
 # To use your own instance, a docker script can be found in `scripts/excalidraw/docker-compose.yml`
 #
-CTFPAD_EXCALIDRAW_URL=https://excalidraw.com:443
+CTFHUB_EXCALIDRAW_URL=https://excalidraw.com:443

.github/workflows/notify.yml

@@ -24,8 +24,8 @@ jobs:
               ● ') }}
 
           color: 0x0000ff
-          username: ${{ github.actor }} on CTFPad
-          avatar_url: "https://github.com/hugsy/ctfpad/blob/refresh-readme/static/images/new_logo_circle.png?raw=true"
+          username: ${{ github.actor }} on CTFHub
+          avatar_url: "https://github.com/hugsy/ctfhub/blob/refresh-readme/static/images/new_logo_circle.png?raw=true"
 
       - name: Triggering Pull Request Discord Notification
         if: github.event_name == 'pull_request' && github.event.action == 'opened' && github.repository_owner == 'hugsy'
@@ -41,8 +41,8 @@ jobs:
             ---
             Link: ${{ github.event.pull_request.html_url }}
           color: 0xff0000
-          username: ${{ github.actor }} on CTFPad
-          avatar_url: "https://github.com/hugsy/ctfpad/blob/refresh-readme/static/images/new_logo_circle.png?raw=true"
+          username: ${{ github.actor }} on CTFHub
+          avatar_url: "https://github.com/hugsy/ctfhub/blob/refresh-readme/static/images/new_logo_circle.png?raw=true"
 
       - name: Triggering Issue Discord Notification
         if: github.event_name == 'issues' && github.event.action == 'opened' && github.repository_owner == 'hugsy'
@@ -58,5 +58,5 @@ jobs:
             ---
             Link: ${{ github.event.issue.html_url }}
           color: 0x00ff00
-          username: ${{ github.actor }} on CTFPad
-          avatar_url: "https://github.com/hugsy/ctfpad/blob/refresh-readme/static/images/new_logo_circle.png?raw=true"
+          username: ${{ github.actor }} on CTFHub
+          avatar_url: "https://github.com/hugsy/ctfhub/blob/refresh-readme/static/images/new_logo_circle.png?raw=true"

.pre-commit-config.yaml

@@ -3,13 +3,13 @@ repos:
     rev: '3.0.6'
     hooks:
       - id: djhtml
-        files: ctfpad/templates/.*\.html$
+        files: ctfhub/templates/.*\.html$
 
       - id: djcss
-        files: static/css/.*\.css$
+        files: ctfhub/static/css/.*\.css$
 
       - id: djjs
-        files: static/js/.*\.js$
+        files: ctfhub/static/js/.*\.js$
 
   - repo: https://github.com/psf/black
     rev: '23.3.0'

README.md

@@ -2,14 +2,14 @@
   <img alt="Logo" src="static/images/new_logo_circle.png" width=20%>
 </p>
 
-<h2 align="center"><b>CTFPad</b></h2>
+<h2 align="center"><b>CTFHub</b></h2>
 <h3 align="center">Where CTFs happen</h3>
 
 <p align="center">
   <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
-  <a href="https://github.com/hugsy/ctfpad/blob/master/LICENSE"><img alt="Licence MIT" src="https://img.shields.io/packagist/l/doctrine/orm.svg?maxAge=2592000?style=plastic"></a>
+  <a href="https://github.com/hugsy/ctfhub/blob/master/LICENSE"><img alt="Licence MIT" src="https://img.shields.io/packagist/l/doctrine/orm.svg?maxAge=2592000?style=plastic"></a>
   <img alt="Python-Version 3.10" src="https://img.shields.io/badge/Python-3.10-brightgreen">
-  <a href="https://discord.gg/fYsAjvsdQT"><img alt="CTFPad on Discord" src="https://img.shields.io/badge/Discord-CTFPad-purple"></a>
+  <a href="https://discord.gg/fYsAjvsdQT"><img alt="CTFHub on Discord" src="https://img.shields.io/badge/Discord-CTFHub-purple"></a>
 </p>
 
 ## What is it?
@@ -47,8 +47,8 @@ A non-exhaustive list of features:
 For most people, this will suffice:
 
 ```bash
-$ git clone https://github.com/hugsy/ctfpad
-$ cd ctfpad
+$ git clone https://github.com/hugsy/ctfhub
+$ cd ctfhub
 $ cp .env.example .env
 ### CHANGE THE CREDENTIALS IN .env ###
 $ nano .env
@@ -67,23 +67,26 @@ $ nano scripts/proxy/.env
 $ docker compose -f scripts/proxy/docker-compose.yml -f ./docker-compose.yml up -d --build
 ```
 
-## Gallery 
+If you're migrating from the first versions called `ctpad`, check out see [PR #83](https://github.com/hugsy/ctfhub/pull/83) to migrate the data to the new environment, search the `Setup > Migration` part.
+
+
+## Gallery
 
 Check out the [docs](docs/gallery.md)
 
 ## Contribution
 
-`CTFPad` was created and maintained by [`@_hugsy_`](https://twitter.com/_hugsy_), but kept fresh thanks to [all the contributors](https://github.com/hugsy/ctfpad/graphs/contributors).
+`CTFHub` was created and maintained by [`@_hugsy_`](https://twitter.com/_hugsy_), but kept fresh thanks to [all the contributors](https://github.com/hugsy/ctfhub/graphs/contributors).
 
-[ ![contributors-img](https://contrib.rocks/image?repo=hugsy/ctfpad) ](https://github.com/hugsy/ctfpad/graphs/contributors)
+[ ![contributors-img](https://contrib.rocks/image?repo=hugsy/ctfhub) ](https://github.com/hugsy/ctfhub/graphs/contributors)
 
 
 If you just like the tool, consider dropping on Discord (or Twitter or other) a simple *"thanks"*, it is always very appreciated.
 
 And if you can, consider [sponsoring me](https://github.com/hugsy/sponsors) - it really helps dedicating time and resources to the projects!
 
 
-## Extra Credits
+## Credits and Links
 
-- [CTFPad](https://github.com/StratumAuhuur/CTFPad): nice project but NodeJS, so yeah. Also [`etherpad-lite`](https://yopad.eu) doesn't support MarkDown easily. I like the name, so I took it shamelessly
 - The world flag images are downloaded from https://flagpedia.net/
+- [CTFHub](https://github.com/StratumAuhuur/CTFHub): NodeJS project that is based on [`etherpad-lite`](https://yopad.eu) (no MarkDown support).

conf/certs/README.md

@@ -20,12 +20,12 @@ Example with default settings working with the provided `nginx.conf`:
 mkcert -install
 
 # Generate a new certificates with the different subdomains:
-mkcert ctfpad.mydomain.com hedgedoc.mydomain.com excalidraw.mydomain.com collab.excalidraw.mydomain.com
+mkcert ctfhub.mydomain.com hedgedoc.mydomain.com excalidraw.mydomain.com collab.excalidraw.mydomain.com
 
 # Move the generated certificates to the certs folder. Assuming you are at the repository root folder:
 mkdir -p ./conf/certs/ctfdad.mydomain.com
-mv ctfpad.mydomain.com*-key.pem ./conf/certs/ctfdad.mydomain.com/privkey.pem
-mv ctfpad.mydomain.com*.pem ./conf/certs/ctfdad.mydomain.com/fullchain.pem
+mv ctfhub.mydomain.com*-key.pem ./conf/certs/ctfdad.mydomain.com/privkey.pem
+mv ctfhub.mydomain.com*.pem ./conf/certs/ctfdad.mydomain.com/fullchain.pem
 ```
 
-If `ctfpad.mydomain.com` is in the `/etc/hosts` file of your machine, then go to `https://ctfpad.mydomain.com` and enjoy the app!
+If `ctfhub.mydomain.com` is in the `/etc/hosts` file of your machine, then go to `https://ctfhub.mydomain.com` and enjoy the app!

conf/nginx/nginx.conf

@@ -1,8 +1,8 @@
 #
-# Basic nginx reverse proxy configuration for CTFPad + hedgedoc + excalidraw
+# Basic nginx reverse proxy configuration for CTFHub + hedgedoc + excalidraw
 #
 # This configuration will use nginx as a HTTPS reverse-proxy
-# - CTFPad   (443 -> 8000)
+# - CTFHub   (443 -> 8000)
 # - HedgeDoc (443 -> 3000)
 # - Excalidraw (443 -> 80)
 #
@@ -30,26 +30,26 @@ http {
     #
     server {
         listen 80;
-        server_name ctfpad.mydomain.com hedgedoc.mydomain.com excalidraw.mydomain.com collab.excalidraw.mydomain.com;
+        server_name ctfhub.mydomain.com hedgedoc.mydomain.com excalidraw.mydomain.com collab.excalidraw.mydomain.com;
         return 301 https://$host$request_uri;
     }
 
 
     #
-    # CTFPad
+    # CTFHub
     #
-    upstream app_ctfpad_server {
-        server ctfpad:8000;
+    upstream app_ctfhub_server {
+        server ctfhub:8000;
     }
 
     server {
         listen              443 ssl;
-        server_name         ctfpad.mydomain.com;
-        ssl_certificate     /etc/nginx/certs/ctfpad.mydomain.com/fullchain.pem; # store letsencrypt keys there
-        ssl_certificate_key /etc/nginx/certs/ctfpad.mydomain.com/privkey.pem;   # store letsencrypt keys there
+        server_name         ctfhub.mydomain.com;
+        ssl_certificate     /etc/nginx/certs/ctfhub.mydomain.com/fullchain.pem; # store letsencrypt keys there
+        ssl_certificate_key /etc/nginx/certs/ctfhub.mydomain.com/privkey.pem;   # store letsencrypt keys there
 
         location / {
-            proxy_pass http://app_ctfpad_server;
+            proxy_pass http://app_ctfhub_server;
             proxy_redirect off;
             proxy_set_header Host $host;
             proxy_set_header X-Real-IP $remote_addr;
@@ -76,8 +76,8 @@ http {
     server {
         listen              443 ssl;
         server_name         hedgedoc.mydomain.com;
-        ssl_certificate     /etc/nginx/certs/ctfpad.mydomain.com/fullchain.pem; # store letsencrypt keys there
-        ssl_certificate_key /etc/nginx/certs/ctfpad.mydomain.com/privkey.pem;   # store letsencrypt keys there
+        ssl_certificate     /etc/nginx/certs/ctfhub.mydomain.com/fullchain.pem; # store letsencrypt keys there
+        ssl_certificate_key /etc/nginx/certs/ctfhub.mydomain.com/privkey.pem;   # store letsencrypt keys there
 
         location / {
             proxy_pass http://app_hedgedoc_server;
@@ -116,8 +116,8 @@ http {
     server {
         listen              443 ssl;
         server_name         excalidraw.mydomain.com;
-        ssl_certificate     /etc/nginx/certs/ctfpad.mydomain.com/fullchain.pem; # store letsencrypt keys there
-        ssl_certificate_key /etc/nginx/certs/ctfpad.mydomain.com/privkey.pem;   # store letsencrypt keys there
+        ssl_certificate     /etc/nginx/certs/ctfhub.mydomain.com/fullchain.pem; # store letsencrypt keys there
+        ssl_certificate_key /etc/nginx/certs/ctfhub.mydomain.com/privkey.pem;   # store letsencrypt keys there
 
         location / {
             proxy_pass http://app_excalidraw_server;
@@ -145,8 +145,8 @@ http {
     server {
         listen 443 ssl;
         server_name collab.excalidraw.mydomain.com;
-        ssl_certificate     /etc/nginx/certs/ctfpad.mydomain.com/fullchain.pem; # store letsencrypt keys there
-        ssl_certificate_key /etc/nginx/certs/ctfpad.mydomain.com/privkey.pem;   # store letsencrypt keys there
+        ssl_certificate     /etc/nginx/certs/ctfhub.mydomain.com/fullchain.pem; # store letsencrypt keys there
+        ssl_certificate_key /etc/nginx/certs/ctfhub.mydomain.com/privkey.pem;   # store letsencrypt keys there
 
         location / {
             proxy_pass http://app_excalidraw_room_server;

ctfhub/__init__.py

@@ -0,0 +1 @@
+default_app_config = "ctfhub.apps.CtfhubConfig"

ctfpad/admin.py ctfhub/admin.py

@@ -2,9 +2,9 @@
 from django.utils.translation import gettext_lazy as _
 
 
-class CtfpadConfig(AppConfig):
-    name = "ctfpad"
-    verbose_name = _("ctfpad")
+class CtfhubConfig(AppConfig):
+    name = "ctfhub"
+    verbose_name = _("ctfhub")
 
     def ready(self):
-        import ctfpad.signals
+        import ctfhub.signals

ctfpad/apps.py ctfhub/apps.py

@@ -1,8 +1,8 @@
+from django.contrib import messages
 from django.http.request import HttpRequest
 from django.shortcuts import redirect
-from django.contrib import messages
-from django.utils.http import urlencode
 from django.urls import reverse
+from django.utils.http import urlencode
 
 
 def is_not_authenticated(view_func):
@@ -29,7 +29,7 @@ def wrapper_func(request: HttpRequest, *args, **kwargs):
         if not request.user.is_authenticated:
             messages.warning(request, "You must be authenticated!")
             return redirect(
-                reverse("ctfpad:user-login")
+                reverse("ctfhub:user-login")
                 + "?"
                 + urlencode({"redirect_to": request.path})
             )

ctfpad/context_processors.py ctfhub/context_processors.py

@@ -1,12 +1,6 @@
 import json
-from django.contrib.auth.forms import UserChangeForm
-from django.contrib.auth.models import User
-
-from django import forms
-from django.core.exceptions import ValidationError
-from django.forms import widgets
 
-from ctfpad.models import (
+from ctfhub.models import (
     Challenge,
     ChallengeCategory,
     ChallengeFile,
@@ -15,6 +9,11 @@
     Tag,
     Team,
 )
+from django import forms
+from django.contrib.auth.forms import UserChangeForm
+from django.contrib.auth.models import User
+from django.core.exceptions import ValidationError
+from django.forms import widgets
 
 
 class UserUpdateForm(UserChangeForm):