radio

radio.ircforever.org
git clone git://git.ircforever.org/radio
Log | Files | Refs | Submodules | README | LICENSE

README (2189B)

      1 ======================================================================
      2 WARNING: This program is still in progress, use it at your own risk.
      3 ======================================================================
      4 
      5 Description
      6 -----------
      7 
      8 This is a simple CGI program written in C which can be hosted on a server
      9 to provide an alternative interface to the icecast web interface and has a
     10 simple thread based commenting system.
     11 
     12 It is officially hosted at theinterlude.live and the icecast interface is
     13 hosted at radio.theinterlude.live.
     14 
     15 
     16 Configuration
     17 -------------
     18 
     19 To get started, edit the config.mk file.
     20 
     21 	NAME - Name of the service.
     22 	TITLE - Title of the service.
     23 	ICECAST_URL - Icecast's web URL.
     24 	INSTALL_DIR - Directory where to host/install all the required files.
     25 	HTTPD_USER - User of the running httpd daemon.
     26 	HTTPD_GROUP - Group of the running httpd daemon.
     27 
     28 Note: HTTPD_USER and HTTPD_GROUP are required for commenting system to work.
     29       Both threads/ and tmp/ directories should be readable and writable by
     30       this user. Both the directories are chowned by this user and group on
     31       installation.
     32 
     33 
     34 Installation
     35 ------------
     36 
     37 	$ make
     38 	$ doas make install
     39 
     40 
     41 Working
     42 -------
     43 
     44 It fetches all the stream information from ${ICECAST_URL}/status-json.xsl
     45 which is auto generated by the icecast and generate a custom web interface.
     46 
     47 All the comments are stored in ${INSTALL_DIR}/threads/thread.db. It is
     48 simple plain text database which is readable and editable by a normal text
     49 editor.
     50 
     51 
     52 Advance Configuration
     53 ---------------------
     54 
     55 It is very easy to customize the html/css interface. Here is the list of
     56 all the configurable files:
     57 
     58 	header.html - It contains the html header.
     59 	footer.html - It contains the html footer.
     60 	thread.html - It contains the comment form.
     61 	style.css - It contain almost all the css configuration.
     62 
     63 NOTE: You should edit these file from the source code directory and run
     64       'make install' to install it in ${INSTALL_DIR}. Editing these files
     65       on INSTALL_DIR is dangerous and overridden on 'make install'.
     66 
     67 
     68 License
     69 -------
     70 
     71 Everything in this repository is released under CC0 1.0 except:
     72 	http.h	- Unlicense or MIT
     73 	pdjson/	- Unlicense