Translate README to Korean
This commit is contained in:
@@ -1,40 +1,39 @@
|
|||||||
# Car
|
# Car
|
||||||
|
|
||||||
PHP based vehicle service for state collection, TCP command dispatch, monitoring, and mobile data usage display.
|
차량 상태 조회, TCP 명령 전송, 모니터링, 데이터 사용량 표시를 제공하는 PHP 기반 차량 서비스입니다.
|
||||||
|
|
||||||
## Main Features
|
## 주요 기능
|
||||||
|
|
||||||
- Vehicle status collection and storage.
|
- 차량 상태를 수집하고 DB에 저장합니다.
|
||||||
- TCP command dispatch for allowed vehicle commands.
|
- 허용된 차량 명령만 TCP 게이트웨이로 전송합니다.
|
||||||
- Monitoring UI with separated status and usage AJAX endpoints.
|
- 모니터링 화면은 상태 AJAX와 사용량 AJAX를 분리해 갱신 비용을 낮춥니다.
|
||||||
- Data usage and billing display with adjustment metadata.
|
- 데이터 사용량과 요금 표시, 보정 metadata를 제공합니다.
|
||||||
- TCP failure reason and receive freshness metadata.
|
- TCP 실패 reason과 마지막 수신 지연을 응답 meta로 확인할 수 있습니다.
|
||||||
|
|
||||||
## Main APIs
|
## 주요 API
|
||||||
|
|
||||||
- `api.php?action=status`
|
- `api.php?action=status`
|
||||||
- `api.php?action=command`
|
- `api.php?action=command`
|
||||||
- `monitor.php?mode=ajax`
|
- `monitor.php?mode=ajax`
|
||||||
- `monitor.php?mode=usage`
|
- `monitor.php?mode=usage`
|
||||||
|
|
||||||
## Structure
|
## 구성
|
||||||
|
|
||||||
- `api.php`: vehicle status and control API.
|
- `api.php`: 차량 상태/제어 API
|
||||||
- `monitor.php`: monitoring UI and AJAX responses.
|
- `monitor.php`: 모니터링 화면과 AJAX 응답
|
||||||
- `common.php`: external secret loading and shared DB/API helpers.
|
- `common.php`: 외부 secret 로드와 공통 DB/API 함수
|
||||||
- `collector_se.php`: CLI/cron state collector.
|
- `collector_se.php`: 상태 수집 CLI/cron
|
||||||
- `sw.js`: service worker.
|
- `sw.js`: service worker
|
||||||
- `assets/`: icons and static assets.
|
- `assets/`: 아이콘과 정적 자산
|
||||||
|
|
||||||
## Secrets
|
## Secret
|
||||||
|
|
||||||
Runtime settings are loaded from `/home/seo/secret/car.php`. Do not commit that file.
|
실행 설정은 `/home/seo/secret/car.php`에서 로드합니다. 이 파일은 저장소에 포함하지 않습니다.
|
||||||
|
|
||||||
Expected values include TCP settings, DB credentials, API token, and allowed IP policy.
|
TCP 설정, DB 접속 정보, API token, 허용 IP 정책은 외부 secret으로 유지합니다.
|
||||||
|
|
||||||
## Security
|
## 보안
|
||||||
|
|
||||||
- Vehicle API uses API token or allowed IP policy.
|
|
||||||
- Control commands are limited to known command codes.
|
|
||||||
- Secret files must remain outside the repository with restricted permissions.
|
|
||||||
|
|
||||||
|
- 차량 API는 API token 또는 허용 IP 정책을 사용합니다.
|
||||||
|
- 차량 제어 명령은 허용된 명령 코드로 제한합니다.
|
||||||
|
- Secret 파일은 저장소 밖에서 제한된 권한으로 유지합니다.
|
||||||
|
|||||||
Reference in New Issue
Block a user