Skip to content

A Web search interface for Ruby reference manual in Japanese

Notifications You must be signed in to change notification settings

ruby/rurema-search

 
 

Repository files navigation

はじめに

名前

るりまサーチ

説明

るりまを全文検索するWebアプリケーションです。

TODO: もっとちゃんと書く。

作者

Kouhei Sutou

<[email protected]>

ライセンス

LGPL 3またはそれ以降のバージョンです。詳しくはlicense/lgpl-3.0.txtを見てください。

依存ソフトウェア

  • Ruby 1.9.1

  • Rack

  • BitClust

  • groonga

  • rroonga

  • racknga

インストール

個人利用の場合

Debian GNU/Linux

% mkdir rurema
% cd rurema
% git clone git:https://github.com/clear-code/rurema-search.git
% cd rurema-search
% ./setup.sh
% ruby1.9.1 rackup
% www-browser https://localhost:9292/

Mac OS X + rbenv

% mkdir rurema
% cd rurema
% git clone git:https://github.com/clear-code/rurema-search.git
% cd rurema-search
% rbenv local 2.1.2
% bundle
% RUBY=`which ruby` ./setup.sh
% rackup > /dev/null 2>&1 &
% open https://localhost:9292/

WSL Ubuntu-20.04(Windows) + rbenv

First, install Groonga in advance. Groonga installation is easy and convenient to install from Ubuntu PPA.

Depending on your environment, you may need to install additional ‘zsh` package.

$ sudo apt install zsh

Enter the following command lines in the terminal of WSL:

$ mkdir rurema
$ cd rurema
$ git clone https://github.com/rurema/doctree.git
$ git clone https://github.com/rurema/bitclust.git
$ git clone https://github.com/ranguba/racknga.git
$ git clone https://github.com/clear-code/rurema-search.git
$ rbenv local 2.6.6
$ cd rurema-search
$ gem install groonga
$ gem install bitclust-core bitclust-dev refe2
$ bundle install
$ ./update.sh
$ rackup

Finally, open localhost:9292/ by your Web browser.

サーバ利用の場合

Debian GNU/Linux wheezy

インストーラをダウンロードします。

% wget https://raw.githubusercontent.com/clear-code/rurema-search/master/setup-wheezy.sh

以下のようにroot権限でインストーラを実行します。(実行前に中身を確認して実行しても問題ないことを確認すること。)

% sudo sh setup-wheezy.sh ホスト名

「ホスト名」にはサーバのホスト名を指定します。例えば、rurema.example.org/でアクセスしたい場合は以下のようにします。

% sudo sh setup-wheezy.sh rurema.example.org

これで「rurema」ユーザが作られ、「~rurema/rurema-search/」以下にるりまサーチがセットアップされます。cronも設定するので毎日定期的に最新版にアップデートされます。

ドキュメント

TODO

メーリングリスト

質問、要望、バグ報告などはるりまのMLにお願いします。

bugs.ruby-lang.org/projects/rurema/wiki/MailingList

感謝

  • okkezさん: バグを報告してくれました。

  • sora_hさん: 検索結果のソート順について意見をくれました。

About

A Web search interface for Ruby reference manual in Japanese

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 76.7%
  • CSS 9.8%
  • HTML 7.7%
  • Shell 5.8%