Installing BicBucStriim on Synology DSM 6 and DSM 7

What is BicBucStriim and why use it?

BicBucStriim is a lightweight PHP web application that turns an existing Calibre library stored on a NAS into a browsable ebook catalogue. It reads the library’s Calibre metadata and makes books available through a web interface and an OPDS feed, allowing computers, tablets, phones and compatible e-readers to browse authors, titles, tags and series and download books directly from the NAS. This is particularly useful on a Synology system because the NAS already provides central, always-on storage; BicBucStriim adds the missing ebook-serving layer without requiring the full Calibre desktop application to run on the NAS. The original project is no longer actively maintained, however, so these instructions are now mainly relevant to legacy installations and compatible community-maintained forks.

Edit 27 April 2022: The original BicBucStriim download is no longer available. These instructions use the maintained BicBucStriim repository, which provides ready-to-use packages containing all required dependencies.

Choose the package that matches your DSM and PHP version:

Synology versionPHP versionBicBucStriim package
DSM 6.2PHP 7.4BicBucStriim 1.7.2
DSM 7.0 or 7.1PHP 7.4BicBucStriim 1.7.2
DSM 7.2 or newerPHP 8.2BicBucStriim 3.6.7

PHP 8.2 is the recommended option when your NAS supports it. If PHP 7.4 or PHP 8.2 is unavailable in Package Center, the maintained version cannot be installed directly using Web Station on that NAS.

1. Install the required Synology packages

Open Package Center and install:

  • Web Station
  • Apache HTTP Server 2.4
  • PHP 7.4 or PHP 8.2, depending on your DSM version

You will also need a Calibre library stored somewhere on the NAS. The library’s main directory should contain the metadata.db file.

2. Create a PHP profile

Open Web Station and create a PHP profile for the installed PHP version.

On DSM 6, this can normally be found under PHP Settings. On DSM 7, look under Script Language Settings.

Enable at least these PHP extensions:

  • gd
  • pdo_sqlite
  • sqlite3

Also enable intl and sodium if they are available. They are recommended but not required for the basic installation.

If PHP’s open_basedir setting is enabled, add the path to your Calibre library. Preserve the existing paths and separate entries with a colon. For example:

/tmp:/var/services/web:/volume1/books/Calibre Library

Assign the PHP profile and Apache HTTP Server 2.4 to the default Web Station service or to a new web-service portal.

3. Enable SSH

Open Control Panel → Terminal & SNMP and temporarily enable SSH.

Connect to the NAS using an administrator account, then become root:

sudo -i

The following commands assume that /volume1/web/bbs does not already exist. Back up or rename an existing installation before continuing.

4. Download and install BicBucStriim

For DSM 6.2, DSM 7.0 or DSM 7.1 with PHP 7.4:

mkdir /volume1/web/bbs
wget -O /tmp/bicbucstriim.zip https://github.com/mikespub-org/rvolz-BicBucStriim/releases/download/v1.7.2/bicbucstriim-1.7.2-php74.zip
unzip /tmp/bicbucstriim.zip -d /volume1/web/bbs

For DSM 7.2 or newer with PHP 8.2:

mkdir /volume1/web/bbs
wget -O /tmp/bicbucstriim.zip https://github.com/mikespub-org/rvolz-BicBucStriim/releases/download/v3.6.7/bicbucstriim-3.6.7-php82.zip
unzip /tmp/bicbucstriim.zip -d /volume1/web/bbs

The downloaded packages already contain their PHP dependencies, so Composer is not required.

5. Set the permissions

Give Web Station read access to the application while allowing it to write to BicBucStriim’s data directory:

chown -R root:http /volume1/web/bbs
find /volume1/web/bbs -type d -exec chmod 750 {} \;
find /volume1/web/bbs -type f -exec chmod 640 {} \;

chown -R http:http /volume1/web/bbs/data
find /volume1/web/bbs/data -type d -exec chmod 770 {} \;
find /volume1/web/bbs/data -type f -exec chmod 660 {} \;

Next, open File Station, locate the shared folder containing your Calibre library and grant the local http group read permission. Apply the permission to all enclosed files and folders. BicBucStriim normally only needs to read the Calibre library.

6. Check the installation

Open the installation checker in your browser:

http://NAS-IP/bbs/installcheck.php

Check that Apache, URL rewriting, SQLite, GD and the data directory all pass their tests.

If you installed the PHP 7.4 build, its checker may incorrectly report that PHP 8 is required. BicBucStriim 1.7.2’s PHP 7.4 package is specifically intended for PHP 7.4, so this warning can be ignored if the other checks pass.

Now open:

http://NAS-IP/bbs/

Sign in with the default credentials:

Username: admin
Password: admin

Change this password immediately. Then open the administration settings and enter the complete path to your Calibre library, for example:

/volume1/books/Calibre Library

The directory you select must contain Calibre’s metadata.db file.

Once configured, the OPDS catalogue is available at:

http://NAS-IP/bbs/opds/

Troubleshooting

If the website produces an HTTP 500 error or a blank page, verify that the selected PHP profile matches the downloaded BicBucStriim package.

If the homepage works but other links return 404 errors, make sure Apache 2.4 is selected and that the .htaccess file was extracted.

If BicBucStriim cannot find or read the library, check both the http group permissions and PHP’s open_basedir setting.

If book covers are not generated, verify that the GD extension is enabled and that /volume1/web/bbs/data is writable by the http user.

After completing the setup, disable SSH again unless you need it for other administrative work. Do not expose BicBucStriim directly to the internet without HTTPS and suitable access restrictions.

Leave a Reply

Your email address will not be published. Required fields are marked *