From 724c0a0ed6ca246adf0661123f25792b79c9e12f Mon Sep 17 00:00:00 2001 From: seo Date: Sun, 7 Jun 2026 00:40:14 +0900 Subject: [PATCH] Translate README to Korean --- README.md | 43 +++++++++++++++++++++---------------------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 6fb9f1f..8ce5b38 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ # Control -PHP based control panel for fan control, system monitoring, WiFi control, WakeLock, and Web Push notifications. +팬 제어, 시스템 모니터링, WiFi 제어, WakeLock, Web Push 알림을 제공하는 PHP 기반 단일 관리 패널입니다. -## Main Features +## 주요 기능 -- Authenticated dashboard for fan, sensor, notice, WiFi, WakeLock, and Push subscription status. -- Background collection and policy application for fan state. -- WebSocket status updates with HTTP fallback. -- Web Push subscription registration, recovery, and notice delivery. +- 로그인 후 팬, 센서, notice, WiFi, WakeLock, Push 구독 상태를 관리합니다. +- 백그라운드 수집과 팬 정책 적용으로 현재 상태를 유지합니다. +- WebSocket으로 상태를 갱신하고, 연결 실패 시 HTTP fallback을 사용합니다. +- Push 구독 등록, 자동 복구, notice 기반 알림 발송을 처리합니다. -## Main APIs +## 주요 API - `public/api.php?action=status` - `public/api.php?action=collect` @@ -17,24 +17,23 @@ PHP based control panel for fan control, system monitoring, WiFi control, WakeLo - `public/api.php?action=wifi` - `public/api.php?action=push_devices` -## Structure +## 구성 -- `public/index.php`: management UI. -- `public/api.php`: status and control API. -- `config/config.php`: DB, auth, CSRF, push, and shell helpers. -- `config/vapid.php`: VAPID bridge loaded from external secret config. -- `apply_policy.php`: CLI/cron fan policy application. -- `bin/control_ws.php`: WebSocket server. +- `public/index.php`: 관리 화면 +- `public/api.php`: 상태 조회와 조작 API +- `config/config.php`: DB, 인증, CSRF, Push, shell 실행 공통 함수 +- `config/vapid.php`: 외부 secret 기반 VAPID 설정 bridge +- `apply_policy.php`: CLI/cron 팬 정책 적용 +- `bin/control_ws.php`: WebSocket 서버 -## Secrets +## Secret -Runtime secrets are loaded from `/home/seo/secret/control.php`. Do not commit that file. +실행 secret은 `/home/seo/secret/control.php`에서 로드합니다. 이 파일은 저장소에 포함하지 않습니다. -Expected values include the app password, DB settings, and VAPID keys. +앱 비밀번호, DB 설정, VAPID key는 외부 secret으로 유지합니다. -## Operations - -- Keep sensor collection cadence aligned with DB growth. -- Confirm fan sysfs paths after hardware or OS changes. -- Keep VAPID keys and app password outside the repository. +## 운영 체크포인트 +- 센서 수집 주기와 DB 증가량을 확인합니다. +- 하드웨어 또는 OS 변경 후 fan sysfs 경로를 확인합니다. +- VAPID key와 앱 비밀번호는 저장소 밖에서 관리합니다.