Sign inSign up

nrew225/shiori

By nrew225

•Updated almost 6 years ago

Image
0

2.7K

nrew225/shiori repository overview

⁠Shiori

⁠Using Docker Image

To use Docker image, you can pull the latest automated build from Docker Hub :

docker pull nrew225/shiori

If you want to build the Docker image on your own, Shiori already has its Dockerfile⁠, so you can build the Docker image by running :

docker build -t shiori .

⁠Configuration

⁠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:

PlatformDirectory
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
VariableDescription
SHIORI_DBMSMust be set to mysql
SHIORI_MYSQL_USERName of MySQL user
SHIORI_MYSQL_PASSPassword for the above user
SHIORI_MYSQL_NAMEName of database to use
SHIORI_MYSQL_ADDRESSAddress of MySQL server, e.g. tcp(127.0.0.1:3306)
⁠PostgreSQL
VariableDescription
SHIORI_DBMSMust be set to postgresql
SHIORI_PG_USERName of PostgreSQL user
SHIORI_PG_PASSPassword for the above user
SHIORI_PG_NAMEName of database to use
SHIORI_PG_HOSTAddress of PostgreSQL server
SHIORI_PG_PORTPort number used by PostgreSQL server

Tag summary

Content type

Image

Digest

Size

6.2 MB

Last updated

almost 6 years ago

docker pull nrew225/shiori