Matrix-Mirrors/pantalaimon
1
0
Fork 0
mirror of https://github.com/matrix-org/pantalaimon.git synced 2025-01-08 22:28:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

README: Add instalation and usage instructions.

Browse Source
This commit is contained in:
Damir Jelić 2019-03-28 17:07:10 +01:00
parent 95f271f45e
commit 367083d6ff
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -4,3 +4,27 @@ pantalaimon
A E2E aware matrix proxy daemon. A E2E aware matrix proxy daemon.
This still in an early development phase. This still in an early development phase.
Instalation
===========
The [Olm](https://git.matrix.org/git/olm/) C library is required to be installed
before installing pantalaimon.
Instalation works like usually with python packages:
python setup.py install
Usage
=====
Running the daemon is relatively easy:
pantalaimon https://example.org:443
After running the daemon configure your client to connect to the daemon instead
of your homeserver. The daemon listens by default on localhost and port 8009.
The listening address and port can be configured:
pantalaimon -l 127.0.0.1 -p 8008 https://example.org:8008