Skip to content

sorbayhq/sorbay

Repository files navigation

Open source asynchronous video communication tool

Quickly create and share screen and camera recordings.

The project comes in two parts:

  • The backend service to store, organize and share recordings (this project)
  • Client for Windows, macOS and Linux(soon) to do the actual recordings

Setup

First, clone the repository to your local machine.

git clone https://github.com/sorbayhq/sorbay
cd sorbay

Next, run the following to set the project up for local development.

On macOS/Linux, make sure to have Docker and Docker-Compose installed. And run:

sh setup/setup.sh

on Windows, make sure to have Docker Desktop installed. And run

setup\setup.cmd

Deployment

Once everything is set up, run the stack.

docker compose up

The backend service should now be running at http://localhost:8000/. On your first visit, you should be redirected to a "Sign In" page. Click on "register" at the bottom to create an account. You can now download the client. Make sure to point it to your local backend service at http://localhost:8000/ during setup.

Leave a star

Consider leaving a star on this Github repository if you think what we are building is useful or might be useful at some point. We are in our very early stages and we don't collect any telemetry. Getting a star is the only viable metric for us to gauge interest.

Hosted Sorbay

We are currently working on a hosted backend service called Sorbay Cloud, due to release in Q2 2023. Make sure to join the waitlist to get notified once we are ready.

Sorbay Cloud will allow you to get up and running in a couple of minutes. Instead of deploying the backend service yourself, simply create an account, download the client and record your first video.

State of the project

Sorbay is in its very early stages. Consider it an alpha that shouldn't be running in production just yet. We are currently working on additional features and these will be influenced by feedback from the community.

Help, bugs & discussion

If you encounter any bugs open up an issue in this repository. If you need help or want to chat about the project, join our Slack channel.