Skip to content

rm-dr/copper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

GitHub Repo stars GitHub License Issues Pull Requests

cargo test GitHub Actions Workflow Status

Copper is the universal, automatic digital library.


Copper is the universal digital library, aiming to replace ad-hoc solutions like Paperless, Calibre, and Beets.

🚨 Warning 🚨

Copper is still very incomplete, and is nowhere near ready for daily use.
This might change once the following projects are resolved:

PRs are very welcome, especially for the web ui!

Features

  • Supports any kind of collection: audio, ebooks, photos, ad infinitum.
  • Simple drag and drop uploads
  • Graphical data pipeline editor
  • Edit items in bulk (planned)
  • Simple backup (planned)
  • Powerful export pipelines (planned)
  • Scriptable api (planned)
  • Flexible data export (planned)
  • Email notifications (planned)
  • Automatic ingestion (planned)
  • Fast & powerful search (planned)
  • Expose data for other services (planned)

Non-features

Functionality that is intentionally omitted from Copper. Use a better tool.

  • Low-code workflows
    • Copper processes data, not logic.
    • Instead, use Node-red or n8n.
  • Advanced playback UI
    • Copper's ui is designed to manage media, not consume it.
    • Instead, use Jellyfin.

Getting started

Copper is designed to be run in docker. To get started, to the following:

  • Download the contents of ./dist
  • cd dist
  • docker compose up -d
  • Read ./dist/docker-compose.yml.
    If you want to run the stack manually, see CONTRIBUTING.md.

A prebuilt docker image will be published once Copper reaches v1.

User Documentation

Has yet to be written. It will likely be embedded in Copper's web ui.

Bugs and Feature requests

Please open an issue.