Skip to content

Commit

Permalink
More Anchor Fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Devon-White committed Feb 27, 2024
1 parent daa8145 commit 4aee7f3
Show file tree
Hide file tree
Showing 23 changed files with 159 additions and 410 deletions.
2 changes: 1 addition & 1 deletion docs/Channel-Variables-Catalog/RECORD_APPEND_16353876.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## RECORD_APPEND

boolean Recording is appended to file. Set `RECORD_APPEND=true` on the channel and all recordings will behave this way to formats which support it (curently [mod\_sndfile](../FreeSWITCH-Explained/Modules/mod_sndfile_32178375.mdx#-freeswitch--mod_sndfile-) for WAV, etc.)
boolean Recording is appended to file. Set `RECORD_APPEND=true` on the channel and all recordings will behave this way to formats which support it (curently [mod\_sndfile](../FreeSWITCH-Explained/Modules/mod_sndfile_32178375.mdx) for WAV, etc.)

**Usage**

Expand Down
2 changes: 1 addition & 1 deletion docs/Channel-Variables-Catalog/hangup_cause_16352598.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# hangup_cause
# Hangup Cause

Created by Ryan Harris, last modified by livem Chan on 2020.07.30

Expand Down
2 changes: 1 addition & 1 deletion docs/Channel-Variables-Catalog/local_ip_v4_16353556.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# local_ip_v4
# Local IP v4

Created by Ryan Harris, last modified by Duvid Rottenberg on 2018.04.24

Expand Down
1 change: 0 additions & 1 deletion docs/Channel-Variables-Catalog/proxy_media_16353349.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

boolean Proxy Media mode puts Freeswitch in a "transparent proxy mode" for the RTP streams. The RTP streams still pass through freeswitch (unlike bypass media mode), however it is lighter on the CPU because freeswitch never even parses the packets or processes them in any way, it simply forwards them onwards.

See also: [Proxy Media](proxy_media_16353349.mdx#proxy_media)

**Usage**

Expand Down
7 changes: 0 additions & 7 deletions docs/Channel-Variables-Catalog/timezone_16352660.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,3 @@ In the directory:
```xml
<param name="timezone" value="America/New_York"/>
```

## Comments:

| In order to get the timezone directory variable in a call, I had to set it as a variable in the directory (not as a param), which makes sense (see: [Routing with directory parameters](../FreeSWITCH-Explained/Configuration/How-Tos/Routing-with-directory-parameters_13173575.mdx#-freeswitch--routing-with-directory-parameters-)). Not sure if this example is a typo or maybe for a different use case.I did this in my directory to test against the variable in the dialplan: &lt;variable name="timezone" value="America/New\_York"/> ![](/images/icons/contenttypes/comment_16.png) Posted by byoungdale at Sep 21, 2018 16:33 |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |


Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@

This is how to Generate TLS certificates in win32\. A temporary solution for Windows users until an automatic script is available.

Click here to expand Table of Contents

* 1 [Creating new CA and certificate](#creating-new-ca-and-certificate)
* 2 [Removing the CA](#-freeswitch--generating-tls-certificates-win32-)
* 3 [Customization](#-freeswitch--generating-tls-certificates-win32-)

### Creating new CA and certificate

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,10 @@



##

## **OBSOLETE DO NOT FOLLOW THESE INSTRUCTIONS**


Click here to expand Table of Contents

* 1 [](#-freeswitch--dead-video-recording-)
* 2 [OBSOLETE DO NOT FOLLOW THESE INSTRUCTIONS](#obsolete-do-not-follow-these-instructions)
* 3 [Media bug](#-freeswitch--dead-video-recording-)
* 4 [Record a single legged call](#-freeswitch--dead-video-recording-)
* 5 [Record a bridged call](#-freeswitch--dead-video-recording-)
* 6 [Record a conference](#record-a-conference)
* 7 [Video eavesdrop](#-freeswitch--dead-video-recording-)
* 8 [Feedbacks](#-freeswitch--dead-video-recording-)

## Media bug

Expand All @@ -28,8 +17,7 @@ git checkout video-media-bug
./bootstrap.sh && ./configure && make install
```

##
Record a single legged call
## Record a single legged call

[Mod\_fsv](../Modules/mod_fsv_6587435.mdx#about) implemented a record\_fsv application, which can record into a .fsv (FreeSWITCH VIDEO) file format.

Expand Down Expand Up @@ -59,8 +47,7 @@ or
<action application="record" data="/tmp/testrecord.mp4"/>
```

##
Record a bridged call
## Record a bridged call

```xml
uuid_setvar <uuid> enable_file_write_buffering false
Expand All @@ -80,17 +67,15 @@ conference 3000 record /tmp/testrecord.fsv
conference 3000 record /tmp/testrecord.mp4
```

##
Video eavesdrop
## Video eavesdrop

Yes, eavesdrop works with video, and, unlike audio, it cannot be "mixed", so you only see a single leg's video while you hear both.

```xml
originate user/1000 &eavesdrop(someuuid)
```

##
Feedbacks
## Feedbacks

Feedbacks are welcome. submit a jira to seven or email [[email protected]](mailto:[email protected])

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@

# Connecting your Avaya and FreeSWITCH via SIP



Click here to expand Table of Contents

* 1 [About this Example](#-freeswitch--connecting-your-avaya-and-freeswitch-via-sip-)
* 2 [Example requirements](#-freeswitch--connecting-your-avaya-and-freeswitch-via-sip-)

## About this Example

Expand All @@ -17,10 +11,3 @@ The following Example explains how to get FreeSWITCH and Avaya working with one
```xml
* Avaya's SES Server
```

## Comments:

| SES Server is no longer a supported product at Avaya. Time permitting, I will document a direct SIP trunk connection from Avaya Communication Manager to Freeswitch. An alternate method is to peer with Avaya Session Manager, which replaces SES Server. ![](/images/icons/contenttypes/comment_16.png) Posted by [email protected] at Sep 17, 2017 23:44 |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |


Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@

OpenVZ is an open source container-based virtualization solution built on Linux. OpenVZ creates isolated, secure containers (otherwise known as VEs or VPSs) on a single physical server enabling better server utilization and ensuring that applications do not conflict. Each container performs and executes exactly like a stand-alone server; containers can be rebooted independently and have root access, users, IP addresses, memory, processes, files, applications, system libraries and configuration files. See [http://wiki.openvz.org](http://wiki.openvz.org/) for more information.

Click here to expand Table of Contents

* 1 [Running FreeSWITCH in OpenVZ](#-freeswitch--freeswitch-in-openvz-)
* 1.1 [Resource Considerations](#resource-considerations)
* 2 [Live Migration of a running FreeSWITCH VE](#live-migration-of-a-running-freeswitch-ve)

## Running FreeSWITCH in OpenVZ

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@

Below is two example sample configurations of Kamailio as a SIP proxy to FreeSWITCH.

Click here to expand Table of Contents

* 1 [Simple Setup](#-freeswitch--kamailio-basic-setup-as-proxy-for-freeswitch-)
* 2 [Simple setup with database lookup](#simple-setup-with-database-lookup)

### Simple Setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@

This tutorial was created from an install of Freeswitch 1.0.6 on Centos 5.5 using the sample configuration files. The system has eth0 on the public network using dhcp and eth1 was on the private network using a static ip address. Depending on your setup some changes to this configuration may be necessary. This tutorial assumes you have a sip phone connected to the system and using extension number 1000 for inbound and outbound dialing. The default install location for conf directory was used, /usr/local/freeswitch/conf.

Click here to expand Table of Contents

* 1 [Multi Homed Dual NIC How To](#multi-homed-dual-nic-how-to)

## Multi Homed Dual NIC How To

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ For those who want to keep track of their chats while not online, run irssi in a
* [Startup documentation](http://www.irssi.org/documentation/startup)
* [Howto to get Irssi running inside screen](http://quadpoint.org/articles/irssi)

Click here to expand Table of Contents

* 1 [Irssi](#-freeswitch--multiple-servers-in-irssi-)
* 2 [See Also](#see-also)

## Irssi

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,6 @@ TODO: Fix script to send all "parking" and "conference" calls to a single FS ser

Tested on CentOS 6.X with OpenSIPS 1.7.1

Click here to expand Table of Contents

* 1 [Install and configure pre-requisites](#install-and-configure-pre-requisites)
* 1.1 [Create 'opensips' user](#-freeswitch--opensips-configuration-for-2-or-more-freeswitch-installs-)
* 1.2 [Create and configure opensips.log](#-freeswitch--opensips-configuration-for-2-or-more-freeswitch-installs-)
* 1.3 [Install dependencies](#-freeswitch--opensips-configuration-for-2-or-more-freeswitch-installs-)
* 1.4 [Download the source](#-freeswitch--opensips-configuration-for-2-or-more-freeswitch-installs-)
* 1.5 [Install OpenSIPS](#-freeswitch--opensips-configuration-for-2-or-more-freeswitch-installs-)
* 2 [Configure OpenSIPS](#-freeswitch--opensips-configuration-for-2-or-more-freeswitch-installs-)
* 2.1 [Create the MySQL database](#-freeswitch--opensips-configuration-for-2-or-more-freeswitch-installs-)
* 2.2 [Create the start-up script](#-freeswitch--opensips-configuration-for-2-or-more-freeswitch-installs-)
* 3 [Start OpenSIPS](#-freeswitch--opensips-configuration-for-2-or-more-freeswitch-installs-)
* 3.1 [Add FreeSWITCH servers to OpenSIPS dispatcher list](#-freeswitch--opensips-configuration-for-2-or-more-freeswitch-installs-)
* 3.2 [Debugging](#-freeswitch--opensips-configuration-for-2-or-more-freeswitch-installs-)

### Install and configure pre-requisites

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@

# Protocols



Click here to expand Table of Contents

* 1 [VoIP endpoint protocols](#voip-endpoint-protocols)
* 1.1 [Signaling](#signaling)
* 1.2 [Media](#media)
# Protocols

FreeSWITCH supports the following protocols:

Expand All @@ -27,7 +19,7 @@ FreeSWITCH supports the following protocols:
* Jingle / Google Talk
* provided by [mod\_dingaling](../Modules/mod_dingaling_6587385.mdx#faq)
* Skype
* provided by [mod\_skypopen](../Modules/mod_skypopen_3966336.mdx#-sk-)
* provided by [mod\_skypopen](../Modules/mod_skypopen_3966336.mdx)
* GSM
* provided by [mod\_gsm](https://wiki.freeswitch.org/index.php?title=Mod%5Fgsm&action=edit&redlink=1 "Mod gsm (page does not exist)")
* ALSA
Expand All @@ -42,7 +34,7 @@ FreeSWITCH supports the following protocols:
* UDPTL + T.38
* provided by [mod\_spandsp](../Modules/mod_spandsp_6587021.mdx)
* Skype
* provided by [mod\_skypopen](../Modules/mod_skypopen_3966336.mdx#-sk-)
* provided by [mod\_skypopen](../Modules/mod_skypopen_3966336.mdx)

It is possible to bridge calls between any of the above protocols, in either direction.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,42 +1,12 @@

# Command Line Interface (fs_cli)



---

Table of Contents (click to expand)

* [0\. About](#-freeswitch--command-line-interface-fs_cli-)
* [1\. Requirements](#1-requirements)
* [2\. Install](#-freeswitch--command-line-interface-fs_cli-)
* [2.1 Server](#-freeswitch--command-line-interface-fs_cli-)
* [2.2 Client](#-freeswitch--command-line-interface-fs_cli-)
* [3\. Usage](#-freeswitch--command-line-interface-fs_cli-)
* [3.1 Available switches](#31-available-switches)
* [3.2 Examples](#32-examples)
* [3.2.1 Simple](#321-simple)
* [3.2.2 Using profiles](#322-using-profiles)
* [3.2.3 Sending a command and then logging off](#323-sending-a-command-and-then-logging-off)
* [4\. Available commands](#4-available-commands)
* [4.1 FreeSWITCH API](#41-freeswitch-api)
* [4.2 Forward slash (/) commands](#42-forward-slash--commands)
* [5\. Configuration](#5-configuration)
* [5.1 switch.conf.xml](#-freeswitch--command-line-interface-fs_cli-)
* [5.2 mod\_console](#-freeswitch--command-line-interface-fs_cli-)
* [5.3 /etc/fs\_cli.conf and \~/.fs\_cli](#53-etcfs_cliconf-and-fs_cli-)
* [5.3.1 Format](#531-format)
* [5.3.2 Configuration options](#532-configuration-options)
* [6\. Wish List](#-freeswitch--command-line-interface-fs_cli-)
* [7\. See Also](#-freeswitch--command-line-interface-fs_cli-)

---

## 0\. About

The `fs_cli` program is a Command-Line Interface that allows a user to connect to a running FreeSWITCH™ instance. The `fs_cli` program can connect to the FreeSWITCH™ process on the local machine or on a remote system. (Network connectivity to the remote system is, of course, required.)

The `fs_cli` program uses FreeSWITCH™ 's [Event Socket Library (ESL)](./Event-Socket-Library/index.mdx#-new-) to tap into FreeSWITCH™'s event system to send commands issued by the user, and to collect the server responses to send to the display. The [Event Socket Library (ESL)](./Event-Socket-Library/index.mdx#-new-), a C-based socket library, was developed for use with `fs_cli,` although a programmer could use this library for any C language program that needs to connect to the event socket. With the `-x` switch (see below) `fs_cli` can issue a command to the server, get a response, and then disconnect.
The `fs_cli` program uses FreeSWITCH™ 's [Event Socket Library (ESL)](./Event-Socket-Library/index.mdx) to tap into FreeSWITCH™'s event system to send commands issued by the user, and to collect the server responses to send to the display. The [Event Socket Library (ESL)](./Event-Socket-Library/index.mdx), a C-based socket library, was developed for use with `fs_cli,` although a programmer could use this library for any C language program that needs to connect to the event socket. With the `-x` switch (see below) `fs_cli` can issue a command to the server, get a response, and then disconnect.

The `fs_cli` program can connect to FreeSWITCH™, whether it has been started as a service (TODO) or on the console (either background or foreground) (TODO), regardless of operating system.

Expand Down Expand Up @@ -181,7 +151,7 @@ REGISTRATIONS 0
### 4.1 FreeSWITCH API
While connected, the user can issue any command in the [FreeSWITCH API](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) - which are all the commands exposed in the [enabled modules](../Configuration/Configuring-FreeSWITCH/index.mdx#modules) and [mod\_commands](../Modules/mod_commands_1966741).
While connected, the user can issue any command in the [FreeSWITCH API](../Introduction/FreeSWITCH-API.mdx) - which are all the commands exposed in the [enabled modules](../Configuration/Configuring-FreeSWITCH/index.mdx#modules) and [mod\_commands](../Modules/mod_commands_1966741).
See the `console` commands for example, exposed by [mod\_console](../Modules/mod_console_1048950.mdx#about) .
Expand Down Expand Up @@ -311,13 +281,6 @@ loglevel => info
## 7\. See Also
* [mod\_event\_socket](../Modules/mod_event_socket_1048924.mdx#11-acl)
* [Event Socket Library](./Event-Socket-Library/index.mdx#-new-)
* [Event Socket Library](./Event-Socket-Library/index.mdx)
* [Event list](../Introduction/Event-System/Event-List_7143557.mdx#nat)
* [Fs\_gui](https://wiki.freeswitch.org/wiki/Fs%5Fgui "Fs gui")
## Comments:
| See this JIRA for an issue I faced: [FS-7718](https://freeswitch.org/jira/browse/FS-7718?src=confmacro) \-[Authenticate](https://freeswitch.org/confluence/plugins/servlet/applinks/oauth/login-dance/authorize?applicationLinkID=c4b15fa3-ad57-3c05-af05-8c167cb92266) to see issue details I was not able to connect to freeswitch on localhost with fs\_cli until I copied the example conf file from /usr/src/freeswitch to /usr/loca/freeswitch.Maybe future releases won't require this but I'm writing here so at least I know how to resolve tfs\_cli connection issues. ![](/images/icons/contenttypes/comment_16.png) Posted by jungleboogie at Jun 23, 2015 22:55 |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,6 @@ Configuration ideas using PortAudio as a means to exchange audio between FreeSWI

Most of the work on this page on the old wiki was prior to March of 2010\. Some configurations and variable names have changed since then.

Click here to expand Table of Contents

* 1 [Configuration](#configuration-)
* 1.1 [Originating Calls](#-originating-calls-)
* 1.2 [Receiving Calls](#-receiving-calls-)
* 1.3 [Music on Hold](#-music-on-hold-)
* 2 [FreeSWITCH as a Dedicated Soft Phone](#freeswitch-as-a-dedicated-soft-phone-)
* 2.1 [Directory](#directory)
* 2.2 [Dialplan](#dialplan)
* 2.3 [SIP Profiles](#sip-profiles)
* 2.4 [See Also](#see-also)

## Configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,31 +15,6 @@ When you call outbound socket, FS automatically puts the call in PARK. You can v

When you use "**sync**" mode, **many things will not works** as you may expect. Particularly, you will **not get DTMF**s, etc. Please check "**async**" option.


Click to expand Table of Contents

* 1 [Diagram](#diagram)
* 2 [Configuration](#configuration)
* 2.1 [Keywords](#keywords)
* 2.1.1 [async](#events)
* 2.1.2 [full](#events)
* 2.2 [Variables](#variables)
* 2.2.1 [socket\_resume](#socket_resume)
* 2.3 [Examples](#server-examples)
* 3 [Server Examples](#server-examples)
* 3.1 [sock.pl](#sockpl)
* 3.2 [Using Netcat](#using-netcat)
* 3.3 [socket2me](#socket2me)
* 3.4 [Java ESL Client](#java-esl-client)
* 3.5 [Javascript / Node.js server](#javascript--nodejs-server-)
* 4 [Events](#socket2me)
* 4.1 [Verto Live Array](#verto-live-array)
* 5 [FAQ](#events)
* 5.1 [Q: Ordering and async keyword](#q-ordering-and-async-keyword)
* 5.2 [Q: Should I use sync mode or async mode?](#q-should-i-use-sync-mode-or-async-mode-)
* 5.3 [Q: Why are API commands returning 'command not found'?](#q-why-are-api-commands-returning-command-not-found-)
* 5.4 [Q: Can I bridge a call with an Outbound socket?](#q-can-i-bridge-a-call-with-an-outbound-socket)

## Diagram

```xml
Expand Down Expand Up @@ -124,7 +99,7 @@ There are several example Perl scripts that use the ESL library. Here's good one

[libs/esl/perl/server2.pl](https://freeswitch.org/stash/projects/FS/repos/freeswitch/browse/libs/esl/perl/server2.pl)

To run it you will need to compile ESL and perlmod. More information is available on the [ESL](./index.mdx#-new-) page.
To run it you will need to compile ESL and perlmod. More information is available on the [ESL](./index.mdx) page.

### Using Netcat

Expand Down Expand Up @@ -426,7 +401,7 @@ You can build on this template in your own JS code.

## FAQ

### Q: Ordering and async keyword
### Q: Ordering and async keyword

_When using async keyword, is there any guarantee regarding ordering?_

Expand Down
Loading

0 comments on commit 4aee7f3

Please sign in to comment.