Browse Source

Add Fax/Email Queue Install Instructions (#219)

* Add Fax/Email Queue Install Instructions

* Update status.rst

* Create email_queue.rst

* Create fax_queue.rst
AlexC 3 years ago
parent
commit
1f4b6861d5
4 changed files with 121 additions and 1 deletions
  1. 41 1
      source/advanced/version_upgrade.rst
  2. 2 0
      source/status.rst
  3. 39 0
      source/status/email_queue.rst
  4. 39 0
      source/status/fax_queue.rst

+ 41 - 1
source/advanced/version_upgrade.rst

@@ -4,7 +4,7 @@ Version Upgrade
 
 Version Upgrade can take several steps to perform. Below will show how to upgrade from specific versions.
 
-4.4 to Master (what will become 4.6)
+4.4 to 5.0
 ^^^^^^^^^^^^^^^^^^
 
 1. Switch branches
@@ -51,6 +51,46 @@ If you have made any changes to these make notes on the changes before you delet
 
 5. If you have customized any provisioning templates makes sure to copy them from /var/www/fusionpbx-4.4/resources/templates/provision and copy them into the right vendor directory in /var/www/fusionpbx/resources/templates/provision. I you haven't customized the provisioning templates you can skip this step.
 
+6. FAX Queue install
+
+* https://docs.fusionpbx.com/en/latest/status/fax_queue.html
+
+- Install as a service
+
+::
+
+ cp /var/www/fusionpbx/app/fax_queue/resources/service/debian.service /etc/systemd/system/fax_queue.service
+ systemctl enable fax_queue
+ systemctl start fax_queue
+ systemctl daemon-reload
+
+- or run as a cron job
+
+::
+
+ crontab -e
+ * * * * * cd /var/www/fusionpbx && php /var/www/fusionpbx/app/fax_queue/resources/job/fax_queue.php
+
+
+7. Email Queue install
+
+* https://docs.fusionpbx.com/en/latest/status/email_queue.html
+
+- Install as a service
+
+::
+
+ cp /var/www/fusionpbx/app/email_queue/resources/service/debian.service /etc/systemd/system/email_queue.service
+ systemctl enable email_queue
+ systemctl start email_queue
+ systemctl daemon-reload
+
+- or run as a cron job
+
+::
+
+ crontab -e
+ * * * * * cd /var/www/fusionpbx && /usr/bin/php /var/www/fusionpbx/app/email_queue/resources/service/email_queue.php
 
 Version 4.2 to 4.4
 ^^^^^^^^^^^^^^^^^^

+ 2 - 0
source/status.rst

@@ -22,7 +22,9 @@ In the **Status** menu you have the options for Active Call Center, Active Calls
   status/agent_status.rst
   status/cdr_statistics.rst
   status/emails.rst
+  status/email_queue.rst
   status/extension_summary.rst
+  status/fax_queue.rst
   status/log_viewer.rst
   status/registrations.rst
   status/services.rst

+ 39 - 0
source/status/email_queue.rst

@@ -0,0 +1,39 @@
+########
+Email Queue
+########
+
+Manage sending emails in a queue. Also works with the transcription of audio files with IBM Watson, Azure, or Google.
+
+Install Instructions
+^^^^^^^^^^^^^^^^^^^^
+
+- Make sure to upgrade to the latest FusionPBX version
+- Update the database structure
+
+  - Advanced -> Upgrade -> Schema
+  
+- Update App Defaults
+
+  - Advanced -> Upgrade -> App Defaults
+  
+* Run the following commands to install as a service
+
+::
+
+ cp /var/www/fusionpbx/app/email_queue/resources/service/debian.service /etc/systemd/system/email_queue.service
+ systemctl enable email_queue
+ systemctl start email_queue
+ systemctl daemon-reload
+
+- or as a cron job
+
+::
+
+ crontab -e
+ * * * * * cd /var/www/fusionpbx && /usr/bin/php /var/www/fusionpbx/app/email_queue/resources/service/email_queue.php
+
+
+Default Settings
+^^^^^^^^^^^^^^^^
+
+Be sure all **Email** category settings are configured properly within Default Settings, or emails will fail to send properly.  

+ 39 - 0
source/status/fax_queue.rst

@@ -0,0 +1,39 @@
+########
+Fax Queue
+########
+
+Manage sending FAX in a queue. Sending a new FAX will go into the queue as waiting. Status updated to sent once they have succeeded or failed after multiple attempts.
+
+Install Instructions
+^^^^^^^^^^^^^^^^^^^^
+
+- Make sure to upgrade to the latest FusionPBX version
+- Update the database structure
+
+  - Advanced -> Upgrade -> Schema
+  
+- Update App Defaults
+
+  - Advanced -> Upgrade -> App Defaults
+  
+* Run the following commands to install as a service
+
+::
+
+ cp /var/www/fusionpbx/app/fax_queue/resources/service/debian.service /etc/systemd/system/fax_queue.service
+ systemctl enable fax_queue
+ systemctl start fax_queue
+ systemctl daemon-reload
+
+- or as a cron job
+
+::
+
+ crontab -e
+ * * * * * cd /var/www/fusionpbx && php /var/www/fusionpbx/app/fax_queue/resources/job/fax_queue.php
+
+
+Default Settings
+^^^^^^^^^^^^^^^^
+
+Be sure all **FAX Queue** category settings are configured properly within Default Settings, or emails will fail to send properly.