Grimmory

Grimmory is a self-hosted app that brings your entire book collection under one roof. Organise, read, annotate, sync, and share.

This is an unofficial snap. After installing, and waiting for the the various services to start, your instance will be accessible at http://localhost:41935

You'll probably want to connect the snap as follows to allow access your books which should be in /mnt/somewhere or /media/somewhere so that the snap can access them:

sudo snap connect grimmory:removable-media

sudo snap connect grimmory:mount-observe

There are three services, nginx (the web server), grimmory-api (the backend API server), and mariadb (the database server). The database files and logs are stored in the snap's data directory, which is preserved across snap updates.

Ports

You can change the port that each service uses with the following commands:

For the port that nginx listens on (default 41935):

sudo snap set grimmory port=<desired-port>

For the port that MariaDB listens on (default 41936):

sudo snap set grimmory database-port=<desired-port>

For the port that grimmory-api listens on (default 41937):

sudo snap set grimmory api-port=<desired-port>

After changing the ports, you will need to restart the snap for the changes to take effect:

sudo snap restart grimmory

Database

If you need to connect to the MariaDB database from outside the snap, the username is grimmory and you can use the following command to get the password:

snap get grimmory database-password

You can also connect with the following command as root:

sudo mariadb --socket=/var/snap/grimmory/common/run/mysql/mysqld.sock -u root --skip-ssl