Fixed container port and fixed container expiry

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Andy Smith
+Copyright (c) 2024 Phan Nhat
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,19 +1,191 @@
 # CTFd Docker Containers Plugin
 
-This CTFd plugin allows you to run ephemeral Docker containers for specific challenges. Teams can request a container to use as needed, and its lifecycle will be managed by the plugin.
+<div align="center">
+  <h3 align="center">CTFd Docker Containers Plugin</h3>
+  <p align="center">
+    A plugin to create containerized challenges for your CTF contest.
+  </p>
+</div>
+
+## Table of Contents
+1. [Getting Started](#getting-started)
+   - [Prerequisites](#prerequisites)
+   - [Installation](#installation)
+2. [Usage](#usage)
+   - [Using Local Docker Daemon](#using-local-docker-daemon)
+   - [Using Remote Docker via SSH](#using-remote-docker-via-ssh)
+3. [Demo](#demo)
+4. [Roadmap](#roadmap)
+5. [License](#license)
+6. [Contact](#contact)
+
+---
+
+## Getting Started
+
+This section provides instructions for setting up the project locally.
+
+### Prerequisites
+
+To use this plugin, you should have:
+- Experience hosting CTFd with Docker
+- Basic knowledge of Docker
+- SSH access to remote servers (if using remote Docker)
+
+### Installation
+
+1. **Clone this repository:**
+   ```bash
+   git clone https://github.com/phannhat17/CTFd-Docker-Plugin.git
+   ```
+2. **Rename the folder:**
+   ```bash
+   mv CTFd-Docker-Plugin containers
+   ```
+3. **Move the folder to the CTFd plugins directory:**
+   ```bash
+   mv containers /path/to/CTFd/plugins/
+   ```
+
+[Back to top](#ctfd-docker-containers-plugin)
+
+---
 
 ## Usage
 
-Place this plugin in your CTFd/plugins directory. The name of the directory MUST be "containers" (so if you cloned this repo, rename "CTFd-Docker-Plugin" to "containers").
+### Using Local Docker Daemon
+
+#### Case A: **CTFd Running Directly on Host:**
+  - Go to the plugin settings page: `/containers/settings`
+  - Fill in all fields except the `Base URL`.
+
+  ![Settings Example](./image-readme/1.png)
+
+#### Case B: **CTFd Running via Docker:**
+  - Map the Docker socket into the CTFd container by modify the `docker-compose.yml` file:
+  ```bash
+  services:
+    ctfd:
+      ...
+      volumes:
+        - /var/run/docker.sock:/var/run/docker.sock
+      ...
+  ```
+  - Restart CTFd
+  - Go to the plugin settings page: `/containers/settings`
+  - Fill in all fields except the `Base URL`.
+
+### Using Remote Docker via SSH
+
+For remote Docker, the CTFd host must have SSH access to the remote server.
+
+#### Prerequisites:
+- **SSH access** from the CTFd host to the Docker server
+- The remote server's fingerprint should be in the `known_hosts` file
+- SSH key files (`id_rsa`) and an SSH config file should be available
+
+#### Case A: **CTFd Running via Docker**
+
+1. **Prepare SSH Config:**
+   ```bash
+   mkdir ssh_config
+   cp ~/.ssh/id_rsa ~/.ssh/known_hosts ~/.ssh/config ssh_config/
+   ```
+
+2. **Mount SSH Config into the CTFd container:**
+   ```yaml
+   services:
+     ctfd:
+       ...
+       volumes:
+         - ./ssh_config:/root/.ssh:ro
+       ...
+   ```
+
+3. **Restart CTFd:**
+   ```bash
+   docker-compose down
+   docker-compose up -d
+   ```
+
+#### Case B: **CTFd Running Directly on Host**
+
+1. **Ensure SSH Access:**
+   - Test the connection:
+     ```bash
+     ssh user@remote-server
+     ```
+
+2. **Configure Docker Base URL:**
+   - In the CTFd plugin settings page (`/containers/settings`), set:
+     ```
+     Base URL: ssh://user@remote-server
+     ```
+
+3. **Restart CTFd:**
+   ```bash
+   sudo systemctl restart ctfd
+   ```
+
+[Back to top](#ctfd-docker-containers-plugin)
+
+---
+
+## Demo
+
+### Admin Dashboard
+- Manage running containers
+- Filter by challenge or player
+
+![Manage Containers](./image-readme/manage.png)
+
+### Challenge View
+
+**Web Access** | **TCP Access**
+:-------------:|:-------------:
+![Web](./image-readme/http.png) | ![TCP](./image-readme/tcp.png)
+
+### Live Demo
+
+![Live Demo](./image-readme/demo.gif)
+
+[Back to top](#ctfd-docker-containers-plugin)
+
+---
+
+## Roadmap
+
+- [x] Support for user mode
+- [x] Admin dashboard with team/user filtering
+- [x] Compatibility with the core-beta theme
+- [x] Monitor share flag 
+- [ ] Monitor detail on share flag 
+- [ ] Prevent container creation on solved challenge
+
+For more features and known issues, check the [open issues](https://github.com/phannhat17/CTFd-Docker-Plugin/issues).
+
+[Back to top](#ctfd-docker-containers-plugin)
+
+---
+
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for details.
+
+> This plugin is an upgrade of [andyjsmith's plugin](https://github.com/andyjsmith/CTFd-Docker-Plugin) with additional features.
+
+If there are licensing concerns, please reach out via email (contact below).
 
-To configure the plugin, go to the admin page, click the dropdown in the navbar for plugins, and go to the Containers page. Then you can click the settings button to configure the connection. You will need to specify some values, including the connection string to use. This can either be the local Unix socket, or an SSH connection. If using SSH, make sure the CTFd host can successfully SSH into the Docker target (i.e. set up public key pairs). The other options are described on the page. After saving, the plugin will try to connect to the Docker daemon and the status should show as an error message or as a green symbol.
+[Back to top](#ctfd-docker-containers-plugin)
 
-To create challenges, use the container challenge type and configure the options. It is set up with dynamic scoring, so if you want regular scoring, set the maximum and minimum to the same value and the decay to zero.
+---
 
-If you need to specify advanced options like the volumes, read the [Docker SDK for Python documentation](https://docker-py.readthedocs.io/en/stable/containers.html) for the syntax, since most options are passed directly to the SDK.
+## Contact
 
-When a user clicks on a container challenge, a button labeled "Get Connection Info" appears. Clicking it shows the information below with a random port assignment.
+**Phan Nhat**  
+- **Discord:** ftpotato  
+- **Email:** [email protected]  
+- **Project Link:** [CTFd Docker Plugin](https://github.com/phannhat17/CTFd-Docker-Plugin)
 
-![Challenge dialog](dialog.png)
+[Back to top](#ctfd-docker-containers-plugin)
 
-A note, we used hidden teams as non-school teams in PCTF 2022 so if you want them to count for decreasing the dynamic challenge points, you need to remove the `Model.hidden == False,` line from the `calculate_value` function in `__init__.py`.