Skip to content

Commit

Permalink
fix section level for the enju install manual. next-l/enju_leaf#1903
Browse files Browse the repository at this point in the history
  • Loading branch information
masao committed Aug 24, 2024
1 parent 71c36e9 commit 87ca8e6
Show file tree
Hide file tree
Showing 7 changed files with 63 additions and 52 deletions.
22 changes: 12 additions & 10 deletions 1.4/enju_install_vm_10.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,16 @@ version: 1.4

toc::[]

== Enjuを運用するにあたっての留意点・注意点
== 第10章 その他(カスタマイズなど)

=== Enjuを運用するにあたっての留意点・注意点

Enjuサーバは,外部からネットワーク経由でアクセスすることができるサービスとして運用されます。したがって,そのセキュリティ管理などには十分に気を配る必要があります。Enjuサーバ自体は,配付時点での最新の状況に対応できるようにセキュリティ対策を講じていますが,日進月歩のネットワーク環境では,新しいネットワーク上の脅威が発生する可能性もあります。このような状況に対応するため,運用に際しては,特に以下の2つにご注意ください。

1. 最新の配付パッケージを使用すること:Enjuコンテナについても,今後,バージョンアップを重ねるたびに配付を予定しています。機能面での充実というだけではなく,セキュリティ面からも最新のパッケージを使用ください。
2. 不必要な外部からのアクセスを禁止すること:場合によっては,ファイアウォールの導入やリモートルータでのフィルタリングについても検討した方が良いこともあるでしょう。

== 「条件を詳しく指定して検索」の画面をカスタマイズする
=== 「条件を詳しく指定して検索」の画面をカスタマイズする

Enju 「条件を詳しく指定して検索」の画面をカスタマイズする方法を説明します。
設定する画面がないため、これはサーバー上の作業をする必要があります。
Expand All @@ -43,7 +45,7 @@ app/views/page/advanced_search.html.erb
docker compose up -d
```

== トップの画面の検索フォームをカスタマイズする
=== トップの画面の検索フォームをカスタマイズする

Enju トップの画面の検索フォームをカスタマイズする方法を説明します。
設定する画面がないため、これはサーバー上の作業をする必要があります。
Expand All @@ -69,7 +71,7 @@ app/views/page/_search_form.html.erb
docker compose up -d
```

== 検索結果一覧画面の検索フォームをカスタマイズする
=== 検索結果一覧画面の検索フォームをカスタマイズする

Enju 検索結果一覧画面の検索フォームをカスタマイズする方法を説明します。
設定する画面がないため、これはサーバー上の作業をする必要があります。
Expand All @@ -78,7 +80,7 @@ Enju 検索結果一覧画面の検索フォームをカスタマイズする方
. `app/views/manifestations/_index_form.html.erb`を編集します。
. <<_条件を詳しく指定して検索の画面をカスタマイズする,10-2節>> の 4. と同様に、Enjuを起動します。

== 検索結果一覧画面に表示項目を追加する
=== 検索結果一覧画面に表示項目を追加する

Enju 検索結果一覧画面に表示される書誌情報や所蔵情報の表示内容をカスタマイズする方法を説明します。
設定する画面がないため、これはサーバー上の作業をする必要があります。
Expand All @@ -96,17 +98,17 @@ Enju 検索結果一覧画面に表示される書誌情報や所蔵情報の表
. <<_条件を詳しく指定して検索の画面をカスタマイズする,10-2節>> の 4. と同様に、Enjuを起動します。


== トップ画面やヘルプなどに表示する画像を置く
=== トップ画面やヘルプなどに表示する画像を置く

. 置きたい画像を用意します。(ここでは例として logo.png とします)
. インストールしてあるEnju の app/assets/images/ 以下に画像ファイルを置きます。※ custom フォルダを作成し、その下にファイルを置くことを推奨します。

[NOTE]
====
======
* フォルダを作成しその下にファイルを置くことも可能です。
* ファイル名やフォルダ名は任意に作成できます(ただし、Enjuが使用するものと衝突する場合は動作保証しかねます)。
* customフォルダ以下のファイルはEnjuが用意した画像と衝突しないことが保証されます。
====
======

