54 lines
1.9 KiB
Markdown
54 lines
1.9 KiB
Markdown
# NFOGuard Webhook Repository - Final Clean Structure
|
|
|
|
After cleanup, the repository contains only essential files for the Docker webhook application.
|
|
|
|
## 📦 Core Application (6 files)
|
|
```
|
|
nfoguard.py # Main webhook server
|
|
requirements.txt # Python dependencies
|
|
Dockerfile # Container build
|
|
VERSION # Version tracking
|
|
LICENSE # MIT license
|
|
bulk_update_movies.py # Utility for bulk library updates
|
|
```
|
|
|
|
## 🗂️ Source Code Modules (8 files)
|
|
```
|
|
core/
|
|
├── database.py # SQLite database management
|
|
├── nfo_manager.py # NFO file creation and management
|
|
├── path_mapper.py # Container path mapping
|
|
└── logging.py # Logging configuration
|
|
|
|
clients/
|
|
├── external_clients.py # TMDB, OMDb, TVDB, Jellyseerr APIs
|
|
├── radarr_client.py # Radarr API client
|
|
├── radarr_db_client.py # Radarr database client
|
|
└── sonarr_client.py # Sonarr API client
|
|
```
|
|
|
|
## 🐳 Docker & Configuration (3 files)
|
|
```
|
|
docker-compose.example.yml # Public example (industry standard naming)
|
|
.env.template # Environment configuration template
|
|
.env.secrets.template # API keys template (includes TVDB_API_KEY)
|
|
```
|
|
|
|
## 📚 Documentation (6 files)
|
|
```
|
|
README.md # Main documentation (mentions companion plugin)
|
|
CHANGELOG.md # Version history
|
|
DEPLOYMENT.md # Deployment guide
|
|
SETUP.md # Setup instructions
|
|
TESTING.md # Testing guide
|
|
SUMMARY.md # Project summary
|
|
```
|
|
|
|
## 🎯 Total: 23 Essential Files
|
|
- **No plugin artifacts** ✅
|
|
- **No CI/development clutter** ✅
|
|
- **No test files** ✅
|
|
- **Industry standard naming** ✅
|
|
- **Clean public webhook application** ✅
|
|
|
|
Perfect for end-users who want to deploy the NFOGuard webhook server! |