Installation check

Explanation

This page executes various checks regarding the environment and the installation directory of BicBucStriim. It checks for typical problems that users had in the past. The checks signal the outcome with a traffic light scheme:

	Everything ok.
	There could be a problem, click on the info button to see if it concerns you.
	A problem was discovered, please click on the info button to find out more.

---

Calibre library check

Enter the path to your Calibre library to check accessibility. A Calibre library directory contains the file metadata.db plus various subdirectories for authors and books.

The test tries to find metadata.db in the directory you enter, and will check if that directory is readable for the application.

If the test fails (red light), check:

• that the directory really exists
• that it contains the files mentioned above
• that it is readable for the application (see also the open_basedir check below)

{% if cd.status == 2 %} {% endif %}

{% if cd.status == 0 %}   {% else %} {% if cd.status == 1 %} {% else %} {% endif %} {% endif %}	Calibre directory Check
Directory exists? {% if cd.dir_exists %}Yes{%else%}No{%endif%} Directory is readable? {% if cd.dir_is_readable %}Yes{%else%}No{%endif%} Directory is executable? {% if cd.dir_is_executable %}Yes{%else%}No{%endif%} Real path of database is: {{ cd.realpath }} Database opened? {% if cd.library_ok %}Yes{%else%}No{%endif%}

---

Environment checks

• {% if is_a == true %} {% else %} {%endif%}

  Apache web server?

  {% if is_a == true %}Yes, {{srv}}.{% else %}No.{%endif%}

  info
• {% if php == true %} {% else %} {%endif%}

  PHP version 5.3+?

  {% if php == true %} Yes, found version {{phpv}}. {% else %} No, found version {{phpv}}. {%endif%}

  info
• {% if htaccess == true %} {% else %} {% if is_a == true %} {% else %} {% endif %} {% endif %}

  Does .htaccess exist?

  {% if htaccess == true %} Yes. {% else %} {% if is_a == true %} No. {% else %} No Apache, please ensure URL rewriting manually. {% endif %} {% endif %}

  info
• {% if mre == true %} {% else %} {% if is_a == true %} {% else %} {% endif %} {% endif %}

  Is URL rewriting enabled?

  {% if mre == true %} Yes. {% else %} {% if is_a == true %} No. {% else %} No Apache, please verify manually. {% endif %} {% endif %}

  info
• {% if hsql != false %} {% else %} {% endif %}

  Is Sqlite3 installed?

  {% if hsql != false %} Yes. {% else %} No. {% endif %}

  info
• {% if hgd2 == true %} {% else %} {% endif %}

  Is GD version 2 (or higher) installed?

  {% if hgd2 == true %} Yes, found version {{hgd2v}}. {% else %} {% if hgd2v == "" %} No. {% else %} No, found {{hgd2v}}. {% endif %} {% endif %}

  info
• {% if mcrypt == true %} {% else %} {% endif %}

  Is Mcrypt enabled? (PHP <7.4)

  {% if mcrypt == true %} Yes. {% else %} No. {% endif %}

  info
• {% if sodium == true %} {% else %} {% endif %}

  Is Sodium enabled? (PHP 7.4+)

  {% if sodium == true %} Yes. {% else %} No. {% endif %}

  info
• {% if intl == true %} {% else %} {% endif %}

  Is PHP module intl enabled?

  {% if intl == true %} Yes. {% else %} No. {% endif %}

  info
• {% if opd == "" %} {% else %} {% endif %}

  Is the open_basedir restriction in effect?

  {% if opd == "" %} No. {% else %} Yes, open_basedir = {{opd}} {% endif %}

  info
• {% if dwrit == true %} {% else %} {% endif %}

  Is the data directory writeable?

  {% if dwrit == true %} Yes. {% else %} No. {% endif %}

  info
• {% if mwrit == true %} {% else %} {% endif %}

  Is data/data.db writeable?

  {% if mwrit == true %} Yes. {% else %} No. {% endif %}

  info

The PHP open_basedir setting is a security measure that restricts file access for PHP applications to a list of specified directories mentioned in the variable. Many NAS devices use this setting.

If your Calibre library is located outside your web server root, this directory should be included in the open_basedir list. To include it, just append the name of your Calibre directory to this list, e.g. ...:/volume1/books (don't forget the colon in front).

BicBucStriim contains a .htaccess file that enables URL rewriting on Apache servers automatically. If the check failed this is probably due to an unpack problem. Sometime unzippers don't unpack hidden files (i.e. files whose names start with a dot) properly. Try a different unzip application.

BicBucStriim contains a .htaccess file that enables URL rewriting on Apache servers automatically. If this is an Apache web server and the check failed, please change the URL rewriting (mod_rewrite) settings of your server/device.

If this is no Apache web server, you have to verify manually that URL rewriting is enabled.

The Sqlite3 database library is required to read the Calibre library data. Sqlite support for PHP is often contained in a module like php5-sqlite. Please install the Sqlite3 support if the check failed.

The GD image library is necessary for thumbnail generation. GD support for PHP is often contained in a module like php5-gd. Please install or update the module if the check failed.

Mcrypt is used by the underlying framework to encrypt browser cookies when using PHP <7.4. BicBucStriim works without it, but then might transmit data unencrypted. In a secure home network this is usually not a problem.

In case you are using BicBucStriim in a public network, you might consider enabling mcrypt to protect your cookies. In order to enable mcrypt, install a module like php-mcrypt.

Sodium is used by the underlying framework to encrypt browser cookies when using PHP 7.4+. BicBucStriim works without it, but then might transmit data unencrypted. In a secure home network this is usually not a problem.

In case you are using BicBucStriim in a public network, you might consider enabling sodium to protect your cookies. In order to enable sodium, install a module like php-sodium.

PHP module intl is used for translation and localization purposes. BicBucStriim works without it, but then some data, like the language of a book, will not be displayed.

In order to enable intl, install the PHP module, probably called php5-intl.

The bbs/data directory contains the configuration database and thumbnails. If it doesn't exist or is not writeable the application can't store anything. If the check failed, please create the directory and/or change the access rights.

The file bbs/data/data.db is part of the BicBucStriim package and stores your configuration data. If the check failed, please verify that it exists and is writeable.

BicBucStriim requires PHP 5.3 or higher. Otherwise some functions might fail.

BicBucStriim works with Apache and other web servers. However, the included configuration file .htaccess is for Apache only. If you are using a different web server please make sure that features like URL rewriting are enabled.