Update README.md

This commit is contained in:
Calvin Montgomery 2013-08-21 18:56:52 -05:00
parent 3abc7ca0c6
commit b45dfac99b

View file

@ -31,32 +31,14 @@ The following media sources are currently supported:
- Livestream.com
- Twitch.tv
- Justin.tv
- Ustream
- Ustream.tv
- RTMP livestreams
- Custom `<iframe>` and `<object>` tags
Installing
----------
Installation instructions for specific distributions are available here: https://github.com/calzoneman/sync/wiki/Installing
This assumes you have Node.JS installed.
I'm using v0.10, please feel free to report which versions do/do not work.
I recommend using at least v0.8.20 due to a bug in previous versions of node
that caused sketchy client connections to crash the server.
First install MySQL on the server. There are many online tutorials for setting up MySQL on
various operating systems.
I recommend installing phpMyAdmin so that you have a nice database administration interface.
Create a new user and database, and make sure the user has full permissions for the database.
Then, follow these instructions to install CyTube:
1. Clone this repository (`git clone https://github.com/calzoneman/sync`)
2. cd to the directory containing the source files
3. Install your distribution's `libmysqlclient` package.
3. Install dependencies: `npm install`
4. Edit `config.js` and input your database details and connection port. Optionally, configure an SMTP transport to use for sending password reset emails (see https://github.com/andris9/Nodemailer).
5. Edit `www/assets/js/iourl.js` and change the value of `IO_URL` to `yourhostname:port` where `port` is the port defined in `config.js`. Also change `WEB_URL` to `yourhostname:web_port` where `web_port` is the websocket port you defined in `config.js`
Installation instructions are available here: https://github.com/calzoneman/sync/wiki/Installing
Running
-------