diff --git a/Caddyfile b/Caddyfile index eac7b74..9adcf3a 100644 --- a/Caddyfile +++ b/Caddyfile @@ -1,16 +1,10 @@ # Caddyfile - Reverse Proxy Configuration # # 使用方法: -# 1. example.com を実際のドメインに置き換えてください -# 2. DNS の A レコードをこのサーバーの IP アドレスに向けてください -# 3. docker compose up -d で起動すると、自動的に HTTPS 証明書が取得されます -# -# ローカル開発用の場合は、以下のように変更してください -# :80 { -# reverse_proxy app:8080 -# } +# 本番環境で公開する場合は、以下の `:80` を実際のドメイン(例: example.com)に変更してください。 +# 変更して docker compose up -d を再実行すると、自動的にHTTPS証明書が取得されます。 -example.com { +:80 { reverse_proxy app:8080 # ログ設定 diff --git a/README.md b/README.md index 2f40717..98e2aa6 100644 --- a/README.md +++ b/README.md @@ -38,10 +38,27 @@ ### 前提条件 -- **Go 1.24 以上** (ローカルビルドの場合) -- **Docker / Docker Compose** (コンテナ実行の場合) +- **Docker Desktop** または Docker / Docker Compose +- (ローカルで直接ビルドする場合のみ)**Go 1.24 以上** -### ローカルで実行 +### 最も簡単な起動方法 + +初めて使う方には、**Dockerを使用した起動**をおすすめします。 + +1. このリポジトリをダウンロード(または `git clone`)し、フォルダを開きます。 +2. フォルダ内にある `config.ini.docker.example` というファイルをコピーし、**名前を `config.ini` に変更**します。 + (※ **必須**: この作業を忘れると起動エラーになります) +3. ターミナル(またはコマンドプロンプトやPowerShell)でこのフォルダを開き、以下のコマンドを実行します: + ```bash + docker-compose up -d --build + ``` +4. ブラウザを開き、**http://localhost** にアクセスしてください。 + +> **注意**: 本番環境(外部公開するサーバー上)で使用する場合は、`Caddyfile` の `:80` を実際のドメインに変更し、`config.ini` 内の `[session] secret` 等の安全な文字列への変更を必ず行ってください。 + +### ローカルビルド(開発者向け) + +開発目的で直接実行する場合の手順です。 ```bash # 1. リポジトリのクローン @@ -66,20 +83,6 @@ cp config.ini.example config.ini ブラウザで **http://localhost:8080** にアクセスしてください。 -### Docker での実行 - -```bash -# 1. 設定ファイルの準備 (必須 ※これを行わないとDockerがディレクトリとして作成し起動に失敗します) -cp config.ini.example config.ini - -# 2. コンテナの起動 -docker-compose up -d --build -``` - -ブラウザで **http://localhost:8080** にアクセスしてください。 - -> **注意**: 本番環境で使用する場合は、`config.ini` の `[session] secret` と `[security] csrf_secret` を必ず変更してください。 - ## 更新方法 ```bash diff --git a/config.ini.docker.example b/config.ini.docker.example index 7518f1e..dcf6183 100644 --- a/config.ini.docker.example +++ b/config.ini.docker.example @@ -22,7 +22,7 @@ secret = CHANGE_THIS_TO_A_SECURE_RANDOM_STRING allow_registration = true [security] -https = true +https = false ; こちらも本番環境では必ず変更してください csrf_secret = CHANGE_THIS_TO_A_SECURE_RANDOM_STRING rate_limit_enabled = true @@ -32,3 +32,15 @@ trusted_proxies = 172.16.0.0/12 [notification] telegram_bot_token = + +[captcha] +; CAPTCHAを有効にするか (true/false) +enabled = false + +; CAPTCHAの種類: "image"(自前生成)または "turnstile"(Cloudflare Turnstile) +type = image + +; Cloudflare Turnstileを使用する場合(typeをturnstileに設定) +; Cloudflare ダッシュボードで取得したサイトキーとシークレットキーを設定 +; turnstile_site_key = 0x4AAAAAAAxxxxxxxxxxxxxxxx +; turnstile_secret_key = 0x4AAAAAAAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx diff --git a/docker-compose.yml b/docker-compose.yml index 3443d8b..0ad6b6b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -9,8 +9,6 @@ services: restart: unless-stopped networks: - internal - expose: - - "8080" depends_on: db: condition: service_healthy