Index: /contributed_modules/modules/README.txt =================================================================== --- /contributed_modules/modules/README.txt (revision 5047) +++ /contributed_modules/modules/README.txt (revision 5047) @@ -0,0 +1,36 @@ +Contributed Modules Repository + +The purpose of this repository is to provide a home for third party contributed +modules to FreePBX. There are many modules in FreePBX which of course have all +been contributed in one form or another. When a module makes it into the main +project it represents a level of comittment and responsibility on the core team +to maintain and support those modules whether the original authors are still +active or not. There are also considerations in the future architectural plans +of FreePBX that sometimes keep new modules form being included in Core because +we know that upcoming changes will severely break them and create major transition +problems. + +However, there are a lot of good and very useful modules that people have developed +and continue to develop for FreePBX and the desire of the project is to support +such development efforts and provide a location where users can go to obtain the +modules. This is the starting point for that effort and as time progresses there +will be efforts in place to support multiple online repositories so that the +FreePBX Module Admin system can be used to install and update such modules. + +For now, the solution is a manual solution. You can either do an svn pull of +the desired module or grab the tarball for that module. Which ever form you +take, the installation of a new module is very straight forward in FreePBX. + +1. Load the module (explode the tarball) in the module directory which by default + is /var/www/html/admin/modules +2. Got to Module Admin where you will see the Module as "Locally Available" and + from there you can install it. + +Note - using such modules is at your own risk and support is limitted to places +like the FreePBX forums or other options that may be available from the author. + +If you have a module that you want to include, you should contact a core FreePBX +developer or simply submit the module as a tarball in the ticket system as a +new module. We will then get it into the repository. Very soon we will have new +abilities to give authors of these modules access to this part of the repository +so they can maintain the modules.