Audioserve Installation and Setup with Docker¶
Introduction¶
Audioserve is a lightweight audiobook server that allows streaming of your audiobook collection. This guide provides step-by-step instructions on how to install and run Audioserve using Docker.
Prerequisites¶
Before proceeding, ensure that you have the following:
- A system with Docker installed.
- A directory containing your audiobooks.
- A basic understanding of terminal/command line usage.
Installation and Running Audioserve¶
1. Pull the Audioserve Docker Image¶
First, download the latest Audioserve image from Docker Hub:
docker pull izderadicka/audioserve
2. Run Audioserve Container¶
To run Audioserve as a Docker container, use the following command:
docker run --rm -it --name audioserve -p 3000:3000 -v /path/to/your/audiobooks:/audiobooks izderadicka/audioserve --no-authentication /audiobooks
Explanation of Parameters:¶
--rm
: Automatically remove the container when it stops.-it
: Runs the container interactively.--name audioserve
: Assigns a name to the container.-p 3000:3000
: Maps port 3000 on the host to port 3000 in the container.-v /path/to/your/audiobooks:/audiobooks
: Mounts your audiobook directory into the container.izderadicka/audioserve
: The Docker image for Audioserve.--no-authentication
: Disables authentication (use only in trusted networks)./audiobooks
: Specifies the audiobook directory within the container.
3. Access Audioserve Web Interface¶
Once the container is running, open your web browser and go to:
http://localhost:3000
If running on a remote server, replace localhost
with the server's IP address.
Running Audioserve in the Background¶
To keep Audioserve running in the background, use the -d
flag:
docker run -d --name audioserve -p 3000:3000 -v /path/to/your/audiobooks:/audiobooks izderadicka/audioserve --no-authentication /audiobooks
Stopping the Container¶
To stop the running container:
docker stop audioserve
Persistent Deployment with Docker Compose (Optional)¶
If you want a more structured setup, create a docker-compose.yml
file:
version: '3'
services:
audioserve:
image: izderadicka/audioserve
container_name: audioserve
restart: unless-stopped
ports:
- "3000:3000"
volumes:
- /path/to/your/audiobooks:/audiobooks
command: ["--no-authentication", "/audiobooks"]
Then, start the container with:
docker-compose up -d
To stop it:
docker-compose down
Additional Configuration¶
- Authentication: Use
--auth-key <your-secret-key>
to enable authentication. - Transcoding: Use
--transcoding-cache <path>
for audio format conversion. - Custom Port: Change
-p 3000:3000
to a different port if needed.
Conclusion¶
You have successfully installed and run Audioserve using Docker. This setup allows easy audiobook streaming on your network. If you need additional features, refer to the official Audioserve documentation.