From d70f507d9eb245350cb06abc55fb01e04e293613 Mon Sep 17 00:00:00 2001
From: usbharu <64310155+usbharu@users.noreply.github.com>
Date: Wed, 6 Dec 2023 14:29:54 +0900
Subject: [PATCH] =?UTF-8?q?doc:=20LocalStorageConfig=E3=81=AB=E3=83=89?=
 =?UTF-8?q?=E3=82=AD=E3=83=A5=E3=83=A1=E3=83=B3=E3=83=88=E3=82=92=E8=BF=BD?=
 =?UTF-8?q?=E5=8A=A0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../dev/usbharu/hideout/application/config/SpringConfig.kt | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/main/kotlin/dev/usbharu/hideout/application/config/SpringConfig.kt b/src/main/kotlin/dev/usbharu/hideout/application/config/SpringConfig.kt
index dfbd3c27..9dfe2f5e 100644
--- a/src/main/kotlin/dev/usbharu/hideout/application/config/SpringConfig.kt
+++ b/src/main/kotlin/dev/usbharu/hideout/application/config/SpringConfig.kt
@@ -43,6 +43,13 @@ data class S3StorageConfig(
     val secretKey: String
 )
 
+
+/**
+ * メディアの保存にローカルファイルシステムを使用する際のコンフィグ
+ *
+ * @property path フォゾンする場所へのパス。 /から始めると絶対パスとなります。
+ * @property publicUrl 公開用URL 省略可能 指定するとHideoutがファイルを配信しなくなります。
+ */
 @ConfigurationProperties("hideout.storage.local")
 data class LocalStorageConfig(
     val path: String,