62 lines
2.2 KiB
Markdown
62 lines
2.2 KiB
Markdown
# NFOGuard Webhook Repository Structure
|
|
|
|
This document shows the clean structure for the NFOGuard webhook Docker application repository.
|
|
|
|
## Core Application Files
|
|
```
|
|
nfoguard.py # Main webhook server application
|
|
requirements.txt # Python dependencies
|
|
Dockerfile # Container build configuration
|
|
VERSION # Version tracking
|
|
```
|
|
|
|
## Source Code Modules
|
|
```
|
|
core/
|
|
├── database.py # SQLite database management
|
|
├── nfo_manager.py # NFO file creation and management
|
|
├── path_mapper.py # Path mapping between containers
|
|
└── logging.py # Logging configuration
|
|
|
|
clients/
|
|
├── external_clients.py # TMDB, OMDb, TVDB, Jellyseerr API clients
|
|
├── radarr_client.py # Radarr API client
|
|
├── radarr_db_client.py # Radarr database client
|
|
└── sonarr_client.py # Sonarr API client
|
|
```
|
|
|
|
## Configuration & Deployment
|
|
```
|
|
docker-compose.yml # Public example docker-compose (uses published image)
|
|
.env.template # Environment configuration template
|
|
.env.secrets.template # API keys template (includes TVDB_API_KEY)
|
|
```
|
|
|
|
## Documentation
|
|
```
|
|
README.md # Main documentation (mentions companion plugin)
|
|
DEPLOYMENT.md # Deployment guide
|
|
SETUP.md # Setup instructions
|
|
TESTING.md # Testing guide
|
|
CHANGELOG.md # Version history
|
|
LICENSE # MIT license
|
|
SUMMARY.md # Project summary
|
|
projectsummary.md # Project overview
|
|
```
|
|
|
|
## Development & Utilities
|
|
```
|
|
test_movie_scan.py # Movie scanning tests
|
|
test_end_to_end.py # End-to-end integration tests
|
|
test_bulk_update.py # Bulk update testing
|
|
bulk_update_movies.py # Movie bulk update utility
|
|
```
|
|
|
|
## Files NOT in Repository
|
|
- Plugin source code (moved to NFOGuard-Emby-Plugin repo)
|
|
- CI/registry configuration files
|
|
- Build artifacts
|
|
- Development docker-compose files
|
|
- Registry troubleshooting files
|
|
|
|
## Total: Clean, focused webhook Docker application repository |