Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified modules/ROOT/assets/images/CallDetailsWidget.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 modified modules/ROOT/assets/images/CallDetailsWidgetHeader.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 modified modules/ROOT/assets/images/CallDetailsWidgetInfo.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 modified modules/ROOT/assets/images/CallDetailsWidgetLegs.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 modified modules/ROOT/assets/images/CallDetailsWidgetMessages.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 modified modules/ROOT/assets/images/CallDetailsWidgetTitle.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 removed modules/ROOT/assets/images/CallFlowMediaMessage.png
Binary file not shown.
Binary file modified modules/ROOT/assets/images/ExportToDropdown.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 modified modules/ROOT/assets/images/MediaQualityWidget.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 modules/ROOT/assets/images/MergeDropdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions modules/ROOT/pages/ReleaseNotes.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,33 @@
= Release Notes
:description: SIP3 Release Notes

== Version: 2025.3.1

=== Captain
* Improved ISUP message processing
* Various performance improvements and bugfixes

=== Salto

* Allowed SIP message processing with empty user
* Improved ISUP message processing
* Add all transactions for processing in a call
* Case-insensitive headers in `sip.message`
* Fixed SDP parsing
* Various performance improvements and bugfixes

=== Twig
* Improved RTP Report post-processing
* Improved ISUP message processing
* Various performance improvements and bugfixes

=== Hoof
* RTP/RTCP quality visualization
* User interface improvements
* Various performance improvements and bugfixes

IMPORTANT: Hoof configuration must be upgraded

== Version: 2025.2.1

=== Captain
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/UpgradeGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ which we packaged into `sip3-java` package for Linux. This package is required f
You should pay attention to checking JAVA_HOME variable in the configuration files.
The file `environment.conf` exists in all application of SIP3 solution. Locations: `/etc/sip3-{application}/environment.conf`
(e.g. '/etc/sip3-salto/environment.conf`).
JAVA_HOME variable should be setted to `/opt/sip3-java`.
JAVA_HOME variable should be set to `/opt/sip3-java`.

Example of `environment.conf`:
```
Expand Down
3 changes: 3 additions & 0 deletions modules/ROOT/pages/features/CallDetails.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,14 @@ On the right side of Header are control elements for this Call.
- Stash the call. It helps to save the call to special collections for storing them for as long as you need (xref:CommunityEditionVsEnterpriseEdition.adoc[EE feature]).
- Share this call. Get link to the call and share it with you teammates.
- Export this call. It allows to export either all or selected call legs in _PNG_ and _PCAP_.
- Merge this call with another opened to show them on one callflow.

NOTE: Check out the Display settings section of xref:features/CallFlowDiagram.adoc[Call Flow Diagram page] to find out how to select call legs.

image::ExportToDropdown.png[Export To Dropdown]

image::MergeDropdown.png[Merge Dropdown]

=== Info
Info always shows main information, that needs to be easily accessible from any tab, like call's __caller__ and __callee__, __start time__, __status__ and __duration__.

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/features/CallFlowDiagram.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ image::CallFlowMediaEventsSitcking.png[Call Flow Media Events Sticking]

The xref:features/MediaRecordingOnDemand.adoc[Media Quality Widget] is shown on event click.

image::CallFlowMediaMessage.png[Call Flow Media Message]
image::MediaQualityWidget.png[Call Flow Media Message]

== Call Flow Sidebar

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/features/Components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ image::Components.png[Components table]

- `Actions` - available actions for this type of component:
* image:SettingsIcon.png[Settings] - view configuration of remote component in JSON
* image:PowerOffIcon.png[Shutdown] - shutdown component (available in xref:CommunityEditionVsEnterpriseEdition.adoc[Enterprise Edition]).
* image:PowerOffIcon.png[Shutdown] - shutdown component (available in xref:CommunityEditionVsEnterpriseEdition.adoc[Enterprise Edition]). With `Ctrl`/`Cmd` pressed component will try to upgrade itself.

NOTE: The Shutdown action will cause the component restart if it was installed as `systemd` service. Only Captain and Salto are supported.

30 changes: 24 additions & 6 deletions modules/ROOT/pages/features/HoofConfiguration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ In general SIP3 Hoof can be deeply customized by our developers. Also SIP3 Hoof
* Custom Searches
* Custom Search Results
* Winbox behaviour
* Media appearance


Hoof configuration is stored in JSON format:
Expand All @@ -29,7 +30,8 @@ Hoof configuration is stored in JSON format:
"features": [], // <5>
"root_path": "", // <6>
"default_route": "/search/advanced", // <7>
"oauth2": {} // <8>
"oauth2": {}, // <8>
"media": {} // <9>
}
----

Expand All @@ -44,7 +46,7 @@ Hoof configuration is stored in JSON format:
<6> `root_path` - Root path used when Hoof is placed after proxy and have prefix in path
<7> `default_route` - Default route after successful login or going to `root_path`
<8> `oauth2` - OAuth2 configuration

<9> `media` - Media configuration
== Timezones

Default configuration have 2 timezones:
Expand Down Expand Up @@ -126,6 +128,7 @@ image::CustomSearchLayout.png[Custom Search Layout]
{
"id": "custom",
"name": "Custom search",
"form_type": "attributes",
"sections": [
{
"id": "main",
Expand Down Expand Up @@ -218,14 +221,16 @@ Search configuration consist of 4 main parameters:
{
"id": "custom", // <1>
"name": "Custom search", // <2>
"sections": [ ], // <3>
"results": { } // <4>
"form_type": "attributes", // <3>
"sections": [ ], // <4>
"results": { } // <5>
}
----
<1> `id` - Custom search ID
<2> `name` - Custom search name
<3> `sections` - Section of search attributes
<4> `results` - Configuration for search results
<3> `form_type` - Search form type. Available values: `attributes`, `advanced`
<4> `sections` - Section of search attributes
<5> `results` - Configuration for search results

=== Section

Expand Down Expand Up @@ -359,6 +364,19 @@ SIP3 Hoof supports OAuth2 authentication and needs to be configured properly:

IMPORTANT: SIP3 Twig must be configured first to enable OAuth2 authentication.

=== Media configuration

Some parameters for media appearance can be configured:
[source,json]
----
{
"media": {
"distance_threshold": 1000 // <1>
}
}
----
<1> `distance_threshold` - minimal distance between RTP Reports in milliseconds.

=== Other parameters

==== root_path
Expand Down