Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 2.37 KB

README.md

File metadata and controls

80 lines (57 loc) · 2.37 KB
Raw

Gluecannon

Gluecannon is a script that orchestrates the deployment and configuration of multiple gluetun VPN containers and a single HAProxy container that acts as a proxy for the VPN containers. It allows you to easily manage and scale your VPN setup using Docker Compose.

Features

  • Load configuration from a YAML file.
  • Generate Docker Compose and HAProxy configuration files based on the loaded configuration.
  • Manage (start, stop) VPN containers and HAProxy using Docker Compose.
  • Run commands through the HAProxy.
  • Start an interactive shell through the HAProxy.

Usage

The script is invoked from the command line with an action argument. The available actions are:

  • up: Start or restart the VPN containers and HAProxy.
  • down: Stop the VPN containers and HAProxy.
  • list: List the running services.
  • run: Run a command through the HAProxy. This action requires an additional argument specifying the command to run.
  • interactive: Start an interactive shell through the HAProxy.
graph LR
    subgraph Docker Network
        direction LR
        subgraph VPN_Providers
            direction LR
            provider1_0[Provider1_Container0]
            provider1_1[Provider1_Container1]
            provider2_0[Provider2_Container0]
        end
        haproxy[HAProxy]
    end
    
    haproxy -->|Routes Traffic| provider1_0
    haproxy -->|Routes Traffic| provider1_1
    haproxy -->|Routes Traffic| provider2_0
    
    subgraph External Network
        user[User]
    end
    
    user -->|Accesses via Proxy| haproxy
Loading

Example usage:

python gluecannon.py up
python gluecannon.py run curl ifconfig.me
python gluecannon.py down

Configuration

The script reads its configuration from a YAML file (config.yml by default). The configuration file specifies the global settings (like the proxy port and Docker image to use), and the settings for each VPN provider (like the number of containers to start and the environment variables to set).

Dependencies

  • Python 3.6 or later
  • Docker
  • Docker Compose
  • Jinja2

Installation

  1. Clone the repository.
  2. Install the dependencies.
  3. Adjust the configuration file to your needs.
  4. Run the script with the desired action.

Contributing

Contributions are welcome. Please submit a pull request or create an issue to discuss the changes.

License

This project is licensed under the MIT License.