Difference between revisions of "FreePBX"

From Help
Jump to: navigation, search
Line 22: Line 22:
 
==After install updates==
 
==After install updates==
 
===Update your PBX===
 
===Update your PBX===
Admin > Modual Admin in dropdown(PIC 5)
+
*Admin > Modual Admin in dropdown(PIC 5)
Click Check Online (PIC 6)
+
**Click Check Online (PIC 6)
You will now see a few lines that will say "Online upgrade avalible" (PIC 7)
+
**You will now see a few lines that will say "Online upgrade avalible" (PIC 7)
Clicking the arrow next to them, it will dropdown, click the "Download and Upgrade to" next to Action. (Pic 8)
+
**Clicking the arrow next to them, it will dropdown, click the "Download and Upgrade to" next to Action. (Pic 8)
That button will change color to a dark blue (PIC 9)
+
**That button will change color to a dark blue (PIC 9)
Scroll down to each Module that is in red and has an update and repeat. Evin if your not using the module, patch them anyway as they can be tied into the system and used as an exploit
+
***Scroll down to each Module that is in red and has an update and repeat. Evin if your not using the module, patch them anyway as they can be tied into the system and used as an exploit
Once you've done all avalible, click Process (PIC 10)
+
***Once you've done all available, click Process (PIC 10)
You will get a confirmation page, click confirm (PIC 11)
+
**You will get a confirmation page, click confirm (PIC 11)
A Status popup will run (PIC 12)
+
***A Status popup will run (PIC 12)
When it's finished, click Return on that popup
+
***When it's finished, click Return on that popup
Click Apply Config again (PIC 13)
+
***Click Apply Config again (PIC 13)
Next, go to System Updates and click Check Online (PIC 14)
+
**Next, go to System Updates and click Check Online (PIC 14)
The "Current System Update Status" will say "Working", and the "Refresh Page" will flash a few times, wait until you get a list below. Look for the lines in light red, and click Update System (PIC 15)
+
***The "Current System Update Status" will say "Working", and the "Refresh Page" will flash a few times, wait until you get a list below. Look for the lines in light red, and click Update System (PIC 15)
You will get an updating popup (PIC 16). Let this run, it might take quite awhile! It is updating the entire operating system. Eventually it will say Complete, click OK (PIC 17)
+
***You will get an updating popup (PIC 16). Let this run, it might take quite awhile! It is updating the entire operating system. Eventually it will say Complete, click OK (PIC 17)
It should now say Updates Available: No updates currently required! (PIC 18)
+
*It should now say Updates Available: No updates currently required! (PIC 18)
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
  
 
===Automatic Updates===
 
===Automatic Updates===
 
Depending on your IT support situation, you may want to change the Automatic Updates on your PBX. (PIC 19)
 
Depending on your IT support situation, you may want to change the Automatic Updates on your PBX. (PIC 19)
Make sure the email address is one that is checked.  
+
*Make sure the email address is one that is checked.  
The red arrows are areas you may want to change, ask your IT administrator or service providor for advise.
+
*The red arrows are areas you may want to change, ask your IT administrator or service provider for advise.
Click Save to save any changes.
+
*Click Save to save any changes.
  
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
  
 
===Setting the System Name:===
 
===Setting the System Name:===
Click Settings > Advanced Settings (PIC 20)
+
*Click Settings > Advanced Settings (PIC 20)
Scroll down about 70% through and find the System Identity line and change it, then click Submit. (PIC 22)
+
**Scroll down about 70% through and find the System Identity line and change it, then click Submit. (PIC 22)
Click Apply Config up in the upper right corner to apply.
+
**Click Apply Config up in the upper right corner to apply.
After Reload, click on Dashboard on top (PIC 23)
+
**After Reload, click on Dashboard on top (PIC 23)
You should see the name change in the System Overview: (PIC 24)
+
*You should see the name change in the System Overview: (PIC 24)
  
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
Line 58: Line 58:
 
===Change IP Address===
 
===Change IP Address===
 
The initial setup will usually use a DHCP address.  You need to change this to a static IP.  The actual address is depending on the local IP schema.  
 
