fusionpbx-docs/source/index.rst

.. image:: _static/images/logo.png
        :width: 130pt
        :align: center
        :height: 76.5pt

|


Welcome to FusionPBX Docs
=========================

**FusionPBX**
---------------

An open source project that provides a customizable and
flexible web interface to the very powerful and highly scalable
multi-platform voice switch called `FreeSWITCH`_.

FusionPBX will run on a variety of operating systems (Optimized for Debian 8+) and
hardware of your choice. FusionPBX provides a GUI for QR Code soft phone provisioning, unlimited
extensions, voicemail-to-email, music on hold, call parking, analog
lines or high density T1/E1 circuits, and many other features. FusionPBX
provides the functionality that business need and provides corporate
level phone system features to small, medium and large businesses. `Click here for the FusionPBX youtube channel`_ .

.. raw:: html

    <div style="text-align: center; margin-bottom: 2em;">
    <iframe width="100%" height="350" src="https://www.youtube.com/embed/XpiVyHqLaus?rel=0" frameborder="0" ; encrypted-media" allowfullscreen></iframe>
    </div>


Benefits of FusionPBX
^^^^^^^^^^^^^^^^^^^^^^^

1. Adding extra functionality to the incredibly robust FreeSWITCH VoIP Platform.
2. Makes FreeSWITCH easy to administer while at the same time
   still allowing you to work directly within `FreeSWITCH`_ Command Line Interface (fs_cli) when you need to. 
3. Gives your users and tenants an attractive GUI interface to interact with. 


`FusionPBX Features`_
^^^^^^^^^^^^^^^^^^^^^^^

+-------------------------+-----------------------+---------------------------------+------------------------------------------+
| `Call Block`_           | `Call Broadcast`_     | `Call Flows`_                   |       `Call Center`_                     |
+-------------------------+-----------------------+---------------------------------+------------------------------------------+
| `Call Detail Records`_  | `Conference`_         |    `Contacts`_                  |      `Fax Server`_                       |
+-------------------------+-----------------------+---------------------------------+------------------------------------------+
| `Follow Me`_            | `Hot Desking`_        |    `IVR Menus`_                 |      `Ring Groups`_                      |
+-------------------------+-----------------------+---------------------------------+------------------------------------------+
| `Multi-Tenant`_         | `Music on Hold`_      |    `Queues`_                    |      `Recordings`_                       |
+-------------------------+-----------------------+---------------------------------+------------------------------------------+
| `Device Provisioning`_  | `Streams`_            |   `QR Code Provisioning`_       | `SMS/MMS ready`_                         |                                                                        
+-------------------------+-----------------------+---------------------------------+------------------------------------------+
| `Time Conditions`_      | `WebRTC ready`_       |    `Voicemail`_                 |      `and lots more...`_                 |
+-------------------------+-----------------------+---------------------------------+------------------------------------------+

Our Ecosystem
^^^^^^^^^^^^^^^

We are a **global community** that has an open and **very friendly** ecosystem.  We encourage community engagement, contribution and feedback. Please join us by getting involved with giving feedback, new feature ideas, helping out with code or Documentation.

Most of the core folks who develop and use FusionPBX can be found hanging out in IRC network **irc.libera.chat** in the **#fusionpbx** channel. Come join us and meet the team.

.. _Device Provisioning: applications/provision.html
.. _Streams: applications/streams.html
.. _QR Code Provisioning: applications/gs_wave.html
.. _SMS/MMS ready: applications/sms_mms.html
.. _FreeSWITCH: https://www.freeswitch.org
.. _FusionPBX: https://www.fusionpbx.com
.. _Click here for the FusionPBX youtube channel: https://www.youtube.com/playlist?list=PLrhVQpI_CtOwQNB_lsNIxrl9SOAuo9ZSF
.. _IVR Menus: applications/ivr.html
.. _Call Broadcast: applications/call_broadcast.html
.. _Call Block: applications/call_block.html
.. _Conference: applications/conference.html
.. _Call Detail Records: applications/call_detail_record.html
.. _Call Center: applications/call_center.html
.. _Call Forward: Call_Forward
.. _Call Flows: applications/call_flows.html
.. _Follow Me: applications/follow_me.html
.. _Music on Hold: applications/music_on_hold.html
.. _Contact Manager: Contact_Manager
.. _Active Extensions: Active_Extensions
.. _Hot Desking: accounts/hot_desking.html
.. _Queues: applications/queues.html
.. _Recordings: applications/recordings.html
.. _Call Recordings: applications/recordings.html
.. _Contacts: applications/contacts.html
.. _Active Calls: Active_Calls
.. _Dialplan Manager: Dialplan_Manager
.. _Conferences: Conferences
.. _Fax Server: applications/fax_server.html
.. _Time Conditions: applications/time_conditions.html
.. _Ring Groups: applications/ring_group.html
.. _Recordings: applications/recordings.html
.. _Voicemail: applications/voicemail.html
.. _Multi-Tenant: advanced/domains.html
.. _WebRTC ready: applications_optional/webrtc.html
.. _and lots more...: features/features.html
.. _FusionPBX Features: features/features.html

Getting Started
=====================

.. toctree::
   :maxdepth: 4
   
   getting_started.rst

Home
=====

.. toctree::
   :maxdepth: 4
   
   home.rst

Accounts
==========

.. toctree::
   :maxdepth: 4

   accounts.rst

Dialplans
==========

.. toctree::
   :maxdepth: 4

   dialplans.rst
   
 
Applications
=============

.. toctree::
   :maxdepth: 4

   applications.rst
   
Status
========

.. toctree::
   :maxdepth: 4

   status.rst

Advanced
==========

.. toctree::
   :maxdepth: 4

   advanced.rst

Hardware
=============

.. toctree::
   :maxdepth: 4

   hardware.rst

Software
===========

.. toctree::
   :maxdepth: 4
   
   software.rst

Additional Information
=======================

.. toctree::
   :maxdepth: 4

   additional_information.rst

Contributing
=============

.. toctree::
   :maxdepth: 4

   contributing.rst

Documentation Guide
====================

.. toctree::
   :maxdepth: 4

   doc_guide.rst

Other
=======

.. toctree::
   :maxdepth: 4

   other.rst