README.rst

Pinkman

To use pinkman, follow the following steps:

1. Create a python virtual environment or use system wide environment

$ python3 -m venv venv
$ source venv/bin/activate

2. Install pinkman package with pip.

$ pip install pinkman

3. Create the config file.

server:
  hostname: localhost
  port: 1025

cache:
  type: sqlite
  path: /tmp/pinkman.db

backend:
  type: http
  method: post
  url: https://pinkman.free.beeceptor.com
  apikey: 5ab99869-f403-4481-bed6-da7c8aad7521

4. Run the pinkman server.

$ pinkman server run -c /etc/config.pinkman.prod.yml

5. Run the pinkman worker.

$ pinkman worker run -c /etc/config.pinkman.prod.yml

6. Forward packets from port 1025 to port 25.

$ iptables -t nat -A PREROUTING -p tcp --dport 1025 -j REDIRECT --to-port 25