Skip to main content

Deploy and set up Docker Compose based web apps with Ansible

Project description

Docksible

About

Install a Dockerized web app on a given remote VPS, with a single command in your local CLI - powered by Ansible.

Supports SSL, so it's perfect for quick demo servers, or even lightweight production environments.

You can also install on localhost or local VMs, perfect for local experiments with different types of apps.

Features

  • WordPress
  • Joomla
  • Redmine (open source issue tracker)
  • "Custom app" - you simply provide a valid container name (from Docker Hub), and any required app specific environment variables (via --extra-env-vars), and it should work.
  • SSL certs, including test certs
  • SSH proxy to tunnel hidden services like database
  • phpMyAdmin container
  • Hopefully more soon ;-)

Requirements

  • Local: Unix with Python 3.9 or newer. Tested this on Gentoo and Ubuntu Linux. Might work on macOS, but I don't know. Won't work on Windows, because it uses Ansible under the hood, which AFAIK is not supported for Windows.
  • Remote: VPS running Ubuntu, or maybe other Debian based flavor, reachable via SSH. It should probably work on all Debian distros, but I have only tested on Ubuntu.

Installing

Intall with Pip: python -m pip install docksible

Usage

These examples should be self explanatory:

  • docksible user@example.com wordpress --letsencrypt --email admin@example.com
  • docksible user@example.com redmine --letsencrypt --email admin@example.com

Run the --help flag for all supported options.

Using the SSH proxy

You can include a simple SSH proxy into your app's Docker network, by passing the --ssh-proxy flag. This will drop in a small container that you can use to port forward some hidden services, like the database. Here's how to do it:

  • Include --ssh-proxy in the Docksible command (ex: docksible user@host wordpress --ssh-proxy)
  • Set up the proxy service's authorized_keys file. This will be improved in the future, but until then:
    • SSH into your server as root
    • Copy root's .ssh/authorized_keys into docksible-volumes/ssh-proxy-data/
    • Shell into the proxy container, and basically chown -R proxy_user:proxy_user /home/proxy_user. This could also be improved, but for now, just needs to be done once.
  • Now the proxy service is ready to use. For example:
    • Set up the tunnel to proxy the database:
    ssh -p 2222 proxy_user@yourserver.com -L 9000:docksible_db:3306
    
    • Connect to the database:
    mysql -u your_db_user -p --port=9000 --host=localhost --protocol=TCP
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docksible-1.0.1.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docksible-1.0.1-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file docksible-1.0.1.tar.gz.

File metadata

  • Download URL: docksible-1.0.1.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for docksible-1.0.1.tar.gz
Algorithm Hash digest
SHA256 905784f7820e4755693a094b7cd4eb9cf4ec417715536b2dca529bd35736955a
MD5 9b23da479847f887c887553e99ff4c5b
BLAKE2b-256 d31c971d1e534bf3c28c5b894944138d5ec1d7554d5aa26ab1fb5ad3bfc78ac7

See more details on using hashes here.

File details

Details for the file docksible-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: docksible-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 21.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for docksible-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 12f45862c0975cd813e6c7ee14272d30ba4c8be40c9d9ff79acc95dc4d057ad0
MD5 598671f09f2714641162908c5884edaa
BLAKE2b-256 3ef9a76c32a81dd0f44877e7795e42bb29e1950b42db4624425fbacf51ecb239

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page