sync/README.md

60 lines
1.5 KiB
Markdown
Raw Normal View History

2013-05-23 11:40:52 -03:00
Read before submitting an issue: https://github.com/calzoneman/sync/wiki/Reporting-an-Issue
===========================================================================================
2013-02-16 11:19:59 -06:00
calzoneman/sync
===============
2013-02-15 23:02:42 -06:00
2013-02-16 11:19:59 -06:00
About
-----
2013-04-09 16:44:47 -05:00
CyTube (formerly Sync) is a server/client combination providing media synchronization, chat,
and administration for an arbitrary number of channels.
I began developing this as a hobby project, and when Synchtube announced their closure, I
began polishing it and readying it for the public.
2013-05-12 17:33:23 -03:00
I am hosting a CyTube server at http://cytu.be
2013-02-16 11:19:59 -06:00
The serverside is written in JavaScript and runs on Node.JS. It makes use
of a MySQL database to store user registrations, cached media metadata, and
data about each channel.
The clientside is written in JavaScript and makes use of Socket.IO and
2013-04-09 16:44:47 -05:00
jQuery as well as the APIs for various media providers.
The web interface uses Bootstrap for layout and styling.
2013-02-16 11:19:59 -06:00
2013-04-09 16:44:47 -05:00
The following media sources are currently supported:
- YouTube (individual videos)
- YouTube Playlists
- Vimeo
- Dailymotion
- Soundcloud
- Livestream.com
- Twitch.tv
2013-05-17 14:39:58 -04:00
- Justin.tv
2013-08-21 18:56:52 -05:00
- Ustream.tv
2013-04-09 16:44:47 -05:00
- RTMP livestreams
2013-08-21 18:56:52 -05:00
- Custom `<iframe>` and `<object>` tags
2013-02-16 11:19:59 -06:00
Installing
----------
2013-08-21 18:56:52 -05:00
Installation instructions are available here: https://github.com/calzoneman/sync/wiki/Installing
2013-04-09 16:44:47 -05:00
2013-02-16 11:19:59 -06:00
Running
-------
2013-10-12 02:13:48 -04:00
Start the server: `node index.js`
2013-02-16 11:19:59 -06:00
You should now be able to connect via `yourhostname:port` where `port` is
the port you defined in config.js
Feedback
--------
Please open a GitHub Issue.
License
-------
2013-03-23 21:28:20 -05:00
Licensed under MIT
2013-02-16 11:19:59 -06:00
See LICENSE for the full license text