Skip to content

Latest commit

 

History

14 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🪄 CommonForms Web UI Installer

One-click installer for CommonForms with a beautiful web interface. Automatically detect and make PDF form fields fillable using AI.

CommonForms Demo License Platform Proxmox

📸 Screenshots

Web Interface Modern drag & drop interface with multi-language support

✨ Features

  • 🚀 One-command installation - Everything configured automatically
  • 🎨 Beautiful Web UI - Modern, responsive interface with drag & drop
  • 🌍 Multi-language - English & German support with language toggle
  • 🔒 Privacy-focused - All processing happens locally on your server
  • CPU-optimized - Runs efficiently without GPU requirements
  • 🔄 Systemd service - Auto-starts on boot, automatic restarts
  • 🎯 Production-ready - Designed for Proxmox LXC containers and VPS
  • 📦 Proxmox automation - Powered by Proxmox Helper Scripts

🎯 What is CommonForms?

CommonForms uses machine learning to automatically detect text fields, checkboxes, and signature areas in PDF documents and makes them fillable. Perfect for:

  • Digitizing paper forms
  • Making scanned documents interactive
  • Converting legacy PDFs to modern fillable forms
  • Automating form processing workflows

📋 Requirements

  • OS: Debian 11+, Ubuntu 20.04+, or Proxmox VE 7.0+
  • RAM: 6 GB minimum
  • CPU: 2+ cores recommended
  • Storage: 5 GB free space minimum
  • Root access: Required for installation

Recommended Platforms

  • ✅ Proxmox LXC containers
  • ✅ Debian/Ubuntu VPS
  • ✅ Bare metal Linux servers

🚀 Installation Methods

Method 1: Proxmox LXC Container (Fully Automated) ⭐ Recommended

Creates a complete Debian 12 LXC container with CommonForms pre-installed in one command!

Note: This method uses the Proxmox Helper Scripts framework (build.func) for standardized LXC container creation and management. The script provides an interactive menu where you can configure all container settings (CPU, RAM, disk, network, etc.) before installation.

# On Proxmox host - run and follow the interactive menu
bash -c "$(curl -fsSL https://raw.githubusercontent.com/HubEight/commonforms-installer/main/create-commonforms-container.sh)"

The script will present you with options to:

  • Use default settings (quick start)
  • Configure advanced settings (CPU, RAM, disk, network, container type, etc.)
  • All configuration is done through the Proxmox Helper Scripts interactive interface

Method 2: Manual Installation (Existing Linux System)

For existing Debian/Ubuntu systems, VPS, or manually created containers:

curl -sSL https://raw.githubusercontent.com/HubEight/commonforms-installer/main/install-commonforms.sh | sudo bash

Or download and run manually:

wget https://raw.githubusercontent.com/HubEight/commonforms-installer/main/install-commonforms.sh
chmod +x install-commonforms.sh
sudo ./install-commonforms.sh

Method 3: Manual Proxmox LXC Setup

Step-by-step manual container creation:

# 1. Create LXC container
pct create 200 local:vztmpl/debian-12-standard_12.7-1_amd64.tar.zst \
  --hostname commonforms \
  --memory 4096 \
  --cores 4 \
  --net0 name=eth0,bridge=vmbr0,ip=dhcp \
  --storage local-lvm \
  --rootfs local-lvm:20 \
  --unprivileged 1

# 2. Start container
pct start 200

# 3. Enter container
pct enter 200

# 4. Install CommonForms
curl -sSL https://raw.githubusercontent.com/HubEight/commonforms-installer/main/install-commonforms.sh | bash

🌐 Access the Web Interface

# Local access
http://localhost:8000

# Network access (replace with your container's IP)
http://YOUR_SERVER_IP:8000

Find your container's IP:

# From Proxmox host
pct exec 200 -- hostname -I

# From inside container
hostname -I

🔧 Service Management

# Check status
systemctl status commonforms

# View logs
journalctl -u commonforms -f

# Restart service
systemctl restart commonforms

🔄 Updating

source /opt/commonforms-env/bin/activate
pip install --upgrade commonforms
systemctl restart commonforms

🗑️ Uninstallation

systemctl stop commonforms
systemctl disable commonforms
rm -rf /opt/commonforms-env
rm -f /opt/commonforms-app.py
rm -f /etc/systemd/system/commonforms.service
systemctl daemon-reload
apt autoremove -y python3-venv libgl1 libglib2.0-0

🙏 Credits & Attribution

This installer is built using:

  • Proxmox Helper Scripts - LXC container automation framework
    • Uses build.func for standardized container creation
    • Follows community-scripts patterns and conventions
    • Copyright (c) 2021-2025 community-scripts ORG
    • License: MIT
  • CommonForms - AI-powered PDF form field detection
    • Original form detection engine
    • License: See original repository

🤝 Contributing

Contributions are welcome! Submit a Pull Request or report issues.

📄 License

This installer is released under the MIT License. CommonForms itself is licensed separately - see original repository.


Made with ❤️ for the self-hosting community

About

One-click installer for CommonForms Web UI - Automatic PDF form field detection with AI

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages