{"id":17058154,"url":"https://github.com/onigoetz/comics-reader","last_synced_at":"2025-09-19T22:29:17.900Z","repository":{"id":28503640,"uuid":"2631864","full_name":"onigoetz/Comics-Reader","owner":"onigoetz","description":"Read your comic book scans on tablet !","archived":false,"fork":false,"pushed_at":"2025-09-14T00:12:16.000Z","size":71916,"stargazers_count":36,"open_issues_count":1,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-09-14T02:29:59.687Z","etag":null,"topics":["cbr","cbz","comic-books","comics-reader","new-topic","pdf-support"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/onigoetz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2011-10-23T18:29:58.000Z","updated_at":"2025-09-14T00:12:19.000Z","dependencies_parsed_at":"2025-09-14T02:32:42.298Z","dependency_job_id":null,"html_url":"https://github.com/onigoetz/Comics-Reader","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/onigoetz/Comics-Reader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onigoetz%2FComics-Reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onigoetz%2FComics-Reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onigoetz%2FComics-Reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onigoetz%2FComics-Reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onigoetz","download_url":"https://codeload.github.com/onigoetz/Comics-Reader/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onigoetz%2FComics-Reader/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276011425,"owners_count":25569837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-19T02:00:09.700Z","response_time":108,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["cbr","cbz","comic-books","comics-reader","new-topic","pdf-support"],"created_at":"2024-10-14T10:28:59.290Z","updated_at":"2025-09-19T22:29:17.873Z","avatar_url":"https://github.com/onigoetz.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Comics reader\n\n[![Latest Version](https://img.shields.io/github/release/onigoetz/Comics-Reader.svg?style=flat-square)](https://github.com/onigoetz/Comics-Reader/releases)\n[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://github.com/onigoetz/Comics-Reader/blob/master/LICENSE.md)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/onigoetz/Comics-Reader/build.yml?style=flat-square\u0026logo=github)\n[![Docker Pulls](https://img.shields.io/docker/pulls/onigoetz/comicsreader?style=flat-square\u0026logo=docker)](https://hub.docker.com/r/onigoetz/comicsreader)\n\n\nRead your comics on your tablet\n\n## What is it ?\nA nice little comic book reader for tablets and mobile phones.\nIt is not intended to work on a desktop computer.\n\n## Features\n\n- Watch your comic books on your phone or tablet, at home or on the go.\n- Uses your filesystem, has an embedded database.\n- Supports most comics formats : CBZ/CBR/ZIP/RAR, PDF, simple image directory.\n- Internal search engine to find your comics easily\n- Use basic auth credentials (from Nginx/Apache) or use the embedded Database to manage users.\n\n## Installing\n\n### Using docker (Recommended)\n\n```\ndocker run -v /your-images-dir:/comics -p 8080:8080 --rm onigoetz/comicsreader\n```\n\nWill start the comics reader using your comic books at `/your-images-dir` and be available at [http://localhost:8080]().\n\n\n### With Node\n\nFirst, you need\n- Nodejs\n- [MuPDF](https://mupdf.com/docs/mutool.html) for PDF support (`brew install mupdf-tools` / `apt install mupdf-tools`)\n\n- Download/clone this repository on your server\n- Symlink your comics to `images` in the app's directory\n- Make the `images/cache` directory writable\n- Run `yarn install`\n- Run `yarn build`\n\nYou can then start the server with `yarn start`.\n\nThis will index the books and start the server.\n\n## Authentication\n\nAuthentication is an optional feature, you can either leverage the basic auth credentials from a server (Apache/Nginx)\nOr use the built-in database.\n\nThis option can be with the `COMICS_AUTH_TYPE` environment variable.\npossible values are \"basic\" (default) or \"db\"\n\nWhen using the \"db\" authentication mode, you need to create users, for this we provide a command-line tool to create them.\n\nNote that the container has to be stopped in order to use the CLI tool as the database is otherwise readonly.\n\n### Creating users\n\n```bash\nsudo docker run --rm -it -v your_images_dir:/comics onigoetz/comicsreader node comics createUser\n```\n\n### Changing password\n\n```bash\nsudo docker run --rm -it -v your_images_dir:/comics onigoetz/comicsreader node comics changePassword\n```\n\n## Tweaking the configuration\n\n### Basedir\n\nBasedir has to be specified as an environment variable when starting the server.\n\n```\nCOMICS_BASE=\"comics\" yarn start\n# OR\ndocker run -e \"COMICS_BASE=comics\" ...\n```\n\n## Reverse proxy through nginx\n\n```\nlocation /BD/ {\n    proxy_pass http://comics:8080/BD/;\n    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n    proxy_set_header X-Forwarded-Host $server_name;\n    proxy_set_header X-Forwarded-Proto $scheme;\n}\n```\n\n## Known issues\n\n- Files with accents in zip (cbz) files don't work.\n\n## Credits and technologies\n\n- The web interface is made with [React](https://facebook.github.io/react/).\n- The photo viewer is made with [PhotoSwipe](http://photoswipe.com/).\n- [Next.js](https://nextjs.org/) powers the server side with a hint of [Express](http://expressjs.com/).\n- [Sharp](http://sharp.pixelplumbing.com/en/stable/) is used to generate the thumbnails. \n- Icon is from [GetDrawings](http://getdrawings.com/get-icon#comic-book-icon-68.jpg)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonigoetz%2Fcomics-reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonigoetz%2Fcomics-reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonigoetz%2Fcomics-reader/lists"}