ブックマークを管理できるPocketクローンの「Shiori」をインストールする手順

公開日:2020/01/15 更新日:2020/01/15
ブックマークを管理できるPocketクローンの「Shiori」をインストールする手順のサムネイル

Pocketというブックマークを管理してオフラインでもブックマークしたWebページを閲覧できるサービスがありますが、ShioriはこのPocketクローンのオープンソースアプリです。この記事では、Shioriをインストールして使うまでの手順をまとめます。

はじめに

Pocketというブックマークを管理してオフラインでもブックマークしたWebページを閲覧できるサービスがありますが、ShioriはこのPocketクローンのオープンソースアプリです。この記事では、実際に自分のサーバーにShioriをインストールし、さらにブラウザからブックマークしたWebページが自分で動かしているShioriに登録するまでの手順をまとめます。 ShioriはGo言語で開発されており、以下がShioriの公式リポジトリです。MITライセンスです。

github.com

Simple bookmark manager built with Go

前提と環境

以下が今回Shioriをインストールした環境になります。

  • OS : Ubuntu18.04
  • Go : 1.13.5 (1.12以上が必須)

Shioriを使用するには、Goがインストールされている必要があります。もしまだGoをインストールしていない場合は、以下に手順をまとめているので必要な方は見てみてください。

www.virment.com

LinuxでGo言語を使用したい場合に、各ディストリビューションのパッケージマネージャーからインストールすることもできますが、バージョンが少し古いことがあります。この記事では、最新版のGoをLinuxにインストールする手順をまとめます。

Shioriをインストールする

Shioriをインストールする方法として、Dockerコンテナを使用する方法、ソースからコンパイルする方法、Go経由でパッケージをダウンロードしてインストールする方法が用意されています(公式ドキュメント参照 )。ここでは、1番簡単なGo経由でパッケージをダウンロードしてインストールする方法を使用します。 具体的には、以下のコマンドでShioriをインストールします。

$ go get -u -v github.com/go-shiori/shiori

上記を実行すると以下のように表示されます。

$ go get -u -v github.com/go-shiori/shiori
github.com/go-shiori/shiori (download)
created GOPATH=/home/cebuntu/go; see 'go help gopath'

// 省略

github.com/lib/pq/oid
github.com/lib/pq/scram
github.com/lib/pq
github.com/mattn/go-sqlite3
github.com/shurcooL/httpfs/vfsutil
github.com/shurcooL/vfsgen
github.com/go-shiori/shiori

なお、上記で実行したgo getコマンドとそのオプションについては、以下に詳しくまとめれていました。

github.com

Goのコマンド

パスを通す

go getを初めて実行した場合、ホームディレクトリにgoという名前のディレクトリが作成されます。そしてShioriの実行ファイルはgo/bin/shioriに配置されています。 したがってこのパスを通すために以下を/.bashrc(もしくは/.profile)の末尾に追記します。

~/.bashrc
export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin

追記したら再読み込みして反映します。

$ source .bashrc

なお、Go言語をインストールした時にGo自体のパスを通すために以下を追記したと思いますが、このパスとは別のパスになります。

export PATH=$PATH:/usr/local/go/bin

以上でShioriのインストールが完了です。インストールが正常に完了しているか確認するために、shioriコマンドでヘルプを表示してみると以下のように表示されます。

$ shiori -h
Simple command-line bookmark manager built with Go

Usage:
  shiori [command]

Available Commands:
  add         Bookmark the specified URL
  check       Find bookmarked sites that no longer exists on the internet
  delete      Delete the saved bookmarks
  export      Export bookmarks into HTML file in Netscape Bookmark format
  help        Help about any command
  import      Import bookmarks from HTML file in Netscape Bookmark format
  open        Open the saved bookmarks
  pocket      Import bookmarks from Pocket’s exported HTML file
  print       Print the saved bookmarks
  serve       Serve web interface for managing bookmarks
  update      Update the saved bookmarks