. 以下のコマンドを実行します。
+
Expand All @@ -125,7 +127,7 @@ $ bundle exec rake assets:precompile
※ 画像ファイルをブラウザから置けるようにする機能を開発予定です(link:https://github.com/next-l/enju_leaf/issues/1113[詳細 #1133])。
// 関連 #1144 //

== ヘッダーをカスタマイズする
=== ヘッダーをカスタマイズする

ヘッダーをカスタマイズする方法を説明します。
現在は、ヘッダーに表示されるタイトルしか変更できないため、
Expand Down Expand Up @@ -166,7 +168,7 @@ $ bundle exec rake assets:precompile

. <<_条件を詳しく指定して検索の画面をカスタマイズする,10-2節>> の 4. と同様です。

== Sitemapsを設定する
=== Sitemapsを設定する

以下のコマンドでサイトマップを作成・更新します。ファイルは`public/sitemap.xml.gz`に作成されます。定期的にサイトマップを更新する場合、以下のコマンドをcronなどに登録してください。

Expand Down
16 changes: 8 additions & 8 deletions 1.4/enju_install_vm_2.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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の標準的な環境から大幅に手をいれる必要がある場合などには、この方法をとることが必要となることもあると思われます。
Expand All @@ -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のインストールは以下の手順で行います。

Expand Down
24 changes: 13 additions & 11 deletions 1.4/enju_install_vm_3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@ version: 1.4

toc::[]

== 動作環境を確認する
== 動作環境の確認とDockerのインストール

=== 動作環境を確認する

作業を開始する前に,Enjuをインストールするコンピュータの環境を確認します。
この文書では,Windows 10 でのやり方について説明します。

////
=== コンピュータの仕様の確認
==== コンピュータの仕様の確認
Dockerを使うためには,使っているコンピュータのCPUが64bit対応で、がハードウェアの仮想化に対応している必要があります。
Expand All @@ -27,7 +29,7 @@ Dockerを使うためには,使っているコンピュータのCPUが64bit対
////

=== Windowsが64bit版であるかの確認,使用可能メモリ容量の確認
==== Windowsが64bit版であるかの確認,使用可能メモリ容量の確認

Windowsが64ビット版であるか,メモリ容量をシステムのプロパティで確認します。※32bit版では動作しません

Expand All @@ -42,7 +44,7 @@ image::../assets/images/1.1/image_install_004.png[[スタート]ボタンを
+
image::../assets/images/1.1/image_install_005.png[コンピュータのプロパティ画面から動作環境を確認します]

=== ハードディスク空き容量の確認
==== ハードディスク空き容量の確認

Enjuコンテナのインストールと動作に必要なハードディスクの空き容量を確認します。

Expand All @@ -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アドレスを確認します。

Expand Down Expand Up @@ -96,7 +98,7 @@ image::../assets/images/1.1/image_install_024.png[表示された画面で,情
////
{::comment}
=== 動作環境による判定
==== 動作環境による判定
Docker用に用意された Next-L Enjuは,バーチャライゼーション・テクノロジー(Virtualization Technology / VT)に対応したCPUを搭載したコンピュータでないと動作しません。
Expand All @@ -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をインストールします。

Expand Down
14 changes: 8 additions & 6 deletions 1.4/enju_install_vm_4.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ version: 1.4

toc::[]

== Enjuの入手
== Enjuのインストール

=== Enjuの入手

Enjuのインストールに必要なパッケージは,すべてネットワーク上で提供されます。

Expand All @@ -21,7 +23,7 @@ Enjuのインストールに必要なパッケージは,すべてネットワ
$ git clone https://github.com/next-l/enju_leaf.git -b 1.4
----

== Dockerの起動
=== Dockerの起動

Dockerを起動します。

Expand All @@ -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の電源ボタンを押すなどして強制終了させると,使用中のデータベースファイルが壊れて,再起動できなくなるなどの問題が発生する可能性があります。

Expand All @@ -50,7 +52,7 @@ $ docker compose down

Enjuコンテナをシャットダウンするタイミングは,図書館の運用方針で決定することができます。起動したら基本的にはずっと動作させ続けていても問題ありません。毎日Enjuコンテナをシャットダウンする,必要な時だけ稼働させるなど,ポリシーに応じた運用をすることができます。

=== Enju コンテナの再起動
==== Enju コンテナの再起動

```
$ docker compose down
Expand Down
3 changes: 2 additions & 1 deletion 1.4/enju_install_vm_5.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ version: 1.4

:toc: macro


toc::[]

== モジュールの追加

Next-L Enju Leaf 1.4では、モジュールによる機能には対応しなくなりました。

include::enju_install_vm_toc.adoc[]
Expand Down
Loading

0 comments on commit 87ca8e6

Please sign in to comment.