Content
---

- [Data directory](#data-directory)
- [Database](#database)


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

| Variable               | Description                                         |
|------------------------|-----------------------------------------------------|
| `SHIORI_DBMS`          | Must be set to `mysql`                              |
| `SHIORI_MYSQL_USER`    | Name of MySQL user                                  |
| `SHIORI_MYSQL_PASS`    | Password for the above user                         |
| `SHIORI_MYSQL_NAME`    | Name of database to use                             |
| `SHIORI_MYSQL_ADDRESS` | Address of MySQL server, e.g. `tcp(127.0.0.1:3306)` or `unix(/tmp/mysqld.sock)` |

### PostgreSQL

| Variable            | Description                                |
|---------------------|--------------------------------------------|
| `SHIORI_DBMS`       | Must be set to `postgresql`                |
| `SHIORI_PG_USER`    | Name of PostgreSQL user                    |
| `SHIORI_PG_PASS`    | Password for the above user                |
| `SHIORI_PG_NAME`    | Name of database to use                    |
| `SHIORI_PG_HOST`    | Address of PostgreSQL server               |
| `SHIORI_PG_PORT`    | Port number used by PostgreSQL server      |


[wiki]: https://github.com/go-shiori/shiori/wiki