From 0d7cb7662c0b515520de856333ff07884d4d157d Mon Sep 17 00:00:00 2001 From: Stefan Darius Date: Fri, 7 Aug 2026 16:36:45 +0300 Subject: [PATCH 1/2] Replace docs.opensips.org URLs with repo relative paths --- docs/manual/Interface-Binary.md | 6 +++--- docs/manual/Interface-CoreEvents.md | 6 +++--- docs/manual/Interface-CoreMI.md | 16 ++++++++-------- docs/manual/Interface-StatusReport.md | 12 ++++++------ docs/manual/Script-CoreFunctions.md | 2 +- docs/manual/Script-CoreParameters.md | 12 ++++++------ docs/manual/Script-Routes.md | 4 ++-- docs/manual/Script-Syntax.md | 8 ++++---- modules/aaa_radius/README.md | 2 +- modules/call_center/README.md | 2 +- modules/call_control/README.md | 6 +++--- modules/clusterer/README.md | 2 +- modules/dialplan/README.md | 2 +- modules/dispatcher/README.md | 2 +- modules/drouting/README.md | 2 +- modules/event_routing/README.md | 6 +++--- modules/osp/README.md | 24 ++++++++++++------------ modules/pike/README.md | 2 +- modules/proto_sctp/README.md | 2 +- modules/sipmsgops/README.md | 2 +- modules/sql_cacher/README.md | 2 +- modules/uac_registrant/README.md | 2 +- net/proto_tcp/README.md | 2 +- net/proto_udp/README.md | 2 +- 24 files changed, 64 insertions(+), 64 deletions(-) diff --git a/docs/manual/Interface-Binary.md b/docs/manual/Interface-Binary.md index 0224d574a97..4ac711ee79f 100644 --- a/docs/manual/Interface-Binary.md +++ b/docs/manual/Interface-Binary.md @@ -9,7 +9,7 @@ The **Binary Internal Interface** is an OpenSIPS core interface which offers an ## Configuring the Binary Internal Interface listeners -In order to listen for incoming Binary Packets, a **bin:** interface must be specified. Its number of listener processes can be tuned with *[tcp_workers](https://docs.opensips.org/manual/devel/script-coreparameters#tcp_workers)* core parameter. +In order to listen for incoming Binary Packets, a **bin:** interface must be specified. Its number of listener processes can be tuned with *[tcp_workers](./Script-CoreParameters.md#tcp_workers)* core parameter. ```opensips @@ -30,7 +30,7 @@ Examples of cluster-enabled modules which use the binary interface are **dialog* ``` -More details can be found in the [dialog](../../modules/dialog/README.md#dialog_clustering) and [usrloc](../../modules/usrloc/README.md#distributed_sip_user_location) documentation pages. +More details can be found in the [dialog](../../modules/dialog/README.md#dialog-clustering) and [usrloc](../../modules/usrloc/README.md#distributed-sip-user-location) documentation pages. --- @@ -42,7 +42,7 @@ In order to **send packets**, the interface provides the following primitives: * *int bin_init(str *mod_name, int packet_type)* - begins the construction of a new Binary Packet * *int bin_push_str(const str *info)* - add a string to the Binary Packet that is currently being built * *int bin_push_int(int info)* - add an integer to the Binary Packet that is currently being built -* *int bin_send(union sockaddr_union *de*[tcp_workers](https://docs.opensips.org/manual/devel/script-coreparameters#tcp_workers) *core parameter.st)* - sends the Binary Packet to a given destination over UDP +* *int bin_send(union sockaddr_union *dest)* - sends the Binary Packet to a given destination over UDP diff --git a/docs/manual/Interface-CoreEvents.md b/docs/manual/Interface-CoreEvents.md index 293c14917ae..8e69d7481f6 100644 --- a/docs/manual/Interface-CoreEvents.md +++ b/docs/manual/Interface-CoreEvents.md @@ -53,7 +53,7 @@ Parameters: Process Auto-Scaling (upscale and downscale). -This event is triggered whenever a new process is created (forked) or a process is terminated due the auto-scaling logic. In order to have this event trigger, the [auto-scaling](https://docs.opensips.org/manual/devel/script-coreparameters#auto_scaling_profile) must be enabled in your configuration. +This event is triggered whenever a new process is created (forked) or a process is terminated due the auto-scaling logic. In order to have this event trigger, the [auto-scaling](./Script-CoreParameters.md#auto_scaling_profile) must be enabled in your configuration. Parameters: * **group_type**: the type/name of the scaling group (UDP/TCP/TIMER). @@ -93,7 +93,7 @@ Parameters: Log message produced. -This event is triggered whenever a log message is produced by OpenSIPS. In order to have this event trigger, the [log_event_enabled](https://docs.opensips.org/manual/3-4/script-coreparameters#log_event_enabled) must be enabled in your configuration. +This event is triggered whenever a log message is produced by OpenSIPS. In order to have this event trigger, the [log_event_enabled](./Script-CoreParameters.md#log_event_enabled) must be enabled in your configuration. Parameters: * **time**: time when the log message was produced @@ -101,7 +101,7 @@ Parameters: * **level**: the log level of this message ("DBG", "INFO" etc.) * **module**: module that produced this log message; absent for logs triggered from the script by the **xlog()** function * **function**: internal function that produced this log message; absent for logs triggered from the script by the **xlog()** function -* **prefix**: logging prefix, configured via the [log_prefix](https://docs.opensips.org/manual/3-4/script-coreparameters#log_prefix) parameter. This parameter is absent if the parameter is not configured. +* **prefix**: logging prefix, configured via the [log_prefix](./Script-CoreParameters.md#log_prefix) parameter. This parameter is absent if the parameter is not configured. * **message**: the actual log message content ## E_PROFILING_PROC diff --git a/docs/manual/Interface-CoreMI.md b/docs/manual/Interface-CoreMI.md index 12e19b2ba82..15529992719 100644 --- a/docs/manual/Interface-CoreMI.md +++ b/docs/manual/Interface-CoreMI.md @@ -412,7 +412,7 @@ Adds a rule to a non-readonly blacklist. **Arguments**: * *name*- the name of the blacklist to add to -* *rule* - a string containing a blacklist rule, according to [**dst_blacklist**](https://docs.opensips.org/manual/devel/script-coreparameters#dst_blacklist) parameter +* *rule* - a string containing a blacklist rule, according to [**dst_blacklist**](./Script-CoreParameters.md#dst_blacklist) parameter * *expire* (optional) - indicates the number of seconds the rule should expire **Output**: success or failed object. @@ -429,7 +429,7 @@ Removes a rule from a non-readonly blacklist. **Arguments**: * *name* - the name of the blacklist to remove from -* *rule* - a string containing a blacklist rule, according to [**dst_blacklist**](https://docs.opensips.org/manual/devel/script-coreparameters#dst_blacklist) parameter +* *rule* - a string containing a blacklist rule, according to [**dst_blacklist**](./Script-CoreParameters.md#dst_blacklist) parameter **Output**: success or failed object. Examples of usage: @@ -478,10 +478,10 @@ you can also terminate by id: ## Status Report ### status_report:get -The MI equivalent of the [sr_check_status() script function](https://docs.opensips.org/manual/devel/script-corefunctions#sr_check_status) - to get the status of an 'status/report' identifier/group. +The MI equivalent of the [sr_check_status() script function](./Script-CoreFunctions.md#sr_check_status-group-identifier) - to get the status of an 'status/report' identifier/group. -**Arguments**: a mandatory *group* and optional *identifier*, see the parameters of the [sr_check_status() script function](https://docs.opensips.org/manual/devel/script-corefunctions#sr_check_status). -**Output**: the readiness, the status and details of the identifier/group (see the aggregation note for the return code of the [sr_check_status() script function](https://docs.opensips.org/manual/devel/script-corefunctions#sr_check_status) +**Arguments**: a mandatory *group* and optional *identifier*, see the parameters of the [sr_check_status() script function](./Script-CoreFunctions.md#sr_check_status-group-identifier). +**Output**: the readiness, the status and details of the identifier/group (see the aggregation note for the return code of the [sr_check_status() script function](./Script-CoreFunctions.md#sr_check_status-group-identifier) Examples of usage: ```bash @@ -505,7 +505,7 @@ $ opensips-mi status_report:get drouting all ### status_report:status Command to list the status of the identifiers within one or all 'status/report' groups. -**Arguments**: an optional 'status/report' *group*, see the [sr_check_status() script function](https://docs.opensips.org/manual/devel/script-corefunctions#sr_check_status) for more details. +**Arguments**: an optional 'status/report' *group*, see the [sr_check_status() script function](./Script-CoreFunctions.md#sr_check_status-group-identifier) for more details. **Output**: the readiness, the status and details for all the identifiers within the requested group, or within all defined/registered groups. Examples of usage: @@ -553,7 +553,7 @@ $ opensips-mi status_report:status Command to list the full set of reports (logs) collected by 'status/report' identifiers. **Arguments**: -* an optional 'status/report' *group*, see the [sr_check_status() script function](https://docs.opensips.org/manual/devel/script-corefunctions#sr_check_status) for more details. If missing, all the groups will be listed. +* an optional 'status/report' *group*, see the [sr_check_status() script function](./Script-CoreFunctions.md#sr_check_status-group-identifier) for more details. If missing, all the groups will be listed. * an optional 'identifier'. If missing, all the identifiers within the group will be listed. **Output**: the reports/logs for the requested identifiers, or for all identifiers within the groups. @@ -624,7 +624,7 @@ $ opensips-mi status_report:reports Command to list all the existing identifiers in OpenSIPS or only from a certain group. **Arguments**: -* an optional 'status/report' *group*, see the [sr_check_status() script function](https://docs.opensips.org/manual/3-3/script-corefunctions#sr_check_status) for more details. If missing, the identifiers from all the groups will be listed. +* an optional 'status/report' *group*, see the [sr_check_status() script function](./Script-CoreFunctions.md#sr_check_status-group-identifier) for more details. If missing, the identifiers from all the groups will be listed. **Output**: an array of groups, each group being an array of identifiers . Examples of usage: diff --git a/docs/manual/Interface-StatusReport.md b/docs/manual/Interface-StatusReport.md index ae465f36531..a71f54b1048 100644 --- a/docs/manual/Interface-StatusReport.md +++ b/docs/manual/Interface-StatusReport.md @@ -24,23 +24,23 @@ I most of the cases, the status and reports of an identifier are internally prod ## Scripting functions -The SR Interface provides a script function to check the readiness status of an identifier (or of an entire group), see the [sr_check_status( group, \[identifier\])](https://docs.opensips.org/manual/devel/script-corefunctions#sr_check_status) function. +The SR Interface provides a script function to check the readiness status of an identifier (or of an entire group), see the [sr_check_status( group, \[identifier\])](./Script-CoreFunctions.md#sr_check_status-group-identifier) function. --- ## MI functions The SR Interface provides multiple functions to check/list the status of one/multiple identifiers and to list their reports: -* [sr_get_status](https://docs.opensips.org/manual/devel/interface-coremi#sr_get_status) -* [sr_list_status](https://docs.opensips.org/manual/devel/interface-coremi#sr_list_status) -* [sr_list_reports](https://docs.opensips.org/manual/devel/interface-coremi#sr_list_reports) -* [sr_list_identifiers](https://docs.opensips.org/manual/devel/interface-coremi#sr_list_identifiers) +* [status_report:get](./Interface-CoreMI.md#status_reportget) +* [status_report:status](./Interface-CoreMI.md#status_reportstatus) +* [status_report:reports](./Interface-CoreMI.md#status_reportreports) +* [status_report:identifiers](./Interface-CoreMI.md#status_reportidentifiers) --- ## Events -The SR framework raises an event each time the status of a Status/Report identifier changes. See the [E_CORE_SR_STATUS_CHANGED event](https://docs.opensips.org/manual/devel/interface-coreevents#E_CORE_SR_STATUS_CHANGED) for more details. +The SR framework raises an event each time the status of a Status/Report identifier changes. See the [E_CORE_SR_STATUS_CHANGED event](./Interface-CoreEvents.md#e_core_sr_status_changed) for more details. --- diff --git a/docs/manual/Script-CoreFunctions.md b/docs/manual/Script-CoreFunctions.md index aa0386a8690..a2a3b3d9de4 100644 --- a/docs/manual/Script-CoreFunctions.md +++ b/docs/manual/Script-CoreFunctions.md @@ -17,7 +17,7 @@ add_local_rport(); ## assert(statement, [description]) -Only works if [enable_asserts](https://docs.opensips.org/manual/devel/script-coreparameters#mpath) is set to *true*. If the given expression evaluates to *false*, script execution is stopped and the [error_route](https://docs.opensips.org/manual/devel/script-routes#error_route) is executed. If [abort_on_assert](https://docs.opensips.org/manual/devel/script-coreparameters#dns_try_ipv6) is enabled, OpenSIPS will also shutdown. +Only works if [enable_asserts](./Script-CoreParameters.md#enable_asserts) is set to *true*. If the given expression evaluates to *false*, script execution is stopped and the [error_route](./Script-Routes.md#error_route) is executed. If [abort_on_assert](./Script-CoreParameters.md#abort_on_assert) is enabled, OpenSIPS will also shutdown. Example of usage: ```opensips diff --git a/docs/manual/Script-CoreParameters.md b/docs/manual/Script-CoreParameters.md index 37f72d60b64..b8b3cb46513 100644 --- a/docs/manual/Script-CoreParameters.md +++ b/docs/manual/Script-CoreParameters.md @@ -14,7 +14,7 @@ Default value is `false`. -Only relevant if [asserts](https://docs.opensips.org/manual/devel/script-corefunctions#assert) are enabled. Set to `true` to make OpenSIPS shut down immediately when a script assert fails. +Only relevant if [asserts](./Script-CoreFunctions.md#assertstatement-description) are enabled. Set to `true` to make OpenSIPS shut down immediately when a script assert fails. Example of usage: ```opensips @@ -443,7 +443,7 @@ Example of usage: ### enable_asserts Default value is `false`. -Set to `true` to enable the [assert](https://docs.opensips.org/manual/devel/script-corefunctions#assert) script statement. +Set to `true` to enable the [assert](./Script-CoreFunctions.md#assertstatement-description) script statement. Example of usage: ```opensips @@ -1236,7 +1236,7 @@ Default value is `false`. On top of RFC 5923 connection reuse, TCP connections in OpenSIPS are also persistent across multiple SIP dialogs. This can be controlled with the [tcp_connection_lifetime](#tcp_connection_lifetime) global parameter. > [!WARNING] -> Enabling the global `tcp_accept_aliases` parameter for end-user initiated connections, which are most likely grouped by one or more public IPs, is an open vector for call hijacking. In such platforms, use the [force_tcp_alias()](https://docs.opensips.org/manual/devel/script-corefunctions#force_tcp_alias) core function to employ RFC 5923 behavior only with adjacent SIP proxies. +> Enabling the global `tcp_accept_aliases` parameter for end-user initiated connections, which are most likely grouped by one or more public IPs, is an open vector for call hijacking. In such platforms, use the [force_tcp_alias()](./Script-CoreFunctions.md#force_tcp_aliasport_alias) core function to employ RFC 5923 behavior only with adjacent SIP proxies. Example of usage: ```opensips @@ -1532,7 +1532,7 @@ xlog_buf_size = 8388608 # given in bytes ### xlog_force_color -Enables the use of [$C(xy)](Script-CoreVar.md#foreground-and-background-colors) color escape sequences in [xlog()](https://docs.opensips.org/manual/devel/script-corefunctions#xlog). Otherwise, color escape sequences have no effect. The default value is `false`. +Enables the use of [$C(xy)](Script-CoreVar.md#foreground-and-background-colors) color escape sequences in [xlog()](./Script-CoreFunctions.md#xloglog_level-format_string). Otherwise, color escape sequences have no effect. The default value is `false`. Usage example: @@ -1542,7 +1542,7 @@ xlog_force_color = true ### xlog_level -Similar to [log_level](#log_level), this parameter independently controls the verbosity of the [xlog()](https://docs.opensips.org/manual/devel/script-corefunctions#xlog) functions. This allows you to separately control the verbosity level for logs generated by code and logs generated by `xlog()`. The default value is `2` / `L_NOTICE`. +Similar to [log_level](#log_level), this parameter independently controls the verbosity of the [xlog()](./Script-CoreFunctions.md#xloglog_level-format_string) functions. This allows you to separately control the verbosity level for logs generated by code and logs generated by `xlog()`. The default value is `2` / `L_NOTICE`. Usage example: @@ -1552,7 +1552,7 @@ xlog_level = 3 # L_DBG ### xlog_print_level -Default level for printing logs generated by the [xlog()](https://docs.opensips.org/manual/devel/script-corefunctions#xlog) core function when the `log_level` parameter is omitted. The default value is `2` / `L_NOTICE`. +Default level for printing logs generated by the [xlog()](./Script-CoreFunctions.md#xloglog_level-format_string) core function when the `log_level` parameter is omitted. The default value is `2` / `L_NOTICE`. Usage example: diff --git a/docs/manual/Script-Routes.md b/docs/manual/Script-Routes.md index addfef1d781..66af74d361f 100644 --- a/docs/manual/Script-Routes.md +++ b/docs/manual/Script-Routes.md @@ -43,7 +43,7 @@ Example of usage: Note that if a 'route(X)' is called from a 'branch_route[Y]' then in 'route[X]' is just processed each separate branch instead of all branches together as occurs in main route. -A route can return a set of values, that can later be retrieved from the route's calling context using the [`$return`](https://docs.opensips.org/manual/devel/script-corevar#return) variable. +A route can return a set of values, that can later be retrieved from the route's calling context using the [`$return`](./Script-CoreVar.md#return-value---return) variable. Example of passing values: ```opensips @@ -198,7 +198,7 @@ onreply_route[global] { ## error_route -The error route is executed automatically when a parsing error occurs during SIP request processing, or when a script [assert](https://docs.opensips.org/manual/devel/script-corefunctions#assert) fails. It allows the administrator to decide what to do in such error cases. +The error route is executed automatically when a parsing error occurs during SIP request processing, or when a script [assert](./Script-CoreFunctions.md#assertstatement-description) fails. It allows the administrator to decide what to do in such error cases. > [!IMPORTANT] > as this is triggered ONLY for SIP request, OpenSIPS has to be able to correctly parse the first line of the SIP message. So any syntax error in the first line will NOT trigger this route (as OpenSIPS will not be able to tell if a reply or request). diff --git a/docs/manual/Script-Syntax.md b/docs/manual/Script-Syntax.md index f9180d6c4b3..91b0a91a56a 100644 --- a/docs/manual/Script-Syntax.md +++ b/docs/manual/Script-Syntax.md @@ -88,16 +88,16 @@ The OpenSIPS scripting language supports the following data types: * Max value: +2,147,483,647 == 2 ^ 31 - 1 * Min value: -2,147,483,648 == - 2 ^ 31 * *string* (unlimited size) - * note that some functions which use strings may have internal buffers which limit the maximum size of the strings (e.g. the [xlog()](https://docs.opensips.org/manual/devel/script-corefunctions#socket_belongs_to_bond) function's output buffer is configurable via [xlog_buf_size](https://docs.opensips.org/manual/devel/script-coreparameters#udp_workers)) + * note that some functions which use strings may have internal buffers which limit the maximum size of the strings (e.g. the [xlog()](./Script-CoreFunctions.md#xloglog_level-format_string) function's output buffer is configurable via [xlog_buf_size](./Script-CoreParameters.md#xlog_buf_size)) * *double* (packed as string), through the **[mathops](../../modules/mathops/README.md)** module ### Complex -* *list* via the **[`$avp` variable](https://docs.opensips.org/manual/devel/script-corevar#avp_variables)** -* *map* via the **[`$json`](../../modules/json/README.md#pv_json)** and **[`$xml`](../../modules/xml/README.md#pv_xml)** variables +* *list* via the **[`$avp` variable](./Script-CoreVar.md#avp-variables)** +* *map* via the **[`$json`](../../modules/json/README.md#jsonid)** and **[`$xml`](../../modules/xml/README.md#xmlpath)** variables ## Function Calling Conventions -All OpenSIPS [core](https://docs.opensips.org/manual/devel/script-corefunctions) and [module](https://docs.opensips.org/manual/devel/function-index) functions internally share the same function interface, such that they benefit from the following calling convention: +All OpenSIPS [core](./Script-CoreFunctions.md) and [module](./Function-Index.md) functions internally share the same function interface, such that they benefit from the following calling convention: diff --git a/modules/aaa_radius/README.md b/modules/aaa_radius/README.md index 19518eb809a..1f43d679225 100644 --- a/modules/aaa_radius/README.md +++ b/modules/aaa_radius/README.md @@ -86,7 +86,7 @@ The left-hand side of the assignment must be an attribute name known by the RADI The right-hand side of the assignment must be a script pseudo variable or -a script AVP. For more information about them see [CookBooks - Scripting Variables](https://docs.opensips.org/manual/devel/script-corevar/). +a script AVP. For more information about them see [CookBooks - Scripting Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Set sets parameter" diff --git a/modules/call_center/README.md b/modules/call_center/README.md index aee9e53408e..e089bc5e045 100644 --- a/modules/call_center/README.md +++ b/modules/call_center/README.md @@ -46,7 +46,7 @@ provisioning purposes - the *cc_flows* and [DB schema](https://docs.opensips.org/manual/devel/install-dbschema/). Data is loaded at startup and cached into memory ; runtime reload is possible via the MI commands (see the *call_center:reload* -command in [exported mi functions](#exported_mi_functions)). +command in [exported mi functions](#exported-mi-functions)). Additionally there is a table *cc_cdrs* for writing diff --git a/modules/call_control/README.md b/modules/call_control/README.md index 8f210e58c00..698b55c4866 100644 --- a/modules/call_control/README.md +++ b/modules/call_control/README.md @@ -357,7 +357,7 @@ The left-hand side of the assignment can be any string. The right-hand side of the assignment must be a script pseudo variable or -a script AVP. For more information about them see [CookBooks - Scripting Variables](https://docs.opensips.org/manual/devel/script-corevar/). +a script AVP. For more information about them see [CookBooks - Scripting Variables](../../docs/manual/Script-CoreVar.md). If the parameter is not set, the default initialize message is sent. @@ -390,7 +390,7 @@ The left-hand side of the assignment can be any string. The right-hand side of the assignment must be a script pseudo variable or -a script AVP. For more information about them see [CookBooks - Scripting Variables](https://docs.opensips.org/manual/devel/script-corevar/). +a script AVP. For more information about them see [CookBooks - Scripting Variables](../../docs/manual/Script-CoreVar.md). If the parameter is not set, the default start message is sent. @@ -423,7 +423,7 @@ The left-hand side of the assignment can be any string. The right-hand side of the assignment must be a script pseudo variable or -a script AVP. For more information about them see [CookBooks - Scripting Variables](https://docs.opensips.org/manual/devel/script-corevar/). +a script AVP. For more information about them see [CookBooks - Scripting Variables](../../docs/manual/Script-CoreVar.md). If the parameter is not set, the default stop message is sent. diff --git a/modules/clusterer/README.md b/modules/clusterer/README.md index bda0c21cc7f..65f5adedc97 100644 --- a/modules/clusterer/README.md +++ b/modules/clusterer/README.md @@ -1423,7 +1423,7 @@ the old ones. For how to access and use the Status/Report information, please see -[Status/Report Interface documentation](https://docs.opensips.org/manual/devel/interface-statusreport/). +[Status/Report Interface](../../docs/manual/Interface-StatusReport.md). ### Usage Example diff --git a/modules/dialplan/README.md b/modules/dialplan/README.md index d94b0738203..5a2e2960dee 100644 --- a/modules/dialplan/README.md +++ b/modules/dialplan/README.md @@ -689,7 +689,7 @@ In terms of reports/logs, the following events will be reported: For how to access and use the Status/Report information, please see -[Status/Report Interface documentation](https://docs.opensips.org/manual/devel/interface-statusreport/). +[Status/Report Interface](../../docs/manual/Interface-StatusReport.md). ### Installation diff --git a/modules/dispatcher/README.md b/modules/dispatcher/README.md index 62a5f258fca..dd952dd5791 100644 --- a/modules/dispatcher/README.md +++ b/modules/dispatcher/README.md @@ -1532,7 +1532,7 @@ discarding the old ones. For how to access and use the Status/Report information, please see -[Status/Report Interface documentation](https://docs.opensips.org/manual/devel/interface-statusreport/). +[Status/Report Interface](../../docs/manual/Interface-StatusReport.md). ## Samples diff --git a/modules/drouting/README.md b/modules/drouting/README.md index c635a9bebe0..bd4573ed997 100644 --- a/modules/drouting/README.md +++ b/modules/drouting/README.md @@ -2057,7 +2057,7 @@ discarding the old ones. For how to access and use the Status/Report information, please see -[https://docs.opensips.org/manual/devel/interface-statusreport/](>https://docs.opensips.org/manual/devel/interface-statusreport/). +[Status/Report Interface](../../docs/manual/Interface-StatusReport.md). ### Installation diff --git a/modules/event_routing/README.md b/modules/event_routing/README.md index c1e37e9eb4d..b67fa168952 100644 --- a/modules/event_routing/README.md +++ b/modules/event_routing/README.md @@ -1,6 +1,6 @@ --- title: "Event (based) Routing Module" -description: "The Event (based) Routing module, or shortly the EBR module, provides a mechanism that allows different SIP processings (of messages in script) to communicate and synchronize between through OpenSIPS Events (see https://docs.opensips.org/manual/devel/interface-events/)." +description: "The Event (based) Routing module, or shortly the EBR module, provides a mechanism that allows different SIP processings (of messages in script) to communicate and synchronize between through OpenSIPS Events." --- ## Admin Guide @@ -12,7 +12,7 @@ description: "The Event (based) Routing module, or shortly the EBR module, provi The Event (based) Routing module, or shortly the EBR module, provides a mechanism that allows different SIP processings (of messages in script) to communicate and synchronize between through OpenSIPS Events -(see https://docs.opensips.org/manual/devel/interface-events/). +(see [Event Interface](../../docs/manual/Interface-Events.md)). This mechanism is based on the Subscribe-Notify concept. Any SIP processing @@ -26,7 +26,7 @@ subscriber processing. Also, the Events are generated either internally by OpenSIPS (predefined Events), either from the script level (custom Events). Please refer to the Event Interface documentation for more on how the Events are generated -(https://docs.opensips.org/manual/devel/interface-events/). +([Event Interface](../../docs/manual/Interface-Events.md)). Depending on how the notification is handled by the subscribing processing, diff --git a/modules/osp/README.md b/modules/osp/README.md index 66bed67ffa1..1bab4e282a8 100644 --- a/modules/osp/README.md +++ b/modules/osp/README.md @@ -413,7 +413,7 @@ modparam("osp","parameterstring_value","") #### source_device_avp -The source_device_avp (string) parameter instructs the OSP module to use the defined AVP to pass the source device IP value in the indirect work mode. The default value is "$avp(_osp_source_device_)". Then the source device IP can be set by "$avp(_osp_source_device_) = pseudo-variables". All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +The source_device_avp (string) parameter instructs the OSP module to use the defined AVP to pass the source device IP value in the indirect work mode. The default value is "$avp(_osp_source_device_)". Then the source device IP can be set by "$avp(_osp_source_device_) = pseudo-variables". All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the source device IP AVP" @@ -425,7 +425,7 @@ modparam("osp","source_device_avp","$avp(srcdev)") #### source_networkid_avp -The source_networkid_avp (string) parameter instructs the OSP module to use the defined AVP to pass the source network ID value. The default value is "$avp(_osp_source_networkid_)". Then the source network ID can be set by "$avp(_osp_source_networkid_) = pseudo-variables". All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +The source_networkid_avp (string) parameter instructs the OSP module to use the defined AVP to pass the source network ID value. The default value is "$avp(_osp_source_networkid_)". Then the source network ID can be set by "$avp(_osp_source_networkid_) = pseudo-variables". All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the source network ID AVP" @@ -437,7 +437,7 @@ modparam("osp","source_networkid_avp","$avp(snid)") #### source_switchid_avp -The source_switchid_avp (string) parameter instructs the OSP module to use the defined AVP to pass the source switch ID value. The default value is "$avp(_osp_source_switchid_)". Then the source switch ID can be set by "$avp(_osp_source_switchid_) = pseudo-variables". All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +The source_switchid_avp (string) parameter instructs the OSP module to use the defined AVP to pass the source switch ID value. The default value is "$avp(_osp_source_switchid_)". Then the source switch ID can be set by "$avp(_osp_source_switchid_) = pseudo-variables". All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the source switch ID AVP" @@ -449,7 +449,7 @@ modparam("osp","source_switchid_avp","$avp(swid)") #### custom_info_avp -The custom_info_avp (string) parameter instructs the OSP module to use the defined AVP to pass the custom information values. The default value is "$avp(_osp_custom_info_)". Then the custom information can be set by "$avp(_osp_custom_info_) = pseudo-variables". All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +The custom_info_avp (string) parameter instructs the OSP module to use the defined AVP to pass the custom information values. The default value is "$avp(_osp_custom_info_)". Then the custom information can be set by "$avp(_osp_custom_info_) = pseudo-variables". All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the custom info AVP" @@ -461,7 +461,7 @@ modparam("osp","custom_info_avp","$avp(cinfo)") #### cnam_avp -The cnam_avp (string) parameter instructs the OSP module to use the defined AVP to pass the CNAM values. The default value is "$avp(_osp_cnam_)". Then the CNAM can be used by "$avp(_osp_cnam_)". All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +The cnam_avp (string) parameter instructs the OSP module to use the defined AVP to pass the CNAM values. The default value is "$avp(_osp_cnam_)". Then the CNAM can be used by "$avp(_osp_cnam_)". All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the CNAM AVP" @@ -485,7 +485,7 @@ modparam("osp", "extraheaders_value", "Source: N") #### source_media_avp, destination_media_avp -These parameters are used to tell the OSP module which AVPs are used to store media addresses. The default values are "$avp(_osp_source_media_address_)" and "$avp(_osp_destination_media_address_)". All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +These parameters are used to tell the OSP module which AVPs are used to store media addresses. The default values are "$avp(_osp_source_media_address_)" and "$avp(_osp_destination_media_address_)". All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the media address AVPs" @@ -498,7 +498,7 @@ modparam("osp", "destination_media_avp", "$avp(destmedia)") #### request_date_avp -The request_date_avp (string) parameter instructs the OSP module to use the defined AVP to pass the SIP request Date header values. The default value is "$avp(_osp_request_date_)". Then the request date can be used by "$avp(_osp_request_date_)". All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +The request_date_avp (string) parameter instructs the OSP module to use the defined AVP to pass the SIP request Date header values. The default value is "$avp(_osp_request_date_)". Then the request date can be used by "$avp(_osp_request_date_)". All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the request date AVP" @@ -510,7 +510,7 @@ modparam("osp","request_date_avp","$avp(reqdate)") #### sdp_fingerprint_avp -The sdp_fingerprint_avp (string) parameter instructs the OSP module to use the defined AVP to pass the SDP find print attribute values. The default value is "$avp(_osp_sdp_fingerprint_)". Then the SDP finger print attributes can be used by "$avp(_osp_sdp_fingerprint_)". All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +The sdp_fingerprint_avp (string) parameter instructs the OSP module to use the defined AVP to pass the SDP find print attribute values. The default value is "$avp(_osp_sdp_fingerprint_)". Then the SDP finger print attributes can be used by "$avp(_osp_sdp_fingerprint_)". All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the SDP finger print AVP" @@ -522,7 +522,7 @@ modparam("osp","sdp_fingerprint_avp","$avp(sdpfp)") #### identity_signature_avp, identity_algorithm_avp, identity_information_avp, identity_type_avp, identity_canon_avp -These parameters instruct the OSP module to use the defined AVPs to pass the Identity related values. The default values are "$avp(_osp_identity_signature_)", "$avp(_osp_identity_algorithm_)", "$avp(_osp_identity_information_)", "$avp(_osp_identity_type_)", "$avp(_osp_identity_canon_)". Then the identity related values can be used by these AVPs. All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +These parameters instruct the OSP module to use the defined AVPs to pass the Identity related values. The default values are "$avp(_osp_identity_signature_)", "$avp(_osp_identity_algorithm_)", "$avp(_osp_identity_information_)", "$avp(_osp_identity_type_)", "$avp(_osp_identity_canon_)". Then the identity related values can be used by these AVPs. All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the Identity related AVPs" @@ -538,7 +538,7 @@ modparam("osp","identity_canon_avp","$avp(idcanon)") #### service_provider_avp -These parameter is used to tell the OSP module which AVP is used to store source service provider information. The default value is "$avp(_osp_service_provider_)". All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +These parameter is used to tell the OSP module which AVP is used to store source service provider information. The default value is "$avp(_osp_service_provider_)". All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the source service provider AVP" @@ -550,7 +550,7 @@ modparam("osp", "service_provider_avp", "$avp(sp)") #### user_group_avp -These parameter is used to tell the OSP module which AVP is used to store source user group information. The default value is "$avp(_osp_user_group_)". All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +These parameter is used to tell the OSP module which AVP is used to store source user group information. The default value is "$avp(_osp_user_group_)". All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the source user group AVP" @@ -562,7 +562,7 @@ modparam("osp", "user_group_avp", "$avp(groupid)") #### user_id_avp -These parameter is used to tell the OSP module which AVP is used to store source user ID information. The default value is "$avp(_osp_user_id_)". All pseudo variables are described in https://docs.opensips.org/manual/devel/script-corevar/. +These parameter is used to tell the OSP module which AVP is used to store source user ID information. The default value is "$avp(_osp_user_id_)". All pseudo variables are described in [Core Variables](../../docs/manual/Script-CoreVar.md). ```opensips title="Setting the source user ID AVP" diff --git a/modules/pike/README.md b/modules/pike/README.md index 935f3ac8927..1cf50ceea0d 100644 --- a/modules/pike/README.md +++ b/modules/pike/README.md @@ -306,7 +306,7 @@ In terms of reports/logs, the following events will be reported: For how to access and use the Status/Report information, please see -[https://docs.opensips.org/manual/devel/interface-statusreport/](>https://docs.opensips.org/manual/devel/interface-statusreport/). +[Status/Report Interface](../../docs/manual/Interface-StatusReport.md). ## Developer Guide diff --git a/modules/proto_sctp/README.md b/modules/proto_sctp/README.md index e73094fd0e6..f376b2ac623 100644 --- a/modules/proto_sctp/README.md +++ b/modules/proto_sctp/README.md @@ -74,7 +74,7 @@ modparam("proto_sctp", "sctp_port", 5070) You need to load the "proto_sctp" module. In your script, make sure you do a **loadmodule "proto_sctp.so"** -after setting the **[mpath](https://docs.opensips.org/manual/devel/script-coreparameters#mpath)**. +after setting the **[mpath](../../docs/manual/Script-CoreParameters.md#mpath)**. ### License diff --git a/modules/sipmsgops/README.md b/modules/sipmsgops/README.md index 9ed7391c620..622ef1b642c 100644 --- a/modules/sipmsgops/README.md +++ b/modules/sipmsgops/README.md @@ -555,7 +555,7 @@ The function returns *true* if the SIP message has any body part with the given > [!NOTE] > If the `mime` is not recognized/known by OpenSIPS, the function will always return true. So take care here !! -> As an alternative you can use the [`$cT`](/manual/devel/script-corevar/#cT) variable, which allows a pure string matching for the mime - so it works for **any** mime. +> As an alternative you can use the [`$cT`](../../docs/manual/Script-CoreVar.md#content-type---ct) variable, which allows a pure string matching for the mime - so it works for **any** mime. This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE. diff --git a/modules/sql_cacher/README.md b/modules/sql_cacher/README.md index e2b03a9c7f1..41e7449ba90 100644 --- a/modules/sql_cacher/README.md +++ b/modules/sql_cacher/README.md @@ -417,7 +417,7 @@ In terms of reports/logs, the following events will be reported: For how to access and use the Status/Report information, please see -[https://docs.opensips.org/manual/devel/interface-statusreport/](>https://docs.opensips.org/manual/devel/interface-statusreport/). +[Status/Report Interface](../../docs/manual/Interface-StatusReport.md). ### License diff --git a/modules/uac_registrant/README.md b/modules/uac_registrant/README.md index a6e33505472..87ab6d5603e 100644 --- a/modules/uac_registrant/README.md +++ b/modules/uac_registrant/README.md @@ -902,7 +902,7 @@ $ opensips-cli -x mi sr_list_reports uac_registrant For how to access and use the Status/Report information, please see -[https://docs.opensips.org/manual/devel/interface-statusreport/](>https://docs.opensips.org/manual/devel/interface-statusreport/). +[Status/Report Interface](../../docs/manual/Interface-StatusReport.md). ### License diff --git a/net/proto_tcp/README.md b/net/proto_tcp/README.md index 4f1e7dda23b..564a1033b4c 100644 --- a/net/proto_tcp/README.md +++ b/net/proto_tcp/README.md @@ -377,7 +377,7 @@ MI FIFO Command Format: **Q: After switching to OpenSIPS 2.1, I'm getting this error: "listeners found for protocol tcp, but no module can handle it"** -You need to load the "proto_tcp" module. In your script, make sure you do a **loadmodule "proto_tcp.so"** after setting the **[mpath](https://docs.opensips.org/manual/devel/script-coreparameters#mpath)**. +You need to load the "proto_tcp" module. In your script, make sure you do a **loadmodule "proto_tcp.so"** after setting the **[mpath](../../docs/manual/Script-CoreParameters.md#mpath)**. **Q: I cannot locate "proto_tcp.so". Where is it?** diff --git a/net/proto_udp/README.md b/net/proto_udp/README.md index 1315e18a3f2..befb8e09e9e 100644 --- a/net/proto_udp/README.md +++ b/net/proto_udp/README.md @@ -71,7 +71,7 @@ modparam("proto_udp", "udp_port", 5070) **Q: After switching to OpenSIPS 2.1, I'm getting this error: "listeners found for protocol udp, but no module can handle it"** -You need to load the "proto_udp" module. In your script, make sure you do a **loadmodule "proto_udp.so"** after setting the **[mpath](https://docs.opensips.org/manual/devel/script-coreparameters#mpath)**. +You need to load the "proto_udp" module. In your script, make sure you do a **loadmodule "proto_udp.so"** after setting the **[mpath](../../docs/manual/Script-CoreParameters.md#mpath)**. **Q: I cannot locate "proto_udp.so". Where is it?** From 6e7f3bcc10c7afd407f01f27e3c0ac1bcdfc87d1 Mon Sep 17 00:00:00 2001 From: Stefan Darius Date: Mon, 10 Aug 2026 17:17:52 +0300 Subject: [PATCH 2/2] docs: update links to DB schema documentation for consistency --- docs/manual/Install-DBSchema.md | 2 +- modules/call_center/README.md | 2 +- modules/dialplan/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/manual/Install-DBSchema.md b/docs/manual/Install-DBSchema.md index fe1007fd59d..c035dfe1bda 100644 --- a/docs/manual/Install-DBSchema.md +++ b/docs/manual/Install-DBSchema.md @@ -3,4 +3,4 @@ title: "DB schema" description: "" --- - +Check [the official documentation website](https://docs.opensips.org/manual/4-1/install-dbschema) for the full OpenSIPS DB Schema. diff --git a/modules/call_center/README.md b/modules/call_center/README.md index e089bc5e045..fc031d8d68b 100644 --- a/modules/call_center/README.md +++ b/modules/call_center/README.md @@ -43,7 +43,7 @@ The main entities in the modules are the flows (queues) and agents. Each entity has a corresponding table in the database, for provisioning purposes - the *cc_flows* and *cc_agents* tables, see -[DB schema](https://docs.opensips.org/manual/devel/install-dbschema/). +[DB schema](../../docs/manual/Install-DBSchema.md). Data is loaded at startup and cached into memory ; runtime reload is possible via the MI commands (see the *call_center:reload* command in [exported mi functions](#exported-mi-functions)). diff --git a/modules/dialplan/README.md b/modules/dialplan/README.md index 5a2e2960dee..4d97041dfdc 100644 --- a/modules/dialplan/README.md +++ b/modules/dialplan/README.md @@ -92,7 +92,7 @@ to do with the module, you need to populate the appropriate DB records. The definition of the tables used by the dialplan module can be found -at [dialplan table documentation](https://docs.opensips.org/manual/devel/install-dbschema/#table-dialplan) +at [dialplan table documentation](../../docs/manual/Install-DBSchema.md#table-dialplan) #### What to place in table