elias/vdo.ninja
1
0
Fork 0
mirror of https://github.com/eliasstepanik/vdo.ninja.git synced 2026-01-18 09:08:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Steve Seguin 2020-05-01 13:14:49 -04:00 committed by GitHub
parent dcd07a777a
commit 47e06550c9
1 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -1,30 +1,33 @@
![ILogo by brimace](obsNinja_logo_full.png)
## What's in this repo?
This is the client-side software for OBS.ninja. Feel free to use it as you will; code contributions very welcomed. You may be best suited at getting ahold of me at steve@seguin.email instead of via Github if urgent though.
## How to Deploy this Repo:
To use, just download and host on a HTTPS-enabled webserver. You may want to hide the .html extensions within your HTTP server as well, else the generated links will not work. Customize the code as desired. Poke me at steve@seguin.email if you wish to commit your changes to obs.ninja directly.
Directions on how to deploy a TURN server are listed in the turnserver.conf file. Useful for bypassing firewalls.
Why deploy? You may want to customize the UI for your brand/business, or control security/privacy beyond what I do already. The server API is fairly flexible, so you can also add features that I do not include currently. Please be aware that the SERVER api changes often, at least at this point in early development, so it is best to CONTRIBUTE to this repo if you intend to keep things compatible.
## What is OBS NINJA
OBS.ninja uses peer 2 peer technology to bring remote cameras into OBS. The server-side load is very small, so I am able to offer it as a service for free. It can be found at https://obs.ninja and the beta version can be found at https://obs.ninja/beta
OBS.Ninja uses peer-to-peer technology to bring remote cameras into OBS. In most cases, all video data is transferred directly from peer to peer, without needing to go through any remote server. This results in high-quality video with super low latency. In a small number of cases, video data may go through an encrypted TURN server, which is used to facilitate peer connections when otherwise not possible.
OBS Ninja is not affiliated with OBS, but OBS Ninja is dependent on OBS to function.
OBS Ninja is not affiliated with OBS, but OBS Ninja is dependent on OBS to function. OBS.Ninja is designed to allow content creators to produce real-time live shows with OBS Studio and to allow smartphones to be used as webcams on a Windows PC.
Please see the sub-reddit added info: https://reddit.com/r/obsninja
Also check out the FAQ for more info: https://github.com/steveseguin/obsninja/wiki
## How to use:
I demo the basic usage of OBS.ninja also on YoutuBe: https://www.youtube.com/watch?v=6R_sQKxFAhg
I demo the basic usage of OBS.Ninja also on YoutuBe: https://www.youtube.com/watch?v=6R_sQKxFAhg
Check the subreddit for added use cases, advanced features, and support.
Check the subreddit for added use cases, advanced features, and support. This includes high-quality audio modes, custom resolutions and video bitrates, and more.
MacOS users will face some challenges in using OBS currently, but there are workarounds.
## What's in this repo?
This repo contains the software for OBS.ninja and its TURN server deployment settings. Feel free to use it as you will; code contributions very welcomed. You may be best suited at getting ahold of me at steve@seguin.email instead of via Github if urgent though.
## How to Deploy this Repo:
To use, just download and host on a HTTPS-enabled webserver. You may want to hide the .html extensions within your HTTP server as well, else the generated links will not work. Customize the code as desired.
Directions on how to deploy a TURN server are listed in the turnserver.conf file. You may wish to do so if you are having problems with my existing TURN server, although most users will not need one. About 10% of users, those often connected via 4G LTE, will require a TURN server. My TURN server does cost me money to host, which I do for free, so please do not abuse it.
Why deploy OBS.Ninja? You may want to customize the UI for your brand/business, or control security/privacy beyond what I do already. I personally feel it is best to CONTRIBUTE desired changes to this repo instead, as technology moves fast and older forked versions will become obsolete.
## Server side / API software?
The Server-side software uses code from my other project, https://Steves.app and https://meshcast.io I have not made the server side software public yet, but the API remains free to access and use. If it gets abused, I'll put up restrictions. I do my best to not collect data of any type, but I may do so to improve the service, such as monitoring site usage, logging errors, or ensuring reliable connectivity.
Other than the hosted TURN server, OBS.Ninja uses public STUN servers and a hosted handshake server. These are used to facilitate the initial setup of peer connections and are not required after a peer connection is established. Development builds of OBS.Ninja may included debugging software, but in-production releases have this removed.
## Issues? problems? Not working?
@ -32,7 +35,7 @@ Please see the sub-reddit for more support: https://reddit.com/r/obsninja
Also check out the FAQ for common answers: https://github.com/steveseguin/obsninja/wiki
If urgent, email me at steve@seguin.email or join me on discord: https://discord.gg/EksyhGA
If urgent, join me on discord: https://discord.gg/EksyhGA or email me at steve@seguin.email
## Related Projects
#### OBS.Ninja's Electron Capture:
@ -44,10 +47,12 @@ A website designed to also work with OBS.Ninja as a Broadcasting tool. Share you
https://steves.app/
## Privacy
I try to avoid data collection whenever possible. Video streams are generally private, but I've yet to fully-secure the system, so use at your own risk. It is best to not share links created with OBS.ninja with those you do not trust. I've provided instructions on how to deploy a TURN server if IP-address privacy is an issue or if direct peer-to-peer connectivity is blocked by a firewall. See: turnserver.conf
I try to avoid data collection whenever possible and video streams are generally designed to be private, but use at your own risk. It is best to not share links created with OBS.Ninja with those you do not trust. I've provided instructions on how to deploy a TURN server if IP-address privacy is an issue for you. See: turnserver.conf
Additional security features are being added weekly. Please ask about these options.
## Feedback
Idea, feed back, bugs, etc -- all welcomed. I'm dumping many of my ideas as issues into Github. Email me or post to the subreddit
Idea, feed back, bugs, etc -- all welcomed. I'm dumping many of my ideas as issues into Github. Feedback is typcially most welcomed via Email or Discord.
## License
License? Well, currently it is free to use and modify however you wish. Please link back here if redistributing. I reserve the right to release future versions that may not be free or may have a different liceence agreement. I cannot be held responsible for what you do with my software and if my server goes down, I will not be responsible for that either.
License? Well, currently it is free to use and modify however you wish. Please link back here if redistributing. I reserve the right to release future versions that may not be free or may have a different licence agreement. I cannot be held responsible for what you do with my software and if problems occur I will not be responsible for that either.