Changeset - b8b66cb2595a
Parent rev.
Child rev.
[Not reviewed]
0 2 1
Jan Kaluza - 10 years ago 2015-12-28 13:10:53
jkaluza@redhat.com
Mention transwhat backend in admin documentation
3 files changed with 18 insertions and 4 deletions:
documentation/admin.md
1
2
documentation/backends/transwhat.md
15
documentation/installation/docker.md
2
2
0 comments (0 inline, 0 general)
documentation/admin.md
➞
Show inline comments
 
@@ -23,16 +23,15 @@ This is Admin documentation for Spectrum 2 transport. If you are user trying to
 
* [Slack Frontend](frontends/slack.html)
 

			




	
	
	
		
 
#### Backends

			




	
	
	
		
 

			




	
	
	
		
 
* [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

			




	
	
	
		
 

			




	
	
	
		
 
* [XMPP Frontend](frontends/xmpp.html)

			




	
	
	
		
 
   * [Spectrum 2 in gateway mode](tutorials/gateway_mode.html)

			




	
	
	
		
 

			




        

    


    
    

    

        

                

                    documentation/backends/transwhat.md
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
new file 100644

			




	
	
	
		
 
---

			




	
	
	
		
 
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

			




        

    


    
    

    

        

                

                    documentation/installation/docker.md
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -49,13 +49,13 @@ You also have to create persistent directory to store various Spectrum 2 data li

			




	
	
	
		
 
	$ mkdir -p /opt/spectrum2/data

			




	
	
	
		
 

			




	
	
	
		
 
## Start Spectrum 2

			




	
	
	
		
 

			




	
	
	
		
 
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`.

			




	
	
	
		
 

			




	
	
	
		
 
## Checking the Spectrum 2 logs

			




	
	
	
		
 

			




	
	
	
		
 
To check the Spectrum 2 logs, use following Docker command:

			




	
	
		
 
@@ -72,7 +72,7 @@ To stop the Spectrum 2 container, use following Docker command:

			




	
	
	
		
 

			




	
	
	
		
 
To upgrade Spectrum 2 container, you at first have to pull the updated Docker image, stop the current container, remove it and start it again using the new version of Docker image. It is very important to have all the Spectrum 2 data stored in the host system as described earlier in this document. Otherwise you won't be able to upgrade running container without loosing the data.

			




	
	
	
		
 

			




	
	
	
		
 
	$ 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

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








    
        Server instance: srv01-10621
    
    
        This site is powered by
            Kallithea,
        which is
        © 2010–2021 by various authors & licensed under GPLv3.
            – Support