From 41c0cac52eef0be9c0371b65d57149c429a42661 Mon Sep 17 00:00:00 2001 From: Ogunaru Date: Thu, 27 Nov 2025 14:01:33 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=EB=B3=80=EA=B2=BD=EC=A0=90=20=EB=8C=80?= =?UTF-8?q?=EC=9D=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 61 +++++++++++----------------------------------- config-sample.json | 27 +++++++------------- docker-compose.yml | 33 +++++++++++++++++++------ 3 files changed, 48 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index 4383939..ac76430 100644 --- a/README.md +++ b/README.md @@ -3,53 +3,7 @@ [![latest](https://github.com/MAX-FLAVOR/BoothChecker/actions/workflows/latest-build.yml/badge.svg)](https://github.com/MAX-FLAVOR/BoothChecker/actions/workflows/latest-build.yml) [![develop](https://github.com/MAX-FLAVOR/BoothChecker/actions/workflows/develop-build.yml/badge.svg)](https://github.com/MAX-FLAVOR/BoothChecker/actions/workflows/develop-build.yml) -*** -### Docker-Compose -``` -services: -services: - booth-checker: - image: ogunarmaya/booth-checker:latest - volumes: - - ./version:/root/boothchecker/version - - ./archive:/root/boothchecker/archive - - ./changelog:/root/boothchecker/changelog - - ./config.json:/root/boothchecker/config.json - depends_on: - - booth-discord - environment: - - OPENAI_API_KEY="YOUR_OPENAI_API_KEY" #Optional - restart: unless-stopped - logging: - driver: "json-file" - options: - max-size: "10m" - max-file: "3" - - booth-discord: - image: ogunarmaya/booth-discord:latest - volumes: - - ./version:/root/boothchecker/version - - ./changelog:/root/boothchecker/changelog - - ./config.json:/root/boothchecker/config.json - depends_on: - - chrome - restart: unless-stopped - logging: - driver: "json-file" - options: - max-size: "10m" - max-file: "3" - - chrome: - image: selenium/standalone-chrome:latest - restart: unless-stopped - logging: - driver: "json-file" - options: - max-size: "10m" - max-file: "3" -``` +BOOTH.pm의 아이템 업데이트를 주기적으로 확인하고 업데이트 감지 시 Discord Bot으로 메세지를 전송합니다. --- @@ -58,8 +12,17 @@ services: ``` { "refresh_interval": 600, + "selenium_url": "http://chrome:4444/wd/hub", + "postgres": { + "host": "postgres", + "port": 5432, + "dbname": "booth", + "user": "booth_user", + "password": "booth_password" + }, "discord_api_url": "http://booth-discord:5000", "discord_bot_token": "YOUR_DISCORD_BOT_TOKEN", + "gemini_api_key": "YOUR_GEMINI_API_KEY", "s3": { "endpoint_url": "YOUR_S3_ENDPOINT_URL", @@ -77,6 +40,10 @@ changelog.html을 S3에 업로드하고, Discord Embed에서 마스킹된 링크 `s3`를 사용하지 않을 경우, `s3` 부분을 제거하면 됩니다. 이 경우 changelog.html은 Discord에 직접 업로드됩니다. +#### 'gemini_api_key' (선택사항) + +변경점을 Google Gemini를 통해 요약합니다. + --- ### Font diff --git a/config-sample.json b/config-sample.json index 84a50b8..1f9450e 100644 --- a/config-sample.json +++ b/config-sample.json @@ -1,15 +1,6 @@ { - "dry_run": false, "refresh_interval": 600, - "fbx_only": false, - "logging": { - "syslog": { - "enabled": false, - "address": "", - "port": 5141 - } - }, - "selenium_url": "http://localhost:4444/wd/hub", + "selenium_url": "http://chrome:4444/wd/hub", "postgres": { "host": "postgres", "port": 5432, @@ -18,14 +9,14 @@ "password": "booth_password" }, "discord_api_url": "http://booth-discord:5000", - "discord_bot_token": "", - "gemini_api_key": "", + "discord_bot_token": "YOUR_DISCORD_BOT_TOKEN", + "gemini_api_key": "YOUR_GEMINI_API_KEY", "s3": { - "endpoint_url": "", - "bucket_name": "", - "bucket_access_url": "", - "access_key_id": "", - "secret_access_key": "" + "endpoint_url": "YOUR_S3_ENDPOINT_URL", + "bucket_name": "YOUR_S3_BUCKET_NAME", + "bucket_access_url": "YOUR_S3_BUCKET_ACCESS_URL", + "access_key_id": "YOUR_S3_ACCESS_KEY_ID", + "secret_access_key": "YOUR_S3_SECRET_ACCESS_KEY" } -} +} \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml index 5804c7a..8daec39 100755 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,6 +1,6 @@ services: booth-checker: - image: ogunarmaya/booth-checker:latest + image: ghcr.io/max-flavor/booth-checker:latest volumes: - ./version:/root/boothchecker/version - ./archive:/root/boothchecker/archive @@ -16,7 +16,7 @@ services: max-file: "3" booth-discord: - image: ogunarmaya/booth-discord:latest + image: ghcr.io/max-flavor/booth-discord:latest volumes: - ./version:/root/boothchecker/version - ./changelog:/root/boothchecker/changelog @@ -30,11 +30,28 @@ services: max-size: "10m" max-file: "3" - chrome: - image: selenium/standalone-chrome:latest + postgres: + image: postgres:18.0 restart: unless-stopped + environment: + POSTGRES_DB: booth + POSTGRES_USER: booth_user + POSTGRES_PASSWORD: booth_password + ports: + 5433:5432 + volumes: + postgres-data:/var/lib/postgresql logging: - driver: "json-file" - options: - max-size: "10m" - max-file: "3" + driver: json-file + options: + max-size: 10m + max-file: "3" + + chrome: + image: selenium/standalone-chrome:latest + restart: unless-stopped + logging: + driver: "json-file" + options: + max-size: "10m" + max-file: "3"