proxtagger

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 50)

A lightweight, open-source web interface to bulk manage Proxmox VM and container tags with backup/restore functionality, conditional tag management and advanced filering.

proxtagger Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🧩 ProxTagger

![Overview image](https://res.cloudinary.com/dh1qu2two/image/upload/v1750360285/Screenshot_2025-06-19_211112_iiiic8.png)

A lightweight, open-source web interface to bulk manage Proxmox VM and container tags with backup and restore functionality, featuring automated conditional tagging rules.

![License](https://img.shields.io/github/license/Reginleif88/proxtagger?label=license)
![Python](https://img.shields.io/badge/python-3.9%2B-blue)
![Flask](https://img.shields.io/badge/flask-3.1.0-green)
[![Support](https://img.shields.io/badge/Support-FF5F5F?logo=ko-fi&logoColor=white)](https://ko-fi.com/reginleif88)

## Overview

ProxTagger provides a simple yet powerful web interface to manage tags for your Proxmox VMs and containers. It simplifies tag management with individual and bulk operations, automated conditional tagging rules, and tag-only backup and restore. The backup feature is useful for snapshotting and reverting tag changes without restoring entire VMs from Proxmox Backup Server.

## Features

- **Comprehensive Tag Management**
   - View all VMs and containers with their tags in an interactive table (powered by DataTables) supporting sorting and pagination.
   - Add/remove tags to individual VMs with a clean, intuitive interface and improved visual feedback.
   - Perform bulk operations to add or remove tags across multiple VMs, with selection persisting across pages/filters.
   - Button to easily clear the current VM selection in the bulk panel.
- **Advanced Filtering & Search**
   - Filter VMs/Containers by Host, VMID range, and Name pattern using the dedicated filter panel.
   - Select all VMs/Containers that match the current filter criteria with a single click.
   - Global search bar supporting **regular expressions** for powerful table filtering across all columns.
- **Tag Colors**
   - Tag chips render in their Proxmox cluster colors so the ProxTagger UI matches the Proxmox UI.
   - Tags without an explicit override use the same deterministic color algorithm Proxmox does, so chips are consistent across both UIs without any configuration.
   - Dedicated "Tag Colors" page with per-tag background and text color pickers; saves are written back to Proxmox's `tag-style` cluster option.
- **Conditional Tag Management**
   - Create automated rules that apply or remove tags based on VM/container properties.
   - Advanced condition builder with AND/OR logic operators for complex filtering.
   - THEN/ELSE actions - different behaviors for matching vs non-matching VMs.
   - Schedule rules to run automatically via cron expressions or execute manually.
   - Test mode with dry-run capabilities to preview changes.
   - Rule execution history and comprehensive logging.
- **Backup & Restore**
   - Download tag configurations as JSON files (also captures cluster tag color overrides).
   - Restore tags and tag colors from previous backups.
   - Backwards-compatible: legacy backup files (pre-tag-colors) still import without changes.
- **Interactive UI**
   - Dynamic table to browse large numbers of VMs/Containers.
   - Consistent toast notifications provide feedback for user actions.
- **Security & Flexibility**
   - Uses Proxmox API tokens for secure authentication.
   - Uses official Proxmox APIs.

## Getting Started

### Prerequisites

- A Proxmox VE server
- API token with appropriate permissions (see API Token Setup section for details)
- Docker (if running in a container)
- Python 3.9+ (if building locally)

### Running with Docker

You can run ProxTagger using pre-built Docker images available on [Docker Hub](https://hub.docker.com/r/reginleif88/proxtagger).

#### Using `docker compose`

To use Docker compose you need to create a docker-compose.yml or use the one in the repository to run the ProxTagger container.

```yaml
services:
  proxtagger:
    image: reginleif88/proxtagger:latest
    container_name: proxtagger_app
    ports:
      - "5660:5660"
    environment:
      - PORT=5660
    volumes:
      - proxtagger_data:/app/data
    restart: unless-stopped

volumes:
  proxtagger_data:
    name: proxtagger_data
    driver: local
```

Execute `docker compose up -d` and then open your browser and navigate to `http://localhost:5660`

#### Using `docker run`

This command starts the container, maps host port 5660 to the application's port 5660 inside the container, sets the listening port via the `PORT` environment variable, uses a persistent volume for data, and runs the latest image.

```bash
# Pull the latest image
docker pull reginleif88/proxtagger:latest

# Run the container
docker run --detach --name proxtagger_app \
  --publish 5660:5660 \
  --env PORT=5660 \
  --volume proxtagger_data:/app/data \
  --restart unless-stopped \
  reginleif88/proxtagger:latest
```

Open your browser and navigate to `http://localhost:5660`

#### Data Persistence and Updates

ProxTagger stores all persistent data (configuration, rules, history) in the `/app/data` directory. This directory is mounted as a Docker volume to preserve your data across container updates.

**Upgrading from older versions:**
If you're upgrading from a version that mounted the entire `/app` directory:

1. Stop the old container
2. Update your docker-compose.yml or docker run command to use the new volume mount (`/app/data`)
3. Start the new container
4. **Migration happens automatically** - the application will detect and migrate your data files on startup
5. Check the web interface for any migration warnings or status messages

### Installation

1.  Clone the repository:
    ```bash
    git clone https://github.com/reginleif88/proxtagger.git
    cd proxtagger
    ```

2.  Install dependencies or do it in virtual env:
    ```bash
    pip install -r requirements.txt
    ```

3.  Run the application:
    ```bash
    python app.py
    ```

4.  Access the web interface:
    Open your browser and navigate to `http://localhost:5660`. The app binds to `0.0.0.0` (all interfaces) by default; set the `PORT` environment variable to use a different port, or edit `app.py` to change the bind host.

## Security Notes

Before exposing ProxTagger, please be aware:

- **No built-in authentication.** ProxTagger has no login screen — anyone who can reach the listening port can manage tags and run conditional rules against your cluster. Run it on a trusted network only, or put it behind a reverse proxy (nginx, Caddy, Traefik, Authelia, etc.) that enforces authentication.
- **Credentials are stored in plaintext.** Your Proxmox host, user, and API token value are written to a JSON file in the `data/` directory (mounted as `/app/data` in Docker). Treat that volume as sensitive and restrict filesystem access accordingly.
- **Use a least-privilege API token.** Grant only the permissions listed in [API Token Setup](#api-token-setup). Avoid reusing a token that has broader rights than ProxTagger needs.

## Configuration

### API Token Setup

You'll need a Proxmox API token with the following permissions:

**Required permissions:**
- `VM.Audit` (to list VMs and containers)
- `VM.Config.Options` (to read and modify tags)

**Optional permissions (for conditional tagging features):**
- `Sys.Audit` (to get HA status and cluster resources)
- `VM.Backup` (to check backup status)
- `VM.Snapshot` (to check snapshot information)
- `Datastore.Audit` (may be needed for backup information)

**Optional permissions (for the Tag Colors page):**
- `Sys.Audit` on `/` — read the cluster-wide tag color map (already needed by some conditional tagging rules).
- `Sys.Modify` on `/` — save tag color changes from the Tag Colors page.

Note: Without the optional permissions, basic tagging functionality will work, but some conditional tagging rules based on HA status, backups, or snapshots may not function properly. The Tag Colors feature also degrades gracefully — without `Sys.Audit` ProxTagger falls back to deterministic colors derived from each tag name (matching Proxmox's own algorithm), and without `Sys.Modify` the Tag Colors page becomes read-only.

To create an API token:

1.  Log in to your Proxmox web interface
2.  Navigate to Datacenter → Permissions → API Tokens
3.  Click "Add" and follow the prompts
4.  **Important:** Note down both the token ID/name and secret - the secret is only shown once!
5.  Ensure the token has the required privileges (VM.Audit, VM.Config.Options)

### First-time Setup

1.  On first launch, you'll be prompted to enter your Proxmox connection details:
    - Host (IP or domain)
    - Port (default: 8006)
    - User (e.g., root@pam)
    - Token name and value
    - SSL verification toggle (disable for self-signed certificates)

2.  After successful connection, the system automatically creates an initial tag backup

## Usage Guide

### VM/Container Table

- Use the search bar (top right) to filter the table. **Regex is supported.** Use the 'X' button to clear the search.
- Click column headers to sort the table.
- Use the pagination controls at the bottom to navigate through pages if you have many VMs/Containers.

### Tag Management

- **Individual Tags**: Click the "+" button in the "Tags" column for any VM/Container to add tags individually. Click the 'x' on a tag chip to remove it.
- **Bulk Operations**: Use the "Bulk Tag Management" panel to perform actions on multiple VMs/Containers:
    - Select VMs/Containers using the checkboxes in the first column. Your selections are remembered even if you change pages or apply filters.
    - Use the "Filter VMs" section within the bulk panel to narrow down the list by Host, VMID range, or Name pattern. Click "Select All Filtered" to quickly select all VMs matching your filters.
    - Click "Clear Selected VMs" to deselect all currently checked VMs/Containers.
    - Choose "Add Tags" or "Remove Tags" operation.
    - Select existing tags or create new ones (new tags only possible in "Add" mode).
    - Click "Apply" to execute the changes on all selected VMs/Containers.

### Conditional Tags

- **Access**: Click "Conditional Tags" in the navigation menu to access the automated tagging system.
- **Quick Templates**: Use pre-built templates for common tagging scenarios:
  - **Debian LXC Tagging**: Automatically tag all Debian-based containers as "deb-lxc"
  - **HA Validation**: Add "HA" tag to VMs with both replication and HA enabled, remove from others
  - **High-Resource VMs**: Tag VMs with more than 4 cores and 8GB RAM as "high-resource"
- **Custom Rules**: Create your own rules using the rule builder:
  - Add conditions based on VM properties (CPU, memory, OS type, HA status, etc.)
  - Use AND/OR logic to combine multiple conditions
  - Set THEN actions (tags to add/remove for matching VMs)
  - Set ELSE actions (tags to add/remove for non-matching VMs)
  - Configure scheduling with cron expressions for automatic execution
- **Testing**: Use "Test Rule" to perform a dry-run and preview which VMs would be affected.
- **Management**: View, edit, delete, and execute rules from the rules table. Monitor execution history and results.

### Tag Colors

- **Access**: Click "Tag Colors" in the sidebar to open the management page.
- **Per-tag colors**: Each tag in your environment is listed with a background and text color picker. Pick the colors you want and click "Save Changes" — ProxTagger writes them back to Proxmox's cluster-wide `tag-style` option, so the colors apply everywhere (Proxmox UI included).
- **Reset**: Use the per-row reset button to remove an override and fall back to the deterministic default (which matches Proxmox's own algorithm), or "Reset all to defaults" to clear every override at once.
- **Permissions**: The page requires `Sys.Audit` on `/` to read existing colors, and `Sys.Modify` on `/` to save. Without those, ProxTagger still renders tags with deterministic colors but the page becomes read-only. Tag colors are also included in tag backups (Export Tags) and restored via Import Tags when the token has `Sys.Modify`.

### Backup & Restore

- **Export Tags**: Click "Export Tags" in the sidebar to download a backup JSON file. The file contains both per-VM tags and the cluster-wide tag color overrides (when the token can read them).
- **Import Tags**: Click "Import Tags" and select a previously exported backup file.
- **Backup format**: Current backups use a versioned wrapper (`{"version": 2, "vms": [...], "tag_colors": {...}}`). Legacy backups produced by older ProxTagger versions (a bare list) still import without changes — restore is backward-compatible.
- **Tag restore**: matches VMs by VMID, Node, and Type, and replaces all existing tags with imported ones. Feedback is provided if VMs from the backup file cannot be found.
- **Color restore**: replaces the entire cluster tag color map with the values from the backup. Requires `Sys.Modify` on `/` — without it, tags are still restored but a warning notes that colors were skipped.

## Troubleshooting

### Common Issues

- **No VMs Visible**: Ensure your API token has `VM.Audit` and `VM.Config.Options` permissions at the appropriate level (/ or node-specific).
- **Conditional Tagging Issues**: If certain conditional tagging properties don't work:
  - HA properties: Requires `Sys.Audit` permission
  - Backup status: Requires `VM.Backup` and possibly `Datastore.Audit` permissions
  - Snapshot information: Requires `VM.Snapshot` permission
- **Connection Failed**: Check your hostname, port and network connectivity.
- **SSL Errors**: Toggle off SSL verification if you're using self-signed certificates.
- **Regex Search Issues**: Ensure you are using valid JavaScript regex syntax in the search bar. Invalid patterns may cause errors or unexpected results (check dev console).

## Technical Details

ProxTagger is built using:

- **Backend**: Python with Flask web framework. Uses Jinja2 for templating.
- **Frontend**: Bootstrap 5 for styling, [DataTables](https://datatables.net/) for table interactivity, and custom JavaScript organized into ES Modules.
- **Storage**: Local .json files for connection details and data.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1.  Fork the Project
2.  Create your Feature Branch
3.  Commit your Changes
4.  Push to the Branch
5.  Open a Pull Request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgements

- [Flask](https://flask.palletsprojects.com/) - The web framework used
- [Bootstrap](https://getbootstrap.com/) - UI framework
- [Bootstrap Icons](https://icons.getbootstrap.com/) - Icon set
- [DataTables](https://datatables.net/) - Table enhancement library
- [Proxmox Team](https://www.proxmox.com/) - For their amazing virtualization platform

proxtagger

proxtagger Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

proxtagger

proxtagger Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README