growiのすすめ~チームでの情報共有・記録の保存に。メモ帳代わりの専用wiki~

growiのすすめ~チームでの情報共有・記録の保存にメモ帳代わりの専用WIKI~ server
2021.12.02

こんにちは。ときうかぜです。
この記事は、自分やチーム専用のwikiについてのお話です。

突然ですが、あなたはブックマークに保存されている「Webページを探す」作業や、GoogleDriveなどのファイルサーバーに保存された「資料を探す」ことを面倒だと思ったことはないでしょうか。
私はよくあります。整理整頓されていないのが主な原因です。

これらの混沌とした情報を整理するためにおすすめのツールがあります。
それがあなた、もしくはコミュニティ専用wikiです。

この記事では、wikiについての使い方の紹介や「growi」の構築方法について触れています。

wikiをつかってできること

私がwikiを使用するまえに感じていたいろんなアプリの問題点をあげてみました。

ブラウザブックマーク機能の問題点

  1. ブラウザのブックマーク機能を使っているうちに、ブックマークが増え探しにくくなっている。
  2. ブックマークを整理するためにフォルダだらけになっている。
  3. 保存する際にタイトルもしっかりと考えず、意味のないタイトルで保存されている。
  4. どのような経緯でブックマークしたのかわからない

GoogleDriveなどのクラウドサービスやファイルサーバーでの問題点

  1. 多数のファルダや資料のなかから目的のものを探し出すのには苦労と時間が必要になる
  2. 資料が項目ごとにまとまっていない・まとめられない
  3. 階層が深いファイルにアクセスする際、フォルダの移動に時間がかかる

これらはすべてwikiで解決できます！

wikiとは？

そもそもWikiがなにかを調べてみました。
Wiki（ウィキ）とは、 みんなが自由に編集できる Web サイトの総称 です。
WikiというとWikipediaを連想すると思いますが、ここで紹介しているのは誰でも閲覧編集できるアプリではなく、限られたメンバーが閲覧編集できるアプリです。

・必要な情報が共有されやすい
・必要な情報を見つけやすい
・共有されている情報を、手軽に更新しやすい

https://backlog.com/ja/wiki-guide/intro/02/

サル先生のwiki入門は、wikiを理解する上でおすすめのページです。

wikiの特性について詳しく丁寧に説明しています。
会社で使用している「backlog」の使用方法を検索している際に見つけたページでした。
これをきっかけとして、会社の申請書類等をまとめたwikiページを作成するなどをするうちにwikiの便利さを理解するようになりました。

使用例

wikiを私なりに説明するとしたら、Webページの形で提供される共同編集可能なメモ帳です。
シンプルなツールですが、工夫次第でさまざまな使い方ができます。例を紹介します。

ブックマークと情報のまとめ

  • 一つの分野でページを作成し、WebページのURLと説明を箇条書きにしていく。
  • Webページの特に重要な部分やよく使用する記述については、抜き出して記しておく。

メリット

ブラウザのブックマークのように散らかることもなく、ページにアクセスがしやすくなる。

Copy Title and Url as Markdown Style

また、このようなプラグインを使用することでブックマークよりも素早く情報の整理・保存ができます。

手順書の作成

  • ある物事に対しての手順書を作成する。
  • 共同編集機能を使用して、複数人で内容を充実させていく。

メリット

手順書は新しく仕事を始める人にとって、とてもありがたい存在です。
また、手順書は質問とそれに答える時間を大幅にへらします。

積極的に書きためていきましょう。

アカウントの共有

  • 自分が管理しているアカウントがあるときに、共有が必要なURLやアカウント情報について、まとめたページを用意する。

メリット

ID・パスワード・ログイン画面URL・ログインその他の処理や操作について記しておくことができます。利用者は、wikiを見るだけである程度は自分で操作を進めることができるようになります。
使い方を聞かれた際はwikiページのURLなどを共有し、wiki情報を見せることで管理者への問い合わせを最小限にできます。

GoogleDriveの整理

  • wikiに共有用URLとファルダの説明を記載する。

メリット

自分に対して公開されている資料は整理ができません。（一覧で表示されるだけ）
wikiを使用することで検索機能を使用せずとも、散らかっているGoogleDriveを自由に整理することができます。GoogleDriveでないクラウドやファイルサーバーを使用している人にもおすすめです。

wikiを使用する

wikiを使用するには、主に2つの方法があります。

  • 有料サービスを使用する
  • サーバーを用意して、ソフトウェアを構築する

この記事では、「growi」というオープンソースを使用してConoHaのVPNにwikiサーバーを構築する方法を紹介します。
冒頭でも少しふれましたが、私は「backlog」のwikiを使用していました。
しかし、この「backlog」のwikiには３つ問題点があります。

backlog wikiの問題点

  1. 「backlog」のwikiは、必要最低限の機能しかない
  2. ツリー表示の親ページを変更するためには子ページを手作業で変更しなければならない
  3. 長年使用しているユーザーは、プロジェクトによって「backlog記法」と「Markdown記法」の混在する