The initial setup will usually use a DHCP address.  You need to change this to a static IP.  The actual address is depending on the local IP schema.  
Admin > System Admin (PIC 25)
+
*Admin > System Admin (PIC 25)
Click Network Settings
+
**Click Network Settings
Click Static
+
**Click Static
Change the "Static IP" to the right IP
+
**Change the "Static IP" to the right IP
If it's in the same subnet, the Netmask and Gateway will probably stay the same (PIC 26)
+
**If it's in the same subnet, the Netmask and Gateway will probably stay the same (PIC 26)
Down at the bottom, click "Save Interface" (PIC 27)
+
**Down at the bottom, click "Save Interface" (PIC 27)
You will get a "warning popuop", click "Save and Apply" (pic 28)
+
**You will get a "warning popuop", click "Save and Apply" (pic 28)
It will say "Saving changes to eth0..."
+
**It will say "Saving changes to eth0..."
A banner will come down from the top and say "undefined". At this point, you should open up a new window and use the new IP address. You will need to log back in. If this doesn't work, go ahead and just reboot this server.
+
*A banner will come down from the top and say "undefined". At this point, you should open up a new window and use the new IP address. You will need to log back in. If this doesn't work, go ahead and just reboot this server.
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
  
 
===Updating Hostname===
 
===Updating Hostname===
In the drop-down Click System Admin (PIC 25)
+
*In the drop-down Click System Admin (PIC 25)
Click Hostname (PIC 29)
+
*Click Hostname (PIC 29)
 
 
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
  
 
==Setting up extensions==
 
==Setting up extensions==
==CHAN_PJSIP===
+
===CHAN_PJSIP===
From the drop-down, choose Applications > Extensions (PIC 30)
+
*From the drop-down, choose Applications > Extensions (PIC 30)
For a newer SIP phone, click +Add Extension and +Add New PJSIP Extension (PIC 31)
+
**For a newer SIP phone, click +Add Extension and +Add New PJSIP Extension (PIC 31)
Update: (PIC 32)
+
***Update: (PIC 32)
User Extension: The extension you will use
+
***User Extension: The extension you will use
Display Name: This is the name that will show when calling out
+
***Display Name: This is the name that will show when calling out
Outbound CID: Only if you want it to be different than the default
+
***Outbound CID: Only if you want it to be different than the default
Secret: You either need to copy this into the phone itself, the phones config file, or change this to whatever the phone currently has.
+
**Secret: You either need to copy this into the phone itself, the phones config file, or change this to whatever the phone currently has.
Everything else can be left alone. Click Submit to save it. Then click "Apply Config" at the top to actually save this. (PIC 13)
+
**Everything else can be left alone. Click Submit to save it. Then click "Apply Config" at the top to actually save this. (PIC 13)
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
  
 
===CHAN_SIP===
 
===CHAN_SIP===
From the drop-down, choose Applications > Extensions (PIC 30)
+
*From the drop-down, choose Applications > Extensions (PIC 30)
For an older SIP phone, click +Add Extension and +Add New CHAN_SIP Extension
+
**For an older SIP phone, click +Add Extension and +Add New CHAN_SIP Extension
User Extension: The extension you will use
+
***User Extension: The extension you will use
Display Name: This is the name that will show when calling out
+
***Display Name: This is the name that will show when calling out
Outbound CID: Only if you want it to be different than the default
+
**Outbound CID: Only if you want it to be different than the default
Secret: You either need to copy this into the phone itself, the phones config file, or change this to whatever the phone currently has.
+
**Secret: You either need to copy this into the phone itself, the phones config file, or change this to whatever the phone currently has.
Everything else can be left alone. Click Submit to save it. Then click "Apply Config" at the top to actually save this. (PIC 13)
+
*Everything else can be left alone. Click Submit to save it. Then click "Apply Config" at the top to actually save this. (PIC 13)
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
  
 
==Trunks and routes==
 
==Trunks and routes==
 
===Adding in your SIP Trunk.===
 
===Adding in your SIP Trunk.===
Connectivity > Trunks (PIC 36)
+
*Connectivity > Trunks (PIC 36)
+Add Trunk, +Add SIP (chan_sip) Trunk (PIC 37)
+
**+Add Trunk, +Add SIP (chan_sip) Trunk (PIC 37)
On the General Tab:
+
***On the General Tab:
Trunk Name
+
****Trunk Name
Outbound Caller ID: The DID from your provider
+
****Outbound Caller ID: The DID from your provider
Continue if Busy: Click yes.
+
****Continue if Busy: Click yes.
Next, Click the sip Settings tab, Outgoing (PIC 38)
+
***Next, Click the sip Settings tab, Outgoing (PIC 38)
Give this a friendlily Trunk Name
+
****Give this a friendly Trunk Name
Enter the rest from what your provider gave you. You may need to change the Context to "from-trunk"
+
****Enter the rest from what your provider gave you. You may need to change the Context to "from-trunk"
Now click Incoming (PIC 38B)
+
***Now click Incoming (PIC 38B)
Give a friendly USER context, put in the user details from your provider, and the Registration String from your provider
+
****Give a friendly USER context, put in the user details from your provider, and the Registration String from your provider
Click Submit at the bottom right and Apply Config at the top.
+
*Click Submit at the bottom right and Apply Config at the top.
 
 
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
  
 
===Outbound Trunk===
 
