py-docker-admin 0.6.1__tar.gz → 0.6.2__tar.gz

{py_docker_admin-0.6.1 → py_docker_admin-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py-docker-admin
-Version: 0.6.1
+Version: 0.6.2
 Summary: A Python package for automating Docker and Portainer installation
 Project-URL: Repository, https://gitlab.com/grenzfall/py-docker-admin
 Project-URL: Issues, https://gitlab.com/grenzfall/py-docker-admin/-/issues
@@ -134,18 +134,80 @@ portainer:
 
 The `base_url` must start with a forward slash (e.g., `/portainer`, `/docker-admin`). When configured, Portainer container will be started with the `--base-url` parameter, ensuring proper path handling behind reverse proxies.
 
---- Persistent Data Management ---
+## Persistent Folder Configuration
 
-For services that require persistent data storage outside of standard Docker volumes, use the `persistent_folder` option within a stack configuration. This allows you to map a specific host directory to a service's data volume.
+The `persistent_folder` feature allows you to automatically set up and manage persistent storage for Docker containers. This is particularly useful for databases, application data, or any service that requires data persistence across container restarts and updates.
+
+### How It Works
+
+1. **Creates host directory** - Ensures the specified host directory exists (creates it if it doesn't)
+2. **Copies initial content** - Optionally copies files or directories to the host directory before deployment
+3. **Mounts to container** - The directory is mounted as a volume in the Docker container
+
+### Configuration
+
+Add `persistent_folder` to your stack configuration in `config.yaml`:
+
+```yaml
+stacks:
+  - name: myapp
+    compose_file: ./docker-compose.yml
+    env_file: ./docker-compose.env
+    persistent_folder:
+      mount_name: app_data          # Must match volume name in docker-compose.yml
+      host_directory: /var/app_data  # Absolute path on host system
+      contents: ./initial_data      # Optional: file/dir to copy to host_directory
+```
+
+### Docker Compose Integration
+
+The `mount_name` must match a volume name defined in your `docker-compose.yml`:
 
 ```yaml
-service_name: my_service
-persistent_folder:
-  mount_name: my_data_volume
-  host_directory: /mnt/persistent/my_data # Absolute path on the host machine
-  contents: ./initial_data/files # Optional: Copy initial files/directories from here to host_directory
+version: '3.8'
+
+services:
+  myapp:
+    image: myapp:latest
+    volumes:
+      - app_data:/app/data  # This matches the mount_name in config
+
+volumes:
+  app_data:  # Volume name that matches mount_name
+    driver: local
+```
+
+### Configuration Options
+
+- **`mount_name`** (required): Name of the volume in your docker-compose.yml file
+- **`host_directory`** (required): Absolute path on the host system where data will be stored
+- **`contents`** (optional): Path to files or directories to copy to the host_directory before deployment
+
+### Example Use Cases
+
+**Database persistence:**
+```yaml
+stacks:
+  - name: postgres-db
+    compose_file: ./postgres-compose.yml
+    persistent_folder:
+      mount_name: pg_data
+      host_directory: /var/persistent/postgres
+      contents: ./initial_db_setup
 ```
 
+**Application data:**
+```yaml
+stacks:
+  - name: web-app
+    compose_file: ./webapp-compose.yml
+    persistent_folder:
+      mount_name: app_storage
+      host_directory: /var/www/app_data
+```
+
+This ensures your container data persists even when containers are recreated or updated, providing reliable data storage across deployments.
+
 ## Requirements
 
 - Python 3.12+

{py_docker_admin-0.6.1 → py_docker_admin-0.6.2}/README.md

@@ -101,18 +101,80 @@ portainer:
 
 The `base_url` must start with a forward slash (e.g., `/portainer`, `/docker-admin`). When configured, Portainer container will be started with the `--base-url` parameter, ensuring proper path handling behind reverse proxies.
 
---- Persistent Data Management ---
+## Persistent Folder Configuration
 
-For services that require persistent data storage outside of standard Docker volumes, use the `persistent_folder` option within a stack configuration. This allows you to map a specific host directory to a service's data volume.
+The `persistent_folder` feature allows you to automatically set up and manage persistent storage for Docker containers. This is particularly useful for databases, application data, or any service that requires data persistence across container restarts and updates.
+
+### How It Works
+
+1. **Creates host directory** - Ensures the specified host directory exists (creates it if it doesn't)
+2. **Copies initial content** - Optionally copies files or directories to the host directory before deployment
+3. **Mounts to container** - The directory is mounted as a volume in the Docker container
+
+### Configuration
+
+Add `persistent_folder` to your stack configuration in `config.yaml`:
+
+```yaml
+stacks:
+  - name: myapp
+    compose_file: ./docker-compose.yml
+    env_file: ./docker-compose.env
+    persistent_folder:
+      mount_name: app_data          # Must match volume name in docker-compose.yml
+      host_directory: /var/app_data  # Absolute path on host system
+      contents: ./initial_data      # Optional: file/dir to copy to host_directory
+```
+
+### Docker Compose Integration
+
+The `mount_name` must match a volume name defined in your `docker-compose.yml`:
 
 ```yaml
-service_name: my_service
-persistent_folder:
-  mount_name: my_data_volume
-  host_directory: /mnt/persistent/my_data # Absolute path on the host machine
-  contents: ./initial_data/files # Optional: Copy initial files/directories from here to host_directory
+version: '3.8'
+
+services:
+  myapp:
+    image: myapp:latest
+    volumes:
+      - app_data:/app/data  # This matches the mount_name in config
+
+volumes:
+  app_data:  # Volume name that matches mount_name
+    driver: local
+```
+
+### Configuration Options
+
+- **`mount_name`** (required): Name of the volume in your docker-compose.yml file
+- **`host_directory`** (required): Absolute path on the host system where data will be stored
+- **`contents`** (optional): Path to files or directories to copy to the host_directory before deployment
+
+### Example Use Cases
+
+**Database persistence:**
+```yaml
+stacks:
+  - name: postgres-db
+    compose_file: ./postgres-compose.yml
+    persistent_folder:
+      mount_name: pg_data
+      host_directory: /var/persistent/postgres
+      contents: ./initial_db_setup
 ```
 
+**Application data:**
+```yaml
+stacks:
+  - name: web-app
+    compose_file: ./webapp-compose.yml
+    persistent_folder:
+      mount_name: app_storage
+      host_directory: /var/www/app_data
+```
+
+This ensures your container data persists even when containers are recreated or updated, providing reliable data storage across deployments.
+
 ## Requirements
 
 - Python 3.12+

{py_docker_admin-0.6.1 → py_docker_admin-0.6.2}/py_docker_admin/__init__.py

@@ -33,7 +33,7 @@ from .models import (
     StackConfig,
 )
 
-__version__ = "0.6.1"
+__version__ = "0.6.2"
 __all__ = [
     "app",
     "MainConfig",

{py_docker_admin-0.6.1 → py_docker_admin-0.6.2/py_docker_admin}/templates/nginx_config.j2

@@ -93,6 +93,13 @@ http {
     {% for site in sites %}
         {% if not site.server_site.startswith('/') %}
 
+        # HTTP to HTTPS redirect for {{ site.site_name }} on port {{ site.server_site }}
+        server {
+            listen {{ site.server_site }};
+            server_name {{ server_name }};
+            return 301 https://$host:$server_port$request_uri;
+        }
+
         # New server block for {{ site.site_name }} on port {{ site.server_site }}
         server {
             listen {{ site.server_site }} ssl;
@@ -116,9 +123,16 @@ http {
                 proxy_set_header X-Real-IP $remote_addr;
                 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
                 proxy_set_header X-Forwarded-Proto $scheme;
+                proxy_set_header X-Forwarded-Port $server_port;
+                proxy_set_header X-Forwarded-Host $host;
+                proxy_set_header X-Script-Name /;
                 proxy_set_header Upgrade $http_upgrade;
                 proxy_set_header Connection "upgrade";
                 proxy_http_version 1.1;
+
+                # Rewrite redirects to use correct protocol and port
+                proxy_redirect http:// https://;
+                proxy_redirect http://$host/ https://$host:{{ site.server_site }}/;
             }
         }
         {% endif %}

{py_docker_admin-0.6.1 → py_docker_admin-0.6.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "py-docker-admin"
-version = "0.6.1"
+version = "0.6.2"
 description = "A Python package for automating Docker and Portainer installation"
 readme = "README.md"
 requires-python = ">=3.12"

{py_docker_admin-0.6.1/py_docker_admin → py_docker_admin-0.6.2}/templates/nginx_config.j2

@@ -93,6 +93,13 @@ http {
     {% for site in sites %}
         {% if not site.server_site.startswith('/') %}
 
+        # HTTP to HTTPS redirect for {{ site.site_name }} on port {{ site.server_site }}
+        server {
+            listen {{ site.server_site }};
+            server_name {{ server_name }};
+            return 301 https://$host:$server_port$request_uri;
+        }
+
         # New server block for {{ site.site_name }} on port {{ site.server_site }}
         server {
             listen {{ site.server_site }} ssl;
@@ -116,9 +123,16 @@ http {
                 proxy_set_header X-Real-IP $remote_addr;
                 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
                 proxy_set_header X-Forwarded-Proto $scheme;
+                proxy_set_header X-Forwarded-Port $server_port;
+                proxy_set_header X-Forwarded-Host $host;
+                proxy_set_header X-Script-Name /;
                 proxy_set_header Upgrade $http_upgrade;
                 proxy_set_header Connection "upgrade";
                 proxy_http_version 1.1;
+
+                # Rewrite redirects to use correct protocol and port
+                proxy_redirect http:// https://;
+                proxy_redirect http://$host/ https://$host:{{ site.server_site }}/;
             }
         }
         {% endif %}