https://github.com/wwwakcan/coturn-setup
A bash script for easy installation and configuration of a COTURN server. This script helps you set up a STUN/TURN server with basic authentication and no SSL.
https://github.com/wwwakcan/coturn-setup
Last synced: 3 months ago
JSON representation
A bash script for easy installation and configuration of a COTURN server. This script helps you set up a STUN/TURN server with basic authentication and no SSL.
- Host: GitHub
- URL: https://github.com/wwwakcan/coturn-setup
- Owner: wwwakcan
- Created: 2025-02-23T15:17:13.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-23T15:20:46.000Z (3 months ago)
- Last Synced: 2025-02-23T16:24:43.550Z (3 months ago)
- Language: Shell
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple COTURN Server Setup Script
A bash script for easy installation and configuration of a COTURN server. This script helps you set up a STUN/TURN server with basic authentication and no SSL.
## Use Cases
This STUN/TURN server can be used in various WebRTC applications and VoIP solutions:
### WebRTC Applications
- Video conferencing applications
- Peer-to-peer file sharing
- Live streaming solutions
- Browser-based chat applications
- Online gaming platforms
- Remote desktop applications
### VoIP Solutions
- SIP clients (JsSIP, SIP.js)
- WebRTC-based softphones
- VoIP mobile applications
- IP PBX systems
- Video calling applications
### Frameworks & Libraries
Can be integrated with:
- JsSIP
- SIP.js
- WebRTC.js
- Janus Gateway
- FreeSWITCH
- Asterisk
- Kamailio
- OpenSIPS
### Example Integration with JsSIP
```javascript
let socket = new JsSIP.WebSocketInterface('wss://your-websocket-server');
let configuration = {
sockets : [ socket ],
uri : 'sip:your_extension@your-sip-domain',
password : 'your-password',
iceServers: [
{ urls: ['stun:your-ip:3478'] },
{
urls: ['turn:your-ip:3478'],
username: 'your-turn-username',
credential: 'your-turn-password'
}
]
};
let phone = new JsSIP.UA(configuration);
phone.start();
```
### Example Integration with WebRTC
```javascript
const configuration = {
iceServers: [
{
urls: "stun:your-ip:3478"
},
{
urls: "turn:your-ip:3478",
username: "your-turn-username",
credential: "your-turn-password"
}
]
};
const pc = new RTCPeerConnection(configuration);
```
## Features
- Simple interactive installation
- Basic STUN/TURN server configuration
- No SSL/TLS (suitable for basic setups)
- Automatic firewall configuration
- User credential management
- Uses IP as realm
## Requirements
- Ubuntu/Debian based system
- Root privileges
- Internet connection for package installation
## Installation
1. Clone the repository:
```bash
git clone https://github.com/wwwakcan/coturn-setup.git
```
2. Make the script executable:
```bash
chmod +x coturn-setup.sh
```
3. Run the script:
```bash
sudo ./coturn-setup.sh
```
## Usage
The script provides an interactive menu with the following options:
1. Install COTURN
- Updates system packages
- Installs COTURN server
- Enables the service
2. Configure COTURN
- Sets server IP address
- Creates user credentials
- Configures firewall rules
- Generates configuration file
3. Exit
## Configuration Details
The script will configure COTURN with:
- STUN/TURN ports: 3478 (UDP/TCP)
- Alternative port: 5349
- UDP relay ports: 49152-65535
- No TLS/DTLS encryption
- Simple logging
- Basic authentication
## Output Example
After configuration, you'll receive:
```
Access Information:
----------------------------------------
STUN Server : stun:YOUR_IP:3478
TURN Server : turn:YOUR_IP:3478
Username : your_username
Password : your_password
Realm : YOUR_IP
Supported Protocols:
- STUN/TURN UDP : Port 3478
- STUN/TURN TCP : Port 3478
----------------------------------------
```
## Security Note
This script configures COTURN without SSL/TLS encryption. It's suitable for basic testing or development environments. For production use, consider adding proper SSL/TLS configuration.
## Contributing
Feel free to fork the repository and submit pull requests for any improvements.
## License
MIT License - feel free to use and modify as needed.