Flags:
  -h, --help       help for shiori
      --portable   run shiori in portable mode

Use "shiori [command] --help" for more information about a command.

Shioriを起動する

Shioriをインストールしたら、以下のコマンドでShioriを起動します。

$ shiori serve

無事に起動すると、以下のように起動状態になります。

$ shiori serve
INFO[0000] Serve shiori in :8080

なお、Shioriはデフォルトではポート番号8080を使用します。もしポート番号を変更したい場合は以下のようにpオプションを使用します。

$ shiori serve -p 8081
INFO[0000] Serve shiori in :8081

もしポート番号がすでに使用されている場合は以下のようにエラーが表示されますので、この場合はポート番号を変更してみてください。

$ shiori serve
INFO[0000] Serve shiori in :8080                        
FATA[0000] Server error: listen tcp :8080: bind: address already in use

また、使用するポート番号がiptablesやその他のファイアウォールによって許可されているかも確認してください。

Shioriにログインする

Shioriを起動したら、ブラウザからShioriをインストールしたサーバーのドメイン(もしくはIPアドレスでもOK)にShioriが使用しているポート番号を付与してアクセスしてみます。 もしShioriをローカルで動かしている場合は、http://localhost:8080でShioriにアクセスできます。 Shioriにアクセスすると、以下のようにログイン画面が表示されます。

shiori-login-page.png

Shioriのデフォルトのアカウントは以下です。

  • ユーザ名:shiori
  • パスワード:gopher

上記をアカウントでログインすると、以下のようにダッシュボードが表示されます。

shiori-logged-in.png

後はGoogle ChromeやFireFoxからShioriの拡張機能を通してブックマークを追加します。

Shioriの拡張機能をChrome、FireFoxに追加する

Shioriの拡張機能は、執筆時点でベータ版でありまだChromeストア等では配布されていません。使用する場合は、こちらの拡張機能のリリースページから拡張機能をダウンロードします。

chose-your-browser.png

Google Chromeの場合

Google Chrome用の拡張機能は、「Source code (zip)」をダウンロードし、ダウンロードしたZIPファイルを展開しておきます。 続いてGoogle Chromeを開いて拡張機能ページにアクセスします。拡張機能ページはメニューからアクセスしてもいいですし、URLにchrome://extensions/を入力してアクセスしてもOKです。 拡張機能ページの右上に以下のように「デベロッパーモード」というスイッチがあるのでこれをオンにし、「パッケージ化されていない拡張機能を読み込む」をクリックします。

load-shiori-extention.png

「パッケージ化されていない拡張機能を読み込む」をクリックすると、フォルダの選択ダイアログが表示されるので、先程展開しておいた「Source Code (zip)」のフォルダを指定します。 読み込まれると以下のようにShioriの拡張機能が追加されます。ここで「詳細」をクリックします。

settings-shiori.png

Shioriの詳細ページの下の方に、以下のように「拡張機能のオプション」という項目があるのでこれをクリックして開きます。

click-settings-shiori.png

以下のようにShioriのサーバーのURLとアカウントの入力ダイアログが開くので、ここで自分のサーバーのURL、アカウントを入力します。

setup-your-shiori-server.png

FireFoxの場合

FireFoxの場合は、リリースページからxpiフィアルをダウンロードしてダブルクリックして拡張機能をFireFoxに追加してください。詳しくは公式ドキュメントに記載されています。

拡張機能からブックマークを追加する

拡張機能を追加すると以下のようにShioriのアイコンが追加されているので、ブックマークしたいWebページを開いた状態でこのアイコンをクリックし、タグ名を入力するか空のままで保存ボタンをクリックします。

shiori-ext-save.png

ブックマークが追加されると、先程ログインしたShioriのダッシュボードに追加したブックマークが以下のように並んでいきいます。

added-bookmark.png

まとめ

PocketクローンのShioriのインストール手順と使い方をまとめました。