Mention transwhat backend in admin documentation
This commit is contained in:
parent
3bda0dccb2
commit
b8b66cb259
3 changed files with 18 additions and 4 deletions
|
@ -26,10 +26,9 @@ This is Admin documentation for Spectrum 2 transport. If you are user trying to
|
|||
|
||||
* [Backends overview](backends/backends.html)
|
||||
* [Libpurple backend](backends/libpurple.html)
|
||||
* [Swiften backend](backends/swiften.html)
|
||||
* [Libcommuni backend](backends/libcommuni.html)
|
||||
* [Skype backend](backends/skype.html)
|
||||
* [Twitter backend](backends/twitter.html)
|
||||
* [Transwhat backend](backends/transwhat.html)
|
||||
|
||||
#### Tutorials
|
||||
|
||||
|
|
15
documentation/backends/transwhat.md
Normal file
15
documentation/backends/transwhat.md
Normal file
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
layout: page
|
||||
title: Spectrum 2
|
||||
---
|
||||
|
||||
### Description
|
||||
|
||||
Transwhat backend adds support for Whatsapp network. It is included in our Docker image. For more information about it, check the [Transwhat GitHub page](https://github.com/dazzzl/transwhat).
|
||||
|
||||
### Configuration
|
||||
|
||||
You have to choose this backend in Spectrum 2 configuration file to use it:
|
||||
|
||||
[service]
|
||||
backend=/opt/transwhat/transwhat.py
|
|
@ -52,7 +52,7 @@ You also have to create persistent directory to store various Spectrum 2 data li
|
|||
|
||||
To start Spectrum 2 on background using Docker, all you have to do is running following Docker command:
|
||||
|
||||
$ docker run --name="spectrum2" -d -v /opt/spectrum2/configuration:/etc/spectrum2/transports -v /opt/spectrum2/data:/var/lib/spectrum2 spectrum2/spectrum2
|
||||
$ docker run --name="spectrum2" -d -p 5222:5222 -v /opt/spectrum2/configuration:/etc/spectrum2/transports -v /opt/spectrum2/data:/var/lib/spectrum2 spectrum2/spectrum2
|
||||
|
||||
It will start Spectrum 2 and load the configuration files from `/opt/spectrum`. It also gives the spawned container name `spectrum2`.
|
||||
|
||||
|
@ -75,4 +75,4 @@ To upgrade Spectrum 2 container, you at first have to pull the updated Docker im
|
|||
$ docker pull spectrum2/spectrum2
|
||||
$ docker stop spectrum2
|
||||
$ docker rm spectrum2
|
||||
$ docker run --name="spectrum2" -d -v /opt/spectrum2/configuration:/etc/spectrum2/transports -v /opt/spectrum2/data:/var/lib/spectrum2 spectrum2/spectrum2
|
||||
$ docker run --name="spectrum2" -d -p 5222:5222 -v /opt/spectrum2/configuration:/etc/spectrum2/transports -v /opt/spectrum2/data:/var/lib/spectrum2 spectrum2/spectrum2
|
||||
|
|
Loading…
Add table
Reference in a new issue