docker-composeを使ってGROWIをインストールしてみよう!

growi_login
Pocket

「情報を共有する」や「情報を探す」ということが難しいと思ったことはないでしょうか。情報は色々な場所に散らばってしまったり、一部の人しか知らなかったりして、必要な情報がどこにあるかわからなくなってしまうことが良くあります。そこで、情報をまとめるために、Wikiというツールがあります。

Wikiとは、情報をまとめるツールであり、情報の共有や複数人で情報の編集などができます。Wikiを使うことにより、必要な情報が共有されやすくなったり、情報を見つけやすくなったりします。

本記事では、GROWIというMarkdownで書けるWikiシステムのインストール方法を記載します。GROWIとは、Markdownで書けるオープンソースのWikiシステムです。オープンソースであるため、無料で使うことができ、Markdownで書けるため、Markdownを良く使う方には編集しやすいWikiだと思います。

スポンサーリンク

GROWIとは

GROWIとは、Markdownで書けるオープンソースのWikiシステムです。Wikiは情報をまとめるツールのひとつですが、複数人で情報をまとめる場合、あらかじめ書式のルールを決めたりします。そうすると、書式のルールを覚える必要があるため、なかなか情報が書きづらくなります。GROWIはMarkdownのルールにのっとって情報をまとめることができるため、Markdownを使う方には情報が書きやすいのが特徴です。

機能

一番の特徴としては、Markdownで書けることです。左右2画面のリアルタイムプレビューで編集ができ、コードハイライトにも対応しているため、効率良く作業ができます。他にも、ドラッグ&ドロップでファイルのアップロードやテーマやレイアウトのカスタマイズができるため、チームに合わせたWikiを作ることができます。

  • Markdown・・・左右2画面のリアルタイムプレビュー、言語ごとのコードハイライト
  • アセット管理・・・ドラッグ&ドロップでのファイルアップロード
  • 3種のキーマップ・・・Vim/Emacs/Sublime Textのキーマップをサポート
  • 絵文字入力・・・EmojiOne v3による絵文字入力が可能
  • テーマの変更・・・サイトやコードハイライトのテーマ変更が可能
  • カスタマイズ・・・レイアウトなどのカスタマイズが可能
  • 高速な検索・・・ElasticSearchを使った全文検索が可能

docker-composeとは

docker-composeとは、複数のコンテナで構成されるアプリケーションについて、簡単にコンテナの動作を実行できるツールです。docker-composeでGROWIをインストールすると、Webアプリケーション用のコンテナ(GROWI)とデータベース用のコンテナ(MongoDB)と検索用のコンテナ(ElasticSearch)作られます。

docker-composeを使う理由

Docker Hubというコンテナを共有できるWebサイトがあり、GROWIもDocker Hubにあるため、GROWIのコンテナをダウンロードすることができます。しかし、GROWIを使うにはMongoDBが必要となるため、サーバにMongoDBをインストールする必要があります。そのため、docker-composeを使ってインストールすることで、GROWIを使うために必要なコンテナを自動的にダウンロードし、コンテナ同士で連携するため、サーバにMongoDBをインストールする必要がなくなります。

GROWIをインストールしてみよう

それでは、docker-composeを使ってGROWIをインストールしてみましょう。docker-composeをインストールしたあと、GROWIをインストールしていきます。docker-composeを使うにはdockerが必要となりますが、dockerはインストールしている前提で進めていきます。

環境

インストールは以下の環境で行います。

  • OS: Ubuntu 18.04(bionic)
  • Docker: 18.06

docker-composeをインストール

docker-composeのインストールは公式サイトの通りに行います。docker-composeの最新バージョンを確認し、docker-composeをインストールしていきます。

docker-composeの最新バージョンを確認

リリースページから、docker-composeの最新バージョンを確認します。「rc」(Release Candidate)はまだ安定板ではないため、「rc」が付いていないバージョンがおすすめです。本記事では、「1.22.0」のバージョンをインストールしていきます。

docker-composeをダウンロード

最新バージョンが確認できましたら、「curl」コマンドでdocker-composeをダウンロードします。URL内にバージョンを指定する箇所がありますので、インストールするバージョンに合わせて変更しましょう。

$ sudo curl -L "https://github.com/docker/compose/releases/download/1.22.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

docker-composeに実行権限を付与

ダウンロードした状態では実行権限が付与されていないため、docker-composeに実行権限を付けます。

$ sudo chmod +x /usr/local/bin/docker-compose

docker-composeが使えるか確認

これでdocker-composeがインストールできました。問題なくインストールできたか確認のため、「docker-compose」コマンドでバージョンを確認してみましょう。

$ docker-compose --version
docker-compose version 1.22.0, build f46880fe

GROWIをインストール

docker-composeのインストールができたため、本題のGROWIをインストールしていきます。GithubからGROWIのリポジトリを複製(クローン)することで、インストールできます。まずはGitをインストールし、そのあとにGROWIのリポジトリをクローンしましょう。

パッケージからGitをインストール

Gitはパッケージからインストールできます。パッケージをアップデートしたあとに、Gitをインストールします。

$ sudo apt-get update
$ sudo apt-get install git

gitが使えるか確認

docker-composeと同じように、問題なくインストールできたか確認のため、「git」コマンドでバージョンを確認してみましょう。

$ git --version
git version 2.17.1

GithubからGROWIのリポジトリをクローン

それでは、「git」コマンドでGROWIのリポジトリをクローンします。クローン後、カレントディレクトリに「growi」というフォルダが作成されます。

$ git clone https://github.com/weseek/growi-docker-compose.git growi
$ ls -ld growi
drwxr-xr-x 6 user user 4096 Oct 10 18:58 growi

docker-composeでGROWIを起動

GROWIのインストールができましたので、あとはGROWIを起動できるか確認します。先ほど作成された「growi」のディレクトリに移動したあと、「docker-compose」コマンドで起動してみましょう。

$ cd growi
$ sudo docker-compose up

GROWIにアクセス

それでは、GROWIにWebブラウザからアクセスしてみましょう。デフォルトでは、3000ポートでアクセスできますので、「http://localhost:3000」でアカウント作成画面が表示されましたら、問題なく起動できています。

growi_login

他のサーバからGROWIにアクセスする方法

デフォルトでは、GROWIを起動しているホストのみアクセスでき、他のサーバからはアクセスができません。そのため、growiのディレクトリ内にあるdocker-compose.ymlの「ports」を編集することで、他のサーバからもアクセスできるようになります。

services:
  app:
    build:
      context: .
      dockerfile: ./Dockerfile
    ports:
      - 3000:3000    #=> デフォルトの「127.0.0.1:」を消し、「3000:3000」にする。

GROWI
growi-docker-compose

スポンサーリンク

feedly、RSSをフォローする