ドキュメントの添付ファイル
どのドキュメントページにも、画像やファイルを直接添付できます。スクリーンショットをエディターにドロップすればインラインで埋め込まれ、PDF、仕様書、アーカイブを添付すればダウンロード可能なカードとして表示されます。ファイルはオブジェクトストレージに保存されるためデータベースを肥大化させることはなく、ページが閲覧・共有される場所ならどこにでも一緒に届きます。
添付ファイルの追加
ドキュメントページをエディターで開き(新規ドキュメント または 編集)、最も手早い方法でファイルを追加します。
- 1 つ以上のファイルをエディターに ドラッグ&ドロップ する
- クリップボードから画像(スクリーンショットなど)を直接 貼り付け る
- エディターのツールバーで ファイルを添付 をクリックしてファイルを選ぶ
複数のファイルを一度に添付できます。新しいドキュメントは最初にファイルを添付した時点で自動的に保存されるため、アップロードが失われることはありません。
画像とファイルの違い
Archyl は 2 つのケースを期待どおりに扱います。
- 画像 は、追加した位置の Markdown に インライン で埋め込まれ、ページ内に直接表示されます。
- その他のファイル(PDF、文書、アーカイブなど)は、本文に挿入されるのではなく、ダウンロード可能なカードとして 添付ファイル パネルに追加されます。
添付ファイルの閲覧
ページを読むとき、添付ファイルはタイトルのすぐ下、ドキュメント上部の添付ファイルパネル に表示されます。そのため読者はスクロールする前に、どんなファイルがあるかを確認できます。各ファイルには次の情報が表示されます。
- 色分けされたファイル種別アイコン、または画像のサムネイル
- ファイル名、種別、サイズ
- ワンクリックの ダウンロード 操作
画像は、本文中で配置した位置にもインラインで表示されます。
添付ファイルの管理
エディターの添付ファイルパネルでは、次の操作ができます。
- 任意のファイルを ダウンロード する
- ファイルを 削除 する(その場で簡単に確認)— ストレージからも削除されます
ドキュメントを削除すると、その添付ファイルも削除されます。
対応ファイル
あらゆる種類のファイル を添付できます。画像はインラインで埋め込まれ、それ以外はすべてダウンロード可能なカードとして表示されます。一般的な例は次のとおりです。
- 画像 — PNG、JPEG、GIF、WebP、SVG、AVIF
- 文書 — PDF、Word、Excel、PowerPoint、プレーンテキスト、Markdown、CSV
- データとアーカイブ — JSON、YAML、ZIP、ログ
デフォルトの上限は 1 ファイルあたり 10 MB です(セルフホスト環境では変更可能)。
ヒント: ブラウザーが認識できないファイル種別でも受け付けられ、ダウンロードとして提供されます。
ストレージとプライバシー
添付ファイルは、アプリケーションのデータベースではなくオブジェクトストレージに保存されます。Archyl Cloud では、そのストレージは Google Cloud Storage で、管理は Archyl が行うため設定は不要です。セルフホスト環境では、S3 互換のプロバイダーを自分で選びます(後述)。
いずれの場合も:
- バケットは 非公開 です。ファイルは必要に応じて生成される有効期限の短い署名付きリンクで配信され、実体のオブジェクトが公開で一覧表示されることはありません。
- ページに埋め込まれたリンクは変わらないため、共有ドキュメントや公開ドキュメントもバケットを公開することなく機能し続けます。
- 保存時の暗号化 はデフォルトで有効です。Google Cloud Storage はすべてのオブジェクトを自動的に暗号化します。セルフホスト環境では、独自のキー(たとえば GCS 上の Cloud KMS CMEK)を指定することもできます。
セルフホスト環境の場合
Archyl Cloud では、添付ファイルは設定なしですぐに使えます。セルフホスト の場合は独自のオブジェクトストレージを用意し、任意の S3 互換プロバイダー(Google Cloud Storage、Amazon S3、MinIO、Cloudflare R2 など)を Archyl に指定できます。
ストレージを設定するまで ファイルを添付 操作は利用できず、アップロードすると "File storage is not configured" という明確なメッセージが返されます。この機能を有効にするには、バックエンドで STORAGE_* 環境変数(エンドポイント、バケット、アクセスキー、シークレットキー)を設定してください。Google Cloud Storage の場合は、相互運用(HMAC)エンドポイントを使用します。すべてのオプションについては、デプロイ構成を参照してください。
次のステップ
- ドキュメントとADR - アーキテクチャドキュメントを作成してリンク
- 共有と埋め込み - ドキュメントを外部に共有
- エクスポート - ダイアグラム付きでドキュメントをエクスポート