moonillusion/lires

A self-hosted research literature manager

Lires

A self-hosted research literature manager!

The name of Lires is a combination of Lire and Research, where Lire is the French word for 'Read'.

Lires is designed to be deployed onto a server to provide a self-hosted collaborative solution for research literature management.

The software mainly consists of three modules:

1. lires, the core server
2. lires-ai, AI server for computational intelligence features
3. lires-web, the WebUI

Features

📚 Shared database
🔄 Cross-platform
🏷️ Cascading tags
📝 Markdown notes
👥 Multi-user management
✨ Artificial intelligence

Currently, it supports PDF files and only provides above mentioned basic features, such as adding tags, notes, and searching. Some advanced features including semantic search, auto summarization and arxiv subscription are also avaliable.
These should be enough for most use cases, more features will be added in the future.

Getting started

Fetch all submodules

git submodule update --init --recursive

Docker deployment

docker compose up

# register a user and download pdf.js viewer on the first run 
# no need to run again if the container is re-created / re-started
docker exec lrs lrs-user add <username> <password> --admin
docker exec lrs lrs-utils download_pdfjs

Now open the browser and visit the WebUI at http://localhost:8081.

Please refer to the documents for more details on getting started.

Manuals and documentations

• Getting started
• Development