Shiori¶

Shiori is a simple bookmarks manager written in Go and distributed under the MIT License. It can be used as a command line application or via the built-in web-UI.

Note

For this guide you should be familiar with the basic concepts of

Prerequisites¶

Note

By default, Shiori runs on port 8080.

To make the application accessible from the outside, configure a web backend:

[isabell@stardust ~]$ uberspace web backend set / --http --port <port>
Set backend for / to port <port>; please make sure something is listening!
You can always check the status of your backend using "uberspace web backend list".
[isabell@stardust ~]$

Installation¶

Like a lot of Go software, Shiori is distributed as a single binary. Download Shiori’s latest release and make sure that the file can be executed.

 [isabell@stardust ~]$ wget https://github.com/go-shiori/shiori/releases/download/v1.5.0/shiori-linux-amd64-stretch -O ~/bin/shiori
 Resolving github.com (github.com)... 140.82.121.3
 Connecting to github.com (github.com)|140.82.121.3|:443... connected.
 HTTP request sent, awaiting response... 302 Found
 Length: 19735216 (19M) [application/octet-stream]
 Saving to: ‘/home/shiori/bin/shiori’

100%[======================================>] 19,735,216  12.2MB/s

 2020-11-11 22:04:39 (12.2 MB/s) - ‘/home/isabell/bin/shiori’ saved [19735216/19735216]
 [isabell@stardust ~]$ chmod u+x ~/bin/shiori
 [isabell@stardust ~]$

Configuration¶

Setup daemon¶

Note

To use a different port instead of 8080, you need to add -p <portnumber> to the command in your shiori.ini file. Remember to adjust the port for the web backend as well.

Create ~/etc/services.d/shiori.ini with the following content.

[program:shiori]
command=shiori serve
autostart=yes
autorestart=yes

After creating the configuration, tell supervisord to refresh its configuration and start the service:

[isabell@stardust ~]$ supervisorctl reread
SERVICE: available
[isabell@stardust ~]$ supervisorctl update
SERVICE: added process group
[isabell@stardust ~]$ supervisorctl status
SERVICE                            RUNNING   pid 26020, uptime 0:03:14
[isabell@stardust ~]$

If it’s not in state RUNNING, check your configuration.

Finishing installation¶

The default user and password is shiori and gopher. Once logged in you will be able to use the web interface. To add a new account, open the settings page and click on “Add new account”. With this, the default user will be deactivated automatically.

Updates¶

Note

Check the update feed regularly to stay informed about the newest version.

Check Shiori’s releases for the latest version. If a newer version is available, stop daemon by supervisorctl stop shiori and repeat the “Installation” step followed by supervisorctl start shiori to restart Shiori.

Tested with Shiori 1.5.0, Uberspace 7.7.9.0

Written by: Kevin Jost <https://github.com/systemsemaphore>