diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..705b0e58 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +venv + +site/ diff --git a/docs/General/user_guides/faq.md b/docs/General/user_guides/faq.md index 520eadcd..0c589768 100644 --- a/docs/General/user_guides/faq.md +++ b/docs/General/user_guides/faq.md @@ -1,12 +1,10 @@ # Frequently Asked Questions -Last Updated: 08/16/2022 - This document is a place to put some of the more Frequently Asked Questions of the service that are quick, short answers. If an answer requires more indepth steps, a guide will be created and linked to from this document. -This is a long document, so to the right side of this page is a Table of Contents that will link you to the sections and within each section is a smaller Table of Contents that will link you to the question you have and the answer. You can also do a search by doing ```Ctrl``` + ```F``` on Windows and Linux or ```Cmd``` + ```F``` on Mac. +This is a long document, so to the right side of this page is a Table of Contents that will link you to the sections and within each section is a smaller Table of Contents that will link you to the question you have and the answer. You can also do a search by doing `Ctrl` + `F` on Windows and Linux or `Cmd` + `F` on Mac. -
+---- ## General @@ -15,7 +13,7 @@ This is a long document, so to the right side of this page is a Table of Content !!! note "" First you will need to get a phone. As long as your phone will allow or handle SIP, you are good to go. - Then check out our [Getting Started Guide](https://hamsoverip.github.io/wiki/General/user_guides/getting-started/) to start the process. + Then check out our [Getting Started Guide](./getting-started.md) to start the process. You can also look through the rest of the Wiki to get an idea on how to get started. @@ -24,26 +22,26 @@ This is a long document, so to the right side of this page is a Table of Content !!! note "" You are already in the best place for getting more help! This Wiki. This is where alot of guides and information can be found about the service and things are added all the time. - Next place you can go is one of our [Chat Services](https://hamsoverip.github.io/wiki/General/user_guides/chat-services/). Our main form of communication is Discord, but some other chat services are bridged into it. + Next place you can go is one of our [Chat Services](./chat-services.md). Our main form of communication is Discord, but some other chat services are bridged into it. ### Can I contribute to the Wiki? !!! note "" - Absolutely! We encourage our user community to contribute to the Wiki to help expand the knowledge here. To see how, check out our [Getting Started Guide](https://hamsoverip.github.io/wiki/General/user_guides/getting-started/) + Absolutely! We encourage our user community to contribute to the Wiki to help expand the knowledge here. To see how, check out our [Getting Started Guide](./getting-started.md) ### What Feature Codes can I use on the system? !!! note "" - All Feature Codes can be found in the [Feature Codes Guide](https://hamsoverip.github.io/wiki/endpoints/pbx/freepbx/feature-codes/) + All Feature Codes can be found in the [Feature Codes Guide](../../endpoints/pbx/freepbx/feature-codes.md) -
+---- ## Troubleshooting ### The light for my HOIP extension is not green (its orange, amber, yellow) and I have not changed anything on my end. What has happened or what do I do? !!! note "" - This is becoming a common issue on the service we are finding. This could be a Carrier Grade NAT situation. We might have to make some adjustments on the peer for your extension. + This is becoming a common issue on the service we are finding. This could be a Carrier Grade NAT situation. We might have to make some adjustments on the peer for your extension. Some steps to take first (in order): @@ -51,7 +49,7 @@ This is a long document, so to the right side of this page is a Table of Content * Reboot your router * Reboot your phone * Double check to make sure none of your configuration has changed (password, domain, etc.) - * If you are using Hamshack Hotline, [please check here](https://hamsoverip.github.io/wiki/General/user_guides/faq/#i-had-to-reprovision-my-phone-with-hh-and-now-hoip-will-not-work-how-do-i-fix-this) to make sure the settings are correct. + * If you are using Hamshack Hotline, [please check here](./faq.md#i-had-to-reprovision-my-phone-with-hh-and-now-hoip-will-not-work-how-do-i-fix-this) to make sure the settings are correct. If these do not fix the issue, you will need to open a ticket to the helpdesk. We will need to make some adjustments. @@ -75,84 +73,72 @@ This is a long document, so to the right side of this page is a Table of Content For those of you that have reprovisioned your phone due to Hamshack Hotline or a factory reset and then reprovisioning Hamshack Hotline to fix these issues and be able to use other services: * Goto your HOIP extension tab and change TCP to UDP. - * In the ```SYSTEM``` tab, please fill in - * ```PRIMARY DNS``` with 8.8.8.8 - * ```SECONDARY DNS``` to 8.8.4.4 + * In the `SYSTEM` tab, please fill in + * `PRIMARY DNS` with 8.8.8.8 + * `SECONDARY DNS` to 8.8.4.4 * or you can use DNS servers of your choice (for example if you run a DNS source on your home network like Pi-Hole or if you don't want to use the Google servers above). * Make sure you have your HOIP extension configured with the proper credentials. * Submit changes and reboot. -### My phone is provisioned but I don't hear any audio after the dial tone when I check my voicemail or make any calls. - -!!! note "" - Check the audio settings of the phone. Make sure the volume is turned up and there are no loose connections. If the phone checks out physically, check to see if the phone is behind a firewall. If it is the following ports need to be opened outbound only. (Keep in mind this is NOT port forwarding, just simply allowing the phone to initiate a connection on these ports - - * SIP Ports UDP - 5160 - * DNS Ports UDP - 53 - * NTP Ports UDP - 123 - * RTP Ports UDP - 8500 through 59999 -
- -### My phone is provisioned but I don't hear any audio after the dial tone when I check my voicemail or make any calls. +### My phone is provisioned but I don't hear any audio after the dial tone when I check my voicemail or make any calls !!! note "" - Check the audio settings of the phone. Make sure the volume is turned up and there are no loose connections. If the phone checks out physically, check to see if the phone is behind a firewall. If it is the following ports need to be opened outbound only. (Keep in mind this is NOT port forwarding, just simply allowing the phone to initiate a connection on these ports + Check the audio settings of the phone. Make sure the volume is turned up and there are no loose connections. If the phone checks out physically, check to see if the phone is behind a firewall. If it is the following ports need to be opened outbound only. (Keep in mind this is NOT port forwarding, just simply allowing the phone to initiate a connection on these ports) * SIP Ports UDP - 5160 * DNS Ports UDP - 53 * NTP Ports UDP - 123 * RTP Ports UDP - 10000 through 15000 NOTE: RTP port can vary on what is set for your device to use. -
+ +---- ## Phones ### What phones work with HOIP? !!! note "" - The nice thing about the Hams Over IP service is we are a BOYD (Bring Your Own Device) service. So any phone that you can configure for SIP connections can be used on the service, on any peer. We have people that use Cisco, Grandstream, Polycomm, Yealink, Fanvil, Softphones and many other types of phones. + The nice thing about the Hams Over IP service is we are a BOYD (Bring Your Own Device) service. So any phone that you can configure for SIP connections can be used on the service, on any peer. We have people that use Cisco, Grandstream, Polycomm, Yealink, Fanvil, Softphones and many other types of phones. As long as you can configure the phone to use SIP, you are good to go. ### How do I configure X phone to work with HOIP? !!! note "" - Take a look through the Configuration Guides in the Wiki and see if your phone has a configuration guide. If not, you can ask on any of our [chat services](https://hamsoverip.github.io/wiki/General/user_guides/chat-services/) to see if someone has configured it. + Take a look through the Configuration Guides in the Wiki and see if your phone has a configuration guide. If not, you can ask on any of our [chat services](./chat-services.md) to see if someone has configured it. - If there is not a configuration guide, you are also welcome to contribute to the Wiki and add a guide for your phone. That would help out others. To see how to contribute, look at the [Contributing Guide](https://hamsoverip.github.io/wiki/wiki/overview/). + If there is not a configuration guide, you are also welcome to contribute to the Wiki and add a guide for your phone. That would help out others. To see how to contribute, look at the [Contributing Guide](../../wiki/overview.md). ### I had to reprovision my phone or factory reset my phone and I cannot find/lost my credientals. What do I do? !!! note "" If you can't find your credentials, you can put a ticket into the [Helpdesk Ticketing](https://helpdesk.hamsoverip.com/osticket/) system and request your credentials be resent to you. - ### How do I access my Voicemail? -!!!note "" - Dial ```*97``` from your phone or hit the voicemail button. This will drop you into your mailbox. If this is the first time accessing your mailbox, the system will walk you through setting up your outgoing voicemail messages and make you change your pin. Once you have all this setup, all you need to do is dial ```*97``` from your phone, or hit the voicemail button and it will just drop you into your box to let you retreive messages. +!!! note "" + Dial `*97` from your phone or hit the voicemail button. This will drop you into your mailbox. If this is the first time accessing your mailbox, the system will walk you through setting up your outgoing voicemail messages and make you change your pin. Once you have all this setup, all you need to do is dial `*97` from your phone, or hit the voicemail button and it will just drop you into your box to let you retreive messages. -
+---- ## PBXs ### What PBXs work with HOIP? !!! note "" - Good Question. As of right now, we know that FreePBX and 3CX both work with the service. Both can connect via SIP Trunks and FreePBX is able to use IAX. But otherwise, we don't really know of more. If you know of others that use SIP Trunks and can configure them, we would like to know more about it. In fact, if you can create a configuration guide, please submit it. + Good Question. As of right now, we know that FreePBX and 3CX both work with the service. Both can connect via SIP Trunks and FreePBX is able to use IAX. But otherwise, we don't really know of more. If you know of others that use SIP Trunks and can configure them, we would like to know more about it. In fact, if you can create a configuration guide, please submit it. If you want to use FreePBX or 3CX, please check out the configuration guides for each here in the Wiki. - ### How do I configure my PBX to work with HOIP? !!! note "" - Good question! If it's one we have a guide for, check out the configuration guides for the PBXs. If it's one that we don't have a guide for, please write one up and submit it. + Good question! If it's one we have a guide for, check out the configuration guides for the PBXs. If it's one that we don't have a guide for, please write one up and submit it. -
+---- ## Website/Ticket System -### I am a new user and just created an account in OS Ticket, but I am not able to log in. +### I am a new user and just created an account in OS Ticket, but I am not able to log in !!! note "" Chances are pretty good the verification email from the system was sent to your spam folder. There are some email providers that either block or mark the emails as spam. Check your spam folder. If it's not there, it might have been blocked. Reach out to an admin on Discord and see if they can activate your account. Once that is done, you should be able to log in and see your tickets. @@ -161,6 +147,10 @@ This is a long document, so to the right side of this page is a Table of Content !!! note "" This could be a couple of things: - + * Remember we are all volunteers. We try to get to tickets as quick as we can, but we also have lives outside of this project. So it could take a day or two before we can get to the ticket * Possibly the same reason as above. Your email provider spam foldered it or blocked it. Again, reach out to an admin on Discord and they can DM you your credentials. + +---- + +!!! info "Last updated 2024-07-09" diff --git a/docs/General/user_guides/getting-started.md b/docs/General/user_guides/getting-started.md index be724624..43c05e77 100644 --- a/docs/General/user_guides/getting-started.md +++ b/docs/General/user_guides/getting-started.md @@ -8,22 +8,22 @@ Please note that you MUST have an extension on the system before you can request So lets get started: -* First, you will need to enter a ticket in our ticketing system. Please go to [https://helpdesk.hamsoverip.com/osticket/](https://helpdesk.hamsoverip.com/osticket/) and create an account. +* First, you will need to enter a ticket in our [ticketing system](https://helpdesk.hamsoverip.com/osticket/) and create an account if you don't already have one. * Once your account is created, you will get a verification email to the email address you used to signup with. - * If you do not have the email within a few minutes, you will need to check your Spam or Junk folders, in case it got routed there by your email provider. * Once you have verified your email, you will need to log into the Ticketing System and then request a new extension. Follow the prompts on the screen to do that. - * After your request is in, it can take a bit before your line is provisioned. Please be patient. - * Once your extension is provisioned, you will get sent an email with your credentials. + * Once your extension is provisioned, you will get sent an email with your credentials. * When configuration screens ask for a user name, your user name is your extension number. - * You can use whatever device you want, but you will need to know how to configure it. Also know that we can support alot of phones, but there are a few that we receommend to make helping the end user easier. However, by joining one of our [chat services](https://hamsoverip.github.io/wiki/General/user_guides/chat-services/), you may be able to find help on phones too. + * You can use whatever device you want, but you will need to know how to configure it. Also know that we can support alot of phones, but there are a few that we receommend to make helping the end user easier. However, by joining one of our [chat services](./chat-services.md), you may be able to find help on phones too. -* While waiting for your line to be provisioned, read through the rest of the Wiki here. There is alot of information in these pages that can help you configure a phone or use other aspects of the service. -* Make sure to join one of our [chat services](https://hamsoverip.github.io/wiki/General/user_guides/chat-services/) for additional help/conversation! -* Signup at the main website [https://hamsoverip.com](https://hamsoverip.com) for the phonebook and BLF Dashboards. This is a seperate account from the Ticketing System. +* While waiting for your line to be provisioned, read through the rest of the Wiki here. There is a lot of information in these pages that can help you configure a phone or use other aspects of the service. +* Make sure to join one of our [chat services](./chat-services.md) for additional help/conversation! +* Visit the main website [https://hamsoverip.com](https://hamsoverip.com) for the phonebook and BLF Dashboards. Finally, and most importantly, enjoy using the service! -Last Updated: 09/03/2022 +--- + +!!! info "Last Updated 2022-09-03" diff --git a/docs/General/user_guides/support.md b/docs/General/user_guides/support.md index cd47d40a..2144aed5 100644 --- a/docs/General/user_guides/support.md +++ b/docs/General/user_guides/support.md @@ -9,7 +9,7 @@ If you need help, here are some steps to take: * Look through the Wiki first. Alot of common questions are already answered here. * Next, if you don't find an answer in these pages, put in a ticket in the ticket system that you can get to from the [main website](https://hamsoverip.com). This allows us to track issues. This allows us to see what common issues are so that we can either put a fix in place, or generate a wiki article to help others in the future. * Once you have a ticket in, someone may reach out for farther information, or to schedule time with you to connect on Discord to get more information or even walk you through your issue. -* You can ask for help in one of our chat servers. Please look here to see what we support and how they are connected: [Chat Services Guide](https://hamsoverip.github.io/wiki/General/user_guides/chat-services/). Keep in mind though you will get alot of answers and it will not be a tracked issue. +* You can ask for help in one of our chat servers. Please look here to see what we support and how they are connected: [Chat Services Guide](./chat-services.md). Keep in mind though you will get alot of answers and it will not be a tracked issue. The biggest key here is to make sure to put a ticket in so that issues and problems can be tracked easier. diff --git a/docs/endpoints/hard_phones/OBi202.md b/docs/endpoints/hard_phones/OBi202.md index f87147a1..5d8bd9a2 100644 --- a/docs/endpoints/hard_phones/OBi202.md +++ b/docs/endpoints/hard_phones/OBi202.md @@ -1,7 +1,6 @@ # Setting Up an OBi 202 Adapter with Hams over IP -I have an analog telephone adapter (ATA) that lets me connect POTS phones to VoIP services. Here's how to get your ATA working with Hams over IP. - +I have an analog telephone adapter (ATA) that lets me connect POTS phones to VoIP services. Here's how to get your ATA working with Hams over IP. ## Logging in to the Device @@ -11,54 +10,58 @@ OBiTALK devices can be configured online with [OBiNET](https://www.obitalk.com/o When using the built-in Web server, you will find that almost all advanced options are greyed out until you un-check that row's Default checkbox. - ## Service Provider Profile Configuration On the left-hand side, under **Service Providers**, click on **ITSP Profile B**. Under the General section: -* Name: Hams over IP -* SignalingProtocol: SIP -![ITSPProfile](https://user-images.githubusercontent.com/19931245/231046347-6e35f7b6-c6be-4260-bb5c-abb35194a735.png) +* Name: Hams over IP +* SignalingProtocol: SIP +![ITSPProfile](https://user-images.githubusercontent.com/19931245/231046347-6e35f7b6-c6be-4260-bb5c-abb35194a735.png) SIP section: -* ProxyServer: `pbx-us1.hamsoverip.com` (or your server name) -* ProxyServerPort: `5160` -* ProxyServerTransport: `UDP` -* OutboundProxy: `pbx-us1.hamsoverip.com` (or your server name) -* OutboundProxyPort: `5160` -* RegisterExpires: `3600` -* X_SessionRefresh: unchecked -* X_LineSeizeSubscribeExpires: `30` -![ITSPProfileSIP](https://user-images.githubusercontent.com/19931245/231046413-f732be9a-2985-479a-9721-c3f2fa9d894c.png) +* ProxyServer: `pbx-us1.hamsoverip.com` (or your server name) +* ProxyServerPort: `5160` +* ProxyServerTransport: `UDP` +* OutboundProxy: `pbx-us1.hamsoverip.com` (or your server name) +* OutboundProxyPort: `5160` +* RegisterExpires: `3600` +* X_SessionRefresh: unchecked +* X_LineSeizeSubscribeExpires: `30` +![ITSPProfileSIP](https://user-images.githubusercontent.com/19931245/231046413-f732be9a-2985-479a-9721-c3f2fa9d894c.png) ## Voice Service Configuration Under the **Voice Services** heading, click on **SP2 Service**. -* Enable: checked -* X_RegisterEnable: checked -* X_UserAgentPort: `5081` -* AuthUserName: your extension -* AuthPassword: your password -* URI: (blank) -* X_EnforceRequestUserID: checked -* X_SRTP: `Use SRTP When Possible` +* Enable: checked +* X_RegisterEnable: checked +* X_UserAgentPort: `5081` +* AuthUserName: your extension +* AuthPassword: your password +* URI: (blank) +* X_EnforceRequestUserID: checked +* X_SRTP: `Use SRTP When Possible` Under **CallerIDName**, enter your caller ID as you want other people to see it. I used my full name and call sign. I'm not sure if HoIP overrides this setting or not. ![VoiceServices](https://user-images.githubusercontent.com/19931245/231046325-be5aa42f-0aab-459e-a0ba-e9a537c7f3cc.png) - ## That's it! Finally, reboot the device and see if the extension will register. Now, pick up whatever telephone you've plugged into your ATA and see if you get a dial tone! ![Yes, this Western Electric 2500DMG now supports VoIP calling!](https://user-images.githubusercontent.com/19931245/231046451-33b4da9a-7c52-47d4-bdb7-96ecfef54618.jpg) -(Yes, this 50-year-old phone actually works with HoIP! The OBi ATA is under my desk and not pictured.) +(Yes, this 50-year-old phone actually works with HoIP! The OBi ATA is under my desk and not pictured.) + +---- + +!!! info "Last updated 2023-04-11 by Colin W1DNS" -73, Colin Cogle, W1DNS. +*[HoIP]: Hams Over IP +*[POTS]: Plain Old Telephone System +*[SIP]: Session Initiation Protocol diff --git a/docs/endpoints/hard_phones/PolycomVVX4xx.md b/docs/endpoints/hard_phones/PolycomVVX4xx.md index ef4e6395..4ffb438c 100644 --- a/docs/endpoints/hard_phones/PolycomVVX4xx.md +++ b/docs/endpoints/hard_phones/PolycomVVX4xx.md @@ -1,57 +1,60 @@ -# Polycom VVX-401/411 -![PolyVVX-401_Phone](https://user-images.githubusercontent.com/40501228/186971221-e9fd9166-ddc9-43d0-a756-6f062820867e.png) +# Polycom VVX-4xx/5xx -The Polycom VVX-401/411 Phone Series are 12-line IP Phones with Color Display, which is a full-featured VoIP (Voice over Internet Protocol) phone that provide voice communication over an IP network. It provides traditional features, such as call forwarding, redialing, speed dialing, transferring calls, conference calling, and accessing voice mail. Calls can be made or received with a handset, headset, or speaker. +![PolyVVX-401_Phone "Polycom VVX-401"](https://user-images.githubusercontent.com/40501228/186971221-e9fd9166-ddc9-43d0-a756-6f062820867e.png "Polycom VVX-401") -The Polycom VVX-401/411 Series IP Phones provides a web interface (aka: GUI - Graphical User Interface) for the phone user that allows you to configure some features of your phone by using a web browser. +The Polycom VVX-4xx/5xx Phone Series are 12-line IP Phones with Color Display, which is a full-featured VoIP (Voice over Internet Protocol) phone that provide voice communication over an IP network. It provides traditional features, such as call forwarding, redialing, speed dialing, transferring calls, conference calling, and accessing voice mail. Calls can be made or received with a handset, headset, or speaker. + +The Polycom VVX-4xx/5xx Series IP Phones provides a web interface (aka: GUI - Graphical User Interface) for the phone user that allows you to configure some features of your phone by using a web browser. This article will guide you through the steps for basic configuration to make it work with HOIP. -**Note:** These steps MIGHT work with other Polycom Models. The examples below are to give guidance in your attempts to provision/configure your Polycom Models. +!!! note "These steps MIGHT work with other Polycom Models. The examples below are to give guidance in your attempts to provision/configure your Polycom Models. Images and screenshots in this article refer to the VVX-401." ## Factory Reset - (if required) -The below steps are an option to be considered, if one the following is observed: +??? info "This is an optional step, which will completely wipe the phone" + + The below steps are an option to be considered, if one the following is observed: -* The phone is on a boot loop and no longer going to the home menu -* The default password or mac password doesn't work -* If it's a 3rd party phone + * The phone is on a boot loop and no longer going to the home menu + * The default password or mac password doesn't work + * If it's a 3rd party phone -**Steps** + To factory-reset your device, carry out the following steps -* Reboot the phone and wait for the starting application. -* While the phone is in the starting application wait for the cancel button to appear then press it. -* The phone will show a 7 seconds count down. This is the only open window to press the key combination to go to the hard reset page. + 1. Reboot the phone and wait for the starting application. + 2. While the phone is in the starting application wait for the cancel button to appear then press it. + 3. The phone will show a 7 seconds count down. This is the only open window to press the key combination to go to the hard reset page. -!!! note "If the phone model is a" + !!! note "If the phone model is a" - * VVX series (VVX300, 301, 310, 311, etc): Press and hold 1 3 5 within the 7-second count down until it prompts you to the password page - * Sound Point IP 335: Press and hold 1 3 5 7 within the 7-second count down until it prompts you to the password page - * Sound Point IP series (IP550,560,570, etc): Press and hold 4 6 8 and \* within the 7-second count down until it prompts you to the password page - * Conference Phone IP5000, 6000, 7000: Press and hold 1 3 5 7 within the 7-second count down until it prompts you to the password page + * VVX series (VVX300, 301, 310, 311, etc): Press and hold 1 3 5 within the 7-second count down until it prompts you to the password page + * Sound Point IP 335: Press and hold 1 3 5 7 within the 7-second count down until it prompts you to the password page + * Sound Point IP series (IP550,560,570, etc): Press and hold 4 6 8 and \* within the 7-second count down until it prompts you to the password page + * Conference Phone IP5000, 6000, 7000: Press and hold 1 3 5 7 within the 7-second count down until it prompts you to the password page -* Enter the device's MAC ID as the password (e.g 0004f28619dc). -* Press the 2nd soft key that corresponds to the mode or (encoding) to change it to ```A->abc``` or ```a->abc```. -* Then (for example) to select the letter F, press the 3 key three times. + 4. Enter the device's MAC ID as the password (e.g 0004f28619dc). + 5. Press the 2nd soft key that corresponds to the mode or (encoding) to change it to `A->abc` or `a->abc`. + 6. Then (for example) to select the letter F, press the 3 key three times. ## Step 1 - Get the IP address of your phone -* Press the ```Home``` Button Icon on your Polycom Phone. +1. Press the `Home` Button Icon on your Polycom Phone. - ![PolyVVX-401_Phone_Home_Button](https://user-images.githubusercontent.com/40501228/186971150-ee8cd2a8-53bd-4c19-9a24-8cf453cdea6f.png) + ![PolyVVX-401_Phone_Home_Button "A picture of the home button on the Polycom VVX-401"](https://user-images.githubusercontent.com/40501228/186971150-ee8cd2a8-53bd-4c19-9a24-8cf453cdea6f.png "A picture of the home button on the Polycom VVX-401") -* On the ```Display Screen``` and using the ```Arrow Keys``` to scroll and select ```Settings```. -* Scroll down to ```Status``` and hit ```Select```. -* Scroll down to ```Network``` and hit ```Select```. -* Scroll down to ```TCP/IP Parameters``` and hit ```Select```. +2. On the `Display Screen` and using the `Arrow Keys` to scroll and select `Settings`. +3. Scroll down to `Status` and hit `Select`. +4. Scroll down to `Network` and hit `Select`. +5. Scroll down to `TCP/IP Parameters` and hit `Select`. This should show your IP Address in the format of xxx.xxx.xxx.xxx (EX: 192.168.0.2) -## Step 2 - Logging in to the Phone Web User Interface** +## Step 2 - Logging in to the Phone Web User Interface -* On your PC, open a Web browser window. (Note: Your PC must be on the same network as the phone.) -* Enter the IP address in the browser address bar. - - This is the IP address you obtained above +1. On your PC, open a Web browser window. (Note: Your PC must be on the same network as the phone.) +2. Enter the IP address in the browser address bar. + This is the IP address you obtained above You will now see this screen (see picture): @@ -59,115 +62,109 @@ You will now see this screen (see picture): ## Step 3 - Configure "Simple Setup" Fields -After successful login of User ADMIN, click on ```Simple Setup``` button near the top left side of the screen. You will then need to populate only the ```Header Fields``` as the pictured in the below example. +After successful login of User ADMIN, click on `Simple Setup` button near the top left side of the screen. You will then need to populate only the `Header Fields` as the pictured in the below example. ![PolyVVX-4xx_Simple_Setup](https://user-images.githubusercontent.com/40501228/186971309-fc32d13e-798a-418b-93fa-eb94ba2f5eab.png) As the example pictured above, enter your information into the following fields: -**TIME SYNCHRONIZATION**
-**Alternate SNTP Server**: north-america.pool.ntp.org
-**Alternate Time Zone**: (Your GMT Zone)
- -**SIP SERVER**
-**Address**: This will be the domain name sent in your credentials email (ex: ```pbx-us1.hamsoverip.com```)
-**Port**: 5160 - -**SIP OUTBOUND PROXY**
-**Address**: This will be the domain name sent in your credentials email (ex: ```pbx-us1.hamsoverip.com```)
-**Port**: 5160
- -**SIP LINE IDENTIFICATION**
-**Display Name**: How you want your "Caller ID" to be displayed to the Called Party.
-**Address**: Enter your Extension from the credentials email.
-**Authentication User ID**: Enter your Extension from the credentials email.
-**Authentication Password**: Enter your password from the credentials email.
-**Label**: Your choice on how you want to label your "Line Key" on your phone display
- -Select ```SAVE``` before leaving screen. +| **TIME SYNCHRONIZATION** || +| -- | -- | +| Alternate SNTP Server: | north-america.pool.ntp.org | +| Alternate Time Zone: | (your timezone) | +| **SIP SERVER** || +| Address: | This will be the domain name sent in your credentials email
(ex: `pbx-us1.hamsoverip.com`) | +| Port: | 5160 | +| **SIP OUTBOUND PROXY** || +| Address: | This will be the domain name sent in your credentials email
(ex: `pbx-us1.hamsoverip.com`) | +| Port: | 5160 | +| **SIP LINE IDENTIFICATION** || +| Display Name: | How you want your "Caller ID" to be displayed to the Called Party. | +| Address: | Enter your **Extension** from the credentials email. | +| Authentication User ID: | Enter your Extension from the credentials email. | +| Authentication Password: | Enter your password from the credentials email. | +| Label: | Your choice on how you want to label your "Line Key" on your phone display | + +Select `SAVE` before leaving screen. If phone reboots, log back in as user ADMIN and continue to Step 4 ## Step 4 - Configure "SIP" Fields -After completing Step 3, click on ```Settings``` button near the top left side of the screen and choose ```SIP```. You will then only need to populater the ```SIP Fields``` as the pictured in the below example. +After completing Step 3, click on `Settings` button near the top left side of the screen and choose `SIP`. You will then only need to populater the `SIP Fields` as the pictured in the below example. ![PolyVVX-4xx_SIP_Settings_UDPOnly](https://user-images.githubusercontent.com/40501228/186977655-6c78bd46-d138-4374-8512-de3044bde942.png) As the example pictured above, enter your information into the following fields: -**OUTBOUND PROXY**
-**Address**: This will be the domain name sent in your credentials email (ex: ```pbx-us1.hamsoverip.com```)
-**Port**: 5160
-**Transport**: UDPOnly
- -**SERVER 1**
-**Special Interop**: Standard
-**Address**: This will be the domain name sent in your credentials email (ex: ```pbx-us1.hamsoverip.com```)
-**Port**: 5160
-**Transport**: UDPOnly
-**Expires (s)**: 3600
-**Subscription Expires (s)**: 3600
-**Register (Radio Button)**:
-**Retry Timeout (ms)**: 0
-**Retry Maximum Count**: 3
-**Line Seize Timeout (s)**: 30
- -Select ```SAVE``` before leaving screen. +| **OUTBOUND PROXY** || +| -- | -- | +| Address: | This will be the domain name sent in your credentials email
(ex: `pbx-us1.hamsoverip.com`) | +| Port: | 5160 | +| Transport: | UDPOnly | +| **SERVER 1** || +| Special Interop: | Standard | +| Address: | This will be the domain name sent in your credentials email
(ex: `pbx-us1.hamsoverip.com`) | +| Port: | 5160 | +| Transport: | UDPOnly | +| Expires (s): | 3600 | +| Subscription Expires (s): | 3600 | +| Register (Radio Button): | Yes | +| Retry Timeout (ms): | 0 | +| Retry Maximum Count: | 3 | +| Line Seize Timeout (s): | 30 | + +Select `SAVE` before leaving screen. If phone reboots, log back in as user ADMIN and continue to Step 5 ## Step 5 - Configure "LINE" Field -After completing Step 4, click on ```Settings``` button near the top left side of the screen and then choose ```LINES``` and highlight ```Line 1```. -Then you will population the only the ```Line 1``` as the pictured in the below example. +After completing Step 4, click on `Settings` button near the top left side of the screen and then choose `LINES` and highlight `Line 1`. +Then you will population the only the `Line 1` as the pictured in the below example. ![PolyVVX-4xx_Line_Settings_UDPOnly](https://user-images.githubusercontent.com/40501228/186977709-adbf52a8-fa45-4eb9-91ee-c887caeb55c0.png) As the example pictured above, enter your information into the following fields: - -**IDENTIFICATION**
-**Display Name**: Your choice. (This is the name YOU will see on your Phone Display for Line 1)
-**Address**: Enter your Extension from the credentials email.
-**Label**: Your choice. Recommend using the same entry from ```Display Name``` above.
-**Type (Radio Button)**:
-**Third Party Name**:
-**Number of Line Keys**: 1
-**Calls Per Line**: Default is "24" - Enter at least "1"
-**Enable SRTP (Radio Button)**:
-**Offer SRTP (Radio Button)**:
-**Require SRTP (Radio Button)**:
-**Server Auto Discovery**:
- -**AUTHENTICATION**
-**Use Login Credentials (Radio Button)**:
-**Domain**: This will be the domain name sent in your credentials email (ex: ```pbx-us1.hamsoverip.com```)
-**User ID**: Enter your Extension from the credentials email.
-**Password**: Enter your password from the credentials email.
- - -**OUTBOUND PROXY**
-**Address**: This will be the domain name sent in your credentials email (ex: ```pbx-us1.hamsoverip.com```)
-**Port**: 5160
-**Transport**: UDPOnly
- -**SERVER 1**
-**Special Interop**: Standard
-**Address**: This will be the domain name sent in your credentials email (ex: ```pbx-us1.hamsoverip.com```)
-**Port**: 5160
-**Transport**: UDPOnly
-**Expires (s)**: 3600
-**Subscription Expires (s)**: 3600
-**Register (Radio Button)**:
-**Retry Timeout (ms)**: 0
-**Retry Maximum Count**: 3
-**Line Seize Timeout (s)**: 30
- -Select ```SAVE``` before leaving screen. +| **IDENTIFICATION** || +| -- | -- | +| Display Name: | (your choice)
(This is the name YOU will see on your Phone Display for Line 1) | +| Address: | Enter your **Extension** from the credentials email. | +| Label: | (your choice)
Recommend using the same entry from `Display Name` above. | +| Type (Radio Button): | Private | +| Third Party Name: | (leave blank) | +| Number of Line Keys: | 1 | +| Calls Per Line: | Default is "24" - Enter at least "1" | +| Enable SRTP (Radio Button): | No | +| Offer SRTP (Radio Button): | No | +| Require SRTP (Radio Button): | No | +| Server Auto Discovery: | Disable | +| **AUTHENTICATION** || +| Use Login Credentials (Radio Button): | Enable | +| Domain: | This will be the domain name sent in your credentials email
(ex: `pbx-us1.hamsoverip.com`) | +| User ID: | Enter your Extension from the credentials email. | +| Password: | Enter your password from the credentials email. | +| **OUTBOUND PROXY** || +| Address: | This will be the domain name sent in your credentials email
(ex: `pbx-us1.hamsoverip.com`) | +| Port: | 5160 | +| Transport: | UDPOnly | +| **SERVER 1** || +| Special Interop: | Standard | +| Address: | This will be the domain name sent in your credentials email
(ex: `pbx-us1.hamsoverip.com`) | +| Port: | 5160 | +| Transport: | UDPOnly | +| Expires (s): | 3600 | +| Subscription Expires (s): | 3600 | +| Register (Radio Button): | Yes | +| Retry Timeout (ms): | 0 | +| Retry Maximum Count: | 3 | +| Line Seize Timeout (s): | 30 | + +Select `SAVE` before leaving screen. Now with Steps 3 thru 5 provisioned/configured, reboot the phone to bind the changes/additions. -Written by: Mark, KI5CYA +--- -Last Updated: 08/28/2022 +!!! info "Written 2022-08-28 by Mark KI5CYA, last updated 2024-08-13 by Dave M7TLB" diff --git a/docs/endpoints/hard_phones/YealinkT4X.md b/docs/endpoints/hard_phones/YealinkT4X.md index 00ee13d7..58cc0048 100644 --- a/docs/endpoints/hard_phones/YealinkT4X.md +++ b/docs/endpoints/hard_phones/YealinkT4X.md @@ -1,7 +1,9 @@ # Yealink T4X Series of Phones + [![T46](https://charliemckinley.com/images/yealinkt46g.png "T46")](https://charliemckinley.com/images/yealinkt46g.png "T46")[![T48](https://charliemckinley.com/images/yealinkt48g.png "T48")](https://charliemckinley.com/images/yealinkt48g.png "T48") ## Find Phone IP + Press the **OK** button for the status screen [![T46](https://charliemckinley.com/images/T46GStatus.jpg "T46")](https://charliemckinley.com/images/T46GStatus.jpg "T46") @@ -9,6 +11,7 @@ Press the **OK** button for the status screen ## Factory Reset There are three ways to **Factory Reset** your phone. + 1. Press the **OK** button, enter the IPv4 address into your web browser. Enter **Username** and **Password** (Default is **admin** and **admin**). Navigate to the **Settings** tab, then to **Upgrade** on the side menu, and press the **Reset to Factory** button and follow the prompts. 1. Press the **Menu** button on the screen, arrow to **Advanced** and press **OK**. Enter the password using the number pad. (1 press of the 2 key is "a", two presses is "b", etc.) Once into the Advanced menu press **5**, then press **1**, then confirm the reset. 1. Press and hold the **OK** button until the **Reset to Factory Setting?** pop up shows, then select the **OK** button on the screen and follow the prompts. @@ -16,6 +19,7 @@ There are three ways to **Factory Reset** your phone. [![T46](https://charliemckinley.com/images/T46Gfactoryreset.jpg "T46")](https://charliemckinley.com/images/T46Gfactoryreset.jpg "T46") ## Programming For HOIP + 1. Enter the web gui by entering the IPv4 address into your web browser. (See Find Phone IP above for directions) 2. Navigate to the **Account** tab. In the **Register** page choose the **account** number you want to set up. 3. Change **Line Active** to **Enabled**. @@ -32,29 +36,35 @@ There are three ways to **Factory Reset** your phone. 14. Click on **Confirm** to save the settings. ## BLF Set Up + Under the **Dsskey** tab, select the **Line Key** area that you want to program, on the desired **Line Key** select **BLF** from the dropdown, enter the extension you want to monitor in the **Value** field, give it the appropriate label in the **Label** field and select the **line number** the BLF is associated with (the **Line** number corresponds directly the **Account** you set up on the **Account** tab.) [![T46](https://charliemckinley.com/images/T46BLF.PNG "T46")](https://charliemckinley.com/images/T46BLF.PNG "T46") [![T46](https://charliemckinley.com/images/T46Account.PNG "T46")](https://charliemckinley.com/images/T46Account.PNG "T46") + ## Tips and Tricks + ### Verizon Models + If you find a Verizon OneTalk version, you can convert it to work with any other SIP provider by following these directions: https://extramile-tech.com/setting-a-verizon-onetalk-phone-back-to-yealink-firmware/ ### Screen Capture + In the Web GUI, click on the **Features** tab, then on **Remote Control**, in the **Action URI Allow IP List** field enter in the IP address of the device you want to allow to capture the screenshots or the word **any** to allow all devices to capture. Then go to http://xxx.xxx.xxx.xxx/servlet?m=mod_action&command=screenshot (where xxx.xxx.xxx.xxx is the IP address of your phone) [![T46](https://charliemckinley.com/images/T46screencapture.PNG "T46")](https://charliemckinley.com/images/T46screencapture.png "T46") ### Power LED + There are several settings that pertain to the red power LED statuses. I prefer "all off". [![T46](https://charliemckinley.com/images/T46powerled.PNG "T46")](https://charliemckinley.com/images/T46powerled.png "T46") ### Notification PopUps + You can enable or disable the popups on the screen. I prefer "no popups". [![T46](https://charliemckinley.com/images/T46notificationpopups.PNG "T46")](https://charliemckinley.com/images/T46notificationpopups.png "T46") +---- - -Written by Charlie, KE8QLV -Last updated 11/25/2022 +!!! info "Last updated 2022-11-25 by Charlie KE8QLV" diff --git a/docs/endpoints/pbx/3cx/configure-3cx-trunk.md b/docs/endpoints/pbx/3cx/configure-3cx-trunk.md index 9195e2f3..40fc2bd7 100644 --- a/docs/endpoints/pbx/3cx/configure-3cx-trunk.md +++ b/docs/endpoints/pbx/3cx/configure-3cx-trunk.md @@ -1,6 +1,6 @@ # Configuring a FreePBX IAX Trunk for HOIP -The Ham's Over IP service offers the ability to connect your home 3CX PBX System to our system. This allows you to use any number of phones on your extension, control your own voicemail and many other things. In many ways, it's easier to run your own PBX then it is to try to connect multiple phones to our system. The more people who can use a their own PBX is the less number of phones trying to register to our network and helps keep resources free. +The Hams Over IP service offers the ability to connect your home 3CX PBX System to our system. This allows you to use any number of phones on your extension, control your own voicemail and many other things. In many ways, it's easier to run your own PBX then it is to try to connect multiple phones to our system. The more people who can use a their own PBX is the less number of phones trying to register to our network and helps keep resources free. 3CX is only a SIP based PBX. Therefore, when requesting a new line for use with 3CX, you will just need to request a new extension. **DO NOT REQUEST A TRUNK.** If you request a trunk, it will be configured for an IAX connection for Asterisk/FreePBX. We do not want that. @@ -15,47 +15,47 @@ This guide assumes that you already have a 3CX PBX setup and ready and have also ### Create the Trunk * Log into your 3CX PBX Management Console. -* Click on ```SIP Trunks``` in the left hand column. -* Click ```Add SIP Trunk```. -* Select ```Generic``` in the ```Select Country``` dropdown. -* Then select ```Asterisk``` in the ```Select Provider in your Country``` dropdown. -* Enter the extension number/Username that you received in the email from the HOIP System in the ```Main Trunk No``` field. -* Click ```Ok```. This should drop you into the edit screen for the trunk. -* Now give it a name in the ```Enter name for Trunk``` field (Suggested "HOIP") -* In the ```Registrar/Server/Gateway Hostname or IP``` field, enter the FQDN of of the PBX Server your extension is on. This will be in the email from the HOIP system. You will only need to put the FQDN in the first box. In the box at the end of that line, you will need to put the port in (5160). - * Example FQDN: ```pbx-us1.hamsoverip.com``` -* Scroll down to the ```Authentication``` section -* In the ```Type of Authentication``` drop down select ```Register/Account based``` -* Put the extension (username) in the ```Authentication ID (aka SIP User ID)``` field. Again, this is from the email that you received from the HOIP System. -* Put the password from the email in the ```Authentication Password``` field. +* Click on `SIP Trunks` in the left hand column. +* Click `Add SIP Trunk`. +* Select `Generic` in the `Select Country` dropdown. +* Then select `Asterisk` in the `Select Provider in your Country` dropdown. +* Enter the extension number/Username that you received in the email from the HOIP System in the `Main Trunk No` field. +* Click `Ok`. This should drop you into the edit screen for the trunk. +* Now give it a name in the `Enter name for Trunk` field (Suggested "HOIP") +* In the `Registrar/Server/Gateway Hostname or IP` field, enter the FQDN of of the PBX Server your extension is on. This will be in the email from the HOIP system. You will only need to put the FQDN in the first box. In the box at the end of that line, you will need to put the port in (5160). + * Example FQDN: `pbx-us1.hamsoverip.com` +* Scroll down to the `Authentication` section +* In the `Type of Authentication` drop down select `Register/Account based` +* Put the extension (username) in the `Authentication ID (aka SIP User ID)` field. Again, this is from the email that you received from the HOIP System. +* Put the password from the email in the `Authentication Password` field. * Leave the rest as default. -* Click ```OK``` at the top to save the settings. Wait a minute or two for the trunk to register. It should register, unless you entered something wrong. If it does not register, go back and check all your settings. +* Click `OK` at the top to save the settings. Wait a minute or two for the trunk to register. It should register, unless you entered something wrong. If it does not register, go back and check all your settings. ### Configure 3CX Outbound Rule Once we have the Trunk setup and registered correctly, now we need an outbound route. This is so you can make calls out of your PBX. -* Click on ```Outbound Rules``` on the left hand menu. -* Click ```Add```. -* Give it a name in ```Rule Name``` (Suggested: "HOIP Outbound") -* In the ```Calls to numbers starting with prefix``` give it a prefix for dialing. This would be a number that the PBX would see at the beginning of the dialed number that it would know to use this new route. I used 8 for mine. If you know of or remember the old "Dial 9 for an outside line" thing in offices, this is the same thing. This way you don't accidently dial out of your HOIP trunk if you are trying to make a different call. -* Scroll Down to the ```Make outbound calls on``` Section. -* For ```Route 1``` select the HOIP Trunk we configured above. -* In the ```Strip Digits``` dropdown, choose the number 1. This will strip off the prefix we defined above and then send the rest of the number dialed down the "trunk". -* Click ```OK``` at the top to save your settings. +* Click on `Outbound Rules` on the left hand menu. +* Click `Add`. +* Give it a name in `Rule Name` (Suggested: "HOIP Outbound") +* In the `Calls to numbers starting with prefix` give it a prefix for dialing. This would be a number that the PBX would see at the beginning of the dialed number that it would know to use this new route. I used 8 for mine. If you know of or remember the old "Dial 9 for an outside line" thing in offices, this is the same thing. This way you don't accidently dial out of your HOIP trunk if you are trying to make a different call. +* Scroll Down to the `Make outbound calls on` Section. +* For `Route 1` select the HOIP Trunk we configured above. +* In the `Strip Digits` dropdown, choose the number 1. This will strip off the prefix we defined above and then send the rest of the number dialed down the "trunk". +* Click `OK` at the top to save your settings. -Now whenever you want to dial someone on HOIP, you will dial ```8+``` (example: 8100070 for N8ACL). Any other house type calls will not go out this trunk. If you use this for a home PBX, you will need to make sure to dial 1-800 or 1-855 to make toll free calls on your home number, depending on the number you use for the prefix. +Now whenever you want to dial someone on HOIP, you will dial `8+` (example: 8100070 for N8ACL). Any other house type calls will not go out this trunk. If you use this for a home PBX, you will need to make sure to dial 1-800 or 1-855 to make toll free calls on your home number, depending on the number you use for the prefix. ### Configure 3CX Inbound Rule -Once we have the Trunk setup and registered correctly, now we need an outbound route. +Once we have the Trunk setup and registered correctly, now we need an outbound route. -* Click on ```Inbound Rules``` on the left hand menu. -* Click ```Add DID Rule```. -* Give it a name in ```Name``` (Suggested: "HOIP Inbound") -* In the ```DID/DDI ``` give it your extension number on HOIP. -* In the ```Route calls to``` Section, this is where you set the routing for the incoming calls for HOIP. You can route both (internal and external) to a specific extension or to a ring group if you have one setup. You could also route the calls to a voicemail box directly if you wanted to. -* Click ```OK``` at the top to save your settings. +* Click on `Inbound Rules` on the left hand menu. +* Click `Add DID Rule`. +* Give it a name in `Name` (Suggested: "HOIP Inbound") +* In the `DID/DDI` give it your extension number on HOIP. +* In the `Route calls to` Section, this is where you set the routing for the incoming calls for HOIP. You can route both (internal and external) to a specific extension or to a ring group if you have one setup. You could also route the calls to a voicemail box directly if you wanted to. +* Click `OK` at the top to save your settings. ### Now Test @@ -67,7 +67,9 @@ The nice thing about 3CX is you can have the PBX handle your voicemail, or you c * If you want HOIP to handle voicemail, just disable the voicemail options for the extension that incoming HOIP calls are being routed to on 3CX. * If you want to handle voicemail your self, you have two additional options for this: - * You can have your HOIP Voicemail box disabled and have everything roll to your PBX - * You can set your pickup time on voicemail to 10 seconds on your 3CX PBX voicemail. This will pickup your call and send it to voicemail before HOIP. This option allows you to keep your HOIP Voicemail Box as a backup in case your PBX goes off line for some reason, allowing you to continue to get voicemails to your extension. + * You can have your HOIP Voicemail box disabled and have everything roll to your PBX + * You can set your pickup time on voicemail to 10 seconds on your 3CX PBX voicemail. This will pickup your call and send it to voicemail before HOIP. This option allows you to keep your HOIP Voicemail Box as a backup in case your PBX goes off line for some reason, allowing you to continue to get voicemails to your extension. -Last Updated: 06/29/2022 \ No newline at end of file +---- + +!!! info "Last Updated 2022-06-29" diff --git a/docs/endpoints/pbx/freepbx/configure-iax-trunk.md b/docs/endpoints/pbx/freepbx/configure-iax-trunk.md index ad4016a1..48b78bdc 100644 --- a/docs/endpoints/pbx/freepbx/configure-iax-trunk.md +++ b/docs/endpoints/pbx/freepbx/configure-iax-trunk.md @@ -1,6 +1,6 @@ # Configuring a FreePBX IAX Trunk for HOIP -The Ham's Over IP service offers the ability to connect your home FreePBX PBX System to our system. This allows you to use any number of phones on your extension, control your own voicemail and many other things. In many ways, it's easier to run your own PBX then it is to try to connect multiple phones to our system. The more people who can use a their own PBX is the less number of phones trying to register to our network and helps keep resources free. +The Hams Over IP service offers the ability to connect your home FreePBX PBX System to our system. This allows you to use any number of phones on your extension, control your own voicemail and many other things. In many ways, it's easier to run your own PBX then it is to try to connect multiple phones to our system. The more people who can use a their own PBX is the less number of phones trying to register to our network and helps keep resources free. It does take a bit of work to get your own PBX configured and setup, but it in the end, the rewards are nice. @@ -89,4 +89,6 @@ Now you will need to create an Inbound Route in order to receive calls on your p You should now be able to make and receive calls across your HOIP Trunk. -Last Updated: 2024-06-01 Dave M7TLB +---- + +!!! info "Last Updated 2024-06-01" diff --git a/docs/endpoints/pbx/freepbx/configure-sip-trunk.md b/docs/endpoints/pbx/freepbx/configure-sip-trunk.md index fe2760da..49b99bb8 100644 --- a/docs/endpoints/pbx/freepbx/configure-sip-trunk.md +++ b/docs/endpoints/pbx/freepbx/configure-sip-trunk.md @@ -3,9 +3,9 @@ !!! note "IMPORTANT NOTE" If you are planning to setup a SIP trunk in FreePBX, you will need to request a regular user extension. ***DO NOT*** request a trunk. This will get you setup an IAX Trunk and that will not work with this method. ---- +---- -The Ham's Over IP service offers the ability to connect your home FreePBX PBX System to our system. This allows you to use any number of phones on your extension, control your own voicemail and many other things. In many ways, it's easier to run your own PBX then it is to try to connect multiple phones to our system. The more people who can use a their own PBX is the less number of phones trying to register to our network and helps keep resources free. +The Hams Over IP service offers the ability to connect your home FreePBX PBX System to our system. This allows you to use any number of phones on your extension, control your own voicemail and many other things. In many ways, it's easier to run your own PBX then it is to try to connect multiple phones to our system. The more people who can use a their own PBX is the less number of phones trying to register to our network and helps keep resources free. It does take a bit of work to get your own PBX configured and setup, but it in the end, the rewards are nice. @@ -13,7 +13,7 @@ This guide assumes that you already have a FreePBX setup and ready. There are ma If you already have an extension on the HOIP Network, you do not need to have it converted or anything. All you would be doing is replacing your existing endpoint with FreePBX and then connecting to that your existing endpoint to your new PBX. You don't have to configure Voicemail on FreePBX if you do not want to and continue to use your existing voicemail box provided on the HOIP Network. If you want to use voicemail on your FreePBX, see the note at the end of this document on steps to take. -Why would you want to configure a SIP trunk over an IAX trunk? +Why would you want to configure a SIP trunk over an IAX trunk? Let's take a look at a couple scenarios: @@ -28,45 +28,45 @@ There are some additonal steps to setting up a SIP trunk, but in many ways it is ### Create the Trunk * Log into your PBX admin screen -* Click ```Conectivity``` and then ```Trunks``` -* Click ```Add Trunk``` on the next screen and then select ```Add SIP (chan_pjsip) Trunk``` in the drop down. -* You should now be in the ```Add Trunk``` screen. Fill in the fields as such: - * ```Trunk Name``` - Name of the Trunk. Suggested: HOIP - * ```Hide CallerID``` - Make sure this is set to ```No```. - * ```Outbound CallerID``` - Your actual extension. This would be the extension for the Trunk that was sent to you in the email. - * ```CID Options``` - Make sure this is set for ```Allow Any CID```. - * ```Disable Trunk``` - Make sure this is set for ```No```. - * Leave the Defaults for everything else. -* Next Click the ```pjsip Settings``` tab. +* Click `Conectivity` and then `Trunks` +* Click `Add Trunk` on the next screen and then select `Add SIP (chan_pjsip) Trunk` in the drop down. +* You should now be in the `Add Trunk` screen. Fill in the fields as such: + * `Trunk Name` - Name of the Trunk. Suggested: HOIP + * `Hide CallerID` - Make sure this is set to `No`. + * `Outbound CallerID``` - Your actual extension. This would be the extension for the Trunk that was sent to you in the email. + * `CID Options` - Make sure this is set for `Allow Any CID`. + * `Disable Trunk` - Make sure this is set for `No`. +* Leave the Defaults for everything else. +* Next Click the `pjsip Settings` tab. * On that screen edit the following: - * On the ```General``` Tab: - * ```Username``` - This is your extension number from the email. - * ```Auth username``` - This is your extension number from the email. - * ```secret``` - This is the password of your extension from the email. - * ```SIP Server``` - this is the domain of the PBX server from your email. ex. ```pbx-us1.hamsoverip.com``` - * ```SIP Server Port``` - This is the port of the PBX server from your email. Typically this will always be ```5160```. - * Leave all other defaults + * On the `General` Tab: + * `Username` - This is your extension number from the email. + * `Auth username` - This is your extension number from the email. + * `secret` - This is the password of your extension from the email. + * `SIP Server` - this is the domain of the PBX server from your email. ex. `pbx-us1.hamsoverip.com` + * `SIP Server Port` - This is the port of the PBX server from your email. Typically this will always be `5160`. + * Leave all other defaults - * Once that is filled out go to the ```Advanced``` tab and find the following fields: - * ```Contact User``` - This will be your extension from the email. - * ```From User``` - This will also be your extension from the email. + * Once that is filled out go to the `Advanced` tab and find the following fields: + * `Contact User` - This will be your extension from the email. + * `From User` - This will also be your extension from the email. - * Click ```Submit``` and then ```Apply Changes``` at the top right. + * Click `Submit` and then `Apply Changes` at the top right. ### Create Outbound Route Once you have the trunk created, you will need to configure an Outgoing Route in order to make outgoing calls on your trunk. -* Click ```Conectivity``` and then ```Outbound Routes``` -* Click ```Add Route```. -* You should now be in the ```Edit Route``` Screen. You will need to fill in the fields as follows: - * ```Route Name``` - This is the name you want to call your outgoing route. Suggested: HOIP - * Skip down to ```Trunk Sequence for Matched Routes``` and select the ```HOIP Trunk``` you created earlier. +* Click `Conectivity` and then `Outbound Routes` +* Click `Add Route`. +* You should now be in the `Edit Route` Screen. You will need to fill in the fields as follows: + * `Route Name` - This is the name you want to call your outgoing route. Suggested: HOIP + * Skip down to `Trunk Sequence for Matched Routes` and select the `HOIP Trunk` you created earlier. * Click ```Submit``` and then Click the red ```Apply Changes``` in the upper right corner of the screen. As long as this is the only route/trunk on your PBX system, you are good to move on. Otherwise, if this is not the only trunk on your system, you may want to setup a prefix to dial to get this trunk. (Very Similiar to the old "Dial 9 to get an outside line" thing back in the day.) -If you want to set this up, click the ```Dial Patterns``` tab and then add a number for the prefix to dial, usually a single digit, in the prefix field for one of the dial patterns. Then add a ```.``` in the ```match pattern``` field next to it. Then ```Submit``` and ```Apply Changes```. +If you want to set this up, click the `Dial Patterns` tab and then add a number for the prefix to dial, usually a single digit, in the prefix field for one of the dial patterns. Then add a `.` in the `match pattern` field next to it. Then `Submit` and `Apply Changes`. Now to select that line, all you need to do is dial the prefix and then the number you want to call. Otherwise, if you do not set this up, all you will need to do is dial the HOIP number you want to call. @@ -74,12 +74,12 @@ Now to select that line, all you need to do is dial the prefix and then the numb Now you will need to create an Inbound Route in order to receive calls on your phone. In order to do this: -* Click ```Conectivity``` and then ```Inbound Routes``` -* Click ```Add Route```. -* You should now be in the ```Edit Route``` Screen. You will need to fill in the fields as follows: - * ```Description``` - This is the name of the Route. Suggested - HOIP - * ```Set Destination``` - This is where you want the incoming call to go to. This can be set to anywhere you want to send the call, for example, a specific extension, a ring group, a specific voicemail box, an IVR or even to a Time Condition. -* Click ```Submit``` and then Click the red ```Apply Changes``` in the upper right corner of the screen. +* Click `Conectivity` and then `Inbound Routes` +* Click `Add Route`. +* You should now be in the `Edit Route` Screen. You will need to fill in the fields as follows: + * `Description` - This is the name of the Route. Suggested - HOIP + * `Set Destination` - This is where you want the incoming call to go to. This can be set to anywhere you want to send the call, for example, a specific extension, a ring group, a specific voicemail box, an IVR or even to a Time Condition. +* Click `Submit` and then Click the red `Apply Changes` in the upper right corner of the screen. You should now be able to make and receive calls across your HOIP Trunk. @@ -89,10 +89,12 @@ The nice thing about FreePBX is you can have the PBX handle your voicemail, or y * If you want HOIP to handle voicemail, just disable the voicemail options for the extension that incoming HOIP calls are being routed to on your FreePBX. * If you want to handle voicemail your self, you have two additional options for this: - * You can have your HOIP Voicemail box disabled and have everything roll to your PBX - * You can set your pickup time on voicemail to 10 seconds on your FreePBX voicemail. This will pickup your call and send it to voicemail before HOIP. This option allows you to keep your HOIP Voicemail Box as a backup in case your PBX goes off line for some reason, allowing you to continue to get voicemails to your extension. To do this in FreePBX: - * Click on ```Settings``` at the top of the screen. This should put you into the ```FreePBX Advanced Settings``` screen. - * Scroll down and find the ```Ringtime Default```. The default setting is 15 seconds. Set this to 10. This will allow your extension to ring for 10 seconds and then your voicemail will pick up before the HOIP one does. If your PBX goes offline, the call will roll over to the HOIP voicemail system instead. - * Then ```Submit``` and ```Apply Changes```. + * You can have your HOIP Voicemail box disabled and have everything roll to your PBX + * You can set your pickup time on voicemail to 10 seconds on your FreePBX voicemail. This will pickup your call and send it to voicemail before HOIP. This option allows you to keep your HOIP Voicemail Box as a backup in case your PBX goes off line for some reason, allowing you to continue to get voicemails to your extension. To do this in FreePBX: + * Click on `Settings` at the top of the screen. This should put you into the `FreePBX Advanced Settings` screen. + * Scroll down and find the `Ringtime Default`. The default setting is 15 seconds. Set this to 10. This will allow your extension to ring for 10 seconds and then your voicemail will pick up before the HOIP one does. If your PBX goes offline, the call will roll over to the HOIP voicemail system instead. + * Then `Submit` and `Apply Changes`. + +---- -Last Updated: 09/03/2022 \ No newline at end of file +!!! info "Last Updated 2024-07-09" diff --git a/docs/endpoints/pbx/freepbx/feature-codes.md b/docs/endpoints/pbx/freepbx/feature-codes.md index d394b877..29b6962c 100644 --- a/docs/endpoints/pbx/freepbx/feature-codes.md +++ b/docs/endpoints/pbx/freepbx/feature-codes.md @@ -3,53 +3,55 @@ These are special commands that allow a user to do certain functions via Asterisk. **Blacklist** -\*30 – Blacklist a number -\*32 – Blacklist the last caller -\*31 – Remove a number from the blacklist +`*30` – Blacklist a number +`*32` – Blacklist the last caller +`*31` – Remove a number from the blacklist **Call Forward** -\*72 – Call Forward All Activate -\*73 – Call Forward All Deactivate -\*74 – Call Forward All Prompting Deactivate -\*90 – Call Forward Busy Activate -\*91 – Call Forward Busy Deactivate -\*92 – Call Forward Busy Prompting Deactivate -\*52 – Call Forward No Answer/Unavailable Activate -\*53 – Call Forward No Answer/Unavailable Deactivate -\*740 – Call Forward Toggle +`*72` – Call Forward All Activate +`*73` – Call Forward All Deactivate +`*74` – Call Forward All Prompting Deactivate +`*90` – Call Forward Busy Activate +`*91` – Call Forward Busy Deactivate +`*92` – Call Forward Busy Prompting Deactivate +`*52` – Call Forward No Answer/Unavailable Activate +`*53` – Call Forward No Answer/Unavailable Deactivate +`*740` – Call Forward Toggle **Call Waiting** -\*70 – Call Waiting – Activate -\*71 – Call Waiting – Deactivate +`*70` – Call Waiting – Activate +`*71` – Call Waiting – Deactivate **Core** -7777 – Simulate Incoming Call +`7777` – Simulate Incoming Call **Do-Not-Disturb (DND)** -\*78 – DND Activate -\*79 – DND Deactivate -\*76 – DND Toggle +`*78` – DND Activate +`*79` – DND Deactivate +`*76` – DND Toggle **Follow Me** -\*21 – Findme Follow Toggle +`*21` – Findme Follow Toggle **Info Services** -\*69 – Call Trace -\*43 – Echo Test -\*65 – Speak Your Exten Number -\*60 – Speaking Clock +`*69` – Call Trace +`*43` – Echo Test +`*65` – Speak Your Exten Number +`*60` – Speaking Clock **Paging and Intercom** -\*80 – Intercom prefix -\*54 – User Intercom Allow -\*55 – User Intercom Disallow +`*80` – Intercom prefix +`*54` – User Intercom Allow +`*55` – User Intercom Disallow **Speed Dial Functions** -\*75 – Set user speed dial -\*0 – Speeddial prefix +`*75` – Set user speed dial +`*0` – Speeddial prefix **Voicemail** -\*98 – Dial Voicemail -\*97 – My Voicemail +`*98` – Dial Voicemail +`*97` – My Voicemail -Last Updated: 06/08/2022 \ No newline at end of file +---- + +!!! info "Last Updated 2024-09-07" diff --git a/docs/endpoints/soft_phones/groundwire.md b/docs/endpoints/soft_phones/groundwire.md index 5304d327..270d066d 100644 --- a/docs/endpoints/soft_phones/groundwire.md +++ b/docs/endpoints/soft_phones/groundwire.md @@ -9,53 +9,61 @@ Groundwire is available for iOS and Android platforms at the following links: * Apple/iOS: [App Store](https://itunes.apple.com/us/app/acrobits-groundwire/id378503081?mt=8) * Android: [Google Play Store](https://play.google.com/store/apps/details?id=cz.acrobits.softphone.aliengroundwire&hl=en_US&gl=US) -## Configuration Steps - -* First download the client from the appropriate App Store. -* Once it is downloaded, open it on your device. It will either open right to the settings screen or to the quickdial tab. If it is not on the settings screen, click the gear in the upper right hand corner of the screen. -* On the Settings screen, tap the ```Accounts``` Option and then click the ```+``` in the upper right hand corner top add a new account. -* On the next screen, select the ```Generic SIP Account``` Option. -* You should now be on the ```New Account``` Screen. Here is where you will configure the account to connect to HOIP. You will need to enter the following in the fields: - * ```Title``` - This is the name of the account you are setting up. Suggested is your extension number (the actual extension) on HOIP. - * ```Username``` - This is the (actual) extension number of your account. - * ```Password``` - This is the password sent in your user credentials email from the HOIP system. - * ```Domain``` - This is the ```domain:port``` of the server you are getting an account on. This will be in the email you received from the HOIP system. An example would be ```pbx-us1.hamsoverip.com:5160```. - * ```Display Name``` - This is optional, but this would be the name you would want displayed on the other end. -* Once you have all of these set, Tap ```Save```. -* Then tap ```Settings``` in the upper left corner. -* Finally tap ```Done``` in the upper right corner. - -You should now be back at the main screen. In the upper left, there should be a dashed green circle around the Extension number. After a few seconds, it should become solid green. This indicates that the account is registered on the server. - -## Configure Push Notifications - -* On the main settings screen, tap ```Incoming Calls``` -* Then tap ```Push Notifications``` at the top of the screen. - -This sets up Push Notifications for Groundwire. - -## Configure Voicemail - -This one is a bit tricky. It doesn't make sense on why all these switches are in different places, but here goes. - -* Click the gear in the upper right hand corner of the screen. -* Tap ```Preferences``` -* Tap ```Controls``` -* Scroll down till you see ```Always show Voicemail button``` and enable that switch. -* Hit ```Done``` -* Go back into the ```Settings``` Gear. -* Tap ```Accounts```. -* Tap the little blue ```information``` circle next to the account you want to edit. -* Tap ```Advanced Settings``` -* Scroll down to ```Voicemail Number``` and enter \*97 there. -* Tap ```Done``` -* Tap ```Settings``` and then Tap ```Done``` and this will bring you back to the main dial screen. -* You should now have a blue voicemail button at the bottom of your dial pad screen. If you tap this, it will dial your voicemail box and let you retreieve voicemails. +## Configuring + +!!! tip "Configure Groundwire..." + + **Configuring** + + * First download the client from the appropriate App Store. + * Once it is downloaded, open it on your device. It will either open right to the settings screen or to the quickdial tab. If it is not on the settings screen, click the gear in the upper right hand corner of the screen. + * On the Settings screen, tap the `Accounts` Option and then click the `+` in the upper right hand corner top add a new account. + * On the next screen, select the `Generic SIP Account` Option. + * You should now be on the `New Account` Screen. Here is where you will configure the account to connect to HOIP. You will need to enter the following in the fields: + * `Title` - This is the name of the account you are setting up. Suggested is your extension number (the actual extension) on HOIP. + * `Username` - This is the (actual) extension number of your account. + * `Password` - This is the password sent in your user credentials email from the HOIP system. + * `Domain` - This is the `domain:port` of the server you are getting an account on. This will be in the email you received from the HOIP system. An example would be `pbx-us1.hamsoverip.com:5160`. + * `Display Name` - This is optional, but this would be the name you would want displayed on the other end. + * Once you have all of these set, Tap `Save`. + * Then tap `Settings` in the upper left corner. + * Finally tap `Done` in the upper right corner. + + You should now be back at the main screen. In the upper left, there should be a dashed green circle around the Extension number. After a few seconds, it should become solid green. This indicates that the account is registered on the server. + + **Push Notifications** + + * On the main settings screen, tap `Incoming Calls` + * Then tap `Push Notifications` at the top of the screen. + + This sets up Push Notifications for Groundwire. + + **Voicemail** + + This one is a bit tricky. It doesn't make sense on why all these switches are in different places, but here goes. + + * Click the gear in the upper right hand corner of the screen. + * Tap `Preferences` + * Tap `Controls` + * Scroll down till you see `Always show Voicemail button` and enable that switch. + * Hit `Done` + * Go back into the `Settings` Gear. + * Tap `Accounts`. + * Tap the little blue `information` circle next to the account you want to edit. + * Tap `Advanced Settings` + * Scroll down to `Voicemail Number` and enter \*97 there. + * Tap `Done` + * Tap `Settings` and then Tap `Done` and this will bring you back to the main dial screen. + * You should now have a blue voicemail button at the bottom of your dial pad screen. If you tap this, it will dial your voicemail box and let you retreieve voicemails. ## Troubleshooting -* If the circle goes red, this indicates that the account is not registered on the server. Try turning off your home wifi on your phone and letting it connect via cellular. If it connects, it's an issue with your home wifi. If it does not register, it is a configuration error. -* If you are having a configuration problem, double check your settings on the account screen. Make sure if you copy and pasted there are no spaces in the username or password or anything. This will cause a registration issue. -* If you have tried all the above and it still won't connect over your home wifi (but it will over Cellular) AND this is your only phone (IE no hardline phone), then you might have a CGNAT problem. Please see this part of the [FAQ Document](https://hamsoverip.github.io/wiki/General/user_guides/faq/#the-light-for-my-hoip-extension-is-not-green-its-orange-amber-yellow-and-i-have-not-changed-anything-on-my-end-what-has-happened-or-what-do-i-do). - -Last Updated: 09/02/2022 \ No newline at end of file +!!! warning "Troubleshooting" + + * If the circle goes red, this indicates that the account is not registered on the server. Try turning off your home wifi on your phone and letting it connect via cellular. If it connects, it's an issue with your home wifi. If it does not register, it is a configuration error. + * If you are having a configuration problem, double check your settings on the account screen. Make sure if you copy and pasted there are no spaces in the username or password or anything. This will cause a registration issue. + * If you have tried all the above and it still won't connect over your home wifi (but it will over Cellular) AND this is your only phone (IE no hardline phone), then you might have a CGNAT problem. Please see this part of the [FAQ Document](https://hamsoverip.github.io/wiki/General/user_guides/faq/#the-light-for-my-hoip-extension-is-not-green-its-orange-amber-yellow-and-i-have-not-changed-anything-on-my-end-what-has-happened-or-what-do-i-do). + +---- + +!!! info "Last Updated 2022-02-09" diff --git a/docs/endpoints/soft_phones/jami.md b/docs/endpoints/soft_phones/jami.md index 265798e3..25696854 100644 --- a/docs/endpoints/soft_phones/jami.md +++ b/docs/endpoints/soft_phones/jami.md @@ -4,7 +4,7 @@ Jami is a Free and Open Source (FOSS) solution for a SIP client. They do provide The client is designed as an IM client for business first with calling capablity added later. This will be something to keep in mind when using the client. As such, there is no actual keypad on the screen at first. Once a call is established, there is the option to open a keypad for entering DTMF commands for Voicemail and other things. -There is not a way to add contacts to the application either. +There is not a way to add contacts to the application either. The client is available for all major desktop platforms (Windows, MacOS and Linux) as well as all iOS and Android. (Note that for MacOS, it is also available in the MacOS App Store in addition to being a direct download.) @@ -12,85 +12,92 @@ Each Platform requires slightly different ways to set up, but for the most part, Jami is available for download from: [https://jami.net/download/](https://jami.net/download/) +## Configuring -## Configure for Desktop Platform. +!!! tip "Configure Jami on..." -**Note:** You do not need to setup a Jami account for this to work. DO NOT USE THAT METHOD. This Client will connect directly to a SIP provider. + === "Desktop app" -First you will need to download and install the client to your desktop platform (How that is done varies from platform to platform and is outside the scope of this document). Once it is installed, open the application. + **Configuring** -* When the initial screen comes up asking if you want to ```Join Jami``` or ```I already have an Existing Account``` don't choose either. Look for the option marked ```Advanced Features``` and click that and then click the option that says ```Configure a SIP Account```. -* Enter the information for the fields on the next screen (the configuration screen is a bit wonky, but the fields listed below are the fields as they appear. Make sure to select the correct fields to put information into): - - * ```Server```: This will be the domain name and port sent in your credentials email (ex: ```pbx-us1.hamsoverip.com:5160```) - * ```Proxy```: LEAVE THIS BLANK - * ```Username```: This is your extension sent in your credentials email. - * ```Password```: This is your password sent in your credentials email. + **Note:** You do not need to setup a Jami account for this to work. DO NOT USE THAT METHOD. This Client will connect directly to a SIP provider. -* Click ```Add SIP Account``` -* You're done. You should have a little circle icon in the upper left with a green dot on it. This indicates the account is connected. + First you will need to download and install the client to your desktop platform (How that is done varies from platform to platform and is outside the scope of this document). Once it is installed, open the application. -### Making and Receiving Calls + * When the initial screen comes up asking if you want to `Join Jami` or `I already have an Existing Account` don't choose either. Look for the option marked `Advanced Features` and click that and then click the option that says `Configure a SIP Account`. + * Enter the information for the fields on the next screen (the configuration screen is a bit wonky, but the fields listed below are the fields as they appear. Make sure to select the correct fields to put information into): + + * `Server`: This will be the domain name and port sent in your credentials email (ex: `pbx-us1.hamsoverip.com:5160`) + * `Proxy`: LEAVE THIS BLANK + * `Username`: This is your extension sent in your credentials email. + * `Password`: This is your password sent in your credentials email. -This is where the app is a little lacking, but for a quick easy SIP client, this is still ok. Remember that this client was designed as an IM client first, with the ability to make and receive calls. + * Click `Add SIP Account` + * You're done. You should have a little circle icon in the upper left with a green dot on it. This indicates the account is connected. -**Making a Call** + **Making a Call** -To make a call, you will need to click on the field marked ```Find a User or search for a conversation``` and then type in the extension you want to call and then click on it in the search results. + This is where the app is a little lacking, but for a quick easy SIP client, this is still ok. Remember that this client was designed as an IM client first, with the ability to make and receive calls. -Once this has been done, to the right an IM window will appear and in the top right hand corner, you will see what looks like the handset for a phone. Click that. The Client will start dialing. + To make a call, you will need to click on the field marked `Find a User or search for a conversation` and then type in the extension you want to call and then click on it in the search results. -Once the call has been connected, you will be able to click on a keypad icon in the Ongoing Call window and bring it up. This will allow you to enter commands. + Once this has been done, to the right an IM window will appear and in the top right hand corner, you will see what looks like the handset for a phone. Click that. The Client will start dialing. -**Receiving a Call** + Once the call has been connected, you will be able to click on a keypad icon in the Ongoing Call window and bring it up. This will allow you to enter commands. -When a call comes into the extension, you will be presented with a screen that will allow you to accept or decline the call. + **Receiving a Call** -## Configure for Mobile Platform + When a call comes into the extension, you will be presented with a screen that will allow you to accept or decline the call. -Unfortuantely, it is not as easy to configure this for mobile and there are a couple of hoops you need to jump through. + === "Mobile app" -After installing the app from the appropriate app store, open the app. + **Configuring** -* You will be presented with a new account screen. Unfortuantly, you will need to create a Jami account for this part, however, it is only nessesary to be able to setup the app at first and then add a SIP account. -* Tap on ```Create Jami Account``` -* On the next screen, deselect the ```Register Username``` switch. This will cause the app to create an anonymous username. Leave everything else alone on this screen. -* Tap ```Create Jami Account``` -* On the next screen, tap the screen once and then next, leaving the Display name and Avatar blank. + Unfortuantely, it is not as easy to configure this for mobile and there are a couple of hoops you need to jump through. -At this point you will now be on the main screen, just like on the Desktop Application. It is here we can now add a SIP account. + After installing the app from the appropriate app store, open the app. -* Tap where the random numbers and letters are at the top of the screen. -* You should get a slide up with the option to ```Add Account```. Tap that. -* Here you should see the same screen that you saw at first, but it will now have the option to ```Create a SIP Account```. Tap that. -* Fill in the fields as below: + * You will be presented with a new account screen. Unfortuantly, you will need to create a Jami account for this part, however, it is only nessesary to be able to setup the app at first and then add a SIP account. + * Tap on `Create Jami Account` + * On the next screen, deselect the `Register Username` switch. This will cause the app to create an anonymous username. Leave everything else alone on this screen. + * Tap `Create Jami Account` + * On the next screen, tap the screen once and then next, leaving the Display name and Avatar blank. - * ```Enter Username```: This is your extension from the credentials email - * ```Enter Password```: This is the password from the credentials email - * ```Enter Address```: This will be the domain name sent in your credentials email (ex: ```pbx-us1.hamsoverip.com```) - * ```Enter Port```: This will be ```5160``` + At this point you will now be on the main screen, just like on the Desktop Application. It is here we can now add a SIP account. -* Tap ```Create SIP Account``` -* It will again ask you to choose a Display Name and Avatar. This does not effect the outbound calls, so you can skip this by tapping the screen and then clicking ```Next``` + * Tap where the random numbers and letters are at the top of the screen. + * You should get a slide up with the option to `Add Account`. Tap that. + * Here you should see the same screen that you saw at first, but it will now have the option to `Create a SIP Account`. Tap that. + * Fill in the fields as below: -You are finally dropped into the application. + * `Enter Username`: This is your extension from the credentials email + * `Enter Password`: This is the password from the credentials email + * `Enter Address`: This will be the domain name sent in your credentials email (ex: `pbx-us1.hamsoverip.com`) + * `Enter Port`: This will be `5160` -### Making and Receiving Calls + * Tap `Create SIP Account` + * It will again ask you to choose a Display Name and Avatar. This does not effect the outbound calls, so you can skip this by tapping the screen and then clicking `Next` -Unlike the desktop app, once you are in the main part of the app, there is a button that will allow you to place calls just like other SIP Clients. + You are finally dropped into the application. -**Making a Call** + **Making a Call** -To make a call, just tap the dialpad button and then dial the number like normal. + Unlike the desktop app, once you are in the main part of the app, there is a button that will allow you to place calls just like other SIP Clients. -**Receiving a Call** + To make a call, just tap the dialpad button and then dial the number like normal. -When a call comes into the extension, you will be presented with a screen that will allow you to accept or decline the call. + **Receiving a Call** + + When a call comes into the extension, you will be presented with a screen that will allow you to accept or decline the call. ## Troubleshooting -* If the mobile app says registration failed or the green check mark is not on the desktop app, this indicates that the account is not registered on the server. Try turning off your home wifi on your phone and letting it connect via cellular. If it connects, it's an issue with your home wifi. If it does not register, it is a configuration error. -* If you are having a configuration problem, double check your settings on the account screen. Make sure if you copy and pasted there are no spaces in the username or password or anything. This will cause a registration issue. -* If you have tried all the above and it still won't connect over your home wifi (but it will over Cellular) AND this is your only phone (IE no hardline phone), then you might have a CGNAT problem. Please see this part of the [FAQ Document](https://hamsoverip.github.io/wiki/General/user_guides/faq/#the-light-for-my-hoip-extension-is-not-green-its-orange-amber-yellow-and-i-have-not-changed-anything-on-my-end-what-has-happened-or-what-do-i-do). +!!! warning "Troubleshooting" + + * If the mobile app says registration failed or the green check mark is not on the desktop app, this indicates that the account is not registered on the server. Try turning off your home wifi on your phone and letting it connect via cellular. If it connects, it's an issue with your home wifi. If it does not register, it is a configuration error. + * If you are having a configuration problem, double check your settings on the account screen. Make sure if you copy and pasted there are no spaces in the username or password or anything. This will cause a registration issue. + * If you have tried all the above and it still won't connect over your home wifi (but it will over Cellular) AND this is your only phone (IE no hardline phone), then you might have a CGNAT problem. Please see this part of the [FAQ Document](https://hamsoverip.github.io/wiki/General/user_guides/faq/#the-light-for-my-hoip-extension-is-not-green-its-orange-amber-yellow-and-i-have-not-changed-anything-on-my-end-what-has-happened-or-what-do-i-do). + +---- -Last Updated: 09/02/2022 \ No newline at end of file +!!! info "Last Updated 2022-09-02" diff --git a/docs/endpoints/soft_phones/zoiper.md b/docs/endpoints/soft_phones/zoiper.md index 5a1ea3af..7c9a4a09 100644 --- a/docs/endpoints/soft_phones/zoiper.md +++ b/docs/endpoints/soft_phones/zoiper.md @@ -1,106 +1,110 @@ # Configuring Zoiper for HOIP -Zoiper is a free SIP client solution that is available for all platforms. +Zoiper is a free SIP client solution that is available for all platforms. -While the Zoiper Mobile App will work with the service, we do not really recommend using it unless you are willing to accept it's short comings. +While the Zoiper Mobile App will work with the service, we do not really recommend using it unless you are willing to accept it's short comings. -Unless you are using the Paid version of the software, Zoiper does not do a keep alive to keep your connection active. +Unless you are using the Paid version of the software, Zoiper does not do a keep alive to keep your connection active. However, the desktop clients do not have that problem. As long as the application is running, it will remain connected to your extension. Zoiper is available for download from: [https://www.zoiper.com/](https://www.zoiper.com/) -## Configure for the Desktop Platform +## Configuring -First you will need to download and install the desktop version of the application for whatever platform you want to use it on. +!!! tip "Configure Zoiper on..." -Once that is done, open the application. The first thing you should see is a splash screen asking if you want to ```Activate your PRO License```. You do not. At the very bottom of that splash screen should be a link that says ```Continue as a Free User```. That is what we want to do, so click that. + === "Desktop app" -On the next screen it should show 2 fields (in this order): + First you will need to download and install the desktop version of the application for whatever platform you want to use it on. -* ```Username/Login```: This will be your extension from the credentials email that you rececived. -* ```Password```: This will be your extension password from the crednetials email that you received. + Once that is done, open the application. The first thing you should see is a splash screen asking if you want to `Activate your PRO License`. You do not. At the very bottom of that splash screen should be a link that says `Continue as a Free User`. That is what we want to do, so click that. -Fill those in and click ```Login``` + On the next screen it should show 2 fields (in this order): -On the next screen you will be asked for: + * `Username/Login`: This will be your extension from the credentials email that you rececived. + * `Password`: This will be your extension password from the crednetials email that you received. -```Hostname```: This will be the domain name and port from the crednetials email that you received. (ex: ```pbx-us1.hamsoverip.com:5160```) + Fill those in and click `Login` -Fill that in and click next. On the next screen it will ask you for an outbound proxy. This is not needed so click ```Skip```. + On the next screen you will be asked for: -On the next screen it will check all the protocols and encryption types. It should find ```SIP UDP``` and that bar should go green. Once it does, click ```Next```. + `Hostname`: This will be the domain name and port from the credentials email that you received. (ex: `pbx-us1.hamsoverip.com:5160`) -Next it will ask you to configure your speakers/mic/video camera. You can go through this or you can skip it if you want. + Fill that in and click next. On the next screen it will ask you for an outbound proxy. This is not needed so click `Skip`. -Finally we are to the main screen. You should see at the top of the window a SIP Address and a green check mark. This means you are connected to your extension. + On the next screen it will check all the protocols and encryption types. It should find `SIP UDP` and that bar should go green. Once it does, click `Next`. -### Making and Receiving Calls + Next it will ask you to configure your speakers/mic/video camera. You can go through this or you can skip it if you want. -**Making Calls** + Finally we are to the main screen. You should see at the top of the window a SIP Address and a green check mark. This means you are connected to your extension. -To make a call, click on the find a contact search field and enter the extension you wish to call. You can also hit the icon of a dial pad next to that field and use your mouse to click the buttons to dial the number as well. + ### Making Calls (Desktop) -**Receiving Calls** + To make a call, click on the find a contact search field and enter the extension you wish to call. You can also hit the icon of a dial pad next to that field and use your mouse to click the buttons to dial the number as well. -To receive a call, you will need to have the application open. It can be minimized, but it needs to be running to accpet incoming calls. + ### Receiving Calls (Desktop) -**Adding Contacts** + To receive a call, you will need to have the application open. It can be minimized, but it needs to be running to accpet incoming calls. -The Desktop version of Zoiper does allow you to enter and save your own contacts. + ### Adding Contacts (Desktop) -To add a contact, click the plus button and fill in the information in the fields. + The Desktop version of Zoiper does allow you to enter and save your own contacts. -## Configure the Mobile App + To add a contact, click the plus button and fill in the information in the fields. -To configure the mobile app, you will need to download and install the app from the appropriate App Store. + === "Mobile app" -Once that is done, open the app. It will ask you for permissions to access varous aspects of your mobile device like Microphone and contacts. Give permissions as you see fit. + To configure the mobile app, you will need to download and install the app from the appropriate App Store. -Once that is done, you should be on the main screen. This should have a large dial pad int he middle of the screen and a large green call button in the middle. At the bottom should be some icons. The last icon to the right should be a gear icon marked ```Settings```. Tap that. + Once that is done, open the app. It will ask you for permissions to access varous aspects of your mobile device like Microphone and contacts. Give permissions as you see fit. -This should bring you to the Settings Screen. + Once that is done, you should be on the main screen. This should have a large dial pad int he middle of the screen and a large green call button in the middle. At the bottom should be some icons. The last icon to the right should be a gear icon marked `Settings`. Tap that. -* Tap ```Accounts``` -* Tap the ```+``` plus sign in the upper right corner to add a new account. + This should bring you to the Settings Screen. - * It will ask you ```Do you already have an account (username and password)?``` tap ```Yes``` + * Tap `Accounts` + * Tap the `+` plus sign in the upper right corner to add a new account. -* Tap ```Manual Configuration``` -* Tap ```SIP Account``` -* Fill in the following: + * It will ask you `Do you already have an account (username and password)?` tap `Yes` - * ```Account Name```: This is what you want to call the account. This can be anything, it is just a place holder to show the name of the account you are using. Suggested using your Extension Number. - * ```Domain```: This is the domain and port number of the server sent to you in the crednetials email you received. - * Example: ```pbx-us1.hamsoverip.com:5160``` - * ```Username```: This is the extension in your credentials email. - * ```Password```: This is the password in your crednetials email. - * The rest of the fields/settings can be left at default. + * Tap `Manual Configuration` + * Tap `SIP Account` + * Fill in the following: -* Tap ```Register``` + * `Account Name`: This is what you want to call the account. This can be anything, it is just a place holder to show the name of the account you are using. Suggested using your Extension Number. + * `Domain`: This is the domain and port number of the server sent to you in the crednetials email you received. + * Example: `pbx-us1.hamsoverip.com:5160` + * `Username`: This is the extension in your credentials email. + * `Password`: This is the password in your crednetials email. + * The rest of the fields/settings can be left at default. -Once the registration process is completed, it should show ```Registration Status: OK``` across the top. This means that you are connected to your extension on the server. + * Tap `Register` -Go back to the dialpad screen. You should see the name of the account and a little ```Ready``` in green. This indicates that you are registered on the server. + Once the registration process is completed, it should show `Registration Status: OK` across the top. This means that you are connected to your extension on the server. -### Making and Receiving Calls + Go back to the dialpad screen. You should see the name of the account and a little `Ready` in green. This indicates that you are registered on the server. -**Making Calls** + ### Making Calls (Mobile) -On the dial pad screen tap out the number you wish to call and tap the big green ```Call``` button. You should dial out and make a connection. + On the dial pad screen tap out the number you wish to call and tap the big green ```Call``` button. You should dial out and make a connection. -**Receiving Calls** + ### Receiving Calls (Mobile) -To receive a call, you will need to have the app open on your device. + To receive a call, you will need to have the app open on your device. -**Adding Contacts** + ### Adding Contacts (Mobile) -Zoiper will need access to your devices address book to allow you to add contacts or be able to view contacts. + Zoiper will need access to your devices address book to allow you to add contacts or be able to view contacts. ## Troubleshooting -* If the mobile app says registration failed or the green check mark is not on the desktop app, this indicates that the account is not registered on the server. Try turning off your home wifi on your phone and letting it connect via cellular. If it connects, it's an issue with your home wifi. If it does not register, it is a configuration error. -* If you are having a configuration problem, double check your settings on the account screen. Make sure if you copy and pasted there are no spaces in the username or password or anything. This will cause a registration issue. -* If you have tried all the above and it still won't connect over your home wifi (but it will over Cellular) AND this is your only phone (IE no hardline phone), then you might have a CGNAT problem. Please see this part of the [FAQ Document](https://hamsoverip.github.io/wiki/General/user_guides/faq/#the-light-for-my-hoip-extension-is-not-green-its-orange-amber-yellow-and-i-have-not-changed-anything-on-my-end-what-has-happened-or-what-do-i-do). - -Last Updated: 09/02/2022 \ No newline at end of file +!!! warning "Troubleshooting" + + * If the mobile app says registration failed or the green check mark is not on the desktop app, this indicates that the account is not registered on the server. Try turning off your home wifi on your phone and letting it connect via cellular. If it connects, it's an issue with your home wifi. If it does not register, it is a configuration error. + * If you are having a configuration problem, double check your settings on the account screen. Make sure if you copy and pasted there are no spaces in the username or password or anything. This will cause a registration issue. + * If you have tried all the above and it still won't connect over your home wifi (but it will over Cellular) AND this is your only phone (IE no hardline phone), then you might have a CGNAT problem. Please see this part of the [FAQ Document](../../General/user_guides/faq.md#the-light-for-my-hoip-extension-is-not-green-its-orange-amber-yellow-and-i-have-not-changed-anything-on-my-end-what-has-happened-or-what-do-i-do). + +---- + +!!! info "Last Updated 2022-02-09" diff --git a/docs/index.md b/docs/index.md index 4670c3cc..8db48775 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,31 +1,36 @@ -# Welcome! +# Hams Over IP Wiki -Welcome to the wiki for the Ham's Over IP VOIP Network! +!["HamsOverIP logo"](https://hamsoverip.com/static/media/banner.fd512c01e82a6f4ed378.webp) -If you are looking for Support help, please check out the [Support Page](https://hamsoverip.github.io/wiki/General/user_guides/support) +## Welcome to the wiki for the Hams Over IP VOIP Network + +!!! tip "Looking for support?" + If you are looking for Support help, please check out the [Support Page](./General/user_guides/support.md) Within these pages you will find a wealth of information about the network and a place where you can find more information about how to operate on the network. -We are of course looking for contributions to this wiki to expand the use of the system. To contribute, please make sure to look at the [Contributing Section](https://hamsoverip.github.io/wiki/wiki/overview) of the wiki on how to contribute. +We are of course looking for contributions to this wiki to expand the use of the system. To contribute, please make sure to look at the [Contributing Section](./wiki/overview.md) of the wiki on how to contribute. + +
-
+!!! note "Wiki Maintainer: Jesse, WH6AV" -The Maintainer of the Wiki is: Jesse, WH6AV + Questions about the Wiki? There are multiple ways to ask them: -Questions about the Wiki? There are multiple ways to ask them: + - :fontawesome-brands-discord: [#wiki-chat](https://discord.com/channels/966060559961296956/975534734157443112) on our Discord server + - :fontawesome-brands-discord: Reach out via DM on Discord to Jesse, WH6AV (@WH6AV - Jesse - 3115069#2552) + - :material-email: [wh6av808(at)gmail(dot)com](mailto:wh6av808@gmail.com) + - :fontawesome-solid-square-phone: 100000 (leave a voicemail if no answer) -* In the Wiki Chat Channel on the Discord Server. -* Reach out via DM on Discord to Jesse, WH6AV (@WH6AV - Jesse - 3115069#2552) -* Email: wh6av808@gmail.com -* HOIP Ext: 100000 (leave a voicemail if no answer) +!!! note "Website Maintainer: Jordan, K4AVG" -
+ Questions/Issues/Concerns about the Website: -The Maintainer of the Website is Jordan, K4AVG + * :fontawesome-brands-discord: Reach out Via DM on Discord to Jordan, K4AVG (@k4avg) + * :fontawesome-solid-square-phone: 100005 -Questions/Issues/Concerns about the Website: +
-* Reach out Via DM on Discord to Jordan, K4AVG (@k4avg) -* Extension 100005 +---- -Last Updated: 07/29/2022 +!!! info "Last Updated 2024-07-09" diff --git a/docs/other/configure-blf.md b/docs/other/configure-blf.md index 68daf400..6de22ca9 100644 --- a/docs/other/configure-blf.md +++ b/docs/other/configure-blf.md @@ -10,21 +10,27 @@ From there, you will need to navigate to the extension you want to edit, be it a When you are at the extension you want to edit, you will need to look for the ```Extended Function``` Field for that line and in that you will place something similiar to the following: -```bash -fnc=sd+blf;ext=@$PROXY;nme=; +``` text +fnc=sd+blf;ext=@$PROXY;sub=@$PROXY;nme=; ``` Where: -* ```fnc=sd+blf;``` - This sets the function of the button for both a speedial and BLF for that button -* ```ext=@$PROXY;``` - This is the extension you want to Speedial/monitor. ```$PROXY``` is a variable that is taken from another part of the phone configuration. Leave that alone. That just basically sets the server. -* ```name=;``` This sets the name of the button that is displayed on the phone screen or the sidecar screen (if it has one). If you are using a sidecar without a screen, this can be omitted for that. -* ***OPTIONAL:*** if you are using a sidecar, you can add ```vid=N``` where N is the number of the line you want to send the call out. In other words, let's say you have a Home VOIP number on line 1 and HOIP on line 2 and you want this button to speedial an extension on HOIP, you would set it to look like ```vid=2```. Otherwise it will default to line 1 of the phone. +* `fnc=sd+blf;` - This sets the function of the button for both a speedial and BLF for that button +* `ext=@$PROXY;` - this corresponds to the `sd` part of the function, and is the extension you want to speeddial. `$PROXY` is a variable that is taken from another part of the phone configuration. Leave that alone. That just basically sets the server. +* `sub=@$PROXY;` - this corresponds to the `blf` part of the function, and is the extension you want to monitor. This is essentially the same as the `ext` section above. +* `name=;` This sets the name of the button that is displayed on the phone screen or the sidecar screen (if it has one). If you are using a sidecar without a screen, this can be omitted for that. +* ***OPTIONAL:*** if you are using a sidecar, you can add `vid=N` where N is the number of the line you want to send the call out. In other words, let's say you have a Home VOIP number on line 1 and HOIP on line 2 and you want this button to speedial an extension on HOIP, you would set it to look like `vid=2`. Otherwise it will default to line 1 of the phone. So an example function string would be: -```bash -fnc=sd+blf;ext=1234@$PROXY;nme=Joe, WA1ABC;vid=2 +``` text +fnc=sd+blf;ext=1234@$PROXY;sub=1234@$PROXY;nme=Joe, WA1ABC;vid=2 ``` -Last Updated: 05/23/2022 \ No newline at end of file +!!! warning "Cross-server BLF" + If your extension is located on one particular server, say US1 (extension beginning with 1), you can only use BLF to monitor lines on the US1 server. You can't use BLF to monitor an EU extension (beginning with 2), for example. + +---- + +!!! info "Last Updated 2024-09-07" diff --git a/docs/other/configure-rf-links.md b/docs/other/configure-rf-links.md index 71802ced..9309f06b 100644 --- a/docs/other/configure-rf-links.md +++ b/docs/other/configure-rf-links.md @@ -20,7 +20,7 @@ You will need to edit the `iax.conf` and `extensions.conf` files. In your `iax.conf` you will need to configure a stanza similar to this: -```ini +```ini title="iax.conf snippet" [stanza-must-match-username] username= type=friend @@ -41,7 +41,7 @@ In your `extensions.conf` you need to configure a stanza similar to below. * ***Note***: you need to change the node numbers shown below to the node that you are having the connection dial into. So, if you configured a private node and if, for example, that node number is 1999, then you would use 1999 in place of 47374 below: -```ini +```ini title="extensions.conf snippet" [hoipphone] exten => 47374,1,answer() exten => 47374,n,Playback(rpt/node) @@ -56,17 +56,17 @@ exten => 47374,n,rpt(47374|P|${CALLSIGN}) exten => 47374,n,rpt,47374|P ``` -***Please be sure you have an FQDN for your network. If you don't know what an FQDN is, please google it. NO IP ADDRESS WILL BE ACCEPTED, as they can change dynamically.*** +***Please be sure you have an Fully-qualified Domain Name (FQDN) for your network. If you don't know what an FQDN is, please research it. IP addresses will not be accepted as part of an IAX2 string, as they can change dynamically.*** Please use an IAX client and test your credentials that you used for HOIP from outside of your network to ensure connectivity. -### Connecting to Ham's Over IP +### Connecting to Hams Over IP Once you have your node configured, you will need to request an ALLSTAR-Link Extension on the HOIP system through the HOIP ticketing system. * Go to [https://hamsoverip.com/](https://hamsoverip.com/) and click "Request a Line". -* If you have an account, sign in and then select `Open a New Ticket`. -* If you do not have an account, then just select `Open a New Ticket`. +* If you have an account, sign in +* Select `Open a New Ticket`. * Fill out the Contact Information Part of the Ticket. * Select the `ALLSTAR-Link Request` Help Topic. * Just note in the `Issue Summary` part that this is a request for a ALLSTAR-Link @@ -79,4 +79,6 @@ Once you have your node configured, you will need to request an ALLSTAR-Link Ext Once your extension is provisioned, you will be emailed with your extension number (which will be the next sequential number in the list) to test and make sure that you can connect to your node. -Last Updated: 2024-06-01 Dave M7TLB +---- + +!!! info "Last Updated 2024-06-01" diff --git a/docs/wiki/contributing.md b/docs/wiki/contributing.md index 0e8621a6..35824d02 100644 --- a/docs/wiki/contributing.md +++ b/docs/wiki/contributing.md @@ -9,51 +9,55 @@ This guide will provide methods to make submissions to the wiki as well as the p Remember, there are some things that you need to keep in mind when submitting new things or changes to the wiki: * The directions must be clear and concise. -* It must be able to be replicated by someone else. Someone should be able to take your document and starting at the top, they should be able to move step by step through it and at the end have the same thing setup as you have. +* It must be able to be replicated by someone else. Someone should be able to take your document and starting at the top, they should be able to move step by step through it and at the end have the same thing setup as you have. * Don't be discouraged if your changes or new item is rejected. It just didn't fit what we needed at the time. If it was rejected, you will be told why and what needs to be done to fix it for it to be included. ## Methods to Contribute ### GitHub Pull Request -If you are familiar with how Git and Github works, or you have used Github before, you can fork and clone the wiki repo [https://github.com/hamsoverip/wiki](https://github.com/hamsoverip/wiki), make a change and do a pull request to submit it back. Once the PR has been reviewed and merged, the change will be deployed to the wiki site automatically. That is all you need to do if you are submitting that way. +If you are familiar with how Git and Github works, or you have used Github before, you can fork and clone the wiki repo [github.com/hamsoverip/wiki](https://github.com/hamsoverip/wiki), make a change and do a pull request to submit it back. Once the PR has been reviewed and merged, the change will be deployed to the wiki site automatically. That is all you need to do if you are submitting that way. This is good for both new items and change requests. -If you have forked and cloned a previous version of the repo, ***PLEASE*** make sure that you merge any outstanding commits from the main repo to your fork and then do a ```git pull``` prior to doing any local editing. This wiki is always in flux and if you do not merge those commits and then do a pull prior to starting editing, you will either miss updates or overwrite things on the repo. It is always good practice to do a merge and a pull prior to starting work on a forked repo anyway. This makes sure you are on the most current ```main``` branch edits. +If you have forked and cloned a previous version of the repo, ***PLEASE*** make sure that you merge any outstanding commits from the main repo to your fork and then do a `git pull` prior to doing any local editing. This wiki is always in flux and if you do not merge those commits and then do a pull prior to starting editing, you will either miss updates or overwrite things on the repo. It is always good practice to do a merge and a pull prior to starting work on a forked repo anyway. This makes sure you are on the most current `main` branch edits. ### Non-Github related way -If you are not familiar with Github, or do not have an account, that is ok. You can still contribute. +If you are not familiar with Github, or do not have an account, that is ok. You can still contribute. -If this is just a change request (in other words something needs to be changed or updated on the wiki), please submit it in the ```Wiki Chat``` channel on Discord. No need to format it or anything. This would be things like "This word is mis-spelled" or "can you add this?" if it is longer, like a rework of an existing document, then please put it into a Markdown Document to make updating easier. +If this is just a change request (in other words something needs to be changed or updated on the wiki), please submit it in the [:fontawesome-brands-discord: #wiki-chat](https://discord.com/channels/966060559961296956/975534734157443112) channel on Discord. No need to format it or anything. This would be things like "This word is mis-spelled" or "can you add this?" if it is longer, like a rework of an existing document, then please put it into a Markdown Document to make updating easier. -If this is a whole new item, it is asked that you make the submission using a Markdown Document. +If this is a whole new item, it is asked that you make the submission using a Markdown Document. -If you are not familiar with Markdown, it is a very simple way to format text files. In fact, this wiki is actually done in Markdown. +??? tip "Not familiar with Markdown?" + If you are not familiar with Markdown, it is a very simple way to format text files. In fact, this wiki is actually done in Markdown. -Markdown makes documentation much easier as it is easier to format commands and such in a way that is familiar. + Markdown makes documentation much easier as it is easier to format commands and such in a way that is familiar. -A Markdown Primer can be found [here](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). + A Markdown Primer can be found [here](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). #### Submission -If you are not using Github to do a pull request, to submit the file, please upload the file to the ```Wiki Chat``` channel on Discord. The person in charge of the Wiki will take it and review it. +If you are not using Github to do a pull request, to submit the file, please upload the file to the [:fontawesome-brands-discord: #wiki-chat](https://discord.com/channels/966060559961296956/975534734157443112) channel on Discord. The Wiki Maintenance team will take it and review it. ## Approval Process -Once the change has been submitted, the document will be reviewed. If more clarification is needed, changes will be asked for and the updated file resubmitted. Once everything is in order, the change will be approved and the submission included in the wiki. +Once the change has been submitted, the document will be reviewed. If more clarification is needed, changes will be asked for and the updated file resubmitted. Once everything is in order, the change will be approved and the submission included in the wiki. -This process is in place to make sure we have very good and complete documentation on things. It does no good to have a wiki and have things that do not work. But at the same time, if you want to make a submission, be thorough. Go through the process of creating the documentation. +This process is in place to make sure we have very good and complete documentation on things. It does no good to have a wiki and have things that do not work. But at the same time, if you want to make a submission, be thorough. Go through the process of creating the documentation. ## Tips for Submission -* Look though the Markdown Primer linked above. -* Look at the Github repo (it's a public repo) for the HOIP Wiki to use documents as examples of how to proceed and how to structure your document [https://github.com/hamsoverip/wiki](https://github.com/hamsoverip/wiki). -* If you have questions, ask. That is what the Wiki Chat is for in Discord. Or reach out to Jeff, N8ACL on Discord directly (@Ravendos#7364). +* Look though the Markdown Primer linked above. +* Look at the Github repo (it's a public repo) for the HOIP Wiki to use documents as examples of how to proceed and how to structure your document [github.com/hamsoverip/wiki](https://github.com/hamsoverip/wiki). +* If you have questions, ask. That is what the [:fontawesome-brands-discord: #wiki-chat](https://discord.com/channels/966060559961296956/975534734157443112) is for in Discord. * Please do not submit anything other then a Markdown Document. This will get your submission rejected right off the bat till it is in the correct format. ## Tips and Tricks Learned about MKDocs + * Typically in Markdown, you only need to indent 2 spaces for nested lists. Apparently in MKDocs, you need to indent 4 Spaces. The upstream provider for the Markdown Plugin for MKDocs has decided to die on a hill and say this is not a bug, which sadly it is. So when doing nested lists (sub points in a list) make sure to indent them 4 spaces. -Last Updated: 07/28/2022 \ No newline at end of file +---- + +!!! info "Last Updated 2024-07-09" diff --git a/docs/wiki/overview.md b/docs/wiki/overview.md index 1536f30d..83e49944 100644 --- a/docs/wiki/overview.md +++ b/docs/wiki/overview.md @@ -1,24 +1,26 @@ # Wiki Overview -See the [Contributing Guide](https://hamsoverip.github.io/wiki/wiki/contributing/) on how to submit content to the wiki. +See the [Contributing Guide](./contributing.md) on how to submit content to the wiki. ## Objectives of This Wiki In order to contribute to the wiki, you need to understand what the wiki is and the objective behind the wiki. -**What we are trying to do** +## What we are trying to do * We are trying to create a series of documents describing the system and its functions. * A place where people can go to get answers for questions about the system. * Create a set of tools and guides for people to be able to operate on the system. * A place to reference advanced techniques on interacting with the system. -**What we are not trying to do** +## What we are not trying to do * We are not looking to include all steps and references for everything - * For example, while we provide the ability to connect an Allstar Node to the system, we are not going to include how to setup an Allstar Node from scratch. There are plenty of other guides on the internet on how to do that. + * For example, while we provide the ability to connect an Allstar Node to the system, we are not going to include how to setup an Allstar Node from scratch. There are plenty of other guides on the internet on how to do that. * We are not trying to be the end all and be all for other VOIP system support. Ultimately we are trying to provide a place where we can encourage the alternative use of existing technology in Amateur Radio Applications. -Last Updated: 07/29/2022 +---- + +!!! info "Last Updated 2024-07-09" diff --git a/mkdocs.yml b/mkdocs.yml index 74ffd059..f4776e5c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,6 +6,7 @@ repo_url: https://github.com/hamsoverip/wiki theme: name: 'material' features: + - content.code.copy - content.tooltips # features: # - navigation.expand @@ -109,7 +110,7 @@ nav: - OBi202: endpoints/hard_phones/OBi202.md - Polycom: - - Polycom VVX4xx Series: endpoints/hard_phones/PolycomVVX4xx.md + - Polycom VVX-4xx/5xx Series: endpoints/hard_phones/PolycomVVX4xx.md - Yealink: - Yealink T4 Series: endpoints/hard_phones/YealinkT4X.md