pacnpal/simpleguardhome
1
0
Fork 0
mirror of https://github.com/pacnpal/simpleguardhome.git synced 2025-12-20 04:21:13 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs(README): update API credentials section to clarify required fields

Browse Source
This commit is contained in:
pacnpal
2025-01-28 20:55:45 -05:00
parent 8b067f59e8
commit 49235c5c2c
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -43,7 +43,7 @@ Then visit `http://localhost:8000` to start managing your AdGuard Home filtering
### System Requirements ### System Requirements
- Python 3.9 or higher (for local installation) - Python 3.9 or higher (for local installation)
- Running AdGuard Home instance - Running AdGuard Home instance
- AdGuard Home API credentials (if authentication is enabled) - AdGuard Home API credentials
- Docker (optional, for containerized deployment) - Docker (optional, for containerized deployment)
### Python Dependencies ### Python Dependencies
@@ -67,8 +67,8 @@ docker pull pacnpal/simpleguardhome:latest
```env ```env
ADGUARD_HOST=http://localhost # AdGuard Home host URL ADGUARD_HOST=http://localhost # AdGuard Home host URL
ADGUARD_PORT=3000 # AdGuard Home API port ADGUARD_PORT=3000 # AdGuard Home API port
ADGUARD_USERNAME=admin # Optional: AdGuard Home username ADGUARD_USERNAME=admin # Required: AdGuard Home username
ADGUARD_PASSWORD=password # Optional: AdGuard Home password ADGUARD_PASSWORD=password # Required: AdGuard Home password
``` ```
3. Run the container: 3. Run the container:
@@ -134,8 +134,8 @@ cp .env.example .env
```env ```env
ADGUARD_HOST=http://localhost # AdGuard Home host URL ADGUARD_HOST=http://localhost # AdGuard Home host URL
ADGUARD_PORT=3000 # AdGuard Home API port ADGUARD_PORT=3000 # AdGuard Home API port
ADGUARD_USERNAME=admin # Optional: AdGuard Home username ADGUARD_USERNAME=admin # Required: AdGuard Home username
ADGUARD_PASSWORD=password # Optional: AdGuard Home password ADGUARD_PASSWORD=password # Required: AdGuard Home password
``` ```
## Running the Application ## Running the Application