Welcome to LIVE
A Nutty Software production - http://www.nutty.ca/live/


VERSION
Beta 1


ABOUT
This readme is provided to help you setup your LIVE server. Each
operating system has difference requirements, so view the table of
contents below and jump down to the appropriate section to get
started.


TABLE OF CONTENTS
1. Executables
2. Ports, routers, and firewalls
3. LIVE Admin for Windows
4. LIVE Command Line for Windows and Linux
5. Registering a Switchboard Account
6. Configuration (config.xml)
7. Credits


1. Executables
i.   LiveAdmin.exe  Windows GUI server
ii.  LiveCL.exe     Windows command line server
iii. LiveCL         Linux command line server


2. Ports, routers, and firewalls
If you're behind a router or firewall, it's important that you
forward traffic on certain ports to your server machine. The
following ports are used by the LIVE server.

i.  TCP port 4502
ii. TCP port 943

TCP port 4502 is the default port used by the LIVE server to host
your room. You are free to modify this; however keep in mind that
Silverlight clients are limited to the port range 4502 - 4534.
The Silverlight LIVE client will be unable to connect to any port
outside this range.

TCP port 943 is used for a Silverlight policy server, which is
required to grant access to LIVE Silverlight clients connecting to your
server. This port value cannot be changed.


3. LIVE Admin for Windows
If you are running LIVE on a Windows based PC, you have two options.
The easiest solution is to run the LIVE Admin executable. This GUI
application makes it easy to start and stop your server, sign up and
sign in to the LIVE Switchboard server, and manage your room.
Alternatively you can run the LIVE Command Line server application,
which will start up your server automatically based on the values
stored in the configuration file. If you already ran the LIVE Admin
GUI, the configuration file will contain your server settings that
will be used by the command line server.

For more help on the LIVE Admin GUI, refer to the help menu in the
application.


4. LIVE Command Line for Windows and Linux
If you are on Linux or you prefer to run the command line version,
you will first need to setup the config.xml file. All of the
properties you need to configure such as your room name, maximum
number of supported clients, etc. is listed in the configuration
file. Simply modify the values to how you would like to run your
server. The only exception here is passwords. Passwords are not
stored in plaintext, they are specially encrypted. You must use
command line arguments in order to supply password information
to the LIVE server. After running, the LIVE server will automatically
encrypt and save the passwords to the configuration file for the next
load.

The following is a list of command line options. You can also view
the command line list by using the keyword "-h" or "--help".

-h or --help					View the list of command line options.
-v or --version					View the version info.
-sp or --switchboardPassword	Specify the switchboard password.
-ap or --adminPassword			Specify the password for the admin account.
-mp or --modPassword			Specify the password for the moderator account.
-up or --userPassword			Specify the password for the user account.

Example: LiveCL --sp "My Switchboard Password" -up "12345"


5. Registering a Switchboard Account
If you are not on a Windows based PC and cannot register with the LIVE
Admin GUI, you can use the web interface to create an account. Visit
http://www.nutty.ca/Switchboard/Register to register a new account.
After registering, put your switchboard account username in the
config.xml file and start the LIVE command line server with the
argument -sp "My Password" to set the password for your switchboard
account.

If you forgot your password, you can have it reset by going to
http://www.nutty.ca/Switchboard/UserResetPassword.


6. Configuration (config.xml)
LIVE Admin GUI provides all the configuration options you need, but
if you're using the command line tool then it's important you
configure your server before running it. You can reuse the config.xml
file generated by the LIVE Admin GUI, or you can manually edit
the file yourself. The following is a quick rundown of all the
configuration settings in the config.xml file.

RelayServerPort="4502"
- Specifies the port to be used by the LIVE server.

RoomName="My Room"
- Specifies the name of your room. When users connect to your server,
they will see this name in their room summary page. If you sign into
the LIVE Switchboard, you do not need to specify a room name. Your
server will automatically use the room name you registered with your
switchboard account.

RoomSummary="Welcome to my room"
- A brief text displayed in the user's room summary page.

RoomMaxClients="32"
- Specifies the maximum number of connections allowed to your server.

RoomIsPublic="false"
- If you sign into the LIVE Switchboard, you have the option to
publicly announce your room on the Internet. Clients will be able to
find your room and join it.

AudioCompressionQuality="8"
- Specifies the audio compression quality from 1 to 10, with 1 being
lowest bitrate and 10 being highest. The following table lists the
bitrate associated with each quality level.

Level 1 = 10 kbps
Level 2 = 12 kbps
Level 3 = 14 kbps
Level 4 = 17 kbps
Level 5 = 21 kbps
Level 6 = 24 kbps
Level 7 = 28 kbps
Level 8 = 32 kbps
Level 9 = 38 kbps
Level 10 = 46 kbps

MediaPath="./media/"
- Specifies the location to save files uploaded by users. You can use
a relative or absolute path.

MaxMediaSize="128000"
- Specifies the maximum file size, in bytes, that can be uploaded by
a user. Users that send a file larger than this value will receive an
error.

MediaPreviewWidth="128"
MediaPreviewHeight="78"
- After a user uploads an image file, a preview version is
created. These two parameters identify the resolution of the preview
image.

IpDiscoveryUrl=""
SwitchboardUrl=""
- These two parameters identify the location to communicate with the
Switchboard server. These should not be changed.

SwitchboardUsername=""
SwitchboardPassword=""
- Specifies the name and password used to login to the switchboard
server. Passwords are not stored in plaintext. You must use the LIVE
Admin GUI or the command line parameter -sp to set this password.
The server will automatically save the encrypted password to the
configuration file.

SwitchboardAutoLogin="true"
If both a switchboard username and password are provided, the command
line server will automatically log into the switchboard server on
startup. For command line servers, you must set this to true if you
want the server to log into the switchboard.

User Privileges
- The LIVE server has three level of users.

i. Administrators - full permissions
2. Moderators - privileged users
3. Users - everyone else

You can selectively enable or disable certain accounts, depending on
how you want to secure your server. In a typical private conference,
you would allow full access to normal users. If you are broadcasting
to a large audience, then you will likely want to limit the features
available to a normal user while granting access to moderators that
will be talking or posting media content.

The following is a list of permissions.
voice - Set true to allow the user to communicate with their microphone
chat - Set true to allow the user to send chat messages
viewPhotos - Set true to allow the user to view photos
postPhotos - Set true to allow the user to post photos
deletePhotos - Set true to allow the user to remove photos


7. Credits
LIVE makes use of the following 3rd party libraries.
i.    libjpeg. Copyright (C) 1991-2012, Thomas G. Lane, Guido Vollbeding.
ii.   OpenSSL. Copyright (c) 1998-2011 The OpenSSL Project
      Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
iii.  Speex. Copyright 2002-2008 Xiph.org Foundation
iv.   Zlib. Copyright (C) 1995-2012 Jean-loup Gailly and Mark Adler