Knowledgebase

Installation

Execute Docker run using the following command:

                             docker run -d \
                                        --name=booklib \
                                        -e DB_HOST=<hostname> \
                                            -e DB_DATABASE=<database_name> \
                                                -e DB_USERNAME=<Username> \
                                                    -e DB_PASSWORD=<Password> \
                                                        -p 8080:8080 \
                                                        -v /path/to/data:/storage \
                                                        -v /path/to/library:/library \
                                                        --restart unless-stopped \
                                                        ghcr.io/MKaterbarg/Booklib

                            

In this comment, there are 4 values which you will need to replace:

• <hostname> - With the hostname or IP address of you MySQL server
• <database_name> - The name of the database you'll be using on said MySQL server
• <Username> - The username of a user with access to the database you'll be using on said MySQL server
• <Password> - The password of a user with access to the database you'll be using on said MySQL server

The storage volume is used for persistent storage, and contains files generated by the software such as thumbnails and logs. The library volume is the path to the library/ies you want to add to Booklib.

Once the container has started, you may login to the system using the URL you specified in your webserver configuration. Login using the initial login details:
Username: admin
Password: password
Make sure to update this as soon as possible using the top-right settings icon/menu

Add your first library using the top right menu. Make sure the www-data user has read permissions on the directories you're adding.