Skip to content

Commit

Permalink
deploy: 2fd1be6
Browse files Browse the repository at this point in the history
  • Loading branch information
iplahte committed Apr 15, 2024
0 parents commit 20ca8b2
Show file tree
Hide file tree
Showing 256 changed files with 31,620 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d725489c5302e763c1be6c7822f5775b
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/apiref.doctree
Binary file not shown.
Binary file added .doctrees/building.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/faq.doctree
Binary file not shown.
Binary file added .doctrees/features.doctree
Binary file not shown.
Binary file added .doctrees/history.doctree
Binary file not shown.
Binary file added .doctrees/howto.doctree
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/installing.doctree
Binary file not shown.
Binary file added .doctrees/maintenance.doctree
Binary file not shown.
Binary file added .doctrees/monitoring.doctree
Binary file not shown.
Binary file added .doctrees/planning.doctree
Binary file not shown.
Binary file added .doctrees/restapi.doctree
Binary file not shown.
Binary file added .doctrees/setupscript.doctree
Binary file not shown.
Binary file added .doctrees/soapapi.doctree
Binary file not shown.
Binary file added .doctrees/troubleshooting.doctree
Binary file not shown.
Binary file added .doctrees/webui.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
4 changes: 4 additions & 0 deletions _downloads/ca0c143bed6e39623be3a2bd971bda8a/100reldisable.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<polycomConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="polycomConfig.xsd">
<voIpProt.SIP voIpProt.SIP.supportFor100rel="0" />
</polycomConfig>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<polycomConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="polycomConfig.xsd">
<call call.DefaultTransferType="Blind">
</call>
</polycomConfig>
Binary file added _images/auto_refresh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/bridge_transport.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/devicefiles_unmanagedtftp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/devices_gw_addnew.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/devices_phone_addnew.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/devices_phonegrp_addnew.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/devices_tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_about.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_alarms_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_alarms_groups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_alarms_history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_alarms_traps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_audit_history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_audit_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_banned.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_cdr_active.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_cdr_historic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_cdr_reports.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_jobs_failed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_jobs_success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_pcap_configure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_pcap_logfiles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_regs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_snapshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/diagnostics_trunkstat.png
Binary file added _images/enum_domain.png
Binary file added _images/ezuce_enum.png
Binary file added _images/features_authcode.png
Binary file added _images/features_authcode_authcode.png
Binary file added _images/features_autoatt.png
Binary file added _images/features_autoatt_att.png
Binary file added _images/features_callback.png
Binary file added _images/features_callpark.png
Binary file added _images/features_callqueue.png
Binary file added _images/features_conf1.png
Binary file added _images/features_conf2.png
Binary file added _images/features_huntgroup.png
Binary file added _images/features_intercom.png
Binary file added _images/features_moh.png
Binary file added _images/features_paging1.png
Binary file added _images/features_paging2.png
Binary file added _images/features_paging3.png
Binary file added _images/features_phonebook1.png
Binary file added _images/features_phonebook2.png
Binary file added _images/features_tab.png
Binary file added _images/firmware_release_notes.png
Binary file added _images/firmware_release_notes_vvx.png
Binary file added _images/group_versiondropdown.png
Binary file added _images/interconnect_trunk1.png
Binary file added _images/interconnect_trunk2.png
Binary file added _images/interconnect_trunk3.png
Binary file added _images/interconnect_trunk4.png
Binary file added _images/interconnect_trunk5.png
Binary file added _images/interconnect_trunk6.png
Binary file added _images/interconnect_trunk7.png
Binary file added _images/interconnect_trunk8.png
Binary file added _images/moh_user.png
Binary file added _images/mwi_subscription.png
Binary file added _images/nagios_nrpe.png
Binary file added _images/phone_versiondropdown.png
Binary file added _images/phoneprofile_customconfigs.png
Binary file added _images/proxy_loglevelinfo.png
Binary file added _images/setup_script_dns.png
Binary file added _images/showadvanced.png
Binary file added _images/speeddial_presence.png
Binary file added _images/superadmin_pwd.png
Binary file added _images/system_db_dbs.png
Binary file added _images/system_db_settings.png
Binary file added _images/system_dialing.png
Binary file added _images/system_maintenance_backup_ftp.png
Binary file added _images/system_maintenance_backup_local.png
Binary file added _images/system_maintenance_export.png
Binary file added _images/system_maintenance_import.png
Binary file added _images/system_maintenance_restore_ftp.png
Binary file added _images/system_maintenance_restore_restore.png
Binary file added _images/system_maintenance_restore_upload.png
Binary file added _images/system_maintenance_restore_upload1.png
Binary file added _images/system_security_certificate_webcsr.png
Binary file added _images/system_security_firewall_groups.png
Binary file added _images/system_security_firewall_ratelimit.png
Binary file added _images/system_security_firewall_rules.png
Binary file added _images/system_security_firewall_settings.png
Binary file added _images/system_security_sipsecurity_settings.png
Binary file added _images/system_servers_addserver.png
Binary file added _images/system_servers_addserver1.png
Binary file added _images/system_servers_addserver4.png
Binary file added _images/system_servers_addserver5.png
Binary file added _images/system_servers_addserver6.png
Binary file added _images/system_servers_coreservices.png
Binary file added _images/system_servers_deviceprovisioning.png
Binary file added _images/system_servers_instantmessaging.png
Binary file added _images/system_servers_server_services.png
Binary file added _images/system_servers_servers.png
Binary file added _images/system_servers_telephonyservices.png
Binary file added _images/system_servers_utilityservices.png
Binary file added _images/system_services_cdr.png
Binary file added _images/system_services_conferenceevent.png
Binary file added _images/system_services_dns_advisor.png
Binary file added _images/system_services_dns_customrecord1.png
Binary file added _images/system_services_dns_customrecord2.png
Binary file added _images/system_services_dns_failover.png
Binary file added _images/system_services_dns_recordview1.png
Binary file added _images/system_services_dns_recordview2.png
Binary file added _images/system_services_dns_recordview3.png
Binary file added _images/system_services_dns_settings.png
Binary file added _images/system_services_ftp.png
Binary file added _images/system_services_im.png
Binary file added _images/system_services_lw.png
Binary file added _images/system_services_ms1.png
Binary file added _images/system_services_ms2.png
Binary file added _images/system_services_ms3.png
Binary file added _images/system_services_mwi.png
Binary file added _images/system_services_mybuddy.png
Binary file added _images/system_services_pp1.png
Binary file added _images/system_services_pp2.png
Binary file added _images/system_services_pp3.png
Binary file added _images/system_services_proxy.png
Binary file added _images/system_services_proxy_stats.png
Binary file added _images/system_services_redis.png
Binary file added _images/system_services_reg.png
Binary file added _images/system_services_rest.png
Binary file added _images/system_services_rls.png
Binary file added _images/system_services_saa.png
Binary file added _images/system_services_snmp.png
Binary file added _images/system_services_trunk1.png
Binary file added _images/system_services_trunk2.png
Binary file added _images/system_services_voicemail.png
Binary file added _images/system_settings_admin.png
Binary file added _images/system_settings_auth1.png
Binary file added _images/system_settings_auth2.png
Binary file added _images/system_settings_devicezone.png
Binary file added _images/system_settings_didpool.png
Binary file added _images/system_settings_domain.png
Binary file added _images/system_settings_extpool.png
Binary file added _images/system_settings_inetcalling.png
Binary file added _images/system_settings_localization.png
Binary file added _images/system_settings_location.png
Binary file added _images/system_settings_nat1.png
Binary file added _images/system_settings_nat2.png
Binary file added _images/system_settings_nat3.png
Binary file added _images/system_settings_ntpsettings.png
Binary file added _images/system_settings_ntpunmanaged.png
Binary file added _images/system_settings_ntpzone.png
Binary file added _images/system_settings_perms.png
Binary file added _images/system_settings_region.png
Binary file added _images/system_tab.png
Binary file added _images/user_sharedlines.png
Binary file added _images/user_usergroup.png
Binary file added _images/user_usergroup_settings.png
Binary file added _images/users_phantom.png
Binary file added _images/users_tab.png
Binary file added _images/wireshark1.png
Binary file added _images/wireshark2.png
Binary file added _images/wireshark3.png
Binary file added _images/wireshark4-ladder.png
Binary file added _images/wireshark5-playstreams.png
Binary file added _images/wireshark6-prepfilter.png
Binary file added _images/wireshark7-export1.png
Binary file added _images/wireshark8-export2.png
17 changes: 17 additions & 0 deletions _sources/apiref.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. index:: API Reference

