qyup/copyright-free-songs repository overview

⁠Docker Image for Copyright-Free Songs

This Docker image provides a streamlined and efficient way to access and utilize a curated collection of copyright-free music. It packages a lightweight server that serves the audio files and metadata necessary for seamless integration with platforms requiring royalty-free audio. This image is designed for developers and content creators looking to quickly incorporate high-quality, legally cleared music into their projects without the complexities of managing a local music library and metadata database.

The image offers a pre-configured environment that simplifies the process of integrating copyright-free music into your workflow. It includes a web server serving the audio files and a JSON API for accessing metadata such as song titles, artists, and genres. This enables easy retrieval of music for use in videos, podcasts, games, and other creative projects.

⁠How to Run

To run the container, use the following command: bash docker run -d
--name copyright-free-songs
-p 8080:80
-v /path/to/your/local/data:/data
supermakerai/copyright-free-songs:latest

Explanation of the command:

• -d: Runs the container in detached mode (in the background).
• --name copyright-free-songs: Assigns the name "copyright-free-songs" to the container.
• -p 8080:80: Maps port 8080 on the host machine to port 80 on the container. This allows you to access the music server through http://localhost:8080.
• -v /path/to/your/local/data:/data: Mounts a local directory to the /data directory inside the container. This is where the music files and metadata are stored. Replace /path/to/your/local/data with the actual path to your data directory on your host machine. If you don't have a local data directory, you can omit this volume mapping, and the container will use the default included sample data.
• supermakerai/copyright-free-songs:latest: Specifies the Docker image to use. Replace latest with a specific tag for a particular version if needed.

Accessing the Music:

Once the container is running, you can access the music files and metadata through the web server.

• Audio files: Located in the /data/audio directory (or the mounted volume's equivalent).
• Metadata API: Accessible at /api/songs. This endpoint returns a JSON array of song objects, each containing information about the song.

Integration with Supermaker.ai:

This container is optimized for integration with the https://supermaker.ai/music/copyright-free-songs/⁠ ecosystem. The metadata format and API endpoints are designed to be compatible with Supermaker.ai's music platform, allowing for seamless retrieval and usage of copyright-free music within your Supermaker.ai projects.