アプリケーションの設定
設定ファイル
設定は, TOML 形式で書かれた config/app.toml を変更することで行います.
配布時の既定値は app.default.toml にあります.
既定値ファイルは更新で置き換わるため, 直接編集せず app.toml に必要な上書きを記述してください.
読み込みは, app.default.toml, app.toml の順で行われ, 同じ項目がある場合は上書きされます.
推奨設定を記載した app_sample.toml が用意されているため,
最初はこのファイル名を app.toml に変更して利用することをおすすめします.
TOMLの記述方法
設定はテーブル (以下の例では, app.site) とキー・値からなります.
値は以下のように キー = 値 の形式で指定します.
[app.site]
top_title = "尾鷲写真集"
top_lead = """
〽尾鷲よいとこ朝日を受けて 浦で五丈の網を曳く
ままになるならあの八鬼山を 鍬でならして通わせる"""
この場合, app.site.top_title, app.site.top_lead が設定されます.
(app.site.top_lead の """ 〜 """ は複数行基本文字列を表し, 長い文章を設定する場合に有用です.)
編集
TOML はテキスト形式ですので, 一般的なテキストエディタで編集することができます.
通常はダブルクリックしてもエディタは起動しませんので, 以下のように編集してください.
(.toml の拡張子にテキストエディタを関連付ける方法もありますが, ここでは触れません.)
| OS | 編集方法 |
|---|---|
| Windows | 右クリックから “編集” を選択, または “プログラムから開く” → “メモ帳” を選択 |
| macOS | 右クリックから “このアプリケーションで開く” → “テキストエディット” を選択 |
編集したら, ファイル転送でサーバ上のファイルを上書きしてください. もちろん, サーバ上で直接ファイルを変更しても差し支えありません. その際には設定を変更する前にコピーを保管しておくことをおすすめします.
パスの解決
相対パス (ファイル名・フォルダ名) は以下の基準で解決されます.
| 相対パス | 解決基準 |
|---|---|
| サーバ上の相対パス | アプリケーションホーム (app_home.txt で指定) |
| URI 上の相対パス | app.site.public_base_uri (app.toml で指定; デフォルト: /) |
相対パスとは, config/app.toml や ../images/mami.jpg のように, / で始まらないパスのことで, 特定のパスからの相対位置を示すものです.
推奨設定
ほとんどの項目は設定変更が必要ありませんが, パフォーマンス・利便性の観点から以下の項目は 変更を強く推奨します.
[app.assets]
public_dir = "/home/mami/www/www.example.com/assets/"
[app.assets.delivery]
method = "direct"
public_uri = "/assets/"
[app.site]
public_base_uri = "https://www.example.com/"
root_dir = "/home/mami/www/www.example.com/"
site_name = "Uranep Works Demo"
top_title = "Demo"
top_lead = """
〽尾鷲よいとこ朝日を受けて 浦で五丈の網を曳く
ままになるならあの八鬼山を 鍬でならして通わせる"""
creator_name = "Uranus & Neptune"
creator_link = "https://example.com/"
サイト出力先のフォルダ (必須)
Uranep Works では, HTML ファイルを直接書き出す方式を採用しています. これらのファイルをどのフォルダに出力するかを設定する必要があります.
| 設定項目 | 内容 |
|---|---|
app.site.root_dir |
サイト出力先のフォルダを指定します. (app.site.public_base_uri と対応するようにしてください.) |
アセット類の保存・公開に関する設定
規定値だと, アセット類 (画像ファイルなど) のアクセスは site.cgi を経由して行われるため,
負荷が高く, 速度も非常に遅くなります.
以下の設定を変更することで, site.cgi を経由せず直接公開領域にアクセスすることができ,
大幅なパフォーマンス向上に寄与します.
| 設定項目 | 内容 |
|---|---|
app.assets.public_dir |
公開用のファイル (画像等) が置かれるフォルダです. /home/mami/www/www.example.com/assets/ のように設定します.アプリケーションホームからの相対パスで ../www/www.example.com/assets/ としても構いません |
app.assets.delivery.method |
これを direct に設定すると, アセット類に直接アクセスが行われます |
app.assets.delivery.public_uri |
app.assets.public_dir で指定したフォルダが, どの URI でアクセスされるか示したものです.この場合, https://www.example.com/assets/ 以下でアクセス可能になります. |
公開ベース URI
これを絶対URI (http:// または https://) で指定していない場合,
OGP 画像が表示されない, Atom によるフィードが作成されないなど,
一部機能が制限されます.
| 設定項目 | 内容 |
|---|---|
app.site.public_base_uri |
どのURIの下でサイトを公開するかを設定します. (app.site.root_dir と対応するようにしてください.) |
サイトのアイデンティティ
動作には必須ではありませんが, 一般的には設定することになるでしょう.
| 設定項目 | 内容 |
|---|---|
app.site.site_name |
サイト名 (ヘッダ左に表示されます.) |
app.site.top_title |
トップページのタイトル (Hero 部に表示されます.) |
app.site.top_lead |
トップページのリード文 (Hero 部に表示されます.) |
app.site.creator_name |
作者名 (フッタ左に表示されます.) |
app.site.creator_link |
作者名がリンクされる URI |
設定変更後の反映
サイトに関する設定変更は, ほとんどの場合サイトを 構築 して反映する必要があります. 画像のサイズやぼかし設定を変更した場合は画像生成も実行してください. ファイル保存先の変更では既存ファイルは自動移動されません.
EXIF の撮影日時や位置情報を表示する場合は, 必要な項目だけを有効にしてください. 位置情報は個人情報になり得るため, 公開してよい情報か確認します.