=============
API Reference
=============

At the heart of the platform are an extensive collection of REST and SOAP web service APIs that enable developers to customize the user experience, or build new applications and integrations.

REST API Refrence
-----------------

:ref:`rest-api-reference`

SOAP API Reference
------------------

:ref:`soap-api-reference`
165 changes: 165 additions & 0 deletions _sources/building.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
.. index:: building

============
Building
============

Server Build
-----------------

You may build sipXcom on a physical server or cloud image where you intend to host the software or create RPMS.

- 2x CPU/vCPU
- 8GB RAM
- 50GB or larger disk
- Minimal CentOS7 OS installation


Docker Build
-----------------

To build sipXcom in a docker image, instantiate a container with the following command:

.. code-block:: bash
docker run -it --hostname=sipxecs --name=sipxecs-centos7 --privileged --env=PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin --label='org.label-schema.build-date=20201113' --label='org.label-schema.license=GPLv2' --label='org.label-schema.name=CentOS Base Image' --label='org.label-schema.schema-version=1.0' --label='org.label-schema.vendor=CentOS' --label='org.opencontainers.image.created=2020-11-13 00:00:00+00:00' --label='org.opencontainers.image.licenses=GPL-2.0-only' --label='org.opencontainers.image.title=CentOS Base Image' --label='org.opencontainers.image.vendor=CentOS' --runtime=runc -d centos:centos7
Prepare Server
-----------------