===Outbound Trunk===
Connectivity > Outbound Routes (PIC 39)
+
*Connectivity > Outbound Routes (PIC 39)
Click "+ Add Outbound Route" (PIC 40)
+
**Click "+ Add Outbound Route" (PIC 40)
Route Settings: (PIC 41)
+
***Route Settings: (PIC 41)
Route Name: a friendly name
+
***Route Name: a friendly name
Trunk Sequence for Matched Routes: choose your SIP trunk you set up before.
+
***Trunk Sequence for Matched Routes: choose your SIP trunk you set up before.
Dial Patterns tab: (PIC 42)
+
***Dial Patterns tab: (PIC 42)
Add two patterns: 1NXXNXXXXXX and 9 (prefix) 1NXXNXXXXXX
+
****Add two patterns: 1NXXNXXXXXX and 9 (prefix) 1NXXNXXXXXX
Click Submit at the bottom right and Apply Config at the top.
+
*Click Submit at the bottom right and Apply Config at the top.
 
 
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
  
 
===Inbound Route===
 
===Inbound Route===
From the top menu, click Connectivity then Inbound Routes (PIC 33)
+
*From the top menu, click Connectivity then Inbound Routes (PIC 33)
Click +Add Inbound Route (PIC 34)
+
**Click +Add Inbound Route (PIC 34)
On the next screen, edit: (PIC 35)
+
**On the next screen, edit: (PIC 35)
Description: A friendly description
+
***Description: A friendly description
DID Number: The assigned DID
+
***DID Number: The assigned DID
Set Destination: Where the calls on this need to go.
+
***Set Destination: Where the calls on this need to go.
Click Submit, and Apply Config at top.
+
*Click Submit, and Apply Config at top.
  
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
Line 140: Line 137:
 
Some phones do not play well with the newer PJSIP protocal. For these, you will need to disable the PJSIP and just use CHAN_SIP. You will get a popup about needing to restart Asterisk, we will do that after all of this.
 
Some phones do not play well with the newer PJSIP protocal. For these, you will need to disable the PJSIP and just use CHAN_SIP. You will get a popup about needing to restart Asterisk, we will do that after all of this.
 
===PJSAN to CHAN_SIP===
 
===PJSAN to CHAN_SIP===
Settings > Advanced Settings
+
*Settings > Advanced Settings
Scroll down to "Dialplan and Operational"
+
**Scroll down to "Dialplan and Operational"
Line "SIP Channel Driver", change in dropdown to "chan_sip"
+
**Line "SIP Channel Driver", change in dropdown to "chan_sip"
Click Submit at the bottom right and Apply Config at the top.
+
**Click Submit at the bottom right and Apply Config at the top.
Settings > Asterisk SIP Settings
+
*Settings > Asterisk SIP Settings
Click the Chan SIP Settings tab
+
**Click the Chan SIP Settings tab
Scroll down to "Advanced General Settings"
+
**Scroll down to "Advanced General Settings"
Change Bind Port to 5060
+
**Change Bind Port to 5060
Change TLS Bind Port to 5061
+
**Change TLS Bind Port to 5061
Click the Yes on "Enable TCP" button
+
**Click the Yes on "Enable TCP" button
In the "Other SIP Settings", add in: tcpenable=yes, tlsenable=yes, tcpbindaddr=0.0.0.0, and transport=tcp,udp,tls. You will need to click "Add field" to get the additional lines.
+
**In the "Other SIP Settings", add in: tcpenable=yes, tlsenable=yes, tcpbindaddr=0.0.0.0, and transport=tcp,udp,tls. You will need to click "Add field" to get the additional lines.
Click Submit at the bottom right and Apply Config at the top.
+
*Click Submit at the bottom right and Apply Config at the top.
Now, you need to restart the server itself.  
+
*Now, you need to restart the server itself.  
SSH into the machine as root
+
**SSH into the machine as root
Give the "shutdown -r now" command; the machine will reboot.
+
**Give the "shutdown -r now" command; the machine will reboot.
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
  
 
===Extension updates===
 
===Extension updates===
 
If you have set any extensions to use CHAN_PJSIP, you will need to convert them:
 
