Komga
Komga is a free and open-source self-hosted media server for digital literature. It supports the CBZ, CBR (non-solid), EPUB and PDF formats.
- For more information about this app, follow this link.
Initial Setup
- Install Komga from the Installers tab on the User Control Panel. Make sure to choose a strong password.
- Once the installation is complete, click the URL provided on the UCP to access the Komga web UI.
- Log in with your UCP username and the password you set during the installation.
Configuration
After logging in for the first time, you will be greeted by an empty dashboard. Before adding content, you need to create at least one library that points to a folder containing your books.
Add a Library
- After the login, you will see a start-up screen, click the Add library button.
- Set a name for your library.
- Set the Root folder to the path inside your home directory where your books are stored.
- Adjust any optional library settings (scanner, analysis, metadata) to your liking.
- Click Next and then Add to save the library.
Komga will now scan the folder and import any supported files. Depending on your library size, the initial scan may take a few minutes.
Supported File Types
Komga supports the following file types:
- Comic book archives: CBZ and CBR (solid RAR archives are not supported)
- eBooks in EPUB format
- PDF files
Folder Structure
Komga uses your folder structure to identify series and books. The recommended layout is:
Library Root/
└── Series Name/
├── example01.cbz
├── example02.epub
└── example03.pdf- Each subfolder under the library root is treated as a series.
- Each supported file inside a series folder is treated as a book.
- For best results, name your files so they sort in reading order (e.g.
Volume 01.cbz,Volume 02.cbz).
Add Books
- Upload your books to your Komga library folder using any of the methods described in our File Management docs (FTP, SFTP, Filebrowser, rsync, etc.).
- After uploading, Komga will detect the new files automatically. If a file does not appear, open the library and press the Scan button to trigger a manual scan.
Connect a Reader App
Komga exposes an OPDS feed that can be used by most third-party literature reader apps to browse and download books from your library.
Use the following connection details:
Host: https://{username}.{servername}.usbx.me/komga/opds/v1.2/catalog
Port: 443
Username: Your Komga username as per your UCP
Password: Your Komga password as per your UCP- Replace
{username}with your Ultra.cc username and{servername}with your assigned server (both are visible on the User Control Panel). - If your app has an HTTPS or SSL toggle, make sure it is enabled.
- Some apps separate the Host and Path fields. In that case, use:
- Host:
{username}.{servername}.usbx.me - Path:
/komga/opds/v1.2/catalog
Update Komga
Komga can be updated to the latest available version via SSH using the App Manager.
- SSH into your Ultra.cc service. See our SSH documentation for instructions.
- Run the following command:
app-komga upgrade- The App Manager will create a backup, pull the latest version, and restart the application.
If you require further assistance, you can open a support ticket here!
Feedback and suggestions regarding this article are welcome on our Discord server