shiori/docs/Configuration.md
András Rutkai e722cb6961
fix: properly parse mysql connection string, docs update (#730)
Mysql connection string update, docs update
2023-09-13 18:31:41 +02:00

1.6 KiB

Content

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:

Platform Directory
Linux ${XDG_DATA_HOME}/shiori (default: ~/.local/share/shiori)
macOS ~/Library/Application Support/shiori
Windows %LOCALAPPDATA%/shiori

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

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 it in environment variables.

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.