push to registry

2025-09-09 15:18:58 -04:00
parent f8f5f95a34
commit 9755bd87b2
4 changed files with 166 additions and 9 deletions
@@ -0,0 +1,51 @@
+# NFOguard - Easy Deployment
+
+[![Docker Pulls](https://img.shields.io/docker/pulls/jskala/nfoguard)](https://hub.docker.com/r/jskala/nfoguard)
+[![GitHub Release](https://img.shields.io/github/v/release/jskala/NFOguard)](https://github.com/jskala/NFOguard/releases)
+
+Latest Version: v1.0.0
+
+## Quick Start
+
+```bash
+# Download the example files
+curl -o docker-compose.yml https://raw.githubusercontent.com/jskala/NFOguard-Deploy/main/docker-compose.yml
+curl -o .env https://raw.githubusercontent.com/jskala/NFOguard-Deploy/main/.env.example
+
+# Edit your .env file
+nano .env
+
+# Start the service
+docker-compose up -d
+```
+
+## Available Images
+
+- **GitHub Container Registry**: `ghcr.io/jskala/nfoguard:latest`
+- **Docker Hub**: `jskala/nfoguard:latest`
+
+## Configuration
+
+See the [.env.example](./.env.example) file for all available configuration options.
+
+## Docker Compose
+
+The [docker-compose.yml](./docker-compose.yml) includes:
+- NFOguard service
+- PostgreSQL database (optional)
+- Volume mounts for data persistence
+- Health checks
+- Restart policies
+
+## Updates
+
+To update to the latest version:
+
+```bash
+docker-compose pull
+docker-compose up -d
+```
+
+## Source Code
+
+The source code is available at: https://github.com/jskala/NFOguard