- Log on as root via ssh

- On first boot you may need to edit */etc/sysconfig/network-scripts/YourNICCard*. Change `ONBOOT="no"` to `ONBOOT="yes"`

- Run `yum update -y`

- Increase Max Number of open files and max user processes for MongoDB (important for larger systems)

- edit */etc/sysctl.conf* to add fs.file-max = 65536 line. ONLY do this if the default returned from `cat /cproc/sys/fs/file-max` is less than 65536.

- edit */etc/security/limits.conf* to add the following block of text:

.. code-block:: bash
* soft nproc 65535
* hard nproc 65535
* soft nofile 65535
* hard nofile 65535`
- Run `reboot`
Update System
-----------------
- Run `yum update -y`
- Run `yum install -y sudo git wget`
Add sipx User
-----------------
sipXcom must be built by a user called *sipx* with sudo privileges. Add the *sipx* user as follows:
- Run `useradd -m sipx`
- If not on docker, run `passwd sipx`
- Run `visudo` and append:
.. code-block:: bash
# add sipx as sudo user
sipx ALL=(ALL) NOPASSWD:ALL
Checkout sipXcom
-----------------
- Run `mkdir /src` and `cd /src`
- Run `git clone https://github.com/onrelay/sipxecs.git`
- Run `chown -R sipx.sipx sipxecs`
Run Master Build Script
-----------------------
- Run `su sipx` to operate as sipx user
- Run `cd /src/sipxecs`
You can now use `sudo ./master-build.sh [options]` to configure and build the source in one step.
This script will create /src/sipxecs/build and /usr/local/sipx directories where all build results are saved.
Building Executables For Current Server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To build on a host server where you intend to run sipXcom, simply run `sudo ./master-build.sh`.
Building RPMs on Docker
~~~~~~~~~~~~~~~~~~~~~~~
To build all rpms on a docker image, simply run `sudo ./master-build.sh --rpm`.
Other Master Build Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Additionally, the master-build.sh script has the following options:
- **-p | --platform**: OS platform of sipxcom RPM to build, e.g. centos-7 (default), rocky-9
- **-a | --architecture**: Hardware architecture of sipxcom RPM to build, e.g. x86_64 (default)
- **-s | --subproject**: subproject to build or sipx for building all RPMs, e.g. sipx (default), sipXconfig, sipXproxy
- **-v | --version**: sipXcom cersion to build, e.g 24.01 (default), 24.07
- **-r | --rpm**: Include this option if building rpms
Advanced Builds
---------------
For more advanced builds, sipXcom relies on GNU autoconf and make mechanisms to build its source. To use these mechanisms directly, you may use the following steps:
- Prepare build folders:
- Run `mkdir -p /src/sipxecs/build`
- Run `cd /src/sipxecs/build`
- Run `sudo mkdir -p /usr/local/sipx`
- Run `sudo chown sipx.sipx /usr/local/sipx`
- To exclude *oss_core* module from build:
- Run `sudo echo oss_core >> .modules-exclude`
- Run `sudo yum install -y oss_core oss_core-devel oss_core-debuginfo`
- Run `sudo mkdir -p /usr/local/sipx/lib`
- Run `sudo ln -s /usr/lib64/liboss_core.la /usr/local/sipx/lib/liboss_core.la`
- Run `sudo ln -s /usr/lib64/liboss_carp.la /usr/local/sipx/lib/liboss_carp.la`
- Run `sudo mkdir -p /usr/local/sipx/opt`
- Run `sudo ln -s /usr/opt/ossapp /usr/local/sipx/opt/ossapp`
- Configure:
- Run `cd /src/sipxecs`
- Run `sudo autoreconf -ivf`
- Run `sudo chown -R sipx.sipx build`
- To build locally:
- Run `cd build`
- Run `sudo ../configure`
- Run `sudo make sipx`
- Create a repo to build RPMs with mock:
- Run `sudo yum install -y createrepo rpm-build mock`
- Run `sudo wget http://li.nux.ro/download/nux/misc/el7/x86_64/thttpd-2.25b-33.el7.nux.x86_64.rpm`
- Run `sudo rpm -ivh thttpd-2.25b-33.el7.nux.x86_64.rpm`
- Run `rm -f thttpd-2.25b-33.el7.nux.x86_64.rpm`
- Run `sudo usermod -a -G mock sipx`
- Run e.g. `sudo ../configure --enable-rpm DISTRO="centos-7-x86_64"`
- Run `sudo make sipx.rpm` (run `sudo chown -R sipx.sipx repo` if it gives a permission error on first try)
Resolving Dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If compilation stops for a subproject, it is possible to list all its dependencies:
- E.g. run `cd /src/sipxecs/sipXproxy`
- Run `grep -R '^BuildRequires' | awk '{print $2}'`
16 changes: 16 additions & 0 deletions _sources/faq.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
***
FAQ
***

