home *** CD-ROM | disk | FTP | other *** search
/ CD Shareware Magazine 1999 April / CD_Shareware_Magazine_31.iso / Free / Internet / shoutcast-win32-101.exe / README.TXT next >
Encoding:
Text File  |  1999-01-15  |  9.0 KB  |  197 lines
  1.           _ _          __ _        _             _              _   
  2.  _ _ _  _| | |___ ___ / _| |_   __| |_  ___ _  _| |_ __ __ _ __| |_ 
  3. | ' \ || | | (_-</ _ \  _|  _| (_-< ' \/ _ \ || |  _/ _/ _` (_-<  _|
  4. |_||_\_,_|_|_/__/\___/_|  \__| /__/_||_\___/\_,_|\__\__\__,_/__/\__|
  5. ====================================================================
  6.                                               streaming audio system
  7.  
  8. README.TXT v1.01 for SHOUTCAST SERVER 1.01 - Jan 15 1999
  9.  
  10. Table of Contents:
  11.   Introduction
  12.   Updates
  13.   Pricing
  14.   Bug reporting
  15.   Credits 
  16.   Installation
  17.   Configuration
  18.   Tech Notes / How it Works
  19.   Remote Administration (new in .TXT v1.01)
  20.   A Word To The Unwise
  21.   License
  22.  
  23. Introduction:
  24.  
  25.   SHOUTcast is a streaming audio system for Windows and Un*x platforms.
  26. The SHOUTcast server is the core of the system, and includes unique
  27. features which distinguish SHOUTcast from other servers, including the 
  28. ability to relay a common stream across multiple SHOUTcast servers to
  29. distribute load, and automatic integration into the SHOUTcast directory
  30. at http://yp.shoutcast.com for effective exposure of your SHOUTcast
  31. server to the world at large, when desired.
  32.  
  33.   SHOUTcast is a product of Nullsoft, Inc, makers of the fantastically
  34. popular Winamp audio player for Win32.  The SHOUTcast system relies on
  35. Winamp for playback and content sourcing.  Winamp is available at
  36. http://www.winamp.com
  37.  
  38. Updates:
  39.  
  40.   SHOUTcast world headquarters is at http://www.shoutcast.com.  Stop by 
  41. to snag the latest version and view online documentation (with pictures,
  42. no less.)
  43.  
  44.   You can view other cool stuff Nullsoft does by visiting the Nullsoft 
  45. home on the web at http://www.nullsoft.com.
  46.  
  47. Pricing:
  48.  
  49.   SHOUTcast is designed to be a by the people, for the people product.
  50. If you are a nonprofit or non-commercial agency, you are free to use
  51. the SHOUTcast product at no cost whatsoever.
  52.  
  53.   Commercial agencies (radio stations, for-profit audio broadcasters, etc)
  54. are asked to help defray the cost of production and maintenance of the
  55. SHOUTcast directory by purchasing SHOUTcast.  The price is currently set
  56. at $299 per server.  Contact sales@shoutcast.com for more info, or visit
  57. the web page.
  58.  
  59. Bug reporting:
  60.  
  61.   SHOUTcast is freeware, and doesn't really have a support team to back it
  62. up.  If you come up with an intelligent question or notice a glaring bug,
  63. please notify us at bugfixes@shoutcast.com, but be advised we cannot 
  64. guarantee we'll be able to get back to you.
  65.  
  66. Credits:
  67.   Justin Frankel        -     System design, and coding.
  68.   Tom Pepper            -     Database design, and coding.
  69.   Dana Dahlstrom        -     Web wonking.
  70.   Jennifer Spencer      -     Moral support.
  71.   Laura Gunn
  72.  
  73.   Thanks to our faithful (and reliable) beta testers:
  74.   Taber, Jamuraa, Dr_Dan, and D4.
  75.  
  76. Installation:
  77.  
  78. Windows:  Unzip into an appropriate location on your drive, i.e. c:\shoutcast.
  79. Make sure you have three files:  sc_serv.exe, sc_serv.ini, and readme.txt.
  80.  
  81. Unix versions:  Use gunzip and tar to decompress and extract the necessary
  82. binaries for your particular operating system.  When complete, you should
  83. have three files:  the server binary, server config file, and this readme.
  84. Make certain the server is chmod u+x, and that the config file is readable
  85. by the user you want to run the server as.  The server does *not* need to
  86. be run as root, unless you want to use port numbers below 1024 to serve
  87. SHOUTcast audio streams.
  88.  
  89. Configuration:
  90.  
  91. Windows:  Edit the sc_serv.ini file in Notepad or click the Edit Config menu 
  92. item in the server.  The parameters should be self-explanatory.  Remember
  93. to quit and restart your server (if it's running) to cause the changes to take
  94. effect.
  95.  
  96. Unix:  Edit the sc_serv.conf file in the text editor of your choice.  Tom
  97. would prefer you use Emacs, because it makes Justin really mad.  Justin would
  98. prefer you use vi, because he thinks Tom suffers from some vicious malaise.
  99. You'll probably be lame and end up using Pico.
  100.  
  101. Tech Notes / How it Works:
  102.  
  103. Without going into too much detail, the SHOUTcast server is an intelligent
  104. repeater.  It receives data from a source, notifies the SHOUTcast directory
  105. when requested to by the client, and repeats the data from the source to
  106. the listeners.  It attempts to do this rather efficiently.
  107.  
  108. The Windows server runs under any 32 bit Windows O/S (NT, 95, 98).  It's
  109. a threaded, multi-processor aware application.  It uses about 2MB of RAM
  110. and very little CPU.
  111.  
  112. The Unix server runs (as of this release) on AIX 4.1, FreeBSD, Linux glibc 
  113. and libc5, and IRIX 5.3 and 6.2.  We'd like to port it to other operating
  114. systems, but we can't run around releasing source, unfortunately.  If you
  115. or someone you love can donate a server for a few hours, we'll do our best
  116. to accomodate.  FreeBSD is the development O/S for SHOUTcast server, and
  117. the O/S we use primarily for testing.
  118.  
  119. Remote Administration:
  120.  
  121. The SHOUTcast server has some remote administration capabilities. v1.01 now
  122. better handles remote disconnects and has less DoS attack potential.
  123. To use the remote administration commands, telnet to the machine running
  124. the server the listening port (usually 8000). Then, you can type in two 
  125. commands:
  126.  
  127.   LOG yourpasswordhere
  128.   - or -
  129.   TAILLOG yourpasswordhere
  130.  
  131. The LOG command sends the entire log. The TAILLOG command sends the end of
  132. the log and tails it, meaning you can monitor how many listeners you have,
  133. etc. NOTE that when you type in the LOG command you may or may not see your
  134. typing. If you see no text, just type it anyway (it is working..)
  135.  
  136.  
  137. A Word To The Unwise:
  138.  
  139. All listeners are only able to listen at what their connections can support.
  140. For most users on the net, when you consider modem/PPP overhead, internet 
  141. congestion, and the fact that most modems out there are around 33.6kbps, it
  142. makes sense to use 24kbps for most public streaming. Even though, 
  143. theoretically, 33.6 users should be able to listen at 32kbps, with overhead 
  144. it becomes impossible.
  145.  
  146. Anyone with a 56k modem sending to an upstream server is affected by the 
  147. asymmetric nature of 56k modems. That is, the fastest a 56k modem can download 
  148. data as fast as 53kbps, the upload data is at most 31.2kbps. Sorry, no
  149. 56 or 32kbps streams are servable over a 56k modem.
  150.  
  151. You cannot serve more users that you have available bandwidth. If you're 
  152. running the SHOUTcast server over a modem link at any speed, the most you 
  153. can muster is one user at 24 or 32kbps. Attempting to serve more users than
  154. you have bandwidth only causes skippage.
  155.  
  156. Shell sysadmins will be *very* unhappy if you consume their available 
  157. bandwidth and server processes without their consent. SHOUTcast is a highly 
  158. demanding program of both software processes and bandwidth. A T1 line can only 
  159. theoretically support about 60 listeners if no other traffic is on that T1. 
  160. Additionally, each listener takes up a system process on the server operating 
  161. system, which can crash some operating systems if allowed to expand beyond
  162. the limits of the system. If you throw up a SHOUTcast server unbeknownst to 
  163. the sysadmin with 50+ maximum users, you had better be prepared to face the 
  164. consequences of your actions.  As a fellow sysadmin, I offer this to you
  165. as your ONLY WARNING.
  166.  
  167. Pick a smart number of maxusers for your server. Calculate by taking the 
  168. available bandwidth you have, multiplying by 0.9 to account for overhead, 
  169. and dividing by the bitrate you want to serve at. For example, an ADSL 
  170. connection @ 768kbps upstream * 0.9 / 24kbps ~= 29 maximum users. Again, 
  171. set this number too high, and when you reach the limit of bandwidth ALL 
  172. the streams will start to skip. 
  173.  
  174. License:
  175.  
  176. SHOUTCAST SERVER(TM)
  177.     SHOUTCAST(TM), all versions, are copyright protected and are the property 
  178. of Nullsoft, Inc.  Until further notice, this software may be used for personal,
  179. non-commercial purposes for free and need not be registered with Nullsoft, Inc. 
  180. Individual commercial use requires the payment of at least $299 per computer and 
  181. that you register the software for commercial use with Nullsoft, Inc.  
  182. Registration entitles the user to use all future shareware versions of SHOUTCAST(TM) 
  183. preceding 2.0, but not to technical support. SHOUTCAST(TM) may not be copied, sold, 
  184. distributed or used in any other manner without the prior written consent of 
  185. Nullsoft, Inc.  Those interested in licensing SHOUTCAST(TM) for other than personal 
  186. or individual commercial use should contact Nullsoft, Inc. c/o sales@shoutcast.com.
  187.  
  188.     To the maximum extent permitted by law, Nullsoft, Inc. disclaims all
  189. warranties regarding this software, express or implied, including but not
  190. limited to warranties of merchantability and fitness for a particular
  191. purpose.  In no event shall Nullsoft, Inc. be liable for consequential,
  192. special, incidental or indirect damages arising out of the use or inability
  193. to use this software even if Nullsoft, Inc. is aware of the possibility of
  194. such damages or a known defect.
  195.  
  196.     By using this software, you are agreeing to the above terms.
  197.