Brave Collective Mumble Management Application

An authenticated Mumble management application and authorization plug-in.

© 2013-2014, Alice Bevan-McGregor and contributors.

https://github.com/bravecollective/core

1. What is

YES THIS NEEDS T.B.D.

2. Installation

Development takes place on GitHub in the core project. Issue tracking, documentation, and downloads are provided there.

You will require an installed and running MongoDB installation. Installation and configuration of MongoDB is beyond the scope of this documentation.

You will require a current WebCore installation. The following will create a new Python virtual environment folder called “brave” in your current working directory, then activate the virtual environment.

curl get.web-core.org | python - brave
cd brave
. bin/activate

Additionally, there are two requirements you will need to manually install as Core Services require features present in as-yet unreleased packages. You will need to perform the following steps:

(git clone git@github.com:marrow/marrow.templating.git; cd marrow.templating; python setup.py develop)
(git clone git@github.com:marrow/marrow.tags.git; cd marrow.tags; python setup.py develop)

Installing the current development version requires Git, a distributed source code management system. Compilation additionally requires the Python development headers and the OpenSSL development headers. In Debian/Ubuntu, these are found in packages `python-dev` and `libssl-dev`.
Run the following to download the development version with Git, and link it into your Python runtime:

git clone https://github.com/bravecollective/core.git
(cd core; python setup.py develop)

Once you have successfully compiled the Core Service, copy `core/development.ini` to `core/local.ini`, and make changes as appropriate. Finally, bootstrap the EVE API system by running:

paster shell local.ini # or development.ini if you didn't customize
from brave.core.util.eve import populate_calls
populate_calls()

You can upgrade to the latest version at any time:

(cd core; git pull; python setup.py develop)

If you would like to make changes and contribute them back to the project, fork the GitHub project, make your changes, and submit a pull request. This process is beyond the scope of this documentation; for more information, see GitHub’s documentation.

3. Running the Service

Make a copy of development.ini called local.ini, update all relevant directives (related to storage of sessions, cache data, and database URI) and run the following to serve content locally:

paster serve local.ini

This will start a development server and present the URL you need to access. (Generally http://127.0.0.1:8080.) If you wish the server to automatically restart in the event of a change to one of the source files (templates and statically served content are exempt) add the --reload switch.

To start the mumble plugin, set up an ICE write secret in /etc/mumble-server.ini, and edit startAuthenticator.sh, replace ICE_SECRET_WRITE with the secret from /etc/mumble-server.ini.

4. License

Brave Collective Mumble Management Application has been released under the MIT Open Source license.

4.1. The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.