commit b782f0aa99048d1baf000432e38363cd17b74524 parent a5cbca0f8581f45c8306a426c39c43385f5d99c6 Author: libredev <libredev@ircforever.org> Date: Tue, 14 Mar 2023 10:02:38 +0530 update README Diffstat:
| M | README | | | 68 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 68 insertions(+), 0 deletions(-)
diff --git a/README b/README @@ -1,5 +1,73 @@ +====================================================================== +WARNING: This program is still in progress, use it at your own risk. +====================================================================== + +Description +----------- + +This is a simple CGI program written in C which can be hosted on a server +to provide an alternative interface to the icecast web interface and has a +simple thread based commenting system. + +It is officially hosted at theinterlude.live and the icecast interface is +hosted at radio.theinterlude.live. + + +Configuration +------------- + +To get started, edit the config.mk file. + + NAME - Name of the service. + TITLE - Title of the service. + ICECAST_URL - Icecast's web URL. + INSTALL_DIR - Directory where to host/install all the required files. + HTTPD_USER - User of the running httpd daemon. + HTTPD_GROUP - Group of the running httpd daemon. + +Note: HTTPD_USER and HTTPD_GROUP are required for commenting system to work. + Both threads/ and tmp/ directories should be readable and writable by + this user. Both the directories are chowned by this user and group on + installation. + + +Installation +------------ + + $ make + $ doas make install + + +Working +------- + +It fetches all the stream information from ${ICECAST_URL}/status-json.xsl +which is auto generated by the icecast and generate a custom web interface. + +All the comments are stored in ${INSTALL_DIR}/threads/thread.db. It is +simple plain text database which is readable and editable by a normal text +editor. + + +Advance Configuration +--------------------- + +It is very easy to customize the html/css interface. Here is the list of +all the configurable files: + + header.html - It contains the html header. + footer.html - It contains the html footer. + thread.html - It contains the comment form. + style.css - It contain almost all the css configuration. + +NOTE: You should edit these file from the source code directory and run + 'make install' to install it in ${INSTALL_DIR}. Editing these files + on INSTALL_DIR is dangerous and overridden on 'make install'. + + License ------- + Everything in this repository is released under CC0 1.0 except: http.h - Unlicense or MIT pdjson/ - Unlicense