Configuration

• Overall Configuration
  • Global configuration
  • HTTP configuration variables
  • Storage Configuration
    • The data Directory
  • Database Configuration
    • MySQL
    • PostgreSQL
• Reverse proxies and the webroot path
  • Nginx

Overall Configuration

Most configuration can be set directly using environment variables or flags. The available flags can be found by running shiori --help. The available environment variables are listed below.

Global configuration

HTTP configuration variables

Storage Configuration

The StorageConfig struct contains settings related to storage.

The data Directory

Shiori is designed to work out of the box, but you can change where it stores your bookmarks if you need to.

By default, Shiori saves your bookmarks in one of the following directories:

If you pass the flag --portable to Shiori, your data will be stored in the shiori-data subdirectory alongside the shiori executable.

To specify a custom path, set the SHIORI_DIR environment variable.

Database Configuration

SHIORI_DBMS is deprecated and will be removed in a future release. Please use SHIORI_DATABASE_URL instead.

Shiori uses an SQLite3 database stored in the above data directory by default. If you prefer, you can also use MySQL or PostgreSQL database by setting the SHIORI_DATABASE_URL environment variable.

MySQL

MySQL example: SHIORI_DATABASE_URL="mysql://username:password@(hostname:port)/database?charset=utf8mb4"

You can find additional details in go mysql sql driver documentation.

PostgreSQL

PostgreSQL example: SHIORI_DATABASE_URL="postgres://pqgotest:password@hostname/database?sslmode=verify-full"

You can find additional details in go postgres sql driver documentation.

Reverse proxies and the webroot path

If you want to serve Shiori behind a reverse proxy, you can set the SHIORI_HTTP_ROOT_PATH environment variable to the path where Shiori is served, e.g. /shiori/.

Keep in mind this configuration wont make Shiori accessible from /shiori path so you need to setup your reverse proxy accordingly so it can strip the webroot path.

We provide some examples for popular reverse proxies below. Please follow your reverse proxy documentation in order to setup it properly.

Nginx

Fox nginx, you can use the following configuration as a example. The important part is the trailing slash in proxy_pass directive:

location /shiori/ {
    proxy_pass http://localhost:8080/;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
}