私のが考える一番不便な点は、ページの整理がしにくいことです。
backlogはタスク管理ツールです。wikiはあくまでもおまけといった立ち位置なのでしょう。
そこで、「backlog」のwikiにかわる専用wikiを探しはじめました。

条件

1．有料サービスは、なるべく避ける

サービス終了の危険性があるため。

2．外からでも閲覧できる

出不精の私には必要ないかもしれないけれど

3．多機能

コメント機能や整理が簡単になるような機能がほしい

4．セキュリティ

認証と暗号通信は必須

これらの条件を満たしたのが「growi」でした。

growiとは

Markdownで記入できるwikiのこと。MITライセンスで使用できます。
crowiをさらに拡張したものです。

OSS開発wikiツールのGROWI | 快適な情報共有を、全ての人へ
GROWIはGROWI, Inc.が開発を行い、MITライセンスで公開しているオープンソースソフトウェアです。 dockerへのインストールやオンプレ対応も可能です。 開発を手伝っていただけるコントリビューター、開発してみたいインターン生も...
growi.org

構築方法

環境はConohaVPSを使用しました。
公式でDockerファイルを準備しているのでこれを利用します。

docker-compose | GROWI Docs
GROWI ドキュメント
docs.growi.org

必要ソフトウェアのインストール

Docker環境の構築

  • Docker
  • docker-compose

上記2つのソフトウェアが必要になります。
aptでインストールできるものは、バージョンが古く使用しないほうが良いため、公式ページのインストール方法を試します。

下記のドキュメントをご覧ください

Install Docker Engine on Ubuntu

Docker Compose のインストール

growiのインストール

growi-docker-composeのダウンロード

git clone https://github.com/weseek/growi-docker-compose.git growi
cd growi

localhost 以外からのアクセス

docker-compose | GROWI Docs
GROWI ドキュメント
docs.growi.org

サーバーにGrowiを構築する場合は先に設定しておく必要があります。
先に接続を許可しないと、サーバーに入れません。

docker-compose.yml ファイル内の ports を変更することで localhost 以外からのアクセスを許可することができます。

https://docs.growi.org/ja/admin-guide/getting-started/docker-compose.html#localhost-%E4%BB%A5%E5%A4%96%E3%81%8B%E3%82%89%E3%81%AE%E3%82%A2%E3%82%AF%E3%82%BB%E3%82%B9

変更前

services:
  app:
    ports:
      - 127.0.0.1:3000:3000

変更後

services:
  app:
    ports:
      - 3000:3000

GROWI の起動確認

ダウンロードしたフォルダ内にて以下のコマンドを実行します。

docker-compose up

`http://localhost:3000/` にアクセスし、初回セットアップ画面(/installer)の表示が確認できれば GROWI 起動完了です。

初期設定を始められます。

なお、遠隔からサーバーにアクセスする場合は必ず暗号化しましょう。
なお、認証にはTCP80とTCP443のポート開放を行う必要があります。
私の環境ではmydnsの認証ができませんでした。

Let's Encrypt による HTTPS 運用

github

バックアップについて

運用を始める前にバックアップについては考えておいてください。
データが保存される前でしたら、かんたんです。

AWS S3に保存する場合

下記のドキュメントが参考になります。

MongoDB の定期バックアップ | GROWI Docs
GROWI ドキュメント
docs.growi.org

NASなどに保存する場合

デフォルトではDockerのボリュームがわかりにくいところに配置されます。
アクセスするためにはルート権限が必要で操作がしにくいためカレントディレクトリにボリュームを作成し、データをここに保存します。

基本的にはgrowi_mongo_dbとgrowi_growi_dataをバックアップすればよいはずですが、気になるようならすべてをバックアップしても良いと思います。

# デフォルトでvolumesが保存されるディレクトリ
/var/lib/docker/volumes

# ls
/var/lib/docker/volumes
backingFsBlockDev  growi_growi_data      growi_mongo_db
growi_es_data      growi_mongo_configdb  metadata.db

growiを立ち上げる前にdocker-compose.ymlを編集し、Volumeの保存先を同じディレクトリにします。

version: '3'

# 省略

    restart: unless-stopped
    volumes:
      - ./data/growi_growi_data/_data:/data　　　# 変更

  mongo:
    image: mongo:4.4
    restart: unless-stopped
    volumes:
      - mongo_configdb:/data/configdb
      - ./data/growi_mongo_db/_data:/data/db　　# 変更

  elasticsearch:
    build:
      context: ./elasticsearch

# 省略

保存用のディレクトリを用意します。

mkdir -p ./data/growi_growi_data ./data/growi_mongo_db

あとはcronを活用し、定期的にこれらのファイルをNASなどにコピーします。

まとめ

いかがでしたでしょうか？
wikiを活用すると情報の伝達がスムーズになります。
なにかしらのコミニュティを運営されている、社内で使用するといった場合には特に効果を発揮します。どんどん活用していきましょう！

コメント

タイトルとURLをコピーしました