If you have set any extensions to use CHAN_PJSIP, you will need to convert them:
Applications > Extensions
+
*Applications > Extensions
Click the Edit icon for the PJSIP extension.
+
**Click the Edit icon for the PJSIP extension.
Click the "Advanced" tab
+
***Click the "Advanced" tab
Under "-Edit Extension" click "Change to CHAN_SIP Driver"
+
***Under "-Edit Extension" click "Change to CHAN_SIP Driver"
Click "Yes" on the "Can Reinvite" button.
+
****Click "Yes" on the "Can Reinvite" button.
Click Submit at the bottom right and Apply Config at the top.
+
*Click Submit at the bottom right and Apply Config at the top.
You may also need to restart the phone itself
+
*You may also need to restart the phone itself
 
[[#top|Return to Top]]
 
[[#top|Return to Top]]
  

Revision as of 02:51, 4 August 2017

Return to Main Page

Initial Install

This is assuming you have a properly prepped VM, physical machine, etc and have already installed the ISO.

  • Enter info (PIC 1)
    • Skip or do activation, depending if you want to register this instance
    • skip/close any advert popups
  • Enter the location of PBX (PIC 2)
    • Pacific (PST) (UTC-8): America/Los_Angeles
    • Mountain (MST) (UTC-7): America/Denver
    • Central(CST) (UTC-6): America/Chicago
    • Eastern(EST) (UTC-5): America/Kentucky/Louisville
  • Next you will get the "FIREWALL Enabled" screen, will come back to this later. (PIC 3) click "ABORT" since our system is already behind a firewall.
  • Continue if you get an RMS add
  • "Not now" on SIPStation free trial
  • You should now see the main Admin screen, the initial setup is finished. To apply the above settings, click the red Apply Config button at the top right. (PIC 4)

Return to Top

After install updates

Update your PBX

  • Admin > Modual Admin in dropdown(PIC 5)
    • Click Check Online (PIC 6)
    • You will now see a few lines that will say "Online upgrade avalible" (PIC 7)
    • Clicking the arrow next to them, it will dropdown, click the "Download and Upgrade to" next to Action. (Pic 8)
    • That button will change color to a dark blue (PIC 9)
      • Scroll down to each Module that is in red and has an update and repeat. Evin if your not using the module, patch them anyway as they can be tied into the system and used as an exploit
      • Once you've done all available, click Process (PIC 10)
    • You will get a confirmation page, click confirm (PIC 11)
      • A Status popup will run (PIC 12)
      • When it's finished, click Return on that popup
      • Click Apply Config again (PIC 13)
    • Next, go to System Updates and click Check Online (PIC 14)
      • The "Current System Update Status" will say "Working", and the "Refresh Page" will flash a few times, wait until you get a list below. Look for the lines in light red, and click Update System (PIC 15)
      • You will get an updating popup (PIC 16). Let this run, it might take quite awhile! It is updating the entire operating system. Eventually it will say Complete, click OK (PIC 17)
  • It should now say Updates Available: No updates currently required! (PIC 18)

Return to Top

Automatic Updates

Depending on your IT support situation, you may want to change the Automatic Updates on your PBX. (PIC 19)

  • Make sure the email address is one that is checked.
  • The red arrows are areas you may want to change, ask your IT administrator or service provider for advise.
  • Click Save to save any changes.

Return to Top

Setting the System Name:

  • Click Settings > Advanced Settings (PIC 20)
    • Scroll down about 70% through and find the System Identity line and change it, then click Submit. (PIC 22)
    • Click Apply Config up in the upper right corner to apply.
    • After Reload, click on Dashboard on top (PIC 23)
  • You should see the name change in the System Overview: (PIC 24)

Return to Top

Change IP Address

The initial setup will usually use a DHCP address. You need to change this to a static IP. The actual address is depending on the local IP schema.

  • Admin > System Admin (PIC 25)
    • Click Network Settings
    • Click Static
    • Change the "Static IP" to the right IP
    • If it's in the same subnet, the Netmask and Gateway will probably stay the same (PIC 26)
    • Down at the bottom, click "Save Interface" (PIC 27)
    • You will get a "warning popuop", click "Save and Apply" (pic 28)
    • It will say "Saving changes to eth0..."
  • A banner will come down from the top and say "undefined". At this point, you should open up a new window and use the new IP address. You will need to log back in. If this doesn't work, go ahead and just reboot this server.

Return to Top

Updating Hostname

  • In the drop-down Click System Admin (PIC 25)
  • Click Hostname (PIC 29)

Return to Top

Setting up extensions

CHAN_PJSIP

  • From the drop-down, choose Applications > Extensions (PIC 30)
    • For a newer SIP phone, click +Add Extension and +Add New PJSIP Extension (PIC 31)
      • Update: (PIC 32)
      • User Extension: The extension you will use
      • Display Name: This is the name that will show when calling out
      • Outbound CID: Only if you want it to be different than the default
    • Secret: You either need to copy this into the phone itself, the phones config file, or change this to whatever the phone currently has.
    • Everything else can be left alone. Click Submit to save it. Then click "Apply Config" at the top to actually save this. (PIC 13)

Return to Top

CHAN_SIP

  • From the drop-down, choose Applications > Extensions (PIC 30)
    • For an older SIP phone, click +Add Extension and +Add New CHAN_SIP Extension
      • User Extension: The extension you will use
      • Display Name: This is the name that will show when calling out
    • Outbound CID: Only if you want it to be different than the default
    • Secret: You either need to copy this into the phone itself, the phones config file, or change this to whatever the phone currently has.
  • Everything else can be left alone. Click Submit to save it. Then click "Apply Config" at the top to actually save this. (PIC 13)

Return to Top

Trunks and routes

Adding in your SIP Trunk.

  • Connectivity > Trunks (PIC 36)
    • +Add Trunk, +Add SIP (chan_sip) Trunk (PIC 37)
      • On the General Tab:
        • Trunk Name
        • Outbound Caller ID: The DID from your provider
        • Continue if Busy: Click yes.
      • Next, Click the sip Settings tab, Outgoing (PIC 38)
        • Give this a friendly Trunk Name
        • Enter the rest from what your provider gave you. You may need to change the Context to "from-trunk"
      • Now click Incoming (PIC 38B)
        • Give a friendly USER context, put in the user details from your provider, and the Registration String from your provider
  • Click Submit at the bottom right and Apply Config at the top.

Return to Top

Outbound Trunk

  • Connectivity > Outbound Routes (PIC 39)
    • Click "+ Add Outbound Route" (PIC 40)
      • Route Settings: (PIC 41)
      • Route Name: a friendly name
      • Trunk Sequence for Matched Routes: choose your SIP trunk you set up before.
      • Dial Patterns tab: (PIC 42)
        • Add two patterns: 1NXXNXXXXXX and 9 (prefix) 1NXXNXXXXXX
  • Click Submit at the bottom right and Apply Config at the top.

Return to Top

Inbound Route

  • From the top menu, click Connectivity then Inbound Routes (PIC 33)
    • Click +Add Inbound Route (PIC 34)
    • On the next screen, edit: (PIC 35)
      • Description: A friendly description
      • DID Number: The assigned DID
      • Set Destination: Where the calls on this need to go.
  • Click Submit, and Apply Config at top.

Return to Top

Alternate CHAN_SIP only

Some phones do not play well with the newer PJSIP protocal. For these, you will need to disable the PJSIP and just use CHAN_SIP. You will get a popup about needing to restart Asterisk, we will do that after all of this.

PJSAN to CHAN_SIP

  • Settings > Advanced Settings
    • Scroll down to "Dialplan and Operational"
    • Line "SIP Channel Driver", change in dropdown to "chan_sip"
    • Click Submit at the bottom right and Apply Config at the top.
  • Settings > Asterisk SIP Settings
    • Click the Chan SIP Settings tab
    • Scroll down to "Advanced General Settings"
    • Change Bind Port to 5060
    • Change TLS Bind Port to 5061
    • Click the Yes on "Enable TCP" button
    • In the "Other SIP Settings", add in: tcpenable=yes, tlsenable=yes, tcpbindaddr=0.0.0.0, and transport=tcp,udp,tls. You will need to click "Add field" to get the additional lines.
  • Click Submit at the bottom right and Apply Config at the top.
  • Now, you need to restart the server itself.
    • SSH into the machine as root
    • Give the "shutdown -r now" command; the machine will reboot.

Return to Top

Extension updates

If you have set any extensions to use CHAN_PJSIP, you will need to convert them:

  • Applications > Extensions
    • Click the Edit icon for the PJSIP extension.
      • Click the "Advanced" tab
      • Under "-Edit Extension" click "Change to CHAN_SIP Driver"
        • Click "Yes" on the "Can Reinvite" button.
  • Click Submit at the bottom right and Apply Config at the top.
  • You may also need to restart the phone itself

Return to Top

Notes for SonicWall:

You may need to go uncheck the "Enforce Host Tag search for CFS" in the diag.html section and hit Accept. See https://wiki.freepbx.org/display/PPS/SonicWall+Basic+Troubleshooting for details. Return to Top