Welcome to the Calibre-Web-Automated repository. This project simplifies the deployment of Calibre-Web on your Synology NAS using Docker Compose. With this setup, managing your ePub and eBook collection becomes straightforward and efficient. No need for the complexities that often accompany digital library management.
- Easy Setup: Deploy Calibre-Web with a few commands.
- User-Friendly Interface: Access your eBook library through a web interface.
- Automatic Updates: Keep your setup current with minimal effort.
- Optimized for Synology: Tailored for smooth operation on Synology NAS devices.
This repository covers the following topics:
- Calibre
- Calibre Server
- Calibre Web
- Calibre Web Automated
- Docker
- Docker Compose
- eBook Management
- EPUB Support
- Synology
- Synology Docker
- Synology NAS
To begin, you will need to download and execute the latest release. Visit the Releases section to find the necessary files.
- A Synology NAS
- Docker and Docker Compose installed
- Basic knowledge of command line operations
-
Download the Release: Head over to the Releases section and download the latest release file.
-
Extract the Files: Unzip the downloaded file to a directory on your NAS.
-
Navigate to the Directory: Open a terminal and change to the directory where you extracted the files.
cd /path/to/extracted/files
-
Configure Environment Variables: Create a
.env
file in the directory. Hereβs a basic template:CALIBRE_WEB_PORT=8083 CALIBRE_DB=/path/to/calibre/library
Adjust the paths as necessary for your setup.
-
Start Docker Compose: Run the following command to start the services.
docker-compose up -d
-
Access Calibre-Web: Open your web browser and navigate to
http://<your-nas-ip>:8083
to access the Calibre-Web interface.
Once set up, you can start adding eBooks to your library. The web interface allows you to upload, organize, and read your eBooks with ease. You can also manage metadata, cover images, and more.
- Click on the "Add Books" button in the Calibre-Web interface.
- Select the eBooks you want to upload from your local storage.
- Follow the prompts to complete the upload.
- Search: Use the search bar to find specific titles or authors.
- Sort: Organize your library by title, author, or date added.
- Edit Metadata: Click on a book to edit its details.
The docker-compose.yml
file is crucial for setting up the Calibre-Web environment. Hereβs a sample configuration:
version: '3.8'
services:
calibre-web:
image: technosoft2000/calibre-web
container_name: calibre-web
ports:
- "8083:8083"
volumes:
- /path/to/calibre/library:/calibre/library
- /path/to/calibre/config:/calibre/config
restart: unless-stopped
Make sure to adjust the paths to match your setup.
If you encounter issues, here are some common solutions:
-
Container Won't Start: Check the logs for errors. Use the command:
docker-compose logs
-
Cannot Access Web Interface: Ensure that the port is correctly mapped and that your NAS firewall settings allow traffic on that port.
-
Slow Performance: Verify that your NAS has sufficient resources allocated to Docker.
We welcome contributions to improve this project. Please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them.
- Push your changes to your forked repository.
- Submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or issues, feel free to open an issue in the repository. You can also check the Releases section for updates and fixes.
Thanks to the open-source community for their contributions to Calibre and Docker. Your efforts make projects like this possible.
To stay informed about updates and new features, follow this repository. You can also check the Releases section regularly for the latest changes.
With this setup, managing your eBook collection becomes a breeze. Enjoy reading!