Skip to content

Installation

  • Install with a single command from PyPi

    pip3 install envelope
    

    • Or install current GitHub master
      pip3 install git+https://github.com/CZ-NIC/envelope.git
      
    • Or just download the project and launch python3 -m envelope
  • If planning to sign/encrypt with GPG, make sure it is installed with sudo apt install gpg — see also the Configure your GPG tutorial.

  • If planning to use S/MIME, you might need a few build prerequisites first, ex: sudo apt install build-essential libssl-dev libffi-dev python3-dev cargo pkg-config
  • If planning to send e-mails, prepare SMTP credentials or follow the Configure your SMTP tutorial.
  • If your e-mails are to be received outside your local domain, see the DMARC section.
  • python-magic is used as a dependency. Due to a well-known name clash with the file-magic package, feel free to run pip uninstall python-magic && pip install file-magic if you need the latter — envelope is fully compatible with both. Both rely on libmagic under the hood, which is probably already installed; if not, install it with sudo apt install libmagic1.

Bash completion

  1. Run: apt install bash-completion jq
  2. Copy envelope-autocompletion.bash to /etc/bash_completion.d/
  3. Restart terminal