Complete guide for using F-IceCore calling features in Frappe.
After installation, you'll find F-IceCore integrated into your Frappe Desk:
- Navbar Button: Look for the phone icon (📞) in the top navbar
- Keyboard Shortcut: Press
Ctrl+Shift+C(orCmd+Shift+Con Mac) - Apps Screen: Find "F IceCore" in your apps list
- Navigate to Settings → F IceCore Settings
- Verify TURN server configuration (auto-configured if you ran the installer)
- Test connection using the "Test TURN Connection" button
-
Click the phone icon in the navbar
-
The call panel will open showing:
- Online Users: Users available to call
- Call History: Your recent calls
- Settings: Configuration options
-
Find the user you want to call in the "Online Users" tab
-
Click the button:
- 📞 Phone icon = Audio call
- 📹 Video icon = Video call
- Press
Ctrl+Shift+C(orCmd+Shift+C) - A dialog will appear
- Select the user from the dropdown
- Choose call type (Audio/Video)
- Click Call
- Open the call panel (phone icon in navbar)
- Go to Call History tab
- Find a previous call
- Click the phone icon to call back
When someone calls you:
- Ringtone will play
- Call dialog appears showing:
- Caller's name and photo
- Call type (Audio/Video/Screen)
- Two buttons: Accept or Decline
- Click the Accept button
- Grant browser permissions if prompted:
- 🎤 Microphone (for audio calls)
- 📹 Camera (for video calls)
- The call window will open
- Wait 5-10 seconds for connection
- Click the Decline button
- The caller will be notified that you declined
- Call will be logged in history
Audio Calls:
- Caller's avatar/photo
- Call duration timer
- Control buttons at the bottom
Video Calls:
- Large remote video (other person)
- Small local video (you) in bottom-right corner
- Control buttons at the bottom
| Button | Function | Shortcut |
|---|---|---|
| 🎤 | Toggle Microphone | Ctrl+M |
| 📹 | Toggle Camera* | - |
| 📞 | End Call | Ctrl+Shift+H |
*Only available in video calls
- Voice only
- Low bandwidth
- Best for quick conversations
- Audio + Video
- See each other while talking
- Requires camera permission
- Share your screen with others
- Great for demos and support
- Select window/screen when prompted
Method 1:
- Click phone icon in navbar
- Go to Settings tab
- Click "Open F IceCore Settings"
Method 2:
- Go to Settings → F IceCore Settings
- TURN Server: Server IP/hostname (auto-configured)
- TURN Secret: Authentication secret (auto-configured)
- STUN Port: Default 3478
- TURN Port: Default 3478
- TURNS Port: Default 5349 (TLS)
- ✅ Enable Audio Calls: Allow voice calling
- ✅ Enable Video Calls: Allow video calling
- ✅ Enable Screen Sharing: Allow screen sharing
- Max Call Duration: Maximum call length in seconds (0 = unlimited)
- Open F IceCore Settings
- Click Test TURN Connection
- Look for success message:
- ✅ Green = Working correctly
- ❌ Red = Configuration issue
- Click phone icon in navbar
- Go to Call History tab
- See your recent calls with:
- Call direction (incoming/outgoing)
- Call status (answered/rejected/missed)
- Call duration
- Timestamp
- Click phone icon in navbar
- Go to Settings tab
- Click "View Call Statistics"
You'll see:
- Total Calls: All calls made/received
- Answered Calls: Successfully connected calls
- Missed Calls: Calls you didn't answer
- Total Duration: Time spent on calls
- Answer Rate: Percentage of answered calls
Users show different statuses:
| Color | Status | Meaning |
|---|---|---|
| 🟢 Green | Online | Available for calls |
| 🟡 Yellow | Away | May not respond immediately |
| 🔴 Red | Busy | In another call or busy |
| ⚫ Gray | Offline | Not available |
Your presence is automatically managed:
- Online when using Frappe
- In Call when on a call
- Offline after 5 minutes of inactivity
| Shortcut | Action |
|---|---|
Ctrl+Shift+C |
Open quick call dialog |
Ctrl+M |
Toggle mute during call |
Ctrl+Shift+H |
Hang up active call |
Use Cmd instead of Ctrl on macOS
F-IceCore requires browser permissions:
Audio Calls:
- Browser will ask for microphone access
- Click Allow
- Permission saved for future calls
Video Calls:
- Browser asks for camera + microphone
- Click Allow for both
- Permissions saved
Chrome:
- Click lock icon in address bar
- Go to Site Settings
- Allow Camera and Microphone
Firefox:
- Click lock icon in address bar
- Click "Permissions"
- Allow Camera and Microphone
Safari:
- Safari → Preferences → Websites
- Select Camera/Microphone
- Allow for your site
- Use headphones to prevent echo
- Good internet connection (WiFi preferred)
- Close unnecessary browser tabs
- Well-lit area for video calls
- Quiet environment
| Call Type | Minimum Speed | Recommended |
|---|---|---|
| Audio | 50 kbps up/down | 100 kbps |
| Video | 500 kbps up/down | 1 Mbps |
| HD Video | 1.5 Mbps up/down | 3 Mbps |
Check:
- Are other users logged in?
- Is Redis running? (
bench startshould show redis_cache) - Refresh the page
Fix:
# Restart bench
bench restartCheck:
- Browser permissions granted?
- Microphone/camera not used by another app?
- Try different browser (Chrome/Firefox recommended)
Fix:
- Close other apps using camera/microphone
- Restart browser
- Check system permissions (macOS: System Preferences → Security & Privacy)
Check:
- Is the other user online?
- Is their status "Available" (not in another call)?
- Internet connection stable?
Fix:
- Both users refresh the page
- Try again after a few seconds
- Check TURN server status in Settings
Check:
- Internet speed (run speed test)
- Too many people on network?
- VPN enabled?
Fix:
- Close bandwidth-heavy applications
- Use wired connection instead of WiFi
- Disable VPN temporarily
Fix:
-
Administrator needs to run:
cd ~/frappe-bench/apps/f_icecore bash install_scripts/install_coturn.sh
-
Or manually configure in F IceCore Settings
Developers can add call buttons to any DocType:
// Add call button to User form
frappe.ui.form.on('User', {
refresh(frm) {
if (frm.doc.name !== frappe.session.user) {
frm.add_custom_button('Call User', () => {
window.FIceCoreUI.initiateCall(frm.doc.name, 'audio');
}, 'Actions');
}
}
});// Audio call
window.FIceCoreUI.initiateCall('user@example.com', 'audio');
// Video call
window.FIceCoreUI.initiateCall('user@example.com', 'video');
// Screen share
window.FIceCoreUI.initiateCall('user@example.com', 'screen');-
Add MP3 files to
f_icecore/public/sounds/:ringtone.mp3- Incoming call soundcalling.mp3- Outgoing call soundhangup.mp3- Call end sound
-
Or set custom paths in F IceCore Settings
F-IceCore logs:
- ✅ Call timestamps (start/end)
- ✅ Call participants
- ✅ Call duration
- ✅ Call status (answered/rejected/missed)
NOT Logged:
- ❌ Call content/recordings
- ❌ Audio/video data
- ❌ Screen sharing content
- Call metadata stored in Frappe database
- Presence cached in Redis (5-minute TTL)
- No call recordings unless explicitly enabled
- Calls are peer-to-peer when possible
- Media goes directly between users
- Server only handles signaling (not media)
- Check this guide first
- Test TURN connection in Settings
- Check browser console for errors (F12)
- Contact administrator if issues persist
When reporting issues, include:
- Browser and version
- Operating system
- Steps to reproduce
- Browser console errors (F12 → Console tab)
Check if F-IceCore is loaded:
console.log(window.FIceCore);
console.log(window.FIceCoreUI);Get debug info:
console.log({
socketio: frappe.socketio.socket.connected,
ice_servers: window.FIceCore.iceServers,
user: frappe.session.user
});Test presence:
frappe.call({
method: 'f_icecore.f_icecore.api.presence.get_online_users',
callback: (r) => console.log('Online users:', r.message)
});Happy Calling! ❄️📞
For technical documentation, see README.md and TESTING_GUIDE.md