Skip to main content

Kolombo - CLI for easy mail server managing 💌

Project description

Kolombo

Kolombo Logo

CLI for easy mail server managing 💌

NB! Work in progress, not ready for production use!

Introduction

What Kolombo does:

  • Configures email domains (example.com/mx.example.com) and users (info@example.com)
  • Generates DKIM keys with TXT records to add to DNS
  • Manages all services needed for email to work in docker-compose

Installation

Python 3.8+, sudo, Docker and docker-compose should be installed on system.

Install with pip:

pip install kolombo

How to use

Documentation is coming, for now, this is how to setup mail server for domain example.com with user info@example.com

# Initialize Kolombo
kolombo init

# Add domain and generate DKIM keys for it
kolombo domain add example.com mx.example.com  # MX field is optional
kolombo dkim generate example.com  # generates DKIM keys and returns DNS TXT record to add
kolombo dkim txt example.com  # returns DNS TXT record to add

# Add user (email) for domain you just added
kolombo user add info@example.com

# Deploy Kolombo services and senders one by one...
kolombo run receiver  # Listens on 25 for incoming mail, gives emails to users that come through nginx 993/995 ports
kolombo run auth  # Authenticates SMTP/POP3/IMAP users from nginx
kolombo run nginx  # Listens on 465 (SMTP), 993 (IMAP) and 995 (POP3)
kolombo run senders  # Send emails from users that come through nginx 465 port

# ... or deploy all everything at once
kolombo run all

# Stop all Kolombo services and senders
kolombo stop all

# ... or stop them one by one
kolombo stop receiver
kolombo stop auth
kolombo stop nginx
kolombo stop senders

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

kolombo-0.5.0.tar.gz (39.4 kB view details)

Uploaded Source

Built Distribution

kolombo-0.5.0-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

Details for the file kolombo-0.5.0.tar.gz.

File metadata

  • Download URL: kolombo-0.5.0.tar.gz
  • Upload date:
  • Size: 39.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for kolombo-0.5.0.tar.gz
Algorithm Hash digest
SHA256 627de4be7ac519f0c7c4d9428f4e5798fea7e59471534aeb344858f914235d1d
MD5 15e5e6351d760480918dff88f04de7bb
BLAKE2b-256 e6c9b62bca02941bc7bb1bff06389d7238dfa40d36e18fdb79e84d3f59ca701d

See more details on using hashes here.

File details

Details for the file kolombo-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: kolombo-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 31.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for kolombo-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 269f1b78c4099ef245ed0fd31c758948e7884a45db73ff07eeda72001c51a1da
MD5 b1bd477409bcc5c3c3fefdeb8755661a
BLAKE2b-256 f84626c1500249861bcfe00403744cb54b35694170382fd6041c54d395047384

See more details on using hashes here.

Supported by

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