root/contributed_modules/modules/README.txt

Revision 9908, 2.1 kB (checked in by tm1000, 3 years ago)

Spelling Correction

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