repository·dev·Indexed 25 days ago
https://github.com/difegue/lanraragiAn open-source archival server for comics and manga built on Mojolicious and Redis. It features web-based reading, an OPDS catalog for external reader software, and a Client API for third-party integration. Supported formats include zip, rar, 7z, cbz, cbr, pdf, and epub. The system includes features for managing archives, chapters, tags, and Tankoubons (meta-archives), as well as a comprehensive API for server interaction.
Use this glossary to understand the core concepts used within the LANraragi interface and configuration:
Shinobu is a background worker process spawned via the Proc::Simple Perl module that runs in parallel with the Mojolicious Server. It is responsible for:
inotify watches.For heavier tasks, Shinobu utilizes a Minion Job Queue.
The application is organized into several key directories:
lib/: Core application code.LANraragi.pm: Entrypoint for the app, handles routing to Controllers.Shinobu.pm: Background worker process.LANraragi/Controller/: Contains logic for specific pages (e.g., Api/).LANraragi/Model/: Application logic independent of Mojolicious (e.g., Archive.pm, Config.pm, Plugins.pm, Search.pm).LANraragi/Plugin/: Stores LRR Plugins (Login, Metadata, Scripts).LANraragi/Utils/: Generic functions used by both the app and Plugins.content/: Default folder for archives.public/: Static files for web clients (CSS, JS, Images, Themes).script/: Execution scripts like launcher.pl and lanraragi (bootstrap).tools/: Build and installation tools, including install.pl.If you prefer using docker-compose.yml, use the following configuration. This setup includes restart: unless-stopped to ensure the service recovers after a reboot or crash.
services:
lanraragi:
image: difegue/lanraragi
container_name: lanraragi
ports:
- "3000:3000"
volumes:
- [YOUR_CONTENT_DIRECTORY]:/home/koyomi/lanraragi/content
- [YOUR_THUMBNAIL_DIRECTORY]:/home/koyomi/lanraragi/thumb
- [YOUR_DATABASE_DIRECTORY]:/home/koyomi/lanraragi/database
restart: unless-stoppedThe Content Folder is the core storage for LANraragi, containing archives, thumbnails, and (on Windows) the Redis database. The folder is subdirectory-aware.
zip/cbzrar/cbr (up to RAR4 only)tar.gz/cbtlzma7z/cb7xzpdfepub (images only via Web Client or Client API)cbw (ComicBookWeb: XML referencing remote images)You can dissociate the thumbnail folder from the Content Folder (e.g., to move it to an SSD or keep the Content Folder read-only).
Warning: If you switch to a new thumbnail location, you must move your existing thumbnails manually; LANraragi does not support automatic migration of thumbnails to a new folder.
A blacklist is a simple list of rules used to remove unwanted tags. You can either list the tags directly or prefix them with a minus sign. Both formats are valid for removing tags.
# Format 1
forbidden content
incomplete
# Format 2
-forbidden content
-incompleteYou can customize a Tankoubon after creation by accessing its Edit metadata page. This allows you to:
Warning on Deletion:
If you want to build a custom or bleeding-edge version from a cloned Git repository, run the following command from the root of the repo:
npm run docker-buildWhen running LANraragi behind an Nginx reverse proxy, you must adjust specific settings to ensure archive uploads and large downloads work correctly.
Key requirements:
client_max_body_size 0; to disable upload size limits.proxy_max_temp_file_size 0; to support large downloads.Upgrade and Connection headers in the location / block to support the batch tagger when using SSL.Example Nginx configuration:
http {
client_max_body_size 0;
}
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
server {
listen 443 ssl;
server_name lanraragi.example.net;
client_max_body_size 0;
proxy_max_temp_file_size 0;
location / {
proxy_pass http://0.0.0.0:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
}
}http {
client_max_body_size 0;
}
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
server {
listen 443 ssl;
server_name lanraragi.example.net;
client_max_body_size 0;
proxy_max_temp_file_size 0;
location / {
proxy_pass http://0.0.0.0:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
}
}Access the LRR Redis database using the LANraragi::Model::Config module. This utilizes the Redis Perl binding library.
my $redis = LANraragi::Model::Config->get_redis;
my $value = $redis->get("key");.pm file into the LANraragi Plugin directory.Note: If LANraragi is running in Debug Mode, debug messages from your plugin will be captured in the logs.