TOC and Markdown Conversions (#280)

* Create getting_started.md

* Create index.md

* Create firewall.md

* Create home.md

* Create accounts.md

* Create dialplans.md

* Update dialplans.md

* Create applications.md

* Update applications.md

* Update getting_started.md

* Create status.md

* Create advanced.md

* Create hardware.md

* Update provision_variables_snom.md

* Create software.md

* Update software.md

* Create additional_information.md

* Create other.md

source/accounts.md

@@ -0,0 +1,12 @@
+# Accounts
+
+In the **Accounts** menu you have access to devices, extensions, gateways, providers and users.
+
+```{toctree}
+:maxdepth: 3
+
+accounts/devices.md
+accounts/extensions.md
+accounts/gateways.md
+accounts/users.md
+```

source/additional_information.md

@@ -0,0 +1,26 @@
+# Additional Information
+
+In the **Additional Information** section you will find topics related to FusionPBX.
+
+```{toctree}
+:maxdepth: 3
+
+additional_information/voip_quality.md
+additional_information/freeswitch.md
+additional_information/sip_tls.md
+additional_information/testimonials.md
+additional_information/password_reset.md
+additional_information/feature_codes.md
+features/features.md
+additional_information/toll_allow.md
+#additional_information/tftp.md
+additional_information/nat.md
+applications/provision.md
+advanced/version_upgrade.md
+additional_information/releases.md
+additional_information/regex.md
+additional_information/postgresql.md
+additional_information/shared_line_appearance.md
+additional_information/cdr_archive.md
+additional_information/government_regulations.md
+```

source/advanced.md

@@ -0,0 +1,30 @@
+# Advanced
+
+In the **Advanced** menu you will find Access Controls, App Manager, Backup, Command, Databases, Default Settings, Domains, Grammer Editor, Group Manager, Menu Manager, Modules, Number Translations, PHP Editor, Provision Editor, Script Editor, Sip Profiles, SQL Query, Transactions, Upgrade, Variables and XML Editor.
+
+```{toctree}
+:maxdepth: 3
+
+advanced/access_controls.md
+#advanced/app_manager.md
+getting_started/backup.md
+advanced/command.md
+advanced/databases.md
+advanced/default_settings.md
+advanced/domains.md
+advanced/grammar_editor.md
+advanced/group_manager.md
+advanced/menu_manager.md
+advanced/modules.md
+advanced/number_translations.md
+advanced/php_editor.md
+advanced/provision_editor.md
+advanced/script_editor.md
+advanced/sip_profiles.md
+advanced/sql_query.md
+advanced/transactions.md
+advanced/upgrade.md
+advanced/variables.md
+advanced/xml_editor.md
+#advanced/version_upgrade.md
+```

source/applications.md

@@ -0,0 +1,36 @@
+# Applications
+
+In the **Applications** menu (Apps) section you will find Bridges, Call Block, Call Broadcast, Call Center, Call Detail Records, Call Flows, Conference Center, Conference Controls, Conference Profiles, Contacts, Fax Server, Follow Me, Grandstream Wave, IVR Menu, Music on Hold, Operator Panel, Phrases, Queues, Recordings, Ring Groups, Streams, Time Conditions and Voicemail.  Other apps can be added also.
+
+```{toctree}
+:maxdepth: 3
+
+applications/bridges.md
+applications/call_block.md
+applications/call_broadcast.md
+applications/call_center.md
+applications/call_detail_record.md
+applications/call_flows.md
+applications/call_recordings.md
+applications/call_routing.md
+applications/conference.md
+applications/conference_center.md
+applications/conference_controls.md
+applications/conference_profiles.md
+applications/contacts.md
+applications/fax_server.md
+applications/follow_me.md
+applications/gs_wave.md
+applications/ivr.md
+applications/messages.md
+applications/operator_panel.md
+applications/phrases.md
+applications/music_on_hold.md
+applications/queues.md
+applications/recordings.md
+applications/ring_group.md
+applications/streams.md
+applications/time_conditions.md
+applications/voicemail.md
+applications/voicemail_transcription.md
+#applications/xmpp.md

source/applications/provision/provision_variables_snom.md

@@ -1,42 +1,22 @@
 # SNOM
 
-Variables used for Provisioning
-\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^\^ Below are a
-list of variables/default settings that can be configured at the system
-level or the domain level to change how phones are provisioned.
+## Variables used for Provisioning
+Below are a list of variables/default settings that can be configured at the system level or the domain level to change how phones are provisioned.
 
-## snom[firmware_url]{#firmware_url}
+### snom_firmware_url
+This is the URL that phones will get their firmware from. This should exclude the model-specific file. To set this to use Snom's servers, use the following value: `https://downloads.snom.com:443/fw/`
 
-This is the URL that phones will get their firmware from. This should
-exclude the model specific file. To set this to use Snom\'s servers, use
-the following value: [https://downloads.snom.com:443/fw/]{.title-ref}
+### snom_firmware_dXXX
+Replace the XXX with the model number of the phone you are using. For example, d785. This is the specific file that will get downloaded for that particular model. This is used in conjunction with the `snom_firmware_url` to download the firmware.
 
-## snom[firmware_dXXX]{#firmware_dxxx}
+### snom_language
+The language the phone will use. This is by default set to "English"; however, more languages are available. Refer to [Snom's Docs](https://service.snom.com/display/wiki/language) to get a listing of languages supported per device.
 
-Replace the XXX with the model number of the phone you are using. For
-example, d785. This is the specific file that will get downloaded for
-that particular model. This is used in conjunction with the
-[snom_firmware_url]{.title-ref} to download the firmware.
+### snom_ntp_server
+The server that Snom will use for its NTP. By default: `0.pool.ntp.org`
 
-## snom[language]{#language}
+### snom_time_zone
+The time zone that the phone will use. This is disabled by default; however, it should be set to avoid the phone asking for a valid timezone on every boot. Valid values can be found on [Snom's webpage](https://service.snom.com/display/wiki/timezone).
 
-The language the phone will use. This is by default set to \"English\"
-however more languages are available. Refer to \[Snom\'s
-Docs\](<https://service.snom.com/display/wiki/language>) to get a
-listing of languages supported per device.
-
-## snom[ntp_server]{#ntp_server}
-
-The server that Snom will use for it\'s NTP. By default: 0.pool.ntp.org
-
-## snom[time_zone]{#time_zone}
-
-The time zone that the phone will use. This is disabled by default
-however should be set to avoid the phone asking for a valid timezone on
-every boot. Valid value can be found on \[Snom\'s
-webpage\](<https://service.snom.com/display/wiki/timezone>).
-
-snom[provision_timer_seconds]{#provision_timer_seconds}
-================== The time in seconds that the phone will wait before
-attempting to provision itself again. This is useful for automatically
-updating the directory when changes are made.
+### snom_provision_timer_seconds
+The time in seconds that the phone will wait before attempting to provision itself again. This is useful for automatically updating the directory when changes are made.

source/dialplans.md

@@ -0,0 +1,15 @@
+# Dialplans
+
+In the **Dialplan** menu you have access to Destinations, Dialplan Manager, Inbound Routes and Outbound Routes.
+
+```{toctree}
+:maxdepth: 2
+  
+dialplan/destinations.md
+dialplan/dialplan_manager.md
+dialplan/dialplan_details.md
+dialplan/dialplan_application.md
+dialplan/inbound_routes.md
+dialplan/outbound_routes.md
+dialplan/advanced_dialplans.md
+```

source/firewall.md

@@ -0,0 +1,20 @@
+# Firewall
+
+**Basic ports used**
+
+- **SIP TCP/UDP**
+  - 5060-5091
+- **RTP UDP**
+  - 16384-32768
+- **SSH**
+  - 22
+- **HTTP**
+  - 80, 443
+
+```{toctree}
+:maxdepth: 3
+
+firewall/iptables.md
+firewall/fail2ban.md
+firewall/pf.md
+```

source/getting_started.md

@@ -0,0 +1,25 @@
+# Getting Started
+
+Welcome! 
+Let's install FusionPBX.
+Follow the menu to the left and you will have a working PBX in no time. For PDF and Epub formats of this documentation click the bottom left on **v:latest** and a menu will pop-up to choose from.  
+
+:::: note
+<p class="admonition-title">Note</p>
+
+There are many ways to install FusionPBX depending on how you want to build your solution.  
+What is presented here represents the quickest, easiest, best supported way to a FusionPBX system.  
+For advanced topics like Bi Directional Replication or High Availability, consider attending the in person or online training at [https://www.fusionpbx.com/training.php](https://www.fusionpbx.com/training.php). Additional FusionPBX training is available via Continuing Education. This is a monthly affordable option to keep you current and ahead of the competition!
+::::
+
+```{toctree}
+getting_started/training.md
+getting_started/quick_install.md
+getting_started/lets_encrypt.md
+applications/provision.md
+getting_started/security.md
+getting_started/backup.md
+getting_started/restore.md
+firewall.md
+getting_started/languages.md
+```

source/hardware.md

@@ -0,0 +1,67 @@
+# Hardware
+
+## Auto Provision Phones
+
+Auto provisioning is disabled by default. This is to give a chance to secure provisioning server with HTTP Authentication or CIDR. HTTP Authentication requires the phone to send hash of the combined username and password in order to get configuration. CIDR is an IP address restriction that can be used to restrict which IP addresses are allowed to get the device configuration. An example of CIDR is xxx.xxx.xxx.xxx/32 the /32 represents a single IP address. To set one of these values go to Advanced > Default Settings and find the Provision category from there used the edit button to set a value. After this is done it is safe to set enabled equal to true.
+
+```{toctree}
+:maxdepth: 4
+  
+applications/provision/provision_auto_yealink.md
+applications/provision/provision_auto_polycom.md
+applications/provision/provision_auto_cisco.md
+applications/provision/provision_auto_fanvil.md
+applications/provision/provision_auto_flyingvoice.md
+applications/provision/provision_auto_grandstream.md
+applications/provision/provision_auto_htek.md
+applications/provision/provision_auto_zoiper.md
+applications/provision/provision_auto_snom.md
+applications/provision/provision_auto_avaya.md
+```
+
+## Manually Provision Phones
+
+How to setup the device using the phone’s web interface.
+
+```{toctree}
+:maxdepth: 4
+  
+applications/provision/provision_manual_yealink.md
+applications/provision/provision_manual_polycom.md
+applications/provision/provision_manual_cisco.md
+applications/provision/provision_manual_fanvil.md
+applications/provision/provision_manual_flyingvoice.md
+applications/provision/provision_manual_grandstream.md
+applications/provision/provision_manual_htek.md
+applications/provision/provision_manual_zoiper.md
+applications/provision/phone_screen_capture.md
+```
+
+## Provisioning Variables/Settings
+
+Each phone has different Fusion Settings that can be applied to configure the phones to the requirements.
+
+```{toctree}
+:maxdepth: 4
+  
+applications/provision/provision_variables_snom.md
+```
+
+## Firewall Devices
+
+Firewall device settings that help with SIP connections.
+
+```{toctree}
+:maxdepth: 4
+   
+hardware/firewall_devices/asus_rt_ac66u.md
+#firewall/firewall_devices/asus_rt_ac66u_sip_alg.md
+firewall/firewall_devices/edgerouterx.md
+#firewall/firewall_devices/edgerouterx_alg.md
+firewall/firewall_devices/pfsense.md
+firewall/firewall_devices/sonicwall_tz_soho.md
+#firewall/firewall_devices/sonicwall_tz_soho_sip_alg.md
+firewall/firewall_devices/zyxel.md
+#firewall/firewall_devices/zyxel_sip_alg.md
+firewall/firewall_devices/cisco_ea6500.md
+```

source/home.md

@@ -0,0 +1,11 @@
+# Home
+
+The **Home** menu gives access to Account Settings, Dashboard, and the option to Logout.
+
+```{toctree}
+:maxdepth: 3
+
+home/account_settings.md
+home/dashboard.md
+home/logout.md
+```

source/index.md

@@ -0,0 +1,53 @@
+<div style="text-align: center;">
+  <img src="_static/images/logo.png" alt="Logo" width="130" height="76.5">
+</div>
+
+<br><br>
+# 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](https://www.freeswitch.org).
+
+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 businesses need and delivers corporate-level phone system features to small, medium, and large businesses. [Click here for the FusionPBX YouTube channel](https://www.youtube.com/playlist?list=PLrhVQpI_CtOwQNB_lsNIxrl9SOAuo9ZSF).
+
+<div style="text-align: center; margin-bottom: 2em;">
+<iframe width="100%" height="350" src="https://www.youtube.com/embed/XpiVyHqLaus?rel=0" frameborder="0" 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 the IRC network **irc.libera.chat** in the **#fusionpbx** channel. Come join us and meet the team!
+
+```{toctree}
+getting_started.md
+home.md
+accounts.md
+dialplans.md
+applications.md
+status.md
+advanced.md
+hardware.md
+software.md
+additional_information.md
+contributing.md
+doc_guide.md
+other.md
+```

source/other.md

@@ -0,0 +1,37 @@
+# Other
+
+Other section is bits of info that needs indexed for the PDF to populate all sections depending how sections are formatted.
+
+```{toctree}
+:maxdepth: 3
+
+#firewall/firewall_devices/asus_rt_ac66u.md
+#firewall/firewall_devices/asus_rt_ac66u_sip_alg.md
+#firewall/firewall_devices/cisco_ea6500.md
+#firewall/firewall_devices/edgerouterx.md
+#firewall/firewall_devices/pfsense.md
+#firewall/firewall_devices/sonicwall_tz_soho.md
+#firewall/firewall_devices/sonicwall_tz_soho_sip_alg.md
+#firewall/firewall_devices/zyxel.md
+#firewall/firewall_devices/zyxel_sip_alg.md
+#applications/provision/provision_auto_yealink.md
+#applications/provision/provision_auto_polycom.md
+#applications/provision/provision_auto_cisco.md
+#applications/provision/provision_auto_fanvil.md
+#applications/provision/provision_auto_grandstream.md
+#applications/provision/provision_auto_htek.md
+#applications/provision/provision_auto_zoiper.md
+#applications/provision/provision_manual_yealink.md
+#applications/provision/provision_manual_polycom.md
+#applications/provision/provision_manual_cisco.md
+#applications/provision/provision_manual_fanvil.md
+#applications/provision/provision_manual_grandstream.md
+#applications/provision/provision_manual_htek.md
+#applications/provision/provision_manual_zoiper.md
+#applications/provision/provision_manual_snom.md
+#applications/provision/phone_screen_capture.md
+applications/xmpp.md
+applications_optional/webrtc.md
+#additional_information/sngrep.md
+features/parking.md
+```

source/software.md

@@ -0,0 +1,12 @@
+# Software
+
+***
+
+```{toctree}
+:maxdepth: 4
+
+getting_started/software_utilities.md
+additional_information/sngrep.md
+additional_information/tftp.md
+firewall.md
+```

source/status.md

@@ -0,0 +1,26 @@
+# Status
+
+In the **Status** menu you have the options for Active Call Center, Active Calls, Active Conferences, Active Queues, Agent Status, CDR Statistics, Emails, Extension Summary, Log Viewer, Registrations, Services, SIP Status, System Status and Traffic Graph.
+
+```{toctree}
+:maxdepth: 3
+
+manual/status.md
+status/active_call_center.md
+status/active_calls.md
+status/active_conferences.md
+status/active_queues.md
+status/agent_status.md
+status/cdr_statistics.md
+status/emails.md
+status/email_queue.md
+status/event_guard.md
+status/extension_summary.md
+status/fax_queue.md
+status/log_viewer.md
+status/registrations.md
+status/services.md
+status/sip_status.md
+status/system_status.md
+status/traffic_graph.md
+```