Skip to content

Installation

There are several supported installation methods available:

Supported methods

Using Precompiled Binary

Download the latest version of shiori from the release page, then put it in your PATH.

On Linux or MacOS, you can do it by adding this line to your profile file (either $HOME/.bash_profile or $HOME/.profile):

export PATH=$PATH:/path/to/shiori

Note that this will not automatically update your path for the remainder of the session. To do this, you should run:

source $HOME/.bash_profile
or
source $HOME/.profile

On Windows, you can simply set the PATH by using the advanced system settings.

Install building from source

Shiori uses Go module so make sure you have version of go >= 1.14.1 installed, then run:

go install github.com/go-shiori/shiori@latest

Ensure your PATH includes the $GOPATH/bin directory so your commands can be easily used:

sh export PATH=$PATH:$(go env GOPATH)/bin

Using Docker Image

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

docker pull ghcr.io/go-shiori/shiori

This docker image is based on the Dockerfile.ci

Building docker image

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 .

This docker image is based on the root Dockerfile

Community provided

There are other methods to have your own shiori instance running, but they are not officially supported by the Shiori team and have been provided by the community.

Contributions are welcome!

Deploying with Fly.io

Contributed by: @jt-wang (Thanks to Oscar Carlsson's post)

You can also deploy direclty to Fly.io using the docker image.

  • lauch a new Fly.io app, and create permanent storage
cd directory-where-you-store-your-shiori-flyio-toml
flyctl launch --no-deploy
flyctl volumes create shiori_data --size 1
  • Add the following sections to your fly.toml:
[build]
image = "ghcr.io/go-shiori/shiori:latest"

[mounts]
source="shiori_data" # change it if you use another volume name in step 1
destination="/shiori"
  • Deploy
flyctl deploy

  • Now the shiori app should run like expected. The default username is shiori and the default password is gopher, ensure you change this credentials when you log in for the first time.

    You can run flyctl open to open your Shiori.