mateocallec/cactus-pad repository overview

⁠Cactus Pad – Docker Image

Cactus Pad is a lightweight collaborative pad application built with NestJS (backend) and React + Vite (frontend).
This Docker image provides a production-ready, self-contained deployment of both the backend and frontend.

⁠Features

• Real-time collaborative pads via WebSockets
• Optional password protection
• AES-256-GCM encryption for stored pad content
• Automatic pad expiration
• Backend and frontend bundled in a single container
• Multi-stage build for optimized image size

⁠Image

cactus-pad:latest

⁠Exposed Ports

⁠Quick Start

docker run -d \
  -p 2100:2100 \
  -p 2101:2101 \
  -p 2102:2102 \
  --env-file .env \
  cactus-pad:latest

⁠Environment Variables

Create a .env file based on .env.template:

# Database configuration
DB_USER=
DB_PASSWORD=
DB_NAME=
DB_ENCRYPTION=

# Application configuration
CACTUS_PAD_EXPIRATION=
CACTUS_DOMAIN=
CACTUS_USE_TLS=
CACTUS_FRONTEND_PORT=
CACTUS_WS_PORT=

⁠Notes

• DB_ENCRYPTION is used to derive the AES-256-GCM encryption key.
• CACTUS_PAD_EXPIRATION is expressed in seconds.
• Pads are automatically deleted after expiration.

⁠Volumes (Optional)

If your database requires persistent storage, mount the appropriate volume depending on your database setup.

⁠Security

• Pad content is encrypted using AES-256-GCM.
• Passwords are hashed using Argon2.
• A SECURITY.md file is provided in the source repository for vulnerability reporting.

⁠License

Released under the French Patriot License. See the LICENSE file in the source repository for details.

⁠Disclaimer

The author(s) do not guarantee that this software, its security measures, privacy policy, or terms of service are legally valid or compliant in any jurisdiction.

This image is provided "as is", without warranty of any kind.

⁠Source Code

GitHub repository: https://github.com/mateocallec/cactus-pad⁠