{"id":49881318,"url":"https://github.com/mishl-dev/shelfd","last_synced_at":"2026-05-15T14:36:55.507Z","repository":{"id":346367119,"uuid":"1184607836","full_name":"mishl-dev/shelfd","owner":"mishl-dev","description":"A self-hosted API that provides a unified interface for accessing ebooks. designed for integration with readers like Foliate.","archived":false,"fork":false,"pushed_at":"2026-03-26T11:15:42.000Z","size":337,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-27T04:27:34.092Z","etag":null,"topics":["ebook","ebook-library","foliate","opds","opds-catalog","opds-server","open-library","open-library-api","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mishl-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-17T18:50:42.000Z","updated_at":"2026-03-26T11:15:45.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mishl-dev/shelfd","commit_stats":null,"previous_names":["mishl-dev/shelfie","mishl-dev/shelfd"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/mishl-dev/shelfd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishl-dev%2Fshelfd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishl-dev%2Fshelfd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishl-dev%2Fshelfd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishl-dev%2Fshelfd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mishl-dev","download_url":"https://codeload.github.com/mishl-dev/shelfd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishl-dev%2Fshelfd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33070211,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-15T11:35:32.926Z","status":"ssl_error","status_checked_at":"2026-05-15T11:35:31.362Z","response_time":103,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ebook","ebook-library","foliate","opds","opds-catalog","opds-server","open-library","open-library-api","rust"],"created_at":"2026-05-15T14:36:54.610Z","updated_at":"2026-05-15T14:36:55.486Z","avatar_url":"https://github.com/mishl-dev.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/logo.svg\" alt=\"shelfd logo\" width=\"132\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eshelfd\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  A small self-hosted OPDS server for ebook archives.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  Browse by subject, search from reader apps, and fill in covers and metadata automatically.\n\u003c/p\u003e\n\n## What It Does\n\n- turns an ebook archive into an OPDS catalog\n- gives you an explore-first browsing feed instead of search-only UX\n- still supports OPDS search for clients like Foliate\n- pulls metadata and covers from Open Library when available\n- generates fallback covers when nothing better exists\n\n## Quick Start\n\nRun with `just`:\n\n```bash\njust up\n```\n\nOr without `just`:\n\n```bash\ndocker compose up --build\n```\n\nThen open:\n\n- `http://localhost:7451/opds`\n\nStop:\n\n```bash\njust down\n```\n\nOr:\n\n```bash\ndocker compose down\n```\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eConfig\u003c/strong\u003e\u003c/summary\u003e\n\n  \u003cbr\u003e\n\n  The defaults are enough to get started, but these are the settings you will most likely care about:\n\n  - `ARCHIVE_URLS`: comma-separated archive base URLs for round-robin racing\n  - `ARCHIVE_BASE`: fallback single archive URL (used if `ARCHIVE_URLS` is not set)\n  - `ARCHIVE_NAME`: display name shown in feeds\n  - `APP_NAME`: app name shown to OPDS clients\n  - `PUBLIC_BASE_URL`: public base URL for generated links\n  - `DATABASE_URL`: SQLite database location\n  - `RUST_LOG`: log level and filters\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eEndpoints\u003c/strong\u003e\u003c/summary\u003e\n\n  \u003cbr\u003e\n\n  - `GET /opds`\n  - `GET /opds/search?q=...`\n  - `GET /healthz`\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eDev\u003c/strong\u003e\u003c/summary\u003e\n\n  \u003cbr\u003e\n\n  ```bash\n  just up\n  just test\n  just lint\n  just fmt\n  ```\n\u003c/details\u003e\n\n## License\n\nMIT. See [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmishl-dev%2Fshelfd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmishl-dev%2Fshelfd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmishl-dev%2Fshelfd/lists"}