# LANraragi

## Nightly Release

- [LANraragi Documentation](https://sugoi.gitbook.io/lanraragi/dev/readme.md)
- [Which installation method is best for me?](https://sugoi.gitbook.io/lanraragi/dev/installing-lanraragi/methods.md): This is a by-OS breakdown of how you can install the software on your machine.
- [LRR for Windows (Win10/11)](https://sugoi.gitbook.io/lanraragi/dev/installing-lanraragi/windows.md)
- [Homebrew (macOS)](https://sugoi.gitbook.io/lanraragi/dev/installing-lanraragi/macos.md)
- [Docker (All platforms)](https://sugoi.gitbook.io/lanraragi/dev/installing-lanraragi/docker.md): Docker is the best way to install the software on remote servers. I don't recommand it for Desktop machines and casual users due to it being a bit complex to wield.
- [Source Code (Linux/macOS)](https://sugoi.gitbook.io/lanraragi/dev/installing-lanraragi/source.md): The following instructions are based on Debian Stretch.
- [Community (Linux)](https://sugoi.gitbook.io/lanraragi/dev/installing-lanraragi/community.md)
- [Jail (FreeBSD)](https://sugoi.gitbook.io/lanraragi/dev/installing-lanraragi/jail.md): If your server is running on FreeBSD (FreeNAS/TrueNAS for example) and you do not want to use virtualization, you can install LANraragi in a jail. This process is rather cli-heavy and error prone (dep
- [Getting Started](https://sugoi.gitbook.io/lanraragi/dev/basic-operations/first-steps.md)
- [Reading Archives](https://sugoi.gitbook.io/lanraragi/dev/basic-operations/archives.md)
- [Adding Metadata](https://sugoi.gitbook.io/lanraragi/dev/basic-operations/metadata.md)
- [Searching the Archive Index](https://sugoi.gitbook.io/lanraragi/dev/basic-operations/searching.md)
- [Categories and Bookmarking](https://sugoi.gitbook.io/lanraragi/dev/basic-operations/categories.md): Organize your archives in dynamic or static Categories.
- [Statistics and Logs](https://sugoi.gitbook.io/lanraragi/dev/basic-operations/stats.md)
- [Themes](https://sugoi.gitbook.io/lanraragi/dev/basic-operations/themes.md)
- [Stamps](https://sugoi.gitbook.io/lanraragi/dev/advanced-usage/stamps.md): Stamps are an additional type of metadata that allow you to annotate pages in Archives.
- [Batch Operations](https://sugoi.gitbook.io/lanraragi/dev/advanced-usage/batch-tagging.md): Batch Operations allow you to execute a task on your choice on a selection of archives.
- [Merging and Splitting Archives](https://sugoi.gitbook.io/lanraragi/dev/advanced-usage/tankoubons-and-chapters.md): The Chapter and Tankoubon features allow you to add levels of hierarchy to your Archives when reading them.
- [Downloading Archives](https://sugoi.gitbook.io/lanraragi/dev/advanced-usage/downloading.md): Download remote URLs directly to LANraragi.
- [Backup and Restore](https://sugoi.gitbook.io/lanraragi/dev/advanced-usage/backup-and-restore.md): You do make backups, right?
- [Tag Rules](https://sugoi.gitbook.io/lanraragi/dev/advanced-usage/tag-rules.md): Blacklist or rewrite tags the way you want
- [Duplicate Detection](https://sugoi.gitbook.io/lanraragi/dev/advanced-usage/duplicate-detection.md): Run a scan of your Library for potential duplicates.
- [Using External Readers](https://sugoi.gitbook.io/lanraragi/dev/advanced-usage/external-readers.md)
- [Network Interface Setup](https://sugoi.gitbook.io/lanraragi/dev/advanced-usage/network-interfaces.md)
- [Proxy Setup](https://sugoi.gitbook.io/lanraragi/dev/advanced-usage/proxy-setup.md)
- [Setup a Development Environment](https://sugoi.gitbook.io/lanraragi/dev/extending-lanraragi/index.md): I'd like to interject for a moment
- [Architecture & Style](https://sugoi.gitbook.io/lanraragi/dev/extending-lanraragi/architecture.md): Read up on all the badly hacked nitty gritty that makes LRR tick here.
- [Translating LANraragi to other languages](https://sugoi.gitbook.io/lanraragi/dev/extending-lanraragi/translations.md): Details on making additional translations for the server's Web UI.
- [Getting started](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/getting-started.md)
- [Search API](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/search-api.md): Perform searches.
- [Archive API](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/archive-api.md): Everything dealing with Archives.
- [Database API](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/database-api.md): Query and modify the database.
- [Category API](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/category-api.md): Endpoints related to Categories.
- [Tankoubon API](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/tankoubon-api.md): Endpoints related to Tankoubons.
- [Stamps API](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/stamp-api.md): Endpoints related to Stamps.
- [Plugin API](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/plugin-api.md): APIs to list and execute Plugins.
- [Shinobu API](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/shinobu-api.md): Shinobu Filewatcher APIs.
- [Minion API](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/minion-api.md): Minion Job Queue APIs.
- [OPDS Catalog](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/opds-catalog.md): Endpoints related to OPDS catalog generation and serving.
- [Miscellaneous other API](https://sugoi.gitbook.io/lanraragi/dev/api-documentation/miscellaneous-other-api.md): Other APIs that don't fit a dedicated theme.
- [Getting started](https://sugoi.gitbook.io/lanraragi/dev/plugin-docs/index.md)
- [Login Plugins](https://sugoi.gitbook.io/lanraragi/dev/plugin-docs/login.md)
- [Metadata Plugins](https://sugoi.gitbook.io/lanraragi/dev/plugin-docs/metadata.md)
- [Downloader Plugins](https://sugoi.gitbook.io/lanraragi/dev/plugin-docs/download.md)
- [Generic Plugins ("Scripts")](https://sugoi.gitbook.io/lanraragi/dev/plugin-docs/scripts.md)
- [Code Examples](https://sugoi.gitbook.io/lanraragi/dev/plugin-docs/code-examples.md)

## Current Release

- [LANraragi Documentation](https://sugoi.gitbook.io/lanraragi/readme.md)
- [Which installation method is best for me?](https://sugoi.gitbook.io/lanraragi/installing-lanraragi/methods.md): This is a by-OS breakdown of how you can install the software on your machine.
- [LRR for Windows (Win10/11)](https://sugoi.gitbook.io/lanraragi/installing-lanraragi/windows.md)
- [Homebrew (macOS)](https://sugoi.gitbook.io/lanraragi/installing-lanraragi/macos.md)
- [Docker (All platforms)](https://sugoi.gitbook.io/lanraragi/installing-lanraragi/docker.md): Docker is the best way to install the software on remote servers. I don't recommand it for Desktop machines and casual users due to it being a bit complex to wield.
- [Source Code (Linux/macOS)](https://sugoi.gitbook.io/lanraragi/installing-lanraragi/source.md): The following instructions are based on Debian Stretch.
- [Community (Linux)](https://sugoi.gitbook.io/lanraragi/installing-lanraragi/community.md)
- [Jail (FreeBSD)](https://sugoi.gitbook.io/lanraragi/installing-lanraragi/jail.md): If your server is running on FreeBSD (FreeNAS/TrueNAS for example) and you do not want to use virtualization, you can install LANraragi in a jail. This process is rather cli-heavy and error prone (dep
- [Getting Started](https://sugoi.gitbook.io/lanraragi/basic-operations/first-steps.md)
- [Reading Archives](https://sugoi.gitbook.io/lanraragi/basic-operations/archives.md)
- [Adding Metadata](https://sugoi.gitbook.io/lanraragi/basic-operations/metadata.md)
- [Searching the Archive Index](https://sugoi.gitbook.io/lanraragi/basic-operations/searching.md)
- [Categories and Bookmarking](https://sugoi.gitbook.io/lanraragi/basic-operations/categories.md): Organize your archives in dynamic or static Categories.
- [Statistics and Logs](https://sugoi.gitbook.io/lanraragi/basic-operations/stats.md)
- [Themes](https://sugoi.gitbook.io/lanraragi/basic-operations/themes.md)
- [Stamps](https://sugoi.gitbook.io/lanraragi/advanced-usage/stamps.md): Stamps are an additional type of metadata that allow you to annotate pages in Archives.
- [Batch Operations](https://sugoi.gitbook.io/lanraragi/advanced-usage/batch-tagging.md): Batch Operations allow you to execute a task on your choice on a selection of archives.
- [Merging and Splitting Archives](https://sugoi.gitbook.io/lanraragi/advanced-usage/tankoubons-and-chapters.md): The Chapter and Tankoubon features allow you to add levels of hierarchy to your Archives when reading them.
- [Downloading Archives](https://sugoi.gitbook.io/lanraragi/advanced-usage/downloading.md): Download remote URLs directly to LANraragi.
- [Backup and Restore](https://sugoi.gitbook.io/lanraragi/advanced-usage/backup-and-restore.md): You do make backups, right?
- [Tag Rules](https://sugoi.gitbook.io/lanraragi/advanced-usage/tag-rules.md): Blacklist or rewrite tags the way you want
- [Duplicate Detection](https://sugoi.gitbook.io/lanraragi/advanced-usage/duplicate-detection.md): Run a scan of your Library for potential duplicates.
- [Using External Readers](https://sugoi.gitbook.io/lanraragi/advanced-usage/external-readers.md)
- [Network Interface Setup](https://sugoi.gitbook.io/lanraragi/advanced-usage/network-interfaces.md)
- [Proxy Setup](https://sugoi.gitbook.io/lanraragi/advanced-usage/proxy-setup.md)
- [Setup a Development Environment](https://sugoi.gitbook.io/lanraragi/extending-lanraragi/index.md): I'd like to interject for a moment
- [Architecture & Style](https://sugoi.gitbook.io/lanraragi/extending-lanraragi/architecture.md): Read up on all the badly hacked nitty gritty that makes LRR tick here.
- [Translating LANraragi to other languages](https://sugoi.gitbook.io/lanraragi/extending-lanraragi/translations.md): Details on making additional translations for the server's Web UI.
- [Getting started](https://sugoi.gitbook.io/lanraragi/api-documentation/getting-started.md)
- [Search API](https://sugoi.gitbook.io/lanraragi/api-documentation/search-api.md): Perform searches.
- [Archive API](https://sugoi.gitbook.io/lanraragi/api-documentation/archive-api.md): Everything dealing with Archives.
- [Database API](https://sugoi.gitbook.io/lanraragi/api-documentation/database-api.md): Query and modify the database.
- [Category API](https://sugoi.gitbook.io/lanraragi/api-documentation/category-api.md): Endpoints related to Categories.
- [Tankoubon API](https://sugoi.gitbook.io/lanraragi/api-documentation/tankoubon-api.md): Endpoints related to Tankoubons.
- [Stamps API](https://sugoi.gitbook.io/lanraragi/api-documentation/stamp-api.md): Endpoints related to Stamps.
- [Plugin API](https://sugoi.gitbook.io/lanraragi/api-documentation/plugin-api.md): APIs to list and execute Plugins.
- [Shinobu API](https://sugoi.gitbook.io/lanraragi/api-documentation/shinobu-api.md): Shinobu Filewatcher APIs.
- [Minion API](https://sugoi.gitbook.io/lanraragi/api-documentation/minion-api.md): Minion Job Queue APIs.
- [OPDS Catalog](https://sugoi.gitbook.io/lanraragi/api-documentation/opds-catalog.md): Endpoints related to OPDS catalog generation and serving.
- [Miscellaneous other API](https://sugoi.gitbook.io/lanraragi/api-documentation/miscellaneous-other-api.md): Other APIs that don't fit a dedicated theme.
- [Getting started](https://sugoi.gitbook.io/lanraragi/plugin-docs/index.md)
- [Login Plugins](https://sugoi.gitbook.io/lanraragi/plugin-docs/login.md)
- [Metadata Plugins](https://sugoi.gitbook.io/lanraragi/plugin-docs/metadata.md)
- [Downloader Plugins](https://sugoi.gitbook.io/lanraragi/plugin-docs/download.md)
- [Generic Plugins ("Scripts")](https://sugoi.gitbook.io/lanraragi/plugin-docs/scripts.md)
- [Code Examples](https://sugoi.gitbook.io/lanraragi/plugin-docs/code-examples.md)