Difference between revisions of "Mumo"

From Mumble Wiki
Jump to: navigation, search
(3rd Party Modules: Drop migrated content)
(Drop category)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
=mumo - The Mumble Moderator=
 
 
 
'''Please refer to our [https://github.com/mumble-voip/mumo/blob/master/README.md repository README file] for documentation.'''
 
'''Please refer to our [https://github.com/mumble-voip/mumo/blob/master/README.md repository README file] for documentation.'''
 
==Contributions==
 
If you have a module that you would like to see shipped with mumo or
 
have any improvements or suggestions please contact us. Whether you
 
prefer a pull request, visiting us in IRC in #mumble on Freenode or
 
starting a thread in our forums at http://forums.mumble.info is up to you.
 
 
==Configuration==
 
To configure and run mumo take a look at the mumo.ini and the module
 
specific configurations in modules-available folder. Enabling modules
 
is done by linking the configuration in modules-available to the
 
modules-enabled folder.
 
 
==Requirements==
 
mumo requires:
 
- python 2.7*
 
- python-zeroc-ice
 
- murmur >=1.2.3*
 
- murmur >=1.2.4 if you want to use a module which needs user interaction via text commands
 
 
* Not tested with lower versions yet
 
 
=Installing mumo=
 
The newest version of mumo is always available from our mumo repository at https://github.com/mumble-voip/mumo .
 
 
== Docker==
 
A docker image can be run with the command:
 
    docker run --name mumo --net=container:<id_of_mumble_server_container> -d -v /path/to/mumo/folder:/data mumblevoip/mumo
 
This is the base of the mumo service. It's allow addition of new module.
 
 
Warning:
 
- the service network-mode is mandatory to link mumble and mumo. Ice need to be in mumble-server localhost.
 
- the volume is to store all modules and configurations, you can add yours here. Subfolders will be automatically created ad first start.
 
- When you add new modules, you need the restart the container.
 
 
Here a docker-compose(v2.4) example:
 
    mumble-mumo:
 
        image: mumblevoip/mumo
 
        container_name: mumble-mumo
 
        restart: on-failure
 
        volumes:
 
            - /path/to/mumo/folder:/data
 
        network_mode : "service:mumble-server"
 
        depends_on:
 
            - mumble-server
 
 
==Ubuntu 12.04==
 
''Note:'' This guide only shows the basic steps for trying out mumo. For a more permanent setup you'll want to run mumo with its own user and a startup script.
 
 
* Make sure you are running a recent Murmur release (1.2.4 or later). Ice should be enabled and a writesecret must be set (see configuration file).
 
* Install dependencies
 
sudo apt-get install python-zeroc-ice python-daemon git
 
* Clone repository
 
cd ~/
 
git clone https://github.com/mumble-voip/mumo.git
 
* Adjust configuration
 
cd mumo
 
nano mumo.ini
 
In the editor set your server's Ice writesecret as the secret variable so mumo can control your server.
 
secret = mysecretwritesecret
 
Close and save by pressing Ctrl + X followed by Y and Enter.
 
* Configure the modules you want to use by editing their ini file in the modules-available folder
 
* Enable modules by linking their config file into the modules-enabled folder
 
cd modules-enabled
 
ln -s ../modules-available/moduleyouwanttouse.ini
 
* Run mumo
 
./mumo.py
 
 
Mumo should now be working with your mumble server. If it doesn't work check the ''mumo.log'' file for more information.
 
 
[[Category:3rd Party]]
 

Latest revision as of 12:32, 12 March 2024

Please refer to our repository README file for documentation.