設定ファイルの項目を調べる

設定したいことから、変更するファイルと項目を探します。サイト名、保存先、プラグイン、言語、秘密値の置き場所を整理します。

目次

どの設定を、どこで変えるか

EmDashの設定は一つのファイルに集まっていません。ページ制作の仕組み、データの保存先、記事の入力欄、管理者が変えるサイト名では、変更場所が違います。

下の表から、変えたいものに対応するファイルや画面を探してください。EmDash 1.4.0の主な設定をまとめています。最初からすべてを設定する必要はなく、使っているテンプレートの値を確認して、必要な項目だけ変えます。

変えたいもの主な場所
EmDashの保存先・プラグインastro.config.mjs内のemdash()
Astroの出力方式・公開先への接続・言語astro.config.mjsのAstro設定
記事を読み込む仕組みsrc/live.config.ts
CloudflareのWorker名・DBなどの接続先対応するCloudflare設定ファイル
新規サイトで最初に作る入力欄などseedファイル
運用中の入力欄管理画面のContent Types(コンテンツの種類)など
サイト名・共通設定管理画面のSettings(設定)
パスワードや暗号化キー実行環境のsecret(秘密情報)管理

emdash()の主要項目

項目役割注意する点
database記事などの保存先必須。環境に合うadapterを選ぶ
storage画像などの保存先未指定時のローカル保存が本番に適切か確認
pluginsネイティブなどの登録サイト本体と同じ実行環境で動く
sandboxed分離して動かすプラグインの登録runnerも必要
sandboxRunner分離実行の担当Node.jsとCloudflareで違う
siteUrl読者が使う公開オリジン認証・メールなどにも関係する
mcpサイトMCPの有効・無効既定は有効。認証は別に必要
migrations内部移行を起動時にどう扱うか既定はauto
admin管理画面の見た目・表示項目公開サイトのテーマとは別
imagesAstro画像最適化との連携既定は有効
objectCache取得結果の再利用省略時は無効

表にあるadapterは、DBなどの接続先に合わせるための部品です。runnerは、隔離したプラグインを実際に動かす仕組みを指します。

EmDashが認識しない設定項目は、警告を出して無視される場合があります。設定を追加したら、起動時の警告も読みましょう。"false"は文字列、falseは「いいえ」を表す値なので、別のものです。型のエラーが出たら、求められている値の種類を確認します。

ローカル保存の設定を読む

次はastro.config.mjs内のEmDash設定の抜粋です。ファイル全体を置き換える例ではありません。

import emdash, { local } from "emdash/astro";
import { sqlite } from "emdash/db";

// 既存のintegrations配列で使う設定
emdash({
  database: sqlite({ url: "file:./data/emdash.db" }),
  storage: local({
    directory: "./uploads",
    baseUrl: "/_emdash/api/media/file",
  }),
});

databaseは記事など、storageは画像などの実ファイルです。すでにデータがあるサイトでこのパスへ変更すると、別の保存先を使うことになります。設定例のパスへ機械的に揃えるのではなく、現在の場所を記録してください。

手元の教材でファイルの有無と配信URLを確かめるには、SQLiteのファイル・画像フォルダー・配信URLの対応表を開いてください。

Cloudflareではd1({ binding: "DB" })とr2({ binding: "MEDIA" })などを使います。ローカル用adapterを、そのまま公開先に適用するものではありません。

コンテンツloaderの設定

src/live.config.tsでは、EmDashから記事を読むloaderを登録します。loaderは、Astroのページ制作と記事データをつなぐ部分です。

import { defineLiveCollection } from "astro:content";
import { emdashLoader } from "emdash/runtime";

export const collections = {
  _emdash: defineLiveCollection({ loader: emdashLoader() }),
};

この設定があることと、記事のpostsなどの定義を作ることは別です。_emdashを記事のコレクション名と取り違えないようにしてください。

siteUrlと言語を分ける

siteUrlには、https://example.comのように、読者が使うURLの先頭部分を指定します。この部分をオリジンと呼び、/news/のようなページの場所は含めません。通信を中継するプロキシを使うNode.jsサイトなどでは、内部の接続先と読者向けURLが異なるため、この値を明示的に設定する必要があります。

設定がなければEMDASH_SITE_URL、次にSITE_URLなどを参照します。実行時だけでなく、画像最適化などのためにビルド時にも必要な値がある点に注意します。

複数の値を指定した場合と、起動し直す手順は公開URLの環境変数の優先順で確認できます。

記事の言語はAstroのi18n、管理画面に含める翻訳はadmin.localesなどで扱います。言語コードを変えても、保存済みの記事の所属言語が自動で移るとは限りません。日本語設定を参照してください。

管理画面の表示設定と権限は別

admin.hiddenNavItemsでメニュー項目を隠せますが、その機能へのアクセス権を消す設定ではありません。URLやAPI、利用者の権限は別に残ります。

admin.siteNameなどの管理画面ブランド設定と、読者向けのサイト名・テーマも区別します。どの画面を変えたいか確認してから設定します。

秘密値は設定例へ埋め込まない

パスワードや暗号化キーをastro.config.mjsへ直接書いたり、import.meta.env経由で取り込んだりすると、ビルドしたファイルに含まれる場合があります。実行環境のsecret管理へ保存し、使うサービスに合った方法で読み込みます。

すべての設定、既定値、adapterの細かな引数は公式Configuration Reference(別タブで開く)が参照先です。設定変更後は、ビルド、起動時のログ、対象機能を一組で確認してください。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。