インストール
Uranep Works は Web (CGI) アプリケーションですので, 利用するためには, サーバの環境が必要です. Uranep Works は, 一般的な共用レンタルサーバで動作するよう, 設計されています. Web サーバと CGI の設定は環境によって異なります. インターネットに公開する前に, 運用者が CGI の実行権限, 権限設定, HTTPS, ログの保護など必要な作業を行ってください.
必要な環境・ソフトウェア
クライアント (手元のWindows/Mac)
以下のアプリは必須で, 必ず用意する必要があります.
- FTP/SFTP/SCP などに対応したファイル転送アプリ (ファイル名変更やパーミッション変更などの操作も行うことができます) 以下のアプリを推奨します.
以下のソフトウェアは任意です.
- TELNET/SSH などに対応したリモートアクセスソフト … 作業や確認がスムーズになりますが, Unix 系 OS に関する知識が必要になります. Windows Terminal または, macOS の “ターミナル” (標準アプリ) 上で, ssh コマンドを利用することを推奨します.
サーバ
以下の環境・ソフトウェアは必須です. 無い場合には動作しませんが, 国内のレンタルサーバの多くでは採用されています.
- FreeBSD や Linux などの Unix 系 OS … Windows サーバには対応していません.
- Apache HTTPD など CGI プログラムを実行可能な HTTP (Web) サーバ
- Perl [5.14 以上]
- Perl モジュール
CGI,URI,DBI,DBD::SQLite,Image::Magickおよび依存モジュール群 … これらは標準モジュールではありませんが, 国内のレンタルサーバの多くで準備されています.
以下の環境・ソフトウェアは任意です.
- Perl モジュール
Crypt::Bcrypt… 一部環境のcrypt関数では, 脆弱なアルゴリズム (DES や MD5) が利用されます. そのような環境でも, このモジュールをインストールすると, bcrypt と呼ばれる十分に強いアルゴリズムが利用可能になります.
動作確認済みのレンタルサーバサービス
以下のサービスで動作することを確認済みです. (動作保証をするものではありません.)
説明書における環境
この説明書では, 以下の環境を前提として記載します. 個別の事情に応じて読み替えてください.
| 項目 | 内容 | 備考 |
|---|---|---|
ホームディレクトリ (~) |
/home/mami |
ログインした場合の初期位置. |
| アプリケーションホーム | ~/uranep/ |
Uranep Works のデータが置かれるフォルダ |
| ドキュメントルート | ~/www/www.example.com/ |
ウェブサイトのデータが置かれるサーバ上のフォルダ |
| CGI プログラムインストール先 | ~/www/www.example.com/uranep/ |
CGI プログラムが置かれるフォルダ |
| Web サイトの URL | https://www.example.com/ |
インストールの流れ
手元で準備を行う場合
- ダウンロードした Uranep Works のファイルを手元の環境で展開します.
- Windows の場合: ダウンロードしたファイルを右クリックして, “その他のオプション” → “すべて展開…” を選択します. (ダイアログが表示されるので, 展開先を指定してください. 展開先はどこでも構いません.)
- Mac の場合: ダウンロードしたファイルをダブルクリックします.
- サーバ上に “アプリケーションホーム” となるインストール先のフォルダを作成します.
- 最初に展開したファイルを, サーバ上に転送します. 以下のように,
uranepフォルダの下にファイルが置かれるようにしてください.[~] (Home) └─ [uranep] ├─ [config] ├─ LICENSE.txt ⁝ (その他フォルダ・ファイル等) - 最初に展開したファイルの一部を, サーバ上に転送します.
展開したファイル群の中から,
htdocs以下にあるuranepという名称のフォルダを CGI プログラム実行可能な場所に置いてください.[~] (Home) └─ [www] └─ [www.example.com] └─ [uranep] ├─ [assets] ├─ [customize] ├─ manage.cgi └─ site.cgi - CGI プログラムのパーミッションを以下の通り変更します.
対象ファイル:manage.cgi,site.cgi
パーミッション:rwx------(700) 所有者のみ読み書き・実行可能 - 手元で
app_home.txtというファイルを用意して,~/www/www.example.com/uranep/app_home.txtとして転送します. これには, アプリケーションホームのディレクトリ名を記載します. たとえば,/home/mami/uranepもしくは, 置かれた場所からの相対ディレクトリで
../../../uranepと記載します.
- データベースファイルを準備します.
~/uranep/db/app_default.sqliteのファイル名をapp.sqliteに変更してください. (既にapp.sqliteが存在する場合は, 上書きしないよう注意してください.)
リモートで準備を行う場合 (上級者向け)
- ダウンロードした Uranep Works のファイルをサーバに転送するか, サーバ上でファイルを取得します.
- リモートアクセスソフトでサーバにログインします.
- ファイルを展開して名前を変更します. (
%はプロンプトを表します.)% unzip uranep-works.vX.X.X.zip % mv uranep-works.vX.X.X uranep - CGI プログラムの準備をします.
% cd uranep % mv uranep/htdocs/uranep ~/www/www.example.com/ % chmod 755 ~/www/www.example.com/uranep/*.cgi - アプリケーションホームを示すファイルを作成します.
% pwd > ~/www/www.example.com/uranep/app_home.txt - データベースを初期化します. (app_default.sql の名前を変更しても構いません)
% sqlite3 db/app.sqlite < db/schemata/app.sql
初期設定
アプリケーションの設定 の “推奨設定” を参照して,
config/app.toml を置いてください.
この設定ファイルが置かれていない場合, 起動に失敗します.
インストールの確認
ブラウザで管理画面 (`https://www.example.com/uranep/manage.cgi) にアクセスして初期設定画面が表示されれば, インストールは完了です.
アクセス権と公開範囲
Web サーバから CGI が読み取れることと, アプリケーションが必要なデータやファイルを書き込めることを確認します. tmp/ と log/ は適切に保護し, 非公開画像を保存する private_dir は Web 公開領域の外に置いてください. 公開画像を CGI 以外の方法で配信する場合は, 公開画像用ディレクトリだけを配信対象にします.