feat(webserver): Add public image URL system with token-based access #1125
+279
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This introduces a reusable system for serving images publicly without authentication, useful for external notification services like Gotify, Discord, or Telegram. Features: - Token-based public image access via /api/v1/publicimage endpoint - No authentication required for accessing images with valid tokens - Configurable expiration time (default: 24 hours, max: 31 days) - Persistent storage in /config/public_images/ (survives restarts) - Automatic cleanup of expired images (periodic + on startup) - Validates file existence even if token not in memory (handles restarts) Configuration options: - public_base_url: External URL for Viseron (e.g., https://viseron.example.com) - public_url_expiry_hours: How long public URLs remain valid (default: 24) Technical details: - Images stored with UUID token as filename - Tokens stored in memory with expiration timestamp - After restart, API falls back to disk lookup if token not in memory - Hourly cleanup task removes expired tokens and files - Startup cleanup removes orphaned files older than max expiry - Supports JPG and PNG formats Example usage: ```yaml webserver: public_base_url: "https://viseron.example.com" public_url_expiry_hours: 48 ```
✅ Deploy Preview for viseron canceled.
|
- Remove unused datetime import in publicimage.py - Fix type annotation for _cleanup_task (asyncio.Task | None) - Simplify cleanup task cancellation to avoid unreachable code
- Break long log messages to stay within 88 character limit - Use %s formatting instead of f-strings for long messages - Shorten comments while preserving meaning
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This introduces a reusable system for serving images publicly without authentication, useful for external notification services like Gotify, Discord, or Telegram.
Features
/api/v1/publicimageendpoint/config/public_images/(survives restarts)Configuration Options
```yaml
webserver:
public_base_url: "https://viseron.example.com"
public_url_expiry_hours: 48 # default: 24, max: 744 (31 days)
```
Technical Details
Use Cases
This system can be used by any notification component that needs to share images externally:
Testing
After merge, other components can use this system by:
Breaking Changes
None - this is a new feature with no impact on existing functionality.