https://github.com/m-wynn/next-mokuro-bookshelf
A bookshelf for your mokuro-scanned books with database storage
https://github.com/m-wynn/next-mokuro-bookshelf
bookshelf japanese manga-reader mokuro ocr
Last synced: 6 months ago
JSON representation
A bookshelf for your mokuro-scanned books with database storage
- Host: GitHub
- URL: https://github.com/m-wynn/next-mokuro-bookshelf
- Owner: m-wynn
- Created: 2023-07-29T06:15:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T03:10:10.000Z (6 months ago)
- Last Synced: 2025-04-13T00:05:41.505Z (6 months ago)
- Topics: bookshelf, japanese, manga-reader, mokuro, ocr
- Language: TypeScript
- Homepage:
- Size: 651 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Next Mokuro Bookshelf
A bookshelf for your [mokuro](https://github.com/kha-white/mokuro)-scanned books
https://github.com/m-wynn/next-mokuro-bookshelf/assets/6320753/de017150-3b9c-4922-b43d-dee6ced129be
# Instructions
## Production Mode
1. Copy .env.example to .env
2. Edit any environment variables you desire (see below)
3. Run `docker compose -f docker-compose..yml up -d` where environment is "dev" or "prod".
4. Upgrade your database with `docker compose -f docker-compose..yml exec next-mokuro-bookshelf npx prisma migrate deploy`
5. Create a new user. The first user will automatically get admin role.
## Environment Variables
- `DATABASE_URL` is a Postgresql database connection URL for [prisma](https://www.prisma.io/docs/orm/overview/databases/postgresql#connection-url). If you are using the one provided in the docker-compose yaml, ensure the username and password match the environment variables set for that.
- `IMAGE_PATH` is the path the images will be stored. I recommend using the path that is volume-mounted in the docker-compose yaml.
- `INVITE_CODE` is a secret variable that users need to know in order to sign up
In addition, the postgresql database included in the docker-compose will use:
- `POSTGRESQL_USER` the user that the application should use to connect
- `POSTGRESQL_PASSWORD` the password the application should use to connect
## Usage
1. Download, install, and run `mokuro` on your volumes via the instructions in [kha-white/mokuro](https://github.com/kha-white/mokuro)
2. Run the application and create an account
3. Navigate to `/admin/volumes` and upload a cover, the images, and `_ocr` json files.
4. Go back to the home page and start reading!
# Troubleshooting
## Database permissions issue
If you see logs like
```
db-1 | initdb: error: could not change permissions of directory "/var/lib/postgresql/data": Operation not permitted
db-1 | fixing permissions on existing directory /var/lib/postgresql/data ...
db-1 | The files belonging to this database system will be owned by user "postgres".
db-1 | This user must also own the server process.
```
Try changing the permissions on `db` folder in this project's root? `chmod u+x db` might work.
# Alternatives
- [ChristopherFritz/Mokuro-Bookshelf](https://github.com/ChristopherFritz/Mokuro-Bookshelf) is a static html page that tracks your state with localstorage