From 49235c5c2c871958d7bd584f1d6f0ba11a1ba373 Mon Sep 17 00:00:00 2001 From: pacnpal <183241239+pacnpal@users.noreply.github.com> Date: Tue, 28 Jan 2025 20:55:45 -0500 Subject: [PATCH] docs(README): update API credentials section to clarify required fields --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 77e3690..4c57a58 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Then visit `http://localhost:8000` to start managing your AdGuard Home filtering ### System Requirements - Python 3.9 or higher (for local installation) - Running AdGuard Home instance -- AdGuard Home API credentials (if authentication is enabled) +- AdGuard Home API credentials - Docker (optional, for containerized deployment) ### Python Dependencies @@ -67,8 +67,8 @@ docker pull pacnpal/simpleguardhome:latest ```env ADGUARD_HOST=http://localhost # AdGuard Home host URL ADGUARD_PORT=3000 # AdGuard Home API port -ADGUARD_USERNAME=admin # Optional: AdGuard Home username -ADGUARD_PASSWORD=password # Optional: AdGuard Home password +ADGUARD_USERNAME=admin # Required: AdGuard Home username +ADGUARD_PASSWORD=password # Required: AdGuard Home password ``` 3. Run the container: @@ -134,8 +134,8 @@ cp .env.example .env ```env ADGUARD_HOST=http://localhost # AdGuard Home host URL ADGUARD_PORT=3000 # AdGuard Home API port -ADGUARD_USERNAME=admin # Optional: AdGuard Home username -ADGUARD_PASSWORD=password # Optional: AdGuard Home password +ADGUARD_USERNAME=admin # Required: AdGuard Home username +ADGUARD_PASSWORD=password # Required: AdGuard Home password ``` ## Running the Application