Skip to content

Latest commit

 

History

History
123 lines (97 loc) · 4.25 KB

README.rst

File metadata and controls

123 lines (97 loc) · 4.25 KB

unMessage

unMessage is a peer-to-peer instant messaging application designed to enhance privacy and anonymity.

Warning

unMessage is alpha software. While every effort has been made to make sure unMessage operates in a secure and bug-free fashion, the code has not been audited. Please do not use unMessage for any activity that your life depends upon.

Features

Quick Start

Install the following requirements via package manager:

$ # If using Debian/Ubuntu
$ sudo apt-get install build-essential gcc libffi-dev libopus0 \
  libsodium-dev libssl-dev portaudio19-dev python-dev python-tk

$ # If using Fedora
$ sudo dnf install gcc libffi-devel libsodium-devel \
  openssl-devel opus portaudio-devel python-devel \
  redhat-rpm-config tkinter

If you have tor installed, make sure its version is at least 0.2.7.1:

$ tor --version

If you must update it or do not have it installed, check the version provided by the package manager:

$ # If using Debian/Ubuntu
$ apt-cache show tor

$ # If using Fedora
$ dnf info tor

If the version to be provided is not at least 0.2.7.1, you will have to set up Tor's package repository. Once you have a repository which can provide an updated tor, install it:

$ # If using Debian/Ubuntu
$ sudo apt-get install tor

$ # If using Fedora
$ sudo dnf install tor

Installing

Finally, using virtualenv, pip and setuptools (the latter probably installed automatically with pip), you can easily install unMessage with:

$ virtualenv ~/unmessage-env
$ . ~/unmessage-env/bin/activate
(unmessage-env)$ pip install unmessage

Launch unMessage with any of the commands:

(unmessage-env)$ unmessage-gui  # graphical user interface (GUI)
(unmessage-env)$ unmessage-cli  # command-line interface (CLI)
(unmessage-env)$ unmessage      # last interface used

Updating

If you installed unMessage with pip, you can also use it for updates:

(unmessage-env)$ pip install --upgrade unmessage

Documentation

You can find installation and usage instructions (for the GUI and the CLI) on the documentation.

Feedback

Please join us on #unMessage:anemone.me or #anemone:anemone.me with Matrix, #anemone at OFTC, or use the GitHub issue tracker to leave suggestions, bug reports, complaints or anything you feel will contribute to this application.