]> git.ipfire.org Git - thirdparty/freeswitch.git/blob - README.md
[Build-System] Update libks and signalwire-c requirements to 2.0
[thirdparty/freeswitch.git] / README.md
1 # FreeSWITCH
2
3 FreeSWITCH is a Software Defined Telecom Stack enabling the digital transformation from proprietary telecom switches to a versatile software implementation that runs on any commodity hardware. From a Raspberry PI to a multi-core server, FreeSWITCH can unlock the telecommunications potential of any device. Combined with our hosted cloud platform, SignalWire, FreeSWITCH can interconnect with the outside world and scale to any size.
4
5 Visit [https://signalwire.com](https://signalwire.com/) or https://github.com/signalwire for more info.
6
7 ## Getting Started
8
9 FreeSWITCH is available on [Github](https://github.com/signalwire/freeswitch) in source code format. You can checkout the development branch and build for many popular platforms including Linux, Windows, MacOSX and BSD. There is an issue tracker and pull request system available as part of the repo online.
10
11 See https://developer.signalwire.com/freeswitch/FreeSWITCH-Explained/ for more detailed instructions.
12
13 ## Additional Help
14
15 If you need assistance or have an interest in using a commercially supported build, you can contact coreteam@freeswitch.com to learn about professional services to support your project.
16
17 ## Voice-over-IP services - SIP / SMS - App Integrations
18
19 [SignalWire](https://signalwire.com) is the primary sponsor of the FreeSWITCH project and was founded by the original developers of FreeSWITCH. SignalWire provides scalable services to enhance and scale your project such as SMS, SIP, Serverless Application hosting as well as programmable telecom. mod_signalwire which is distributed in this code base allows you to instantly pair with SignalWire and extend your FreeSWITCH.
20
21 ## Documentation
22
23 The main index for documentation is available at:
24
25 * https://freeswitch.org/confluence/
26
27
28 ### Release notes:
29
30 * https://freeswitch.org/confluence/display/FREESWITCH/Release+Notes
31
32 ### Install from packages
33
34 Step by step tutorials to install FreeSWITCH from packages:
35
36 * [Debian](https://freeswitch.org/confluence/display/FREESWITCH/Debian) [<b>Recommended</b>]
37 * [Raspberry Pi](https://freeswitch.org/confluence/display/FREESWITCH/Raspberry+Pi)
38 * [CentOS 7](https://freeswitch.org/confluence/display/FREESWITCH/CentOS+7+and+RHEL+7)
39
40 ### Build from source
41
42 Example Dockerfiles to build FreeSWITCH and dependencies from source:
43 * https://github.com/signalwire/freeswitch/tree/master/docker/examples
44
45 Step by step tutorials to build FreeSWITCH with provided dependency packages:
46 * [Debian](https://freeswitch.org/confluence/display/FREESWITCH/Debian#Debian-buildfromsource) [<b>Recommended</b>]
47 * [Raspberry Pi](https://freeswitch.org/confluence/display/FREESWITCH/Raspberry+Pi)
48 * [CentOS 7](https://freeswitch.org/confluence/display/FREESWITCH/CentOS+7+and+RHEL+7)
49
50 ## Downloads
51
52 * [Tarballs](https://files.freeswitch.org/releases/freeswitch/)
53 * [Windows Installer](http://files.freeswitch.org/windows/installer/x64/)
54 * [Windows Sound Packages](http://files.freeswitch.org/windows/installer/x64/sounds/)
55
56 ## Contributions
57
58 GitHub pull requests are the recommended way to contribute to the FreeSWITCH source code:
59
60 * https://github.com/signalwire/freeswitch/pulls
61
62 ## Community
63
64 Slack is our chat system where the developers, the FreeSWITCH team, and the most active users are present.
65 This is the place to get answers faster and chat with other users in real time. All you need to do is enter your email and verify it on the Slack signup page and you are ready to join in the discussion!
66
67 Slack Community:
68 * https://signalwire.community/
69
70 Mailing list:
71
72 * http://lists.freeswitch.org/mailman/listinfo/freeswitch-users
73
74 **Thank you for using FreeSWITCH!**