readme.txt

This is the audiostreamlogger!

This project contains a multi-service Docker application for recording, cleaning, generating peak files, and serving a frontend for audio files. The setup uses Docker Compose to manage the services and their interactions.

Prerequisites

	•	Docker: Install Docker
	•	Docker Compose: Install Docker Compose

Project Structure

	•	recorder: Service to record audio files.
	•	cleaner: Service to clean up audio files.
	•	peakfilegenerator: Service to generate peak files from audio files.
	•	frontend: Service to provide a web interface to interact with audio files.
	•	audio: Directory to store audio files.
	•	settings.json: Configuration file for the application.

Getting Started

    1.	Clone the repository:
        git clone https://github.com/yourusername/audiostreamlogger.git
        cd audiostreamlogger

    2.	Build and run the application:
        docker-compose up --build

    3.	Access the application:
        Open your browser and navigate to http://localhost:9702.


Stopping the Application

    To stop the application, press Ctrl+C in the terminal where docker-compose up is running, or run:

Configuration

    The application is configured using the settings.json file. This file specifies the streams to be recorded, including their country, name, folder, and URL. Optional values are the codec, bitrate, container and sample frequency. When these are not set, the recorder defaults to 160k mp3s at 44.1kHz. Also the log retention can be adjusted.

    Example settings.json:

    {
    "log_retention":168,
    "streams":[
        {
            "country":"Netherlands",
            "name":"RTV_Connect",
            "folder":"rtvconnect",
            "url":"https://stream.rtvconnect.nl/radio/8000/ffm-320-mp3"
        },
        {
            "country":"Netherlands",
            "name":"Glow_FM",
            "folder":"glowfm",
            "url":"https://stream.glowfm.nl/glowfm.mp3",
            "codec":"libopus",
            "bitrate":"64k",
            "container":"webm",
            "frequency": 48000
        }
    ]
    }

    In the .env file the port the webserver is hosted on can be changed. This is an example:

    PORT=9703