From 87ca8e618499d5a262f74545a9f8575778c1c362 Mon Sep 17 00:00:00 2001 From: Masao Takaku Date: Sat, 24 Aug 2024 16:09:42 +0900 Subject: [PATCH] fix section level for the enju install manual. next-l/enju_leaf#1903 --- 1.4/enju_install_vm_10.adoc | 22 ++++++++++++---------- 1.4/enju_install_vm_2.adoc | 16 ++++++++-------- 1.4/enju_install_vm_3.adoc | 24 +++++++++++++----------- 1.4/enju_install_vm_4.adoc | 14 ++++++++------ 1.4/enju_install_vm_5.adoc | 3 ++- 1.4/enju_install_vm_6.adoc | 28 +++++++++++++++------------- 1.4/enju_install_vm_8.adoc | 8 +++++--- 7 files changed, 63 insertions(+), 52 deletions(-) diff --git a/1.4/enju_install_vm_10.adoc b/1.4/enju_install_vm_10.adoc index 281eb73..cd867f9 100644 --- a/1.4/enju_install_vm_10.adoc +++ b/1.4/enju_install_vm_10.adoc @@ -10,14 +10,16 @@ version: 1.4 toc::[] -== Enjuを運用するにあたっての留意点・注意点 +== 第10章 その他（カスタマイズなど） + +=== Enjuを運用するにあたっての留意点・注意点 Enjuサーバは，外部からネットワーク経由でアクセスすることができるサービスとして運用されます。したがって，そのセキュリティ管理などには十分に気を配る必要があります。Enjuサーバ自体は，配付時点での最新の状況に対応できるようにセキュリティ対策を講じていますが，日進月歩のネットワーク環境では，新しいネットワーク上の脅威が発生する可能性もあります。このような状況に対応するため，運用に際しては，特に以下の２つにご注意ください。 1. 最新の配付パッケージを使用すること：Enjuコンテナについても，今後，バージョンアップを重ねるたびに配付を予定しています。機能面での充実というだけではなく，セキュリティ面からも最新のパッケージを使用ください。 2. 不必要な外部からのアクセスを禁止すること：場合によっては，ファイアウォールの導入やリモートルータでのフィルタリングについても検討した方が良いこともあるでしょう。 -== 「条件を詳しく指定して検索」の画面をカスタマイズする +=== 「条件を詳しく指定して検索」の画面をカスタマイズする Enju 「条件を詳しく指定して検索」の画面をカスタマイズする方法を説明します。 設定する画面がないため、これはサーバー上の作業をする必要があります。 @@ -43,7 +45,7 @@ app/views/page/advanced_search.html.erb docker compose up -d ``` -== トップの画面の検索フォームをカスタマイズする +=== トップの画面の検索フォームをカスタマイズする Enju トップの画面の検索フォームをカスタマイズする方法を説明します。 設定する画面がないため、これはサーバー上の作業をする必要があります。 @@ -69,7 +71,7 @@ app/views/page/_search_form.html.erb docker compose up -d ``` -== 検索結果一覧画面の検索フォームをカスタマイズする +=== 検索結果一覧画面の検索フォームをカスタマイズする Enju 検索結果一覧画面の検索フォームをカスタマイズする方法を説明します。 設定する画面がないため、これはサーバー上の作業をする必要があります。 @@ -78,7 +80,7 @@ Enju 検索結果一覧画面の検索フォームをカスタマイズする方 . `app/views/manifestations/_index_form.html.erb`を編集します。 . <<_条件を詳しく指定して検索の画面をカスタマイズする,10-2節>> の 4. と同様に、Enjuを起動します。 -== 検索結果一覧画面に表示項目を追加する +=== 検索結果一覧画面に表示項目を追加する Enju 検索結果一覧画面に表示される書誌情報や所蔵情報の表示内容をカスタマイズする方法を説明します。 設定する画面がないため、これはサーバー上の作業をする必要があります。 @@ -96,17 +98,17 @@ Enju 検索結果一覧画面に表示される書誌情報や所蔵情報の表 . <<_条件を詳しく指定して検索の画面をカスタマイズする,10-2節>> の 4. と同様に、Enjuを起動します。 -== トップ画面やヘルプなどに表示する画像を置く +=== トップ画面やヘルプなどに表示する画像を置く . 置きたい画像を用意します。（ここでは例として logo.png とします） . インストールしてあるEnju の app/assets/images/ 以下に画像ファイルを置きます。※ custom フォルダを作成し、その下にファイルを置くことを推奨します。 [NOTE] -==== +====== * フォルダを作成しその下にファイルを置くことも可能です。 * ファイル名やフォルダ名は任意に作成できます（ただし、Enjuが使用するものと衝突する場合は動作保証しかねます）。 * customフォルダ以下のファイルはEnjuが用意した画像と衝突しないことが保証されます。 -==== +====== . 以下のコマンドを実行します。 + @@ -125,7 +127,7 @@ $ bundle exec rake assets:precompile ※ 画像ファイルをブラウザから置けるようにする機能を開発予定です（link:https://github.com/next-l/enju_leaf/issues/1113[詳細 #1133]）。 // 関連 #1144 // -== ヘッダーをカスタマイズする +=== ヘッダーをカスタマイズする ヘッダーをカスタマイズする方法を説明します。 現在は、ヘッダーに表示されるタイトルしか変更できないため、 @@ -166,7 +168,7 @@ $ bundle exec rake assets:precompile . <<_条件を詳しく指定して検索の画面をカスタマイズする,10-2節>> の 4. と同様です。 -== Sitemapsを設定する +=== Sitemapsを設定する 以下のコマンドでサイトマップを作成・更新します。ファイルは`public/sitemap.xml.gz`に作成されます。定期的にサイトマップを更新する場合、以下のコマンドをcronなどに登録してください。 diff --git a/1.4/enju_install_vm_2.adoc b/1.4/enju_install_vm_2.adoc index 5a1dfe2..a3c60a3 100644 --- a/1.4/enju_install_vm_2.adoc +++ b/1.4/enju_install_vm_2.adoc @@ -11,17 +11,17 @@ version: 1.4 toc::[] +== Enjuを動作させる方法 + Enjuを動作させる方法について説明します。 -== 概要 +=== 概要 Enjuを実行させるために、Project Next-LではGitHub上でソースコードを公開しているほか、Docker環境用のコンテナも作成・提供しています。これに対応してEnjuをインストールする方法としては、いくつか方法がありますが、ここでは2つ紹介します(下図を参照)。 1. Enjuを動作させるのに必要な各種ミドルウェアやモジュール群をインストールし、Enjuのプログラムを実行 2. **Dockerがインストールされたコンピュータで、EnjuのDockerコンテナを実行** -// image::../assets/images/1.1/image_install_002.png[Enjuを動作させる方法] - 各図書館の状況や開発形態によって、これらの手法から最適な手法を選択することが必要となります。 1.の方法はEnjuが動作する環境整備から行っていこうとするもので、実行することができるコンピュータの範囲も広く、取り込むモジュールの選択なども行えるなど最も自由度が高い方法です。コンピュータの能力に応じたパフォーマンスも発揮することができます。その反面、インストールのためにはOSや、Ruby on Railsの開発環境、ネットワークに関わる比較的高度な知識などが必要となります。初心者には、かなりハードルが高いということもできます。各図書館の状況などにあわせ、Enjuの標準的な環境から大幅に手をいれる必要がある場合などには、この方法をとることが必要となることもあると思われます。 @@ -42,23 +42,23 @@ Next-L Enjuがインストールされたサーバコンピュータにクライ image::../assets/images/1.1/image_install_001.png[Next-L Enjuの利用イメージ] -== Dockerについて +=== Dockerについて Dockerは、広く利用されているコンテナ実行環境構築・運用ソフトウェアです。 -=== Dockerの概要 +==== Dockerの概要 Dockerは、Docker社によって提供されているアプリケーション実行環境構築・運用ソフトウェアです。Dockerでは、アプリケーションの入った「コンテナ」を実行することができます。 -=== Dockerを利用するメリット +==== Dockerを利用するメリット Dockerを用いた場合、その上で動作するアプリケーションを「コンテナ」、つまりセットアップ済みのファイルとして提供できるメリットがあります。これに対してDockerを使用しない場合は、LinuxなどのOSのインストールからはじめて、Ruby, Ruby on Rails、さらにSolrのようなミドルウェアのインストールが必要になります。またコンテナ環境では、他のパッケージシステムとの競合などに注意を払う必要もありません。比較的簡単に行えるDockerのインストールを行うだけで、Enjuの動作環境の構築を大幅に簡略化することができます。 またDockerは個人用途では無償で提供されており、追加費用なしで動作環境を構築できることも大きなメリットです。 -== インストールの流れ +=== インストールの流れ -=== インストールの全体 +==== インストールの全体 Dockerを使ったEnjuのインストールは以下の手順で行います。 diff --git a/1.4/enju_install_vm_3.adoc b/1.4/enju_install_vm_3.adoc index 4e838b8..2a564eb 100644 --- a/1.4/enju_install_vm_3.adoc +++ b/1.4/enju_install_vm_3.adoc @@ -11,13 +11,15 @@ version: 1.4 toc::[] -== 動作環境を確認する +== 動作環境の確認とDockerのインストール + +=== 動作環境を確認する 作業を開始する前に，Enjuをインストールするコンピュータの環境を確認します。 この文書では，Windows 10 でのやり方について説明します。 //// -=== コンピュータの仕様の確認 +==== コンピュータの仕様の確認 Dockerを使うためには，使っているコンピュータのCPUが64bit対応で、がハードウェアの仮想化に対応している必要があります。 @@ -27,7 +29,7 @@ Dockerを使うためには，使っているコンピュータのCPUが64bit対 //// -=== Windowsが64bit版であるかの確認，使用可能メモリ容量の確認 +==== Windowsが64bit版であるかの確認，使用可能メモリ容量の確認 Windowsが64ビット版であるか，メモリ容量をシステムのプロパティで確認します。※32bit版では動作しません @@ -42,7 +44,7 @@ image::../assets/images/1.1/image_install_004.png[［スタート］ボタンを + image::../assets/images/1.1/image_install_005.png[コンピュータのプロパティ画面から動作環境を確認します] -=== ハードディスク空き容量の確認 +==== ハードディスク空き容量の確認 Enjuコンテナのインストールと動作に必要なハードディスクの空き容量を確認します。 @@ -56,11 +58,11 @@ image::../assets/images/1.1/image_install_006.png[［スタート］ボタンを image::../assets/images/1.1/image_install_007.png[ハードディスクの空き容量の確認] [NOTE] -==== +====== ハードディスクに必要な空き容量は，蔵書規模により異なります。25.0GBは蔵書が20 万件の規模を想定しています。これよりも蔵書規模が大きい場合は，より多くの容量が必要となります。 -==== +====== -=== IPアドレスの確認 +==== IPアドレスの確認 ホストOSのIPアドレスを確認します。 @@ -96,7 +98,7 @@ image::../assets/images/1.1/image_install_024.png[表示された画面で，情 //// {::comment} -=== 動作環境による判定 +==== 動作環境による判定 Docker用に用意された Next-L Enjuは，バーチャライゼーション・テクノロジー(Virtualization Technology / VT)に対応したCPUを搭載したコンピュータでないと動作しません。 @@ -114,16 +116,16 @@ Docker用に用意された Next-L Enjuは，バーチャライゼーション {:/comment} //// -== Dockerのダウンロードとインストール +=== Dockerのダウンロードとインストール ここでは Windows の場合を説明しますが，Mac，Linuxなど様々なOS上で動きます。 -=== Dockerのダウンロード +==== Dockerのダウンロード Docker DesktopをDocker社のWebサイトからダウンロードします。 次のWebページでlink:https://www.docker.com/products/docker-desktop/[Downloads]をクリックします。 -=== Dockerのインストール +==== Dockerのインストール 前項でダウンロードしたファイルを実行し，Docker Desktopをインストールします。 diff --git a/1.4/enju_install_vm_4.adoc b/1.4/enju_install_vm_4.adoc index 33d5c4e..c03fed2 100644 --- a/1.4/enju_install_vm_4.adoc +++ b/1.4/enju_install_vm_4.adoc @@ -11,7 +11,9 @@ version: 1.4 toc::[] -== Enjuの入手 +== Enjuのインストール + +=== Enjuの入手 Enjuのインストールに必要なパッケージは，すべてネットワーク上で提供されます。 @@ -21,7 +23,7 @@ Enjuのインストールに必要なパッケージは，すべてネットワ $ git clone https://github.com/next-l/enju_leaf.git -b 1.4 ---- -== Dockerの起動 +=== Dockerの起動 Dockerを起動します。 @@ -31,15 +33,15 @@ $ cd enju_leaf $ docker compose up -d ---- -== Enjuの起動確認 +=== Enjuの起動確認 Windows上でWebブラウザを起動し、アドレス欄に http://localhost:8080 と入力してください（ブラウザによっては localhost:8080 でも可）。 これで，Enjuのサーバに対してアクセスすることが可能になりました。 -== Enjuサーバの停止と再起動 +=== Enjuサーバの停止と再起動 -=== Enju コンテナのシャットダウン +==== Enju コンテナのシャットダウン Enjuコンテナを終了(シャットダウン)させる場合には，正しい手順でのシャットダウンを行う必要があり，Dockerをいきなり終了させたり，PCの電源ボタンを押すなどして強制終了させると，使用中のデータベースファイルが壊れて，再起動できなくなるなどの問題が発生する可能性があります。 @@ -50,7 +52,7 @@ $ docker compose down Enjuコンテナをシャットダウンするタイミングは，図書館の運用方針で決定することができます。起動したら基本的にはずっと動作させ続けていても問題ありません。毎日Enjuコンテナをシャットダウンする，必要な時だけ稼働させるなど，ポリシーに応じた運用をすることができます。 -=== Enju コンテナの再起動 +==== Enju コンテナの再起動 ``` $ docker compose down diff --git a/1.4/enju_install_vm_5.adoc b/1.4/enju_install_vm_5.adoc index d14247a..4154a8f 100644 --- a/1.4/enju_install_vm_5.adoc +++ b/1.4/enju_install_vm_5.adoc @@ -8,9 +8,10 @@ version: 1.4 :toc: macro - toc::[] +== モジュールの追加 + Next-L Enju Leaf 1.4では、モジュールによる機能には対応しなくなりました。 include::enju_install_vm_toc.adoc[] diff --git a/1.4/enju_install_vm_6.adoc b/1.4/enju_install_vm_6.adoc index c1160fd..39086e2 100644 --- a/1.4/enju_install_vm_6.adoc +++ b/1.4/enju_install_vm_6.adoc @@ -10,7 +10,9 @@ version: 1.4 toc::[] -== 検索における異体字の同一視 +== 検索エンジンの設定 + +=== 検索における異体字の同一視 書誌情報には「森鷗外／鴎外」「内田百閒／百間」「芥川龍之介／竜之介」のように、さまざまな異体字が混在しています。 これらを別字として扱ってしまうと大量の検索漏れが生じるので、検索においては「鷗」と「鴎」を同一視する必要があります。 @@ -18,7 +20,7 @@ toc::[] 検索時に異体字を同一視させるためには、検索エンジン側でその設定を行わなければなりません。 本章ではEnjuと連携して動作する全文検索エンジンApache Solrにおける設定手順を説明します。 -=== 異体字を同一視するようにSolrを設定する +==== 異体字を同一視するようにSolrを設定する SolrのCharFilterという機能を使えば異体字を同一視して検索させることができます。 @@ -30,7 +32,7 @@ SolrのCharFilterという機能を使えば異体字を同一視して検索さ これにより、「大嶋」で「大島」も「大嶌」もヒットするようになります。 -==== マッピングファイルを作成 +====== マッピングファイルを作成 以下のような形式のマッピングファイルを作ります。 @@ -65,13 +67,13 @@ Unicodeのコード番号で文字を指定することもできます。4桁の 変換元は空文字列にできませんが、変換先は空文字列を指定することができます。 -==== マッピングファイルを配置 +====== マッピングファイルを配置 Enju インストールディレクトリーの下に solr/conf があります。 前節で作成したマッピングファイルをここに入れておきます。 -==== 設定ファイルにファイル名を書く +====== 設定ファイルにファイル名を書く solr/conf ディレクトリーの中に schema.xml というXMLファイルがあります。 @@ -94,7 +96,7 @@ solr/conf ディレクトリーの中に schema.xml というXMLファイルが また、漢字の異体字とラテン文字の置き換え（「æ」→「ae」など）を別ファイルにする、といった分け方もできます。 -==== Enjuの再起動とSolrの再インデックス +====== Enjuの再起動とSolrの再インデックス 設定が終わったら、設定を反映するために、Enju を再起動（リスタート）して、書誌情報を再度インデックスします。 @@ -104,17 +106,17 @@ solr/conf ディレクトリーの中に schema.xml というXMLファイルが これで異体字でも検索ができるようになるはずです。 -==== 参考サイト +====== 参考サイト [https://cwiki.apache.org/confluence/display/solr/CharFilterFactories#CharFilterFactories-solr.MappingCharFilterFactory](https://cwiki.apache.org/confluence/display/solr/CharFilterFactories#CharFilterFactories-solr.MappingCharFilterFactory) 上記ページにCharFilterの仕様などが詳しく書かれています。公式サイトです。 -=== 異体字の考え方 +==== 異体字の考え方 異体字のマッピングファイルを作るにあたって注意すべきことなどを述べます。 -==== 時代性 +====== 時代性 現在、「著」と「着」は別字であり、「著しい」「著す」「著作」／「着る」「着く」「着信」などと使い分け、交換できません。 @@ -124,7 +126,7 @@ solr/conf ディレクトリーの中に schema.xml というXMLファイルが このように、ある二つの漢字が異体字であるかどうかはそれが使われた時代によって変わります。 -==== 異体字のような別字 +====== 異体字のような別字 「斉」と「齊」は異体字の関係にあります。「斎」と「齋」もそうです。しかし、「斉・齊」と「斎・齋」とは別字です。「書斎」は「書斉」とは書けず、「一斉」は「一斎」とは書けません。 @@ -132,7 +134,7 @@ solr/conf ディレクトリーの中に schema.xml というXMLファイルが 検索上は異体字かどうかに拘泥せず、この四字を同一視するのがよいかもしれません。 -==== 代用漢字 +====== 代用漢字 「国際連盟」「連合艦隊」はそれが存在した時代には「國際聯盟」「聯合艦隊」と書かれていました。しかし、「聯」は「連」の異体字ではありません。 @@ -144,7 +146,7 @@ solr/conf ディレクトリーの中に schema.xml というXMLファイルが 単語単位で「午后」を「午後」に変換するのでなく文字単位で「后」を「後」に変換する場合，「后」（きさき）による検索で大量の検索ノイズが発生するかもしれません。 -==== 中国語の簡体字 +====== 中国語の簡体字 中国の「広東省」は簡体字で「广东省」と書きます。「广」／「広」、「东」／「東」は異体字の関係にあるので、このペアもマッピングファイルに入れておけば、中国語の書誌情報も手軽に検索できてすこぶる便利ではないでしょうか。 @@ -154,7 +156,7 @@ solr/conf ディレクトリーの中に schema.xml というXMLファイルが このように、どの字とどの字が異体字の関係になるかは、言語によっても異なります。 -==== 検索ノイズとの兼ね合い +====== 検索ノイズとの兼ね合い 上で見たように，異体字マッピングを拡充すれば検索漏れが減らせる一方で検索ノイズが増えることがあります。再現率（検索漏れの少なさ）と適合率（検索ノイズの少なさ）は一般にはトレードオフの関係にあります。 diff --git a/1.4/enju_install_vm_8.adoc b/1.4/enju_install_vm_8.adoc index 897036b..6705467 100644 --- a/1.4/enju_install_vm_8.adoc +++ b/1.4/enju_install_vm_8.adoc @@ -11,16 +11,18 @@ version: 1.4 toc::[] +== Enjuのアップデート及び停止・起動 + Enjuは，以下の手順で，Enjuのソースコードが公開されているGitHubから変更されたファイルを取り込み最新版にすることができます。 -== Enjuの停止 +=== Enjuの停止 以下のコマンドを入力します。 ``` $ docker compose down ``` -== 最新ソースコードの取り込み +=== 最新ソースコードの取り込み . 以下のコマンドを入力します。 + @@ -38,7 +40,7 @@ $ docker compose run --rm web rake db:migrate $ docker compose run --rm web rake assets:precompile ``` -== Enjuを（再）起動 +=== Enjuを（再）起動 以下のコマンドを入力します。 ```