Skip to content

volf52/robinson

 
 

Repository files navigation

Robinson

Self-hosted management of the books in your personal library

Self-hosted Book management for your personal library.

Add your bookcases, shelves and books. Track where they're stored, who they're loaned to and where you are.

Check your reading timeline and search your library. Easily add book by scanning their ISBN.

Features

  • Organizes books into, shelves and bookcase
  • Add books by scanning an ISBN barcode with your phone
  • Uses multiple sources to pull book information from ISBN
  • Bookmarking, keep your place
  • Search across all books
  • Favorites, bookmarking and ratings are kept on a per-user basis
  • Organize physical books and eBooks
  • Built in eBook reader
  • Install on your device as a Progressive Web App (PWA)

Installation

If you're ready to self-host robinson yourself here's some steps to get started;

Install the docker engine on your OS of choice.

Create a docker-compose.yml file on your OS.

Copy the following in it.

services:
    mongo:
        image: mongo:latest
        restart: unless-stopped
        environment:
            MONGO_INITDB_ROOT_USERNAME: robinson
            MONGO_INITDB_ROOT_PASSWORD: robinson123
            MONGO_INITDB_DATABASE: robinson
        volumes:
            - robinson-data:/data/db
    robinson:
        image: ghcr.io/ryanmccartney/robinson:latest
        restart: unless-stopped
        environment:
            PORT: 80
            NODE_ENV: production
            DB_NAME: robinson
            DB_USER: robinson
            DB_PASSWORD: robinson123
            SESSION_SECRET: pleaseChangeMe
        depends_on:
            - mongo
        ports:
            - 80:80
volumes:
    robinson-data:

Please change your DB_PASSWORD and SESSION_SECRET for your own instance.

Run docker compose up -d.

Access robinson at http://localhost:80

Login with the default username admin and password robinson123

Documentation

Read the full docs at ryan.mccartney.info/robinson

About

Your personal library assistant

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 99.0%
  • Other 1.0%