From 7694dab673f02d0e1eb826ce26194d8c889d97b5 Mon Sep 17 00:00:00 2001 From: Dmitry Date: Sat, 11 Jan 2025 23:39:06 +0200 Subject: [PATCH 1/2] add spellcheck --- .github/workflows/tests.yml | 5 +- Makefile | 3 + en/Makefile | 5 + en/best-practices/numbers-translations.rst | 10 +- en/best-practices/teams-direct-routing.rst | 8 +- en/cdr-export.rst | 2 +- en/conf.py | 13 +- en/database-tuning.rst | 14 +- en/disconnect-codes.rst | 2 +- en/general.rst | 22 +- .../installation-1.12/cdr-database.rst | 4 +- .../installation-1.12/release-notes.rst | 2 +- .../installation-1.12/routing-database.rst | 4 +- en/installation/installation-1.12/web.rst | 2 +- .../installation-1.13/cdr-database.rst | 4 +- .../installation-1.13/release-notes.rst | 4 +- .../installation-1.13/routing-database.rst | 4 +- .../installation-1.13/upgrade-from-1.12.rst | 4 +- en/installation/installation-1.13/web.rst | 2 +- en/quick-start/quick_start.rst | 14 +- en/sems/sems-module-codecs.rst | 12 +- en/sems/sems-module-di_log.rst | 2 +- en/sems/sems-module-jsonrpc.rst | 2 +- en/sems/sems-module-yeti.rst | 2 +- en/sems/sems.rst | 20 +- en/spelling_wordlist.txt | 213 ++++++++++++++++++ .../billing/invoice_templates.rst | 20 +- en/web-interface/billing/invoices.rst | 4 +- en/web-interface/cdr/cdr-history.rst | 6 +- en/web-interface/cdr/cdr-partitions.rst | 4 +- en/web-interface/cdr/rtp-statistics.rst | 8 +- .../equipment/disconnect_policy_codes.rst | 7 +- en/web-interface/equipment/gateways.rst | 30 +-- .../equipment/radius_accounting_profiles.rst | 2 +- .../equipment/radius_auth_profiles.rst | 8 +- en/web-interface/equipment/registrations.rst | 2 +- en/web-interface/general.rst | 2 +- en/web-interface/logs/api_log.rst | 4 +- en/web-interface/logs/log_partitions.rst | 2 +- en/web-interface/reports/bad_routing.rst | 2 +- .../reports/custom_cdr_report.rst | 6 +- en/web-interface/routing/customers-auths.rst | 6 +- en/web-interface/routing/index.rst | 4 +- .../routing/yeti-ui-routing-area_prefixes.rst | 2 +- .../routing/yeti-ui-routing-destinations.rst | 2 +- ...-ui-routing-routing_plan_static_routes.rst | 2 +- .../routing/yeti-ui-routing-routing_plans.rst | 4 +- .../routing/yeti-ui-routing-routing_tags.rst | 18 +- en/web-interface/system/nodes.rst | 4 +- .../system/yeti-ui-system-admin_users.rst | 2 +- .../yeti-ui-system-background_tasks.rst | 2 +- .../yeti-ui-system-disconnect_codes.rst | 4 +- .../yeti-ui-system-global_configuration.rst | 4 +- .../system/yeti-ui-system-jobs.rst | 2 +- .../system/yeti-ui-system-networks.rst | 2 +- .../yeti-ui-system-networks_prefixes.rst | 4 +- .../yeti-ui-system-smtp_connections.rst | 2 +- .../yeti-ui-rtd-outgoing_registrations.rst | 2 +- en/yeti-cli/commands.rst | 16 +- en/yeti-cli/index.rst | 2 +- en/yeti-cli/installation.rst | 6 +- en/yeti-client/configuration.rst | 2 +- en/yeti-client/installation.rst | 2 +- 63 files changed, 411 insertions(+), 169 deletions(-) create mode 100644 en/spelling_wordlist.txt diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index e7e6090..ff6d99e 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -11,11 +11,14 @@ jobs: steps: - uses: actions/checkout@v2 - name: install sphinx - run: pip install sphinx sphinx_rtd_theme sphinxcontrib-mermaid sphinxcontrib.googleanalytics sphinxcontrib-video + run: pip install sphinx sphinx_rtd_theme sphinxcontrib-mermaid sphinxcontrib.googleanalytics sphinxcontrib-video sphinxcontrib.spelling - name: install graphviz run: sudo apt install graphviz + - name: Run spellcheck + run: make spellcheck + - name: Run linkcheck run: make linkcheck diff --git a/Makefile b/Makefile index 443101b..1063b2a 100644 --- a/Makefile +++ b/Makefile @@ -11,6 +11,9 @@ $(langs): linkcheck: make -C $(langs) linkcheck +spellcheck: + make -C $(langs) spelling + clean: $(langs:=-clean) dep: diff --git a/en/Makefile b/en/Makefile index fc85e50..6ef682a 100644 --- a/en/Makefile +++ b/en/Makefile @@ -171,6 +171,11 @@ linkcheck: @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." +spelling: + $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Spell check complete; look for any errors in the above output" + doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ diff --git a/en/best-practices/numbers-translations.rst b/en/best-practices/numbers-translations.rst index cda289d..4a9fb18 100644 --- a/en/best-practices/numbers-translations.rst +++ b/en/best-practices/numbers-translations.rst @@ -18,19 +18,19 @@ Yeti has flexible configuration of numbers modifications - it allows to change s In most cases numbers translations implemented using `POSIX Regular Expressions `_. This section describes general principles and examples of using POSIX Regular Expressions in Yeti. -Yeti uses Postgresql `REGEXP_REPLACE(phonenumber, rewrite_rule, rewrite_result) `_ function with following arguments: +Yeti uses PostgreSQL `REGEXP_REPLACE(phonenumber, rewrite_rule, rewrite_result) `_ function with following arguments: phonenumber It is a phone number (source or destination) that replacement should be taken place. rewrite_rule - It is a POSIX regular expression for matching substrings that should be replaced. + It is a POSIX regular expression for matching sub-strings that should be replaced. rewrite_result - It is a string that to replace the substrings which match the *rewrite_rule*. + It is a string that to replace the sub-strings which match the *rewrite_rule*. -The REGEXP_REPLACE() function returns a new phonenumber with the elements, which match a regular expression pattern, replaced by a new substring. +The REGEXP_REPLACE() function returns a new phonenumber with the elements, which match a regular expression pattern, replaced by a new sub-string. Examples @@ -43,7 +43,7 @@ How to add prefix 888 to number |br| **rewrite_result** = 888\\1 - where ^ - matches at the beginning of the phonenumber, $ - matches at the end of the phonenumber, (.*) - regular expression matches a sequence of 0 or more characters, 888 - prefix to add, \\1 - first marked subexpression matched (in our case - it is phone number (source or destination) that replacement should be taken place). Some examples of adding digits to the beginning of the phonenumber with using different arguments are provided below: + where ^ - matches at the beginning of the phonenumber, $ - matches at the end of the phonenumber, (.*) - regular expression matches a sequence of 0 or more characters, 888 - prefix to add, \\1 - first marked sub-expression matched (in our case - it is phone number (source or destination) that replacement should be taken place). Some examples of adding digits to the beginning of the phonenumber with using different arguments are provided below: a) **original phone number** = 7335255 ; **rewrite_rule** = ^(.*)$ ; **rewrite_result** = 0\\1 ; **resulting phone number** = 07335255 b) **original phone number** = 2296132 ; **rewrite_rule** = ^(.*)$ ; **rewrite_result** = 066\\1 ; **resulting phone number** = 0662296132 diff --git a/en/best-practices/teams-direct-routing.rst b/en/best-practices/teams-direct-routing.rst index a8dee51..f1e1c7f 100644 --- a/en/best-practices/teams-direct-routing.rst +++ b/en/best-practices/teams-direct-routing.rst @@ -21,7 +21,7 @@ This part out of scope of this document. You have to complete next steps yoursel * Domain name for SBC address required. Domain name **A record** should point to Yeti load balancer IP address. **SRV** records not supported by MS Teams. - * Valid TLS certificate should be installed on Yeti load balancer. If you planning to using multitenacy on MS Teams side(multiple MS Teams accounts connected to same Yeti-Switch system) you have to use wildcard certificate. See https://learn.microsoft.com/en-us/microsoftteams/direct-routing-plan#public-trusted-certificate-for-the-sbc for details. + * Valid TLS certificate should be installed on Yeti load balancer. If you planning to using multi-tenancy on MS Teams side(multiple MS Teams accounts connected to same Yeti-Switch system) you have to use wildcard certificate. See https://learn.microsoft.com/en-us/microsoftteams/direct-routing-plan#public-trusted-certificate-for-the-sbc for details. #. Validate SBC domain name on Teams side using DNS TXT record according to MS Teams documentation. @@ -73,7 +73,7 @@ Orig Append Headers Reply Should contain **Allow: INVITE, ACK, CANCEL, BYE, INFO, NOTIFY, PRACK, UPDATE, OPTIONS**. Redefining **Allow** header there affects transfer logic on MS Teams side when call originated by MS Teams. Without this settings MS Teams will send **REFER** requests to Yeti-Switch to handle call transfer and it will fail because Yeti-Switch is not processing such requests in this scenario. Term Append Headers Req - Should contain **Allow: INVITE, ACK, CANCEL, BYE, INFO, NOTIFY, PRACK, UPDATE, OPTIONS**. Redefining **Allow** header there affects transfer logic on teams side when call originated by Yeti to MS Teams. In case of multitenant configuration **term append headers req** should also contain **X-RR-Domain: subdomain.teams.example.com**. + Should contain **Allow: INVITE, ACK, CANCEL, BYE, INFO, NOTIFY, PRACK, UPDATE, OPTIONS**. Redefining **Allow** header there affects transfer logic on teams side when call originated by Yeti to MS Teams. In case of multi-tenant configuration **term append headers req** should also contain **X-RR-Domain: subdomain.teams.example.com**. Term Use Outbound Proxy Should be **YES** @@ -82,7 +82,7 @@ Term Proxy Transport Protocol Should be **TLS** Term Outbound Proxy - Shoyld be **subdomain.teams.example.com** + Should be **subdomain.teams.example.com** Media Encryption Mode Should be **SRTP SDES** @@ -122,7 +122,7 @@ Call routing ===================== * Incoming call routing works as usual - call will be authenticated by customer auth matching logic, then routing will be done according to routing plan. -* Outgount call routing works as usual - just create Dialpeer with MS Teams gateway and Yeti will send call to proper trunk. +* Outgoing call routing works as usual - just create Dialpeer with MS Teams gateway and Yeti will send call to proper trunk. diff --git a/en/cdr-export.rst b/en/cdr-export.rst index 35449e3..bcaff81 100644 --- a/en/cdr-export.rst +++ b/en/cdr-export.rst @@ -5,7 +5,7 @@ CDR export configuration ======================== -CDR export feature allows operator to unload CDR from database to CSV file. Yeti uses `Postgresql COPY `_ method for CSV generation, so the file will be saved by postgresql daemon. +CDR export feature allows operator to unload CDR from database to CSV file. Yeti uses `PostgreSQL COPY `_ method for CSV generation, so the file will be saved by PostgreSQL daemon. .. figure:: cdr-export-download.png diff --git a/en/conf.py b/en/conf.py index c2e4af1..a9ae961 100644 --- a/en/conf.py +++ b/en/conf.py @@ -26,10 +26,13 @@ # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ["sphinx.ext.graphviz", "sphinx.ext.mathjax", "sphinxcontrib.mermaid", "sphinxcontrib.googleanalytics", "sphinxcontrib.video"] +extensions = ["sphinx.ext.graphviz", "sphinx.ext.mathjax", "sphinxcontrib.mermaid", "sphinxcontrib.googleanalytics", "sphinxcontrib.video", "sphinxcontrib.spelling"] + +spelling_lang = 'en_US' +tokenizer_lang = 'en_US' +spelling_show_suggestions = True +spelling_ignore_acronyms = True +spelling_word_list_filename = ['spelling_wordlist.txt'] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -306,6 +309,4 @@ googleanalytics_id = "G-1YGEQV43K8" -mermaid_version = "11.4.1" - diff --git a/en/database-tuning.rst b/en/database-tuning.rst index 0eeac06..9eb4730 100644 --- a/en/database-tuning.rst +++ b/en/database-tuning.rst @@ -1,13 +1,17 @@ .. :maxdepth: 2 + +.. spelling:word-list:: + postgresql + .. _database_tuning: ============================ Databases performance tuning ============================ -By default Postgresql RDBMS configured to consume minimal system resources. This approach allows Postgresql to start on any server after installation. YETI as well as any other system uses Postgresql requires changing default configuration in order to archive best performance. +By default PostgreSQL RDBMS configured to consume minimal system resources. This approach allows PostgreSQL to start on any server after installation. YETI as well as any other system uses PostgreSQL requires changing default configuration in order to archive best performance. -We recommends to change next configuration variables at /etc/postgresql/13/yeti/postgresql.conf +We recommends to change next configuration variables at /etc/postgresql/16/yeti/postgresql.conf .. code-block:: ini @@ -18,11 +22,11 @@ We recommends to change next configuration variables at /etc/postgresql/13/yeti/ Set **shared_buffers** variable to 1/3 of total RAM installed to server if you share this server with some another application. For example we recommends install yeti-web on same server as routing database. -If your server is dedicated for postgresql set **shared_buffers** to 2/3 of your RAM. +If your server is dedicated for PostgreSQL set **shared_buffers** to 2/3 of your RAM. -When configuration changed you should restart your postgresql instance using `service postgresql restart` +When configuration changed you should restart your PostgreSQL instance using `service postgresql restart` -.. seealso:: Read Postgresql manual https://www.postgresql.org/docs/13/ to understand postgresql architecture and features +.. seealso:: Read PostgreSQL manual https://www.postgresql.org/docs/16/ to understand RDBMS architecture and features diff --git a/en/disconnect-codes.rst b/en/disconnect-codes.rst index 0324fa4..9eacfb2 100644 --- a/en/disconnect-codes.rst +++ b/en/disconnect-codes.rst @@ -120,7 +120,7 @@ Radius request error Invalid radius profile Invalid radius profile configured Invalid radius response - RADIUS responce has unexpected format + RADIUS response has unexpected format Radius reject RADIUS servers send Access-Reject diff --git a/en/general.rst b/en/general.rst index 93342cb..51f35ef 100644 --- a/en/general.rst +++ b/en/general.rst @@ -14,11 +14,11 @@ YETI — class4 SIP softswitch with integrated billing and intelligent routing s Solution is intended to act as distributed SBC on the networks of the service providers which are working using protocol SIP. System supports a variety of intelligent routing algorithms. -Softswitch handles SIP signalling and RTP traffic. Supports transcoding, detailed CDRs (more than 100 fields) allows to save all parameters which are needed for billing, debugging and analytic reports. +Softswitch handles SIP signaling and RTP traffic. Supports transcoding, detailed CDRs (more than 100 fields) allows to save all parameters which are needed for billing, debugging and analytic reports. Yeti supports intelligent LCR/ASR/ACD routing by various criteria. Below is short list of supported features. -Signalling and RTP processing ------------------------------ +Signaling and RTP processing +---------------------------- - SIP v.2.0 over UDP, TCP and TLS transports - IPv6 support. Flexible resolving configuration - SRTP with DTLS and SDES mechanisms @@ -62,7 +62,7 @@ Authorization - DST, SRC prefixes - SIP R-URI domain - Custom SIP header -- Geolocation of the signalling node +- Geolocation of the signaling node - External RADIUS server Routing @@ -71,7 +71,7 @@ Routing - Re-routing which is transparent for the client. Flexible configuration for the conditions when to use next route - Rewriting or transparent passing of the disconnect codes for the client -- Flexible LCR configuration (quiality control, prices limit). +- Flexible LCR configuration (quality control, prices limit). Possibility of the fast implementation of the any desired alternative algorithm - Capacity control for gateways, destinations, companies, accounts - Source and Destination number based Blacklisting and per number translation rules @@ -88,18 +88,18 @@ Billing - Realtime CDR writing. Possibility to skip CDR write for specific disconnect codes - Realtime traffic blocking when balance limit reached -- Flexible rateplanes configuration and routing policies to provide optimal profitability +- Flexible rateplans configuration and routing policies to provide optimal profitability - Configurable billing intervals, support of the connect fee - Invoices and documents generation from templates - Dynamic price calculation for client from real termination price. This mode useful to sell traffic for the trusted clients at the minimum cost price - Integration with external systems -- Possibility to send CDRs to the external systems (e.g for antifraud analysis) +- Possibility to send CDRs to the external systems (e.g for anti-fraud analysis) - REST API for data modification (in development) - Lawful interception sensors. Allows to configure traffic mirroring to the external equipment without affecting on system work. It's possible to configure different sensors for different call legs and gateways. - At this moment system supports IP-IP and IP over Ethernet incapsulation. + At this moment system supports IP-IP and IP over Ethernet encapsulation. - Support to receive information about upper limit for the rate for the each call from the custom SIP header from the client. - Ability to show information about real termination cost (supplier rates) to the trusted clients, and information about cost for the client ( useful in case of dynamic rate calculation) @@ -122,7 +122,7 @@ Administration Such configuration is fault tolerant to the network and hardware issues, and provides correct CDR billing after reconnection between system parts. - Convenient web-interface with possibility to find simply any system entities. Interface operators modifications logging allows to provide a high level of security. Supported export and import for all system configuration base objects. - Time-consuming tasks are performed in background to prevent blocking of the web-interface. -- All components are developed and packaged for single platform (Debian GNU/Linux) and can be setup/upgraded using standart package manager (apt). +- All components are developed and packaged for single platform (Debian GNU/Linux) and can be setup/upgraded using system package manager (apt). - CLI interface for routing system. Allows to manage all routing nodes and use extended debugging tools. - Recording of the PCAP dumps for the calls to provide simple debugging. Recorded dumps are available through web-interface. - CDRs have big amount of the debugging info. @@ -137,8 +137,8 @@ Yeti consists of the following components: - Switch server (SEMS + YETI module) - Incoming traffic balancer (Kamailio) -- Routing database (Postgresql) -- CDR database (Postgresql) +- Routing database (PostgreSQL) +- CDR database (PostgreSQL) - Realtime data storage(Redis) - Management Web-interface (RoR, ruby) - CLI interface (python) [optional] diff --git a/en/installation/installation-1.12/cdr-database.rst b/en/installation/installation-1.12/cdr-database.rst index d5c24e9..c22c1b0 100644 --- a/en/installation/installation-1.12/cdr-database.rst +++ b/en/installation/installation-1.12/cdr-database.rst @@ -1,5 +1,7 @@ .. :maxdepth: 2 +.. spelling:word-list:: + postgresql ========================== CDR databases installation @@ -17,7 +19,7 @@ CDRs databases require similar set of packages as routing database # apt update && apt install postgresql-13 postgresql-contrib-13 postgresql-13-prefix postgresql-13-pgq3 postgresql-13-pgq-ext postgresql-13-yeti postgresql-13-pllua pgqd -.. warning:: It is important to install Postgresql from `PGDG `_ repository. See :doc:`repositories` for details +.. warning:: It is important to install PostgreSQL from `PGDG `_ repository. See :doc:`repositories` for details diff --git a/en/installation/installation-1.12/release-notes.rst b/en/installation/installation-1.12/release-notes.rst index 340d75c..499b0b0 100644 --- a/en/installation/installation-1.12/release-notes.rst +++ b/en/installation/installation-1.12/release-notes.rst @@ -30,7 +30,7 @@ Upgrading to 1.12.79 In yeti-web version 1.12.79 asynchronous CDR statistics calculation was introduced. This new mechanism requires additional configuration after system upgrade. -Enable CDR Stats add configutation for CDR stats process to **/opt/yeti-web/config/pgq_processors.yml**: +Enable CDR Stats add configuration for CDR stats process to **/opt/yeti-web/config/pgq_processors.yml**: .. code-block:: yaml diff --git a/en/installation/installation-1.12/routing-database.rst b/en/installation/installation-1.12/routing-database.rst index 7eca4a5..a31ff23 100644 --- a/en/installation/installation-1.12/routing-database.rst +++ b/en/installation/installation-1.12/routing-database.rst @@ -1,5 +1,7 @@ .. :maxdepth: 2 +.. spelling:word-list:: + postgresql ============================= Routing database installation @@ -11,7 +13,7 @@ Routing database installation Supported versions ------------------ -The only supported postgresql version is 13. +The only supported PostgreSQL version is 13. Packages installation diff --git a/en/installation/installation-1.12/web.rst b/en/installation/installation-1.12/web.rst index 2f56032..b608c16 100644 --- a/en/installation/installation-1.12/web.rst +++ b/en/installation/installation-1.12/web.rst @@ -8,7 +8,7 @@ WEB interface installation Server requirements: - amd64 architecture -- Debian 11 Bullseye distibution +- Debian 11 Bullseye distribution - at least 4GB of RAM Packages installation diff --git a/en/installation/installation-1.13/cdr-database.rst b/en/installation/installation-1.13/cdr-database.rst index 0881f7d..3568c69 100644 --- a/en/installation/installation-1.13/cdr-database.rst +++ b/en/installation/installation-1.13/cdr-database.rst @@ -1,5 +1,7 @@ .. :maxdepth: 2 +.. spelling:word-list:: + postgresql ========================== CDR databases installation @@ -17,7 +19,7 @@ CDRs databases require similar set of packages as routing database # apt update && apt install postgresql-16 postgresql-contrib-16 postgresql-16-prefix postgresql-16-pgq3 postgresql-16-pgq-ext postgresql-16-yeti postgresql-16-pllua pgqd -.. warning:: It is important to install Postgresql from `PGDG `_ repository. See :doc:`repositories` for details +.. warning:: It is important to install PostgreSQL from `PGDG `_ repository. See :doc:`repositories` for details diff --git a/en/installation/installation-1.13/release-notes.rst b/en/installation/installation-1.13/release-notes.rst index ca6063c..6aec4f2 100644 --- a/en/installation/installation-1.13/release-notes.rst +++ b/en/installation/installation-1.13/release-notes.rst @@ -5,8 +5,8 @@ Release notes ============= * Debian 12 support - * Postgresql 16 support - * Migration to new debian repo + * PostgreSQL 16 support + * Migration to new Debian repo * Ruby upgraded to 3.3.5 * Improved privacy processing * Registrar scalability improvements diff --git a/en/installation/installation-1.13/routing-database.rst b/en/installation/installation-1.13/routing-database.rst index 5e57c1b..8e6c3f2 100644 --- a/en/installation/installation-1.13/routing-database.rst +++ b/en/installation/installation-1.13/routing-database.rst @@ -1,5 +1,7 @@ .. :maxdepth: 2 +.. spelling:word-list:: + postgresql ============================= Routing database installation @@ -11,7 +13,7 @@ Routing database installation Supported versions ------------------ -The only supported postgresql version is 16. +The only supported PostgreSQL version is 16. Packages installation diff --git a/en/installation/installation-1.13/upgrade-from-1.12.rst b/en/installation/installation-1.13/upgrade-from-1.12.rst index afb7f66..32eff49 100644 --- a/en/installation/installation-1.13/upgrade-from-1.12.rst +++ b/en/installation/installation-1.13/upgrade-from-1.12.rst @@ -18,10 +18,10 @@ Upgrade OS Upgrade Debian GNU/Linux to version 12. -Upgrade Postgresql instances +Upgrade PostgreSQL instances ---------------------------- -Upgrade routing and CDR databases instances from Postgresql 13 to Postgresql 16. +Upgrade routing and CDR databases instances from PostgreSQL 13 to PostgreSQL 16. Upgrade yeti-web package diff --git a/en/installation/installation-1.13/web.rst b/en/installation/installation-1.13/web.rst index ee8e6d4..b0266a0 100644 --- a/en/installation/installation-1.13/web.rst +++ b/en/installation/installation-1.13/web.rst @@ -8,7 +8,7 @@ WEB interface installation Server requirements: - amd64 architecture -- Debian 12 Bookworm distibution +- Debian 12 Bookworm distribution - at least 4GB of RAM Packages installation diff --git a/en/quick-start/quick_start.rst b/en/quick-start/quick_start.rst index b8edef7..87d04c3 100644 --- a/en/quick-start/quick_start.rst +++ b/en/quick-start/quick_start.rst @@ -118,7 +118,7 @@ At the fourth step it is necessary to configure: - - at least one :ref:`Dialpeer's ` record that should be associated with :ref:`Routing Group `, :ref:`Vendor `, :ref:`Vendor's Account ` and :ref:`Vendor's Gateway ` that were configured above. In our example we use **380** (international code of Ukraine) as *Prefix* and we'll pay one monetary unit per minute to the Vendor after the initial interval (by default - 1 minute) and 2 monetary units during initial interval. This :ref:`Dialpeer ` will be used as a route for all traffic to ukrainian numbers; + - at least one :ref:`Dialpeer's ` record that should be associated with :ref:`Routing Group `, :ref:`Vendor `, :ref:`Vendor's Account ` and :ref:`Vendor's Gateway ` that were configured above. In our example we use **380** (international code of Ukraine) as *Prefix* and we'll pay one monetary unit per minute to the Vendor after the initial interval (by default - 1 minute) and 2 monetary units during initial interval. This :ref:`Dialpeer ` will be used as a route for all traffic to Ukrainian numbers; .. table:: Example of records filling (only fields that should be changed from default values are shown) :widths: auto @@ -213,7 +213,7 @@ At the last step it is necessary to create some :ref:`Payment's ` reco Amount 50 ============================== ===================== -Fot the call testing it is necessary to fill :ref:`Routing Simulation ` form and to press **Simulate routing** button. +For the call testing it is necessary to fill :ref:`Routing Simulation ` form and to press **Simulate routing** button. .. table:: Example of records filling (only fields that should be changed from default values are shown) :widths: auto @@ -264,7 +264,7 @@ At the first step we'll configure one additional :ref:`Dialpeer's ` r **Step 2. Test the call** -Fot the call testing it is necessary to fill :ref:`Routing Simulation ` form and to press **Simulate routing** button. +For the call testing it is necessary to fill :ref:`Routing Simulation ` form and to press **Simulate routing** button. .. table:: Example of records filling (only fields that should be changed from default values are shown) :widths: auto @@ -278,7 +278,7 @@ Fot the call testing it is necessary to fill :ref:`Routing Simulation ` **Step 3. Test the call** -Fot the call testing it is necessary to fill :ref:`Routing Simulation ` form and to press **Simulate routing** button. +For the call testing it is necessary to fill :ref:`Routing Simulation ` form and to press **Simulate routing** button. .. table:: Example of records filling (only fields that should be changed from default values are shown) :widths: auto @@ -457,7 +457,7 @@ At the fourth step we'll edit :ref:`Dialpeer's ` record that was conf **Step 5. Test the call** -Fot the call testing it is necessary to fill :ref:`Routing Simulation ` form and to press **Simulate routing** button. +For the call testing it is necessary to fill :ref:`Routing Simulation ` form and to press **Simulate routing** button. .. table:: Example of records filling (only fields that should be changed from default values are shown) :widths: auto @@ -541,7 +541,7 @@ At the third step we'll configure one additional :ref:`Dialpeer's ` r **Step 4. Test the call** -Fot the call testing it is necessary to fill :ref:`Routing Simulation ` form and to press **Simulate routing** button. +For the call testing it is necessary to fill :ref:`Routing Simulation ` form and to press **Simulate routing** button. .. table:: Example of records filling (only fields that should be changed from default values are shown) :widths: auto diff --git a/en/sems/sems-module-codecs.rst b/en/sems/sems-module-codecs.rst index 0207f55..27d1b19 100644 --- a/en/sems/sems-module-codecs.rst +++ b/en/sems/sems-module-codecs.rst @@ -13,7 +13,7 @@ Module **opus** implements OPUS codec for SEMS. module "opus"{} -Module doesn't require onfiguration. +Module doesn't require configuration. ============== @@ -28,7 +28,7 @@ Module **gsm** implements GSM codec for SEMS. module "gsm"{} -Module doesn't require onfiguration. +Module doesn't require configuration. =============== @@ -43,7 +43,7 @@ Module **ilbc** implements iLBC codec for SEMS. module "ilbc"{} -Module doesn't require onfiguration. +Module doesn't require configuration. @@ -59,7 +59,7 @@ Module **l16** implements L16 codec for SEMS. module "l16"{} -Module doesn't require onfiguration. +Module doesn't require configuration. @@ -75,7 +75,7 @@ Module **g722** implements L16 codec for SEMS. module "l16"{} -Module doesn't require onfiguration. +Module doesn't require configuration. @@ -91,4 +91,4 @@ Module **g729bcg** implements g729 codec for SEMS. module "g729bcg"{} -Module doesn't require onfiguration. +Module doesn't require configuration. diff --git a/en/sems/sems-module-di_log.rst b/en/sems/sems-module-di_log.rst index d0500a8..a4f969b 100644 --- a/en/sems/sems-module-di_log.rst +++ b/en/sems/sems-module-di_log.rst @@ -7,7 +7,7 @@ Module **di_log** The **di_log** module provides a ring buffer logging facility which on request dumps the ring buffer contents either as result of the DI call or in a file on HD. dumping the ring buffer can be invoked via JSONRPC interface (for example remotely from the stats module). -Ring buffer size and string length can be customized at compile time, see DILog.h. **di_log** module allows to run sems with logleve=3(debug) in production without significant performance loss. +Ring buffer size and string length can be customized at compile time, see DILog.h. **di_log** module allows to run sems with loglevel=3(debug) in production without significant performance loss. .. code-block:: c diff --git a/en/sems/sems-module-jsonrpc.rst b/en/sems/sems-module-jsonrpc.rst index c52a66b..8a5efc7 100644 --- a/en/sems/sems-module-jsonrpc.rst +++ b/en/sems/sems-module-jsonrpc.rst @@ -27,7 +27,7 @@ listen.port TCP port of JSONRPC socket server_threads - How many worker threads will be forked for JSONRPC requets handling + How many worker threads will be forked for JSONRPC requests handling .. note:: :doc:`yeti-cli <../yeti-cli/index>` console is client for SEMS JSONRPC interface. diff --git a/en/sems/sems-module-yeti.rst b/en/sems/sems-module-yeti.rst index 0ac066b..31ea238 100644 --- a/en/sems/sems-module-yeti.rst +++ b/en/sems/sems-module-yeti.rst @@ -6,7 +6,7 @@ Module **yeti** =============== -Module **yeti** implements SBC funtions for Yeti-switch project +Module **yeti** implements SBC functions for Yeti-switch project .. code-block:: c diff --git a/en/sems/sems.rst b/en/sems/sems.rst index 6f059da..9964896 100644 --- a/en/sems/sems.rst +++ b/en/sems/sems.rst @@ -96,8 +96,8 @@ log_events (default: false) log_sessions (default: false) Log new UAC/UAS sessions at the info level -signalling/media -^^^^^^^^^^^^^^^^ +signaling/media +^^^^^^^^^^^^^^^ force_outbound_if (default: false) Force interface index for outgoing SIP and RTP packets. Uses IPPROTO_IP/IP_PKTINFO.ipi_ifindex, IPPROTO_IPV6/IPV6_PKTINFO.ipi6_ifindex for sendmsg @@ -106,25 +106,25 @@ use_raw_sockets (default: false) Global switch to use SOCK_RAW for outgoing SIP/UDP and RTP packets ssl_key_log_file (default: empty) - Write TLS and SRTP secrets to the specified file in SSLKEYLOG format. Useful to decrypt signalling and media in the traces collected by the external tools. + Write TLS and SRTP secrets to the specified file in SSLKEYLOG format. Useful to decrypt signaling and media in the traces collected by the external tools. -signalling -^^^^^^^^^^ +signaling +^^^^^^^^^ session_processor_threads (default: 10) Session processor threads count. Session processor threads handle events from the sessions events queues sip_udp_server_threads (default: 4) - SIP UDP transport workers threads count. UDP transport workers receive UDP signalling traffic + SIP UDP transport workers threads count. UDP transport workers receive UDP signaling traffic sip_tcp_server_threads (default: 4) - SIP TCP transport workers threads count. TCP transport workers handle TCP/TLS/WS/WSS signalling traffic + SIP TCP transport workers threads count. TCP transport workers handle TCP/TLS/WS/WSS signaling traffic sip_nat_handling (default: false) Force SIP dialog Next Hop to be remote ip/port/trsp on requests with single Via header proxy_sticky_auth (default: false) - Force **uac_auth** plugin to always send SIP request to the same endoint that sent auth challenge (avoid DNS and DNS SRV balancing/failover) + Force **uac_auth** plugin to always send SIP request to the same endpoint that sent auth challenge (avoid DNS and DNS SRV balancing/failover) ignore_notify_lower_cseq (default: false) Ignore lower CSeq value for NOTIFY requests. fixes subscription dialog usage for implementations which follow 3265 instead of 5057 @@ -163,7 +163,7 @@ outbound_proxy (default: empty) Use outbound proxy for all outgoing SIP requests force_outbound_proxy (default: false) - Whether to appply **outbound_proxy** for in-dialog requests. will put outbound proxy URI at the top of the existent Route Set + Whether to apply **outbound_proxy** for in-dialog requests. will put outbound proxy URI at the top of the existent Route Set force_cancel_route_set (default: false) Add SIP dialog Route Set to CANCEL requests if true @@ -435,7 +435,7 @@ Section **media-interfaces** Section **modules** ------------------- -Section modules describles which modules should be loaded. Module can optionally accept configuration. +Section modules describes which modules should be loaded. Module can optionally accept configuration. .. code-block:: c :caption: modules configuration example diff --git a/en/spelling_wordlist.txt b/en/spelling_wordlist.txt new file mode 100644 index 0000000..de16628 --- /dev/null +++ b/en/spelling_wordlist.txt @@ -0,0 +1,213 @@ +Сalls +acc +Acd +Acl +addr +adpcm +alaw +aline +alines +allowlist +amd +Anonymize +aor +Api +apiBaseUrl +Asr +Auth +auth +Auths +Autorefresh +backend +Balancer +balancer +Balancers +blockedPages +blocklist +callee +callid +cdr +cdrwriter +cfg +cli +Clusterization +Codec +codec +Codecs +comparation +conf +config +Configs +cron +crt +CSeq +cseq +Csv +Datagram +decrypt +di +dialogs +Dialpeer +dialpeer +dialpeers +Dns +Dp +Dst +dst +dtmf +eg +elseif +failover +fmt +geo +Geolocation +github +gsm +gw +hba +hostname +iLBC +inband +ini +inv +ip +ipaddr +IPv +Jitter +jitter +journalctl +jsonrpc +Kamailio +Lcr +LebB +LegA +Lega +legA +LegB +Legb +legB +legb +lnp +lnp +loadtree +logdump +logfile +loglevel +Lrn +lrn +multirate +Namespace +namespace +Namespaces +nat +Nginx +nginx +Num +Numberlist +numberlist +Numberlists +odt +Ok +ok +Pai +pai +param +Params +pcap +pcap +pgq +pgqd +phonenumber +PoP +Ppi +ppi +pre +preload +preloaded +presetuped +Prober +prober +Probers +Probers +probers +prometheus +ptime +Rateplan +rateplan +Rateplans +rateplans +rcvbuf +Realtime +realtime +reconnection +recv +redis +reinvite +repo +Req +req +Resolvers +retransmit +Robonia +RoR +routeset +Rpc +rpc +Rpid +rpid +rsr +rst +rtcp +rtp +ruri +Sdp +sdp +SEMS +sems +sendmsg +Sha +showtree +shutted +Signalling +signalling +Smtp +Softswitch +softswitch +speex +Src +src +srtp +srv +ssl +Ssrc +stderr +stdout +Succ +Successnozerolen +syslog +systemctl +tariffication +tcp +Thinq +thinQ +transcode +Transcoded +transcoded +transcoding +trsp +Tx +UA +uac +udp +ulaw + +unhandled +unhold +Uniq +Uptime +Uri +uri +usr +wsize +yml +zrtp diff --git a/en/web-interface/billing/invoice_templates.rst b/en/web-interface/billing/invoice_templates.rst index 6db25e5..55b0680 100644 --- a/en/web-interface/billing/invoice_templates.rst +++ b/en/web-interface/billing/invoice_templates.rst @@ -6,12 +6,12 @@ PDF document templates which will be used to generate invoice. Template - it is Placeholders will be replaced with actual data during PDF document generation. System can store many different templates and you can choose desired template for each account independently. -.. warning:: It is highly recommeded to use LibreOffice to create/edit invoice templates. +.. warning:: It is highly recommended to use LibreOffice to create/edit invoice templates. Invoice Template attributes ``````````````````````````` Id - Unique invoice temlpate id. + Unique invoice template id. Name Unique invoice template name. Filename @@ -99,14 +99,14 @@ It is possible to have table data inserted in invoice. Currently these tables su =============================== ===================================================================================== Table name Description =============================== ===================================================================================== -INV_ORIG_DST_TABLE Calls originated by account, groupped by destination prefix(from Destination object) -INV_ORIG_DST_SUCC_TABLE Successful calls originated by account, groupped by destination prefix -INV_ORIG_NETWORKS_TABLE Calls originated by account, groupped by destination Network -INV_ORIG_NETWORKS_SUCC_TABLE Successful calls originated by account, groupped by destination Network -INV_TERM_DST_TABLE Calls terminated to account, groupped by destination prefix(from Dialpeer object) -INV_TERM_DST_SUCC_TABLE Successful calls terminated to account, groupped by destination prefix -INV_TERM_NETWORKS_TABLE Calls terminated to account, groupped by destination network -INV_TERM_NETWORKS_SUCC_TABLE Successful calls terminated to account, groupped by destination network +INV_ORIG_DST_TABLE Calls originated by account, grouped by destination prefix(from Destination object) +INV_ORIG_DST_SUCC_TABLE Successful calls originated by account, grouped by destination prefix +INV_ORIG_NETWORKS_TABLE Calls originated by account, grouped by destination Network +INV_ORIG_NETWORKS_SUCC_TABLE Successful calls originated by account, grouped by destination Network +INV_TERM_DST_TABLE Calls terminated to account, grouped by destination prefix(from Dialpeer object) +INV_TERM_DST_SUCC_TABLE Successful calls terminated to account, grouped by destination prefix +INV_TERM_NETWORKS_TABLE Calls terminated to account, grouped by destination network +INV_TERM_NETWORKS_SUCC_TABLE Successful calls terminated to account, grouped by destination network INV_SRV_DATA_TABLE Table of services related transactions =============================== ===================================================================================== diff --git a/en/web-interface/billing/invoices.rst b/en/web-interface/billing/invoices.rst index eb6d011..d94fc5e 100644 --- a/en/web-interface/billing/invoices.rst +++ b/en/web-interface/billing/invoices.rst @@ -16,7 +16,7 @@ Invoice provides possibility to summarize billing information for mutual settlem :ref:`Account ` that is related to this invoice. State Status of the invoice. New invoices are created with status *Pending*. - After changing status of invoice to *Approve*, it is considered confirmed and is sent to the contragent's email (configured in account settings). + After changing status of invoice to *Approve*, it is considered confirmed and is sent to the contractor's email (configured in account settings). If account has invoice template, system also will generate PDF document. Start date Date and time of beginning of the billing period in the invoice. @@ -37,7 +37,7 @@ Invoice provides possibility to summarize billing information for mutual settlem Billing duration Billed calls duration calculated based on call duration and billing intervals(initial and next interval length). Calculated as sum(customer_duration) from CDRs. Type - Generation of the invoice can be performed manually or automatically, if invoices autogeneration period for account was choosen. + Generation of the invoice can be performed manually or automatically, if invoices auto-generation period for account was chosen. Three types of invoices are available: Auto, Auto partial and Manual. Direction The invoice can have on the two possible directions: Vendor or Customer. diff --git a/en/web-interface/cdr/cdr-history.rst b/en/web-interface/cdr/cdr-history.rst index a6a058f..b727bd3 100644 --- a/en/web-interface/cdr/cdr-history.rst +++ b/en/web-interface/cdr/cdr-history.rst @@ -18,9 +18,9 @@ Storage of Call Detail Records (CDR) for all calls (or call attempts) what are p Unique CDR's id. Time Start Date and time of call starting. - Time Contect + Time Connect Date and time of receiving 200OK response. - Time Contect + Time End Date and time of receiving Bye. Customer Value of the :ref:`*Name* ` attribute of the Customer Contractor for the call. @@ -114,7 +114,7 @@ Storage of Call Detail Records (CDR) for all calls (or call attempts) what are p Customer Invoice :ref:`Invoice ` with billing information about changing balance of Customer's :ref:`Account ` (in case of success call). Routing Delay - Delay (in miliseconds) between receiving call by Yeti (from Originator) and starting of its termination (to Terminator). + Delay (in seconds) between receiving call by Yeti (from Originator) and sending it to termination gateway. PDD Post Dial Delay (PDD) for this call ( time between the start of the call and the moment the phone of the called party starts ringing) in seconds. RTT diff --git a/en/web-interface/cdr/cdr-partitions.rst b/en/web-interface/cdr/cdr-partitions.rst index a0b1877..bd5c4dc 100644 --- a/en/web-interface/cdr/cdr-partitions.rst +++ b/en/web-interface/cdr/cdr-partitions.rst @@ -21,5 +21,5 @@ CDR Partitions database view allow to see details for partitioned tables. Total Size Size of partition with indexes Approximate Row Count - Not pricese count row count based on internal Postgresql statistics - + Estimated row count based on internal PostgreSQL statistics + diff --git a/en/web-interface/cdr/rtp-statistics.rst b/en/web-interface/cdr/rtp-statistics.rst index 55bd88d..9bfae98 100644 --- a/en/web-interface/cdr/rtp-statistics.rst +++ b/en/web-interface/cdr/rtp-statistics.rst @@ -113,12 +113,12 @@ Yeti calculates statistics for RTP streams processed by system. Such statistics Tx Ssrc `SSRC `_ of transmitted stream. **Local data**. Tx Packets - Count of packets trasmitted by yeti to remote gateway. **Local data**. + Count of packets transmitted by yeti to remote gateway. **Local data**. Tx Bytes Unit: **byte** |br| - Data amount trasmitted by yeti to remote gateway. **Local data**. + Data amount transmitted by yeti to remote gateway. **Local data**. Tx Total Lost - Count of packets trasmitted by yeti to remote gateway and lost during delivering to remote gateway. Value calculated as difference between count of transmitted packets and count of received packets on remote side(reported by RTCP) + Count of packets transmitted by yeti to remote gateway and lost during delivering to remote gateway. Value calculated as difference between count of transmitted packets and count of received packets on remote side(reported by RTCP) Tx Payloads Transcoded RTP payloads that was transcoded before transmitting. Field is empty is transcoding was not used for RTP processing. **Local data**. Tx Payloads Relayed @@ -134,4 +134,4 @@ Yeti calculates statistics for RTP streams processed by system. Such statistics Mean RTP jitter calculated from RTCP reports (in case if remote side sent such reports) on transmitted stream Tx RTCP Jitter Std Unit: **ms** |br| - `Standard deviation `_ of RTP jitter calculated from RTCP reports (in case if remote side sent such reports) on trasmitted stream + `Standard deviation `_ of RTP jitter calculated from RTCP reports (in case if remote side sent such reports) on transmitted stream diff --git a/en/web-interface/equipment/disconnect_policy_codes.rst b/en/web-interface/equipment/disconnect_policy_codes.rst index 732e6a3..7d16ded 100644 --- a/en/web-interface/equipment/disconnect_policy_codes.rst +++ b/en/web-interface/equipment/disconnect_policy_codes.rst @@ -16,8 +16,9 @@ Code's overriding scenarios that are used by :ref:`Disconnect policies `. For REGISTER requests authentification applied automatically. +.. warning:: **Incoming auth username** and **Incoming auth password** will enable incoming INVITE and REGISTER requests username/password authentication procedure. INVITE request username/password authentication is additional step(after IP authentication) and it should be enabled in **Customer Auth**, see :ref:`Require incoming auth `. For REGISTER requests authentication applied automatically. @@ -316,13 +317,13 @@ Port Leave it empty to enable DNS SRV resolving of name in **Host**. Registered aor mode - Used for call termination to gateways with dynamic IP addresses. When enabled YETI sends call to R-URI received from remote UA(in Contact header) during registration procedure. For incoming REGISTER request authentification YETI uses credentials specified in :ref:`Incoming auth username ` and :ref:`Incoming auth password ` fields. + Used for call termination to gateways with dynamic IP addresses. When enabled YETI sends call to R-URI received from remote UA(in Contact header) during registration procedure. For incoming REGISTER request authentication YETI uses credentials specified in :ref:`Incoming auth username ` and :ref:`Incoming auth password ` fields. Supported modes: - **Do not use** - feature disabled. INVITE will be sent do static IP/DNS name defined in **Host** - **Use AOR as is** - INVITE R-URI will be set to Contact received during registration procedure. - - **Use AOR, replace userpart with dst number** - INVITE R-URI will be set to Contact, but userpart will be replaced with destination number. This mode is useful when remote system send maintain single registration but expect to receive call to multiple DST numbers(in R-URI). + - **Use AOR, replace userpart with dst number** - INVITE R-URI will be set to Contact, but user-part will be replaced with destination number. This mode is useful when remote system send maintain single registration but expect to receive call to multiple DST numbers(in R-URI). Resolve ruri Indicates necessity to rewrite R-URI domain part with resolved IP @@ -382,7 +383,7 @@ Ringing timeout .. _gateway_fake_180_timer: Fake 180 timer - Allows to set up timer for 183 SIP messages with SDP. If there is no 183 message during this timer, SEMS would send 180 message forsibly. + Allows to set up timer for 183 SIP messages with SDP. If there is no 183 message during this timer, SEMS would send 180 message forcibly. Allow 1xx without to tag Allows behavior, which violates RFC, when YETI will process 1xx responses without To-tag. @@ -391,7 +392,7 @@ Max 30x redirects Amount of 301/302 SIP redirects that are allowed by Yeti for this Gateway (in case of using Gateway as Terminator of calls). Calls won't be redirected in case of filling this field by 0 (zero) value. Max transfers - Amount of SIP transfers(using REFER mechanism) that are allowed by Yeti for this Gateway (in case of using Gateway as Terminator of calls). Calls won't be transfered in case of filling this field by 0 (zero) value. + Amount of SIP transfers(using REFER mechanism) that are allowed by Yeti for this Gateway (in case of using Gateway as Terminator of calls). Calls won't be transferred in case of filling this field by 0 (zero) value. Sip timer B Overwrites the value of SIP timer B (transaction timeout). Call can be rerouted if this allowed by disconnect policy configuration. @@ -518,6 +519,9 @@ Rtp ping Rtp timeout If set, call will be dropped with appropriate disconnect reason in CDR if no RTP arrived during this interval. + +.. spelling:word-list:: + noaudio Filter noaudio streams Cut all streams except of 'audio' from SDP in INVITE to the termination gateway. @@ -545,7 +549,7 @@ Media encryption mode - **Disable** - Plain RTP will be used(no encryption) - **SRTP SDES** - SRTP with `SDES `_ key negotiation mechanism. In this mode SRTP keys will be sent in SIP SDP payload so it is important to secure SIP signalling by TLS or other secure transport. - - **SRTP DTLS** - SRTP with `DTLS `_ key negotiation mechanism. DTLS is RTP inband mechanism and it doesn't requeire secured SIP signalling. + - **SRTP DTLS** - SRTP with `DTLS `_ key negotiation mechanism. DTLS is RTP inband mechanism and it doesn't require secured SIP signalling. - **SRTP ZRTP** - SRTP with `ZRTP `_ key negotiation mechanism. ZRTP is not standard but sill widely used. .. seealso:: SEMS should be properly configured to support SRTP, see :ref:`SEMS media interfaces configuration ` @@ -619,7 +623,7 @@ DTMF data-path displayed on diagram: .. warning:: - To receive/send DTMF using RTPEvent mechanist appropriate payload type should be negotiated first. + To receive/send DTMF using RTPEvent mechanism appropriate payload type should be negotiated first. - Ensure **telephone-event** payload present in codec group. - Ensure **telephone-event** payload correctly negotiated with remote gateway after SDP offer/answer procedure. diff --git a/en/web-interface/equipment/radius_accounting_profiles.rst b/en/web-interface/equipment/radius_accounting_profiles.rst index aeb9f45..dbbeaf5 100644 --- a/en/web-interface/equipment/radius_accounting_profiles.rst +++ b/en/web-interface/equipment/radius_accounting_profiles.rst @@ -12,7 +12,7 @@ Yeti supports additional accounting of calls on external RADIUS server. RADIUS A Unique RADIUS Accounting Profile's id. Name Unique name of Accounting profile. - Uses for informational purposes and doesn't affect system behaviour. + Uses for informational purposes and doesn't affect system behavior. Server IP address or hostname of external RADIUS server. Port diff --git a/en/web-interface/equipment/radius_auth_profiles.rst b/en/web-interface/equipment/radius_auth_profiles.rst index f8d47ed..559d699 100644 --- a/en/web-interface/equipment/radius_auth_profiles.rst +++ b/en/web-interface/equipment/radius_auth_profiles.rst @@ -12,7 +12,7 @@ Yeti supports additional authorization of incoming call on external RADIUS (Remo Unique RADIUS Auth Profile's id. Name Unique name of Auth profile. - Uses for informational purposes and doesn't affect system behaviour. + Uses for informational purposes and doesn't affect system behavior. Server IP address or hostname of external RADIUS server. Port @@ -36,11 +36,11 @@ Yeti supports additional authorization of incoming call on external RADIUS (Remo The Type of the RADIUS attribute (decimal value between 0 and 255). Regarding to the `RFC 2865: Remote Authentication Dial In User Service (RADIUS) `_ values 192-223 are reserved for experimental use, values 224-240 are reserved for implementation-specific use, and values 241-255 are reserved and should not be used. A RADIUS server and client MAY ignore Attributes with an unknown Type. - Name Name of attribute. It uses for information only and doesn't transfer in the RADIUS packet. - - Is vsa + - Is VSA If this checkbox is enabled it indicates that it is Vendor Specific Attribute and doesn't described by `RFC 2865 - Remote Authentication Dial In User Service (RADIUS) `_. - - Vsa vendor + - VSA Vendor Decimal value (between 0 and (2^32 - 1)) of the Vendor's ID in the attribute. In the `RFC 2865 - Remote Authentication Dial In User Service (RADIUS) `_ - the high-order octet is 0 and the low-order 3 octets are the SMI Network Management Private Enterprise Code of the Vendor in network byte order. - - Vsa vendor type + - VSA Vendor type Decimal value (between 0 and 255) of the specific Vendor type of attribute. - Value String that is used as template for filling value of RADIUS Attribute with using pre-defined placeholders (variables) that are described in note bellow. It is possible to combine several placeholders together with pre-defined text to one string. Resulting value will be converted to the data of necessary *Format* (see below). In case of impossibility to convert resulting value to necessary *Format* an error will be occurred. diff --git a/en/web-interface/equipment/registrations.rst b/en/web-interface/equipment/registrations.rst index 1b9fcfa..072af71 100644 --- a/en/web-interface/equipment/registrations.rst +++ b/en/web-interface/equipment/registrations.rst @@ -44,7 +44,7 @@ Registration attributes Retry delay Set the delay before sending a new REGISTER request to a registrar, when received error code or timeout occurred. Max attempts - Maximum amount of attempts for sending a REGISTER request, when an error code received from a registrar or timeout occured. In order to re-enable attempts of registration, you should disable the registration and then enable again. + Maximum amount of attempts for sending a REGISTER request, when an error code received from a registrar or timeout occurred. In order to re-enable attempts of registration, you should disable the registration and then enable again. Sip Interface Name Name of signalling interface from sems.conf that will be used to build outgoing REGISTER request. diff --git a/en/web-interface/general.rst b/en/web-interface/general.rst index de2991e..fa68e8f 100644 --- a/en/web-interface/general.rst +++ b/en/web-interface/general.rst @@ -5,7 +5,7 @@ General Information .. _general_information: - YETI Web interface allows you to manage all possible entities in the system including CDRs, reporting, billing, routing, sytem configuration and others. It was developed using the most powerful and flexible web frameworks such as `Ruby on Rails `_ and `Active Admin `_. + YETI Web interface allows you to manage all possible entities in the system including CDRs, reporting, billing, routing, system configuration and others. It was developed using the most powerful and flexible web frameworks such as `Ruby on Rails `_ and `Active Admin `_. General structure of the YETI Web interface includes tree main sections: diff --git a/en/web-interface/logs/api_log.rst b/en/web-interface/logs/api_log.rst index af1c80c..17b06b3 100644 --- a/en/web-interface/logs/api_log.rst +++ b/en/web-interface/logs/api_log.rst @@ -17,9 +17,9 @@ API Log contains records about all requests via Application Programming Interfac Path Relative path to requested procedure. DB Duration - Duration (im milliseconds) of processing request by Database. + Duration (in milliseconds) of processing request by Database. Page Duration - Total response time (im milliseconds). + Total response time (in milliseconds). Controller Controller that is contained procedure that was requested. Action diff --git a/en/web-interface/logs/log_partitions.rst b/en/web-interface/logs/log_partitions.rst index 5fd8a9b..df51072 100644 --- a/en/web-interface/logs/log_partitions.rst +++ b/en/web-interface/logs/log_partitions.rst @@ -21,4 +21,4 @@ Log Partitions view allow to see details for partitioned tables in Routing datab Total Size Size of partition with indexes Approximate Row Count - Not pricese count row count based on internal Postgresql statistics + Row count estimation based on internal PostgreSQL statistics diff --git a/en/web-interface/reports/bad_routing.rst b/en/web-interface/reports/bad_routing.rst index 74f7083..88c2b41 100644 --- a/en/web-interface/reports/bad_routing.rst +++ b/en/web-interface/reports/bad_routing.rst @@ -14,7 +14,7 @@ Bad routing report is used for monitoring failed attempts of the call's routing Customer :ref:`Customer ` that is related to the calls (bad routing attempts) that will be used for selecting CDRs for this *Bad routing* report. Choose "Any" for selecting calls from all Customers. Rateplan - :ref:`Rateplan ` that was applied to the calls (bad routing attempts) that will be used for selecting CDRs for this *Bad routing* report. Choose "Any" for selecting calls for all Ratepalns. + :ref:`Rateplan ` that was applied to the calls (bad routing attempts) that will be used for selecting CDRs for this *Bad routing* report. Choose "Any" for selecting calls for all Rateplans. Routing Plan :ref:`Routing plan ` that was applied to the calls (bad routing attempts) that will be used for selecting CDRs for this *Bad routing* report. Choose "Any" for selecting calls for all Routing plans. Internal Disconnect Code diff --git a/en/web-interface/reports/custom_cdr_report.rst b/en/web-interface/reports/custom_cdr_report.rst index 00a81d4..4a52f1d 100644 --- a/en/web-interface/reports/custom_cdr_report.rst +++ b/en/web-interface/reports/custom_cdr_report.rst @@ -46,7 +46,7 @@ Reports data .. figure:: custom_cdr_data.png -Custom CDR report have two set of columns - Group By colums and Aggregated columns. Group by columns defined by system operator during report creation(using **Group by** attribute). Aggregated columns are predefined: +Custom CDR report have two set of columns - Group By columns and Aggregated columns. Group by columns defined by system operator during report creation(using **Group by** attribute). Aggregated columns are predefined: Сalls Total calls count including rerouting attempts. @@ -73,10 +73,10 @@ ACD Average call duration calculates as Calls Duration/Successful Calls count ASR Origination - Answer seizure ratio from call originator point of view. If call have multiple rerouting attempts and last attempt was successful, call will be threated as successful during ASR calculation. + Answer seizure ratio from call originator point of view. If call have multiple rerouting attempts and last attempt was successful, call will be counted as successful during ASR calculation. ASR Termination - Answer seizure ratio from termination side point of view. If call have multiple rerouting attempts each attemtp will be counted separately during ASR calculation. + Answer seizure ratio from termination side point of view. If call have multiple rerouting attempts each attempt will be counted separately during ASR calculation. Origination Cost Total price of calls for originator. This column represents sum of CDRs customer_price values diff --git a/en/web-interface/routing/customers-auths.rst b/en/web-interface/routing/customers-auths.rst index fb91a7b..3da1fdd 100644 --- a/en/web-interface/routing/customers-auths.rst +++ b/en/web-interface/routing/customers-auths.rst @@ -148,7 +148,7 @@ On the third step of authentication algorithm Yeti sorts of *Customer Auth* reco After sorting of *Customer Auth* records routing procedure will be continued with using first record from the sorted list of *Customer Auth* records that was received. -Customer Auth form is splitted to 3 tabs and each one is described below. +Customer Auth form contains few tabs and each one is described below. General **Customers Auth**'s attributes: ```````````````````````````````````````` @@ -162,7 +162,7 @@ General **Customers Auth**'s attributes: Name Unique name of Accounting profile. - Uses for informational purposes and doesn't affect system behaviour. + Uses for informational purposes and doesn't affect system behavior. Enabled Disabled records will be ignored. Customer @@ -208,7 +208,7 @@ General **Customers Auth**'s attributes: The capacity of the Customer Auth, i.e. how many calls it accepts at the moment. Allow Receive Rate Limit A Customer may send special SIP-header in which he sends the price for this call he wants to pay. - And YETI will rely on this price on the routing stage if we allow such a behaviour. + And YETI will rely on this price on the routing stage if we allow such a behavior. Send Billing Information If enabled, YETI adds the special SIP-header into 200 SIP-message, which contains current price for calls, in order to a Customer should be informed. diff --git a/en/web-interface/routing/index.rst b/en/web-interface/routing/index.rst index af8d12b..a7d387b 100644 --- a/en/web-interface/routing/index.rst +++ b/en/web-interface/routing/index.rst @@ -15,9 +15,9 @@ On the second step of algorithm Yeti will check Customer's balance if :ref:`Chec On the third step of general routing algorithm Yeti makes pre-Routing numbers translations. Yeti rewrites (if necessary) Name field in the Source-number, Source-number and Destination-number for incoming call (by :ref:`using POSIX Regular Expressions `) with using :ref:`Number translation settings ` of :ref:`Customer Auth ` record that was selected. On this step Yeti also rewrites (if necessary) Source and Destination numbers which will be send to Radius-server if it's required (by :ref:`using POSIX Regular Expressions `) with using :ref:`Radius options ` of :ref:`Customer Auth ` record that was selected. -On the fourth step of general routing algorithm Yeti makes processing of destination :ref:`Numberlist ` if this :ref:`Numberlist ` was setted up in the :ref:`Customer Auth ` record. Depending on chosen :ref:`mode ` Yeti is going via all related :ref:`Numberlist items ` and makes some :ref:`actions `. As a result of this step Yeti could drop the call with **Disconnect code 8001** (Destination blacklisted) or just rewrite (if necessary) Source and Destination numbers (by :ref:`using POSIX Regular Expressions `) with using :ref:`rewrite rules ` of :ref:`Numberlist items ` record or :ref:`rewrite rules ` relevant :ref:`Numberlist ` record. +On the fourth step of general routing algorithm Yeti makes processing of destination :ref:`Numberlist ` if this :ref:`Numberlist ` was set in the :ref:`Customer Auth ` record. Depending on chosen :ref:`mode ` Yeti is going via all related :ref:`Numberlist items ` and makes some :ref:`actions `. As a result of this step Yeti could drop the call with **Disconnect code 8001** (Destination blacklisted) or just rewrite (if necessary) Source and Destination numbers (by :ref:`using POSIX Regular Expressions `) with using :ref:`rewrite rules ` of :ref:`Numberlist items ` record or :ref:`rewrite rules ` relevant :ref:`Numberlist ` record. -On the fifth step of general routing algorithm Yeti makes processing of source :ref:`Numberlist ` if this :ref:`Numberlist ` was setted up in the :ref:`Customer Auth ` record. Depending on chosen :ref:`mode ` Yeti is going via all related :ref:`Numberlist items ` and makes some :ref:`actions `. As a result of this step Yeti could drop the call with **Disconnect code 8002** (Source blacklisted) or just rewrite (if necessary) Source and Destination numbers (by :ref:`using POSIX Regular Expressions `) with using :ref:`rewrite rules ` of :ref:`Numberlist items ` record or :ref:`rewrite rules ` relevant :ref:`Numberlist ` record. +On the fifth step of general routing algorithm Yeti makes processing of source :ref:`Numberlist ` if this :ref:`Numberlist ` was set in the :ref:`Customer Auth ` record. Depending on chosen :ref:`mode ` Yeti is going via all related :ref:`Numberlist items ` and makes some :ref:`actions `. As a result of this step Yeti could drop the call with **Disconnect code 8002** (Source blacklisted) or just rewrite (if necessary) Source and Destination numbers (by :ref:`using POSIX Regular Expressions `) with using :ref:`rewrite rules ` of :ref:`Numberlist items ` record or :ref:`rewrite rules ` relevant :ref:`Numberlist ` record. On the sixth step of general routing algorithm Yeti will be looking for :ref:`Areas ` (by using :ref:`Area prefixes `) that are related to the Source number (**From name**) and Destination number (**URI name**) after them processing and translation on the previous steps. :ref:`Area ` records that were found (if any), are used for detecting :ref:`Routing Tags ` for the call on the basis :ref:`Routing Tag detection Rules `. diff --git a/en/web-interface/routing/yeti-ui-routing-area_prefixes.rst b/en/web-interface/routing/yeti-ui-routing-area_prefixes.rst index e14c67a..173f6c0 100644 --- a/en/web-interface/routing/yeti-ui-routing-area_prefixes.rst +++ b/en/web-interface/routing/yeti-ui-routing-area_prefixes.rst @@ -9,7 +9,7 @@ Area prefixes are used for determination of :ref:`Areas ` by source or de **Area prefixe**'s attributes: `````````````````````````````` Id - Unique Area prefixe's id. + Unique Area prefix id. Prefix This field is used for setting prefix for this *Area*. Call will be associated with this *Area* (Source or Destination) only in case of matching this *Prefix* with first symbols of relevant number (A or B). Area diff --git a/en/web-interface/routing/yeti-ui-routing-destinations.rst b/en/web-interface/routing/yeti-ui-routing-destinations.rst index 0b27c98..71aecee 100644 --- a/en/web-interface/routing/yeti-ui-routing-destinations.rst +++ b/en/web-interface/routing/yeti-ui-routing-destinations.rst @@ -17,7 +17,7 @@ General **Destination**'s attributes: .. _destination_prefix: Prefix - This field is used for lookup *Destination* by destination number (number B). Destination will be choosed for call routing only in case of matching this *Prefix* with first symbols of destination number. Under buttom of this field information about according :ref:`Network Prefix ` record (if any) is shown. + This field is used for lookup *Destination* by destination number (number B). Destination will be chosen for call routing only in case of matching this *Prefix* with first symbols of destination number. Under bottom of this field information about according :ref:`Network Prefix ` record (if any) is shown. You can enter two or more *Prefixes* that are separated by comma in this field. In this case Yeti will create two or more independent *Destination* records that are had same parameters, except *Prefix*. .. note:: Principles of matching *Prefix* field of *Destination* and destination number (number B) could be found :ref:`here `. diff --git a/en/web-interface/routing/yeti-ui-routing-routing_plan_static_routes.rst b/en/web-interface/routing/yeti-ui-routing-routing_plan_static_routes.rst index 737b243..439432d 100644 --- a/en/web-interface/routing/yeti-ui-routing-routing_plan_static_routes.rst +++ b/en/web-interface/routing/yeti-ui-routing-routing_plan_static_routes.rst @@ -13,7 +13,7 @@ Routing plan static routes are used only for two methods of sorting that could b Routing Plan :ref:`Routing plan ` that is related for this Routing plan static route. Prefix - This field is used for setting prefix for filtering static routes by destination number (number B). This record will be used during one of two methods of sorting in the framework of :ref:`Routing plan ` (**QD-Static, LCR, ACD&ASR control** or **Static only, No ACD&ASR control**) only in case of matching this *Prefix* with first symbols of destination number. Under buttom of this field information about according :ref:`Network Prefix ` record (if any) is shown. In case if two or more routes will match the destination number by this parameter (prefix) only one record will be selected for sorting on the basis longest prefix match algorithm. + This field is used for setting prefix for filtering static routes by destination number (number B). This record will be used during one of two methods of sorting in the framework of :ref:`Routing plan ` (**QD-Static, LCR, ACD&ASR control** or **Static only, No ACD&ASR control**) only in case of matching this *Prefix* with first symbols of destination number. Under bottom of this field information about according :ref:`Network Prefix ` record (if any) is shown. In case if two or more routes will match the destination number by this parameter (prefix) only one record will be selected for sorting on the basis longest prefix match algorithm. .. _routing_plan_static_route_priority: diff --git a/en/web-interface/routing/yeti-ui-routing-routing_plans.rst b/en/web-interface/routing/yeti-ui-routing-routing_plans.rst index 055ca37..c78e280 100644 --- a/en/web-interface/routing/yeti-ui-routing-routing_plans.rst +++ b/en/web-interface/routing/yeti-ui-routing-routing_plans.rst @@ -57,9 +57,9 @@ Routing Plans are used for describing common parameters that can be applied for **LCRD, Prio, ACD&ASR control** - Sorting on the basis of modified least-cost routing (LCR) algorithm with following sorting on the basis of internal :ref:`Priority ` of :ref:`Dialpeers ` (routes with lowest price will be on the top of rating, in case of same prices sorting on priorities will be used) with control of :ref:`Acd Limit ` and :ref:`Asr Limit ` parameters of :ref:`Dialpeer ` (routes where values of these parameters are less than presetuped limits couldn't be chosen for routing). Difference of this algorithm from the classic LCR algorithm is on the using :ref:`Rate Delta Max ` value during the sorting of :ref:`Dialpeers ` by price. :ref:`Dialpeers ` with prices that are different one from other less than :ref:`Rate Delta Max ` value will be on one level of sorting by price and :ref:`Priority ` will be used for building routing rating between them. - **Route testing** - This mode of sorting usually used for testing routes from different Vendors. In this mode you can use especial format of destination number: XX*YYYYYYYYYY, where XX - :ref:`Vendor ID ` and YYYYYYYYYY - phone number. In this mode most preffered :ref:`Dialpeer ` of :ref:`Vendor ` with XX ID will be used for the routing. + **Route testing** - This mode of sorting usually used for testing routes from different Vendors. In this mode you can use especial format of destination number: XX*YYYYYYYYYY, where XX - :ref:`Vendor ID ` and YYYYYYYYYY - phone number. In this mode most preferred :ref:`Dialpeer ` of :ref:`Vendor ` with XX ID will be used for the routing. - **QD-Static, LCR, ACD&ASR control** - Sorting on the basis of modified internal :ref:`Priority ` of :ref:`Dialpeers ` with following sorting on the basis of least-cost routing (LCR) algorithm (routes with highest priorities will be on the top of rating, in case of same priorities LCR sorting will be used) with control of :ref:`Acd Limit ` and :ref:`Asr Limit ` parameters of :ref:`Dialpeer ` (routes where values of these parameters are less than presetuped limits couldn't be chosen for routing). In this method of sorting :ref:`Priority ` of :ref:`Dialpeers ` will be re-writen by :ref:`Priority ` of the :ref:`Routing plan static route ` (if this static route is present in this *Routing plan*). + **QD-Static, LCR, ACD&ASR control** - Sorting on the basis of modified internal :ref:`Priority ` of :ref:`Dialpeers ` with following sorting on the basis of least-cost routing (LCR) algorithm (routes with highest priorities will be on the top of rating, in case of same priorities LCR sorting will be used) with control of :ref:`Acd Limit ` and :ref:`Asr Limit ` parameters of :ref:`Dialpeer ` (routes where values of these parameters are less than presetuped limits couldn't be chosen for routing). In this method of sorting :ref:`Priority ` of :ref:`Dialpeers ` will be re-written by :ref:`Priority ` of the :ref:`Routing plan static route ` (if this static route is present in this *Routing plan*). **Static only, No ACD&ASR control** - Sorting only on the basis of :ref:`Priority ` of the :ref:`Routing plan static route ` (if this static route is present in this *Routing plan*) without control of :ref:`Acd Limit ` and :ref:`Asr Limit ` parameters of :ref:`Dialpeer `. Routes with highest priorities will be on the top of rating. Routing will be done only in case of presence of :ref:`Routing plan static route ` record and :ref:`Dialpeer ` record that are related to this *Routing plan*. diff --git a/en/web-interface/routing/yeti-ui-routing-routing_tags.rst b/en/web-interface/routing/yeti-ui-routing-routing_tags.rst index 5df5d04..ac157e1 100644 --- a/en/web-interface/routing/yeti-ui-routing-routing_tags.rst +++ b/en/web-interface/routing/yeti-ui-routing-routing_tags.rst @@ -6,7 +6,7 @@ Routing Tags Routing Tags are used for creating transparent routing rules within Yeti's routing logic. Routing Tags for every call are detected after processing call with using :ref:`Numberlists ` on the basis :ref:`Routing Tag detection Rules ` and later they could be used for choosing :ref:`Destinations ` and :ref:`Dialpeers ` for the call routing. -Example of using Routing Tags for markuping call is represented on the picture below: +Example of using Routing Tags for marking calls is represented on the picture below: .. graphviz:: ../graphviz/routing_tags.dot @@ -31,17 +31,17 @@ Example of using *Routing Tags* for selecting :ref:`Destinations ` As you can see on this picture above, after the routing procedure Call has three Tags: **Tag1; Tag2; Tag3**. At same time in the Yeti's Database three ref:`Destinations ` and three :ref:`Dialpeers ` records are stored: - - Destination 1 is marked by three Tags **Tag1; Tag2; Tag3** and **AND** mode used for the comparision of *Routing Tags*; - - Destination 2 is marked by **Tag1** only and **OR** mode used for the comparision of *Routing Tags*; - - Destination 3 is marked by **Tag1** only and **AND** mode used for the comparision of *Routing Tags*; - - Dialpeer 1 is marked by **Tag1; Tag2; Tag3** and **AND** mode used for the comparision of *Routing Tags*; - - Dialpeer 2 is marked by **Tag2** only and **AND** mode used for the comparision of *Routing Tags*; - - Dialpeer 3 is marked by **Tag1; Tag2; Tag3; Tag4** and **AND** mode used for the comparision of *Routing Tags*. + - Destination 1 is marked by three Tags **Tag1; Tag2; Tag3** and **AND** mode used for the comparison of *Routing Tags*; + - Destination 2 is marked by **Tag1** only and **OR** mode used for the comparison of *Routing Tags*; + - Destination 3 is marked by **Tag1** only and **AND** mode used for the comparison of *Routing Tags*; + - Dialpeer 1 is marked by **Tag1; Tag2; Tag3** and **AND** mode used for the comparison of *Routing Tags*; + - Dialpeer 2 is marked by **Tag2** only and **AND** mode used for the comparison of *Routing Tags*; + - Dialpeer 3 is marked by **Tag1; Tag2; Tag3; Tag4** and **AND** mode used for the comparison of *Routing Tags*. After selection procedures with using parameters above only two Destinations (Destination 1 and Destination 2) and one Dialpeer (Dialpeer 1) records were selected via following reasons: - - Destination 3 wasn't selected because in **AND** mode of comparision record should contain the same set of *Routing Tags*, but in the example above it contains only one Tag; - - Dialpeer 2 wasn't selected by the same reasons (in **AND** mode of comparision record should contain the same (with a call) set of *Routing Tags*; + - Destination 3 wasn't selected because in **AND** mode of comparison record should contain the same set of *Routing Tags*, but in the example above it contains only one Tag; + - Dialpeer 2 wasn't selected by the same reasons (in **AND** mode of comparison record should contain the same (with a call) set of *Routing Tags*; - Dialpeer 3 wasn't selected because this record contains one additional Tag (**Tag4**) and could not be selected in the **AND** mode. diff --git a/en/web-interface/system/nodes.rst b/en/web-interface/system/nodes.rst index 07be102..8744162 100644 --- a/en/web-interface/system/nodes.rst +++ b/en/web-interface/system/nodes.rst @@ -14,9 +14,9 @@ Every node represents independent installation of YETI-SEMS, which communicate t Name Node's name. Pop - Point of presence. Might be useful for logic grupping of nodes (different data-centers, as example). + Point of presence. Might be useful for logic grouping of nodes (different data-centers, as example). Rpc endpoint - IP address and port on which YETI-SEMS is waiting for RPC connections. Value of this field should have format IP:PORT, for example 127.0.0.1:7080. See :ref:`SEMS sems.conf ` for defails + IP address and port on which YETI-SEMS is waiting for RPC connections. Value of this field should have format IP:PORT, for example 127.0.0.1:7080. See :ref:`SEMS sems.conf ` for details   In view mode user can use next tabs: diff --git a/en/web-interface/system/yeti-ui-system-admin_users.rst b/en/web-interface/system/yeti-ui-system-admin_users.rst index c153ab9..6ab04e2 100644 --- a/en/web-interface/system/yeti-ui-system-admin_users.rst +++ b/en/web-interface/system/yeti-ui-system-admin_users.rst @@ -4,7 +4,7 @@ Admin Users ~~~~~~~~~~~ -Users that have access to this YETI WEB interface. This section allow to control credetials for Yeti Admin interface and :ref:`Yeti Admin API ` +Users that have access to this YETI WEB interface. This section allow to control credentials for Yeti Admin interface and :ref:`Yeti Admin API ` Attributes: ``````````` diff --git a/en/web-interface/system/yeti-ui-system-background_tasks.rst b/en/web-interface/system/yeti-ui-system-background_tasks.rst index 86321b3..dc8b195 100644 --- a/en/web-interface/system/yeti-ui-system-background_tasks.rst +++ b/en/web-interface/system/yeti-ui-system-background_tasks.rst @@ -10,7 +10,7 @@ Background Tasks are used for storing records about ongoing tasks that are makin Priority of this *Background Task*. Attempts Current amount of attempts of make action for this *Background Task*. - Hadler + Handler Some serialized data that is related to this *Background Task*. Last Error Last Error of action's attempt for this *Background Task*. diff --git a/en/web-interface/system/yeti-ui-system-disconnect_codes.rst b/en/web-interface/system/yeti-ui-system-disconnect_codes.rst index 0bdb1ae..014a67c 100644 --- a/en/web-interface/system/yeti-ui-system-disconnect_codes.rst +++ b/en/web-interface/system/yeti-ui-system-disconnect_codes.rst @@ -24,9 +24,9 @@ Disconnect Codes are used for defining special actions for some SIP disconnect c In case of enabling of this field Yeti will not re-route call after receiving this *Disconnect Code*. Pass reason to originator In case of enabling of this field Yeti will transfer reason from termination :ref:`Gateway ` to origination. - Rewrited code + :spelling:ignore:`Rewrited` code If this field is not empty new numeric code from this field will be transfer to origination :ref:`Gateway `. - Rewrited reason + :spelling:ignore:`Rewrited` reason If this field is not empty new textual reason from this field will be transfer to origination :ref:`Gateway `. Store cdr In case of enabling of this field Yeti will store CDRs for calls that were terminated with this *Disconnect Code*. diff --git a/en/web-interface/system/yeti-ui-system-global_configuration.rst b/en/web-interface/system/yeti-ui-system-global_configuration.rst index fd9f531..d56d3f8 100644 --- a/en/web-interface/system/yeti-ui-system-global_configuration.rst +++ b/en/web-interface/system/yeti-ui-system-global_configuration.rst @@ -27,7 +27,7 @@ Import Helpers Dir .. _system_global_configuration_active_calls_require_filter: Active Calls Require Filter - Requre any filter on the *RT data -> Active Calls* page. + Require any filter on the *RT data -> Active Calls* page. Registrations Require Filter Require any filter on the *RT data -> Outgoing Registrations* page. @@ -46,7 +46,7 @@ Active Calls Autorefresh Enable Max Call Duration Global parameter of maximum call duration (seconds). Random Disconnect Enable - If **true** YETI will randomly disconnect calls whose duration more than **Random Disconnect Length** by sendind BYE message to parties. + If **true** YETI will randomly disconnect calls whose duration more than **Random Disconnect Length** by sending BYE request to parties. Random Disconnect Length Duration of calls (seconds) which YETI will disconnect if **Random Disconnect Enable** enabled. Drop Call If LNP Fail diff --git a/en/web-interface/system/yeti-ui-system-jobs.rst b/en/web-interface/system/yeti-ui-system-jobs.rst index f1c994c..9c705b3 100644 --- a/en/web-interface/system/yeti-ui-system-jobs.rst +++ b/en/web-interface/system/yeti-ui-system-jobs.rst @@ -12,7 +12,7 @@ You could press "Run" link for execute some procedure or "Unlock" in case of som - **CdrBatchCleaner** - procedure of removing old batches of information from temporary table in Routing Database; - - **PartitionRemoving** - procedure of removing partitions of tables :ref:`CDR History `, :ref:`Auth logs `, :ref:`RTP Statistics ` and :ref:`API Logs `. Storage period for each table defined at regulated by configurations pareter **partition_remove_delay** at /opt/yeti-web/config/yeti_web.yml + - **PartitionRemoving** - procedure of removing partitions of tables :ref:`CDR History `, :ref:`Auth logs `, :ref:`RTP Statistics ` and :ref:`API Logs `. Storage period for each table defined at regulated by configurations parameter **partition_remove_delay** at /opt/yeti-web/config/yeti_web.yml - **CallsMonitoring** - procedure that is used for periodical (once per minute) calculation of cost for all active calls for each :ref:`Account ` and comparison their cost with current :ref:`Account Balance `. If account balance is less than cost of all active calls for the :ref:`Account ` all calls will be dropped by Yeti. This procedure also is used for calculating statistics for :ref:`Dushboard ` and :ref:`Active calls `; diff --git a/en/web-interface/system/yeti-ui-system-networks.rst b/en/web-interface/system/yeti-ui-system-networks.rst index 7450a10..7b255f2 100644 --- a/en/web-interface/system/yeti-ui-system-networks.rst +++ b/en/web-interface/system/yeti-ui-system-networks.rst @@ -4,7 +4,7 @@ Networks ~~~~~~~~ - Catalogue of carriers. It contains names of carriers and uses in **Network prefixes** then. + Catalog of carriers. It contains names of carriers and uses in **Network prefixes** then. **Network**'s attributes: diff --git a/en/web-interface/system/yeti-ui-system-networks_prefixes.rst b/en/web-interface/system/yeti-ui-system-networks_prefixes.rst index fbfd172..ba4931b 100644 --- a/en/web-interface/system/yeti-ui-system-networks_prefixes.rst +++ b/en/web-interface/system/yeti-ui-system-networks_prefixes.rst @@ -4,12 +4,12 @@ Network Prefixes ~~~~~~~~~~~~~~~~ -Catalogue of phone prefixes. Yeti database contains preloaded data of prefixes. User could edit them or add another. +Catalog of phone prefixes. Yeti database contains preloaded data of prefixes. User could edit them or add another. **Network Prefixe**'s attributes: ````````````````````````````````` Id - Network Prefixe's id. + Network Prefix id. Prefix This field is used for setting prefix for the *Network*. Call will be associated with this *Network* (Source or Destination) only in case of matching this *Prefix* with first symbols of relevant number (A or B). Country diff --git a/en/web-interface/system/yeti-ui-system-smtp_connections.rst b/en/web-interface/system/yeti-ui-system-smtp_connections.rst index f309bfa..8afac67 100644 --- a/en/web-interface/system/yeti-ui-system-smtp_connections.rst +++ b/en/web-interface/system/yeti-ui-system-smtp_connections.rst @@ -12,7 +12,7 @@ It is necessary to have an SMTP connection in order to YETI can send invoices an SMTP connection's id. Name Unique name of SMTP connection. - Uses for informational purposes and doesn't affect system behaviour. + Uses for informational purposes and doesn't affect system behavior. Host IP address or hostname of SMTP server. Port diff --git a/en/web-interface/yeti-ui-rtd/yeti-ui-rtd-outgoing_registrations.rst b/en/web-interface/yeti-ui-rtd/yeti-ui-rtd-outgoing_registrations.rst index 20f0e31..b0cd3bb 100644 --- a/en/web-interface/yeti-ui-rtd/yeti-ui-rtd-outgoing_registrations.rst +++ b/en/web-interface/yeti-ui-rtd/yeti-ui-rtd-outgoing_registrations.rst @@ -40,7 +40,7 @@ Outgoing Registrations are used for monitoring of current status of :ref:`outgoi Last Request Time Timestamp of last sending REGISTER request for this *Outgoing Registration*. Last Succ Req Time - Timestamp of last sending sucess REGISTER request for this *Outgoing Registration*. + Timestamp of last sending successful REGISTER request for this *Outgoing Registration*. Attempt Current amount of attempts for sending REGISTER request for this *Outgoing Registration*. Max Attempts diff --git a/en/yeti-cli/commands.rst b/en/yeti-cli/commands.rst index 5562a5a..d368cdb 100644 --- a/en/yeti-cli/commands.rst +++ b/en/yeti-cli/commands.rst @@ -18,16 +18,16 @@ use Switch connection to specific node. All command will be sent to this node. loadtree - Loads command tree from SEMS to local cache. yeti-cli use local cache for command autocompleteon + Loads command tree from SEMS to local cache. yeti-cli use local cache for command auto-completion showtree Displays content of command tree cache formatting disable - Disable output autoformatting mode + Disable output auto-formatting mode formatting enable - Enable output autoformatting mode + Enable output auto-formatting mode exit Exit from console @@ -54,7 +54,7 @@ core.show.media.streams core.show.interfaces Displays current SEMS interfaces configuration. See **signaling-interfaces** and **media-interfaces** sections of **sems.conf**. core.show.log-level - Diplays current log-level for each log destination. Recommended values is 3 for **di_log** and 2 for **syslog** + Displays current log-level for each log destination. Recommended values is 3 for **di_log** and 2 for **syslog** core.show.connections Displays active connections on each SEMS interface. core.show.version @@ -68,13 +68,13 @@ core.show.recorder.stats core.show.tr_blacklist Displays SIP transactions destinations blacklist. core.set.dump-level.signalling - Swith SEMS node to global signalling tracing mode. Signalling PCAP trace will be saved for each session independend on Customer Auth dump level parameters. + Switch SEMS node to global signaling tracing mode. Signaling PCAP trace will be saved for each session independent on Customer Auth dump level parameters. core.set.dump-level.none Disabling any global tracing core.set.dump-level.full - Switch SEMS node to full tracing mode. Signalling and RTP trace will be saved for each session independend on Customer Auth dump level parameters. + Switch SEMS node to full tracing mode. Signalling and RTP trace will be saved for each session independent on Customer Auth dump level parameters. core.set.dump-level.rtp - Switch SEMS node to RTP tracing mode. RTP trace will be saved for each session independend on Customer Auth dump level parameters. + Switch SEMS node to RTP tracing mode. RTP trace will be saved for each session independent on Customer Auth dump level parameters. core.set.log-level.di_log Allow to modify loglevel for **di_log** destination in runtime, without SEMS restart. core.set.log-level.syslog @@ -117,7 +117,7 @@ yeti.show.resource.state /-1 /-1 Show state of selected resource for selected entity (Entities such as 'Customer account', 'Customer Auth', 'Dialpeer' etc) *Example: show resource state 6 123* yeti.show.resource.state /-1 /-1 used - Show usage of selected resource (For debbuging purposes) + Show usage of selected resource (For debugging purposes) yeti.show.router.cdrwriter.opened-files Show opened files which used by router in order to write CDR yeti.show.sensors diff --git a/en/yeti-cli/index.rst b/en/yeti-cli/index.rst index 75b4853..2118fa7 100644 --- a/en/yeti-cli/index.rst +++ b/en/yeti-cli/index.rst @@ -3,7 +3,7 @@ Yeti CLI utility ================ -yeti-cli utility gives ability to manage yeti cluster via :doc:`SEMS JSONRPC interface <../sems/sems-module-jsonrpc>`. It has frendly console interface with tab completions. +yeti-cli utility gives ability to manage yeti cluster via :doc:`SEMS JSONRPC interface <../sems/sems-module-jsonrpc>`. It has friendly console interface with tab completions. .. figure:: shutdown.gif diff --git a/en/yeti-cli/installation.rst b/en/yeti-cli/installation.rst index c58d1cf..d970c47 100644 --- a/en/yeti-cli/installation.rst +++ b/en/yeti-cli/installation.rst @@ -26,12 +26,12 @@ To configure yeti-cli parameters edit /etc/yeti/yeti-cli.yml file. tree_clear_on_use: False -* **nodes** - Array of nodes condifurations +* **nodes** - Array of nodes configurations * **timeout** - result waiting timeout * **default_node** - default node, to which we connect on start -* **prompt_system_name** - Promt string +* **prompt_system_name** - Prompt string -Config path can be overrided via enviroment variable YETI_CMD_CFG_PATH +Config path can be overridden via environment variable YETI_CMD_CFG_PATH Now you can run yeti-cli from shell: diff --git a/en/yeti-client/configuration.rst b/en/yeti-client/configuration.rst index 63ba28f..0f366ce 100644 --- a/en/yeti-client/configuration.rst +++ b/en/yeti-client/configuration.rst @@ -4,7 +4,7 @@ Configuration ============= -Customer portal has one configuration file located at **/opt/yeti-client/dist/config.js**. This file will be overwrited during **yeti-client** package upgrade by default values so be ready to restore configuration after upgrade. +Customer portal has one configuration file located at **/opt/yeti-client/dist/config.js**. This file will be overwritten during **yeti-client** package upgrade by default values so be ready to restore configuration after upgrade. Config file example: diff --git a/en/yeti-client/installation.rst b/en/yeti-client/installation.rst index dcadfb3..dff18d1 100644 --- a/en/yeti-client/installation.rst +++ b/en/yeti-client/installation.rst @@ -4,7 +4,7 @@ Installation ============ -Customer portal packed to debian package **yeti-cli** and available for Debian 9 and Debian 10 distribution. To install it run: +Customer portal packed to Debian package **yeti-cli** and available for Debian 9 and Debian 10 distribution. To install it run: .. code-block:: console From 19cdc42b412f240e1bb3bed1a6f0be4f60a21df9 Mon Sep 17 00:00:00 2001 From: Dmitry Date: Sat, 11 Jan 2025 23:40:33 +0200 Subject: [PATCH 2/2] add spellcheck --- en/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/conf.py b/en/conf.py index a9ae961..90a81fb 100644 --- a/en/conf.py +++ b/en/conf.py @@ -309,4 +309,4 @@ googleanalytics_id = "G-1YGEQV43K8" - +mermaid_version = "11.4.1"