build epub reader for self hosted
- easy to deploy, and you own all of your data
- desktop and mobile support
- dark mode
- bookmark and highlight support
- multi-user support
if you want to build from source, see how to develop below.
generally, you should use docker image directly. here is the example of docker compose config.
version: "3"
services:
beryllium:
image: lee88688/beryllium
ports:
- 3000:3000
environment:
# this env should be add, do not add quote to password string
# this is used for startup. when admin user is created, this is no longer need.
- ADMIN_USER_PASSWORD=some-password
# the default admin user name is admin,
# if you want to rename, please uncomment this line
# - ADMIN_USER_NAME=some-other-name
volumes:
- /path/to/data:/app/data/app/data/db.sqlite stores the database, and /app/data/asar stores the upload epub files.
the epub file uploaded from the user will be transformed into the asar file format. the asar file is just like tar file which combine the extracted files inside epub into one. so you should keep you epub files if you want to reuse them later. and there is a way to convert asar file to epub.
- create
.envfile, like.env.example - prisma
npx prisma db push, push schema to dbnpx prisma db seed, seed db
This is a T3 Stack project bootstrapped with create-t3-app.
We try to keep this project as simple as possible, so you can start with just the scaffolding we set up for you, and add additional things later when they become necessary.
If you are not familiar with the different technologies used in this project, please refer to the respective docs. If you still are in the wind, please join our Discord and ask for help.
To learn more about the T3 Stack, take a look at the following resources:
- Documentation
- Learn the T3 Stack — Check out these awesome tutorials
You can check out the create-t3-app GitHub repository — your feedback and contributions are welcome!
Follow our deployment guides for Vercel, Netlify and Docker for more information.