https://github.com/fishjam-dev/fishjam

General purpose media server. Supports WebRTC, HLS, RTSP, SIP
https://github.com/fishjam-dev/fishjam

hls real-time rtsp sip webrtc

Last synced: about 2 months ago
JSON representation

General purpose media server. Supports WebRTC, HLS, RTSP, SIP

• Host: GitHub
• URL: https://github.com/fishjam-dev/fishjam
• Owner: fishjam-dev
• License: apache-2.0
• Created: 2022-12-21T21:20:41.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-16T09:19:36.000Z (9 months ago)
• Last Synced: 2024-05-16T09:49:16.939Z (9 months ago)
• Topics: hls, real-time, rtsp, sip, webrtc
• Language: Elixir
• Homepage: https://jellyfish-dev.github.io/jellyfish-docs/
• Size: 6.98 MB
• Stars: 157
• Watchers: 5
• Forks: 7
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fishjam

[![codecov](https://codecov.io/gh/fishjam-dev/fishjam/branch/main/graph/badge.svg?token=ANWFKV2EDP)](https://codecov.io/gh/fishjam-dev/fishjam)

[![CircleCI](https://circleci.com/gh/fishjam-dev/fishjam.svg?style=svg)](https://circleci.com/gh/fishjam-dev/fishjam)

Fishjam is an open-source, general-purpose media server that ships with support for multiple media protocols.

It can be thought of as a multimedia bridge meant for creating different types of multimedia systems that lets 

you easily create a real-time video conferencing system, a broadcasting solution, or both at the same time.

It leverages the [Membrane RTC Engine](https://github.com/fishjam-dev/membrane_rtc_engine), a real-time communication engine/SFU library built with [Membrane](https://membrane.stream/).

## Installation

There are two ways of running Fishjam:

- building from source (requires Elixir and native dependencies)

- using Fishjam Docker images

To learn more, refer to [Installation page](https://fishjam-dev.github.io/fishjam-docs/getting_started/installation) in Fishjam docs.

## SDKs

Fishjam provides server SDKs (used to manage the state of Fishjam server) and client SDKs (used to connect to the Fishjam instance, receive media, etc.).

To get the list of all available SDKs, go to [SDKs page](https://fishjam-dev.github.io/fishjam-docs/getting_started/sdks) in Fishjam docs.

## Examples

- WebRTC Dashboard

    A standalone dashboard that can create rooms, add peers and send media between the peers. Available [here](https://github.com/fishjam-dev/fishjam-dashboard).

To use the dashboard, you need to set up Fishjam with WebRTC, refer to [WebRTC peer page](https://fishjam-dev.github.io/fishjam-docs/getting_started/peers/webrtc) in Fishjam docs to learn how to do that.

Dashboard makes HTTP requests to Fishjam that need to be authorized and requires a token to do so, learn more from [Authentication page](https://fishjam-dev.github.io/fishjam-docs/getting_started/authentication) in Fishjam docs.

## Documentation

Everything you need to get started with Fishjam is available in the [Fishjam docs](https://fishjam-dev.github.io/fishjam-docs/).

You can read about theoretical concepts and problems we encountered in the [Fishjambook](https://fishjam-dev.github.io/book/).

## Copyright and License

Copyright 2022, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)

[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)

Licensed under the [Apache License, Version 2.0](LICENSE)