Why sipxcom over asterisk, freepbx, etc?
----------------------------------------

The biggest difference is sipxcom proxy is a `stateless proxy <https://tools.ietf.org/html/rfc3261#page-116>`_, where other proxies such as Asterisk are `B2BUAs <https://tools.ietf.org/html/rfc7092>`_.

This means sipxcom is only involved in the call setup. It is never involved in relaying audio or video (RTP) media unless you're using a b2bua function, like :ref:`conferencing` , :ref:`voicemail`, :ref:`auto-attendants`, or :ref:`call-queue`.
Once there is a 200 OK with SDP to a INVITE, and ACK to the 200 OK with SDP, the media (RTP) is direct between phone to phone.

Because of this sipxcom (on sufficient hardware) can handle 10s of thousands of SIP transactions per second, per proxy instance. Some services such as proxy and registrar can run on multiple servers, increasing capability and reliability.

Compare against Asterisk where `their wiki <https://wiki.asterisk.org/wiki/display/~mmichelson/SIP+performance+notes>`_ indicates the calls per second rate is somewhere between 30 to 40 on a HP DL360, and it is standalone.
At the time of this writing, that wiki entry was last modified Jan 31st of 2011. In 2011 a (Gen 7) HP DL360 would support a max of two Intel socket FCLGA1366 (Xeon 55xx) processors and 384GB of RAM.
Loading

0 comments on commit 20ca8b2

Please sign in to comment.