octopize.deploy_tool 0.1.0__tar.gz → 0.3.0__tar.gz

octopize_deploy_tool-0.3.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: octopize.deploy_tool
+Version: 0.3.0
+Summary: Deployment configuration tool for Octopize Avatar platform
+Project-URL: Homepage, https://octopize.io
+Project-URL: Documentation, https://docs.octopize.io/docs/deploying/self-hosted
+Project-URL: Repository, https://github.com/octopize/avatar-deployment
+Project-URL: Issues, https://github.com/octopize/avatar-deployment/issues
+Author-email: Octopize <contact@octopize.io>
+License: MIT
+Keywords: avatar,configuration,deployment,octopize
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Installation/Setup
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.13
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Octopize Avatar Deployment Tool
+
+Automated configuration tool for deploying Octopize Avatar platform using Docker Compose.
+
+## Quick Start
+
+```bash
+# Install
+pip install octopize-avatar-deploy
+
+# Run interactive configuration
+octopize-avatar-deploy --output-dir /app/avatar
+
+# Deploy
+cd /app/avatar
+docker compose down --volumes --remove-orphans  # Clean old containers if redeploying
+docker compose up -d
+```
+
+## Usage Options
+
+### Interactive Mode (Default)
+
+```bash
+octopize-avatar-deploy --output-dir /app/avatar
+```
+
+### Non-Interactive Mode
+
+```bash
+# Create config file
+cat > config.yaml << EOF
+PUBLIC_URL: avatar.example.com
+ENV_NAME: prod
+ORGANIZATION_NAME: MyCompany
+EOF
+
+# Run with config
+octopize-avatar-deploy --output-dir /app/avatar --config config.yaml --non-interactive
+```
+
+## Command Line Options
+
+```
+--output-dir DIR           Output directory (default: current directory)
+--config FILE              YAML configuration file
+--non-interactive          Non-interactive mode (requires config file)
+--template-from PATH       Use local templates instead of downloading from GitHub
+--save-config              Save configuration to deployment-config.yaml
+--verbose                  Show detailed output
+```
+
+## What Gets Generated
+
+```
+/app/avatar/
+├── .env                            # Environment configuration
+├── docker-compose.yml              # Docker services
+├── nginx/nginx.conf                # Nginx config
+├── authentik/
+│   ├── octopize-avatar-blueprint.yaml
+│   ├── custom-templates/           # Email templates
+│   └── branding/                   # Logo, favicon, background
+└── .secrets/                       # Generated secrets (22 files)
+```
+
+## Deployment Steps
+
+1. **Generate configuration:**
+
+   ```bash
+   octopize-avatar-deploy --output-dir /app/avatar
+   ```
+
+2. **Review generated files:**
+
+   ```bash
+   cd /app/avatar
+   cat .env
+   ls -la .secrets/
+   ```
+
+3. **Add TLS certificates (production):**
+
+   ```bash
+   mkdir -p tls
+   cp /path/to/fullchain.pem tls/
+   cp /path/to/privkey.pem tls/
+   ```
+
+4. **Start services:**
+
+   ```bash
+   docker compose down --volumes --remove-orphans
+   docker compose up -d
+   ```
+
+5. **Verify deployment:**
+
+   ```bash
+   docker compose ps
+   docker compose logs -f
+   curl https://avatar.example.com/api/health
+   ```
+
+## Troubleshooting
+
+### "bind source path does not exist" error
+
+Old containers from previous deployment. Solution:
+
+```bash
+docker compose down --volumes --remove-orphans
+docker compose up -d
+```
+
+### Templates not downloading
+
+```bash
+rm -rf .avatar-templates/
+octopize-avatar-deploy --output-dir /app/avatar --verbose
+```
+
+## Development
+
+```bash
+# Clone
+git clone https://github.com/octopize/avatar-deployment
+cd avatar-deployment/deployment-tool
+
+# Install dependencies
+just install
+
+# Run tests
+just test-all
+
+# Run locally
+just run-interactive-local
+```

octopize_deploy_tool-0.3.0/README.md

@@ -0,0 +1,139 @@
+# Octopize Avatar Deployment Tool
+
+Automated configuration tool for deploying Octopize Avatar platform using Docker Compose.
+
+## Quick Start
+
+```bash
+# Install
+pip install octopize-avatar-deploy
+
+# Run interactive configuration
+octopize-avatar-deploy --output-dir /app/avatar
+
+# Deploy
+cd /app/avatar
+docker compose down --volumes --remove-orphans  # Clean old containers if redeploying
+docker compose up -d
+```
+
+## Usage Options
+
+### Interactive Mode (Default)
+
+```bash
+octopize-avatar-deploy --output-dir /app/avatar
+```
+
+### Non-Interactive Mode
+
+```bash
+# Create config file
+cat > config.yaml << EOF
+PUBLIC_URL: avatar.example.com
+ENV_NAME: prod
+ORGANIZATION_NAME: MyCompany
+EOF
+
+# Run with config
+octopize-avatar-deploy --output-dir /app/avatar --config config.yaml --non-interactive
+```
+
+## Command Line Options
+
+```
+--output-dir DIR           Output directory (default: current directory)
+--config FILE              YAML configuration file
+--non-interactive          Non-interactive mode (requires config file)
+--template-from PATH       Use local templates instead of downloading from GitHub
+--save-config              Save configuration to deployment-config.yaml
+--verbose                  Show detailed output
+```
+
+## What Gets Generated
+
+```
+/app/avatar/
+├── .env                            # Environment configuration
+├── docker-compose.yml              # Docker services
+├── nginx/nginx.conf                # Nginx config
+├── authentik/
+│   ├── octopize-avatar-blueprint.yaml
+│   ├── custom-templates/           # Email templates
+│   └── branding/                   # Logo, favicon, background
+└── .secrets/                       # Generated secrets (22 files)
+```
+
+## Deployment Steps
+
+1. **Generate configuration:**
+
+   ```bash
+   octopize-avatar-deploy --output-dir /app/avatar
+   ```
+
+2. **Review generated files:**
+
+   ```bash
+   cd /app/avatar
+   cat .env
+   ls -la .secrets/
+   ```
+
+3. **Add TLS certificates (production):**
+
+   ```bash
+   mkdir -p tls
+   cp /path/to/fullchain.pem tls/
+   cp /path/to/privkey.pem tls/
+   ```
+
+4. **Start services:**
+
+   ```bash
+   docker compose down --volumes --remove-orphans
+   docker compose up -d
+   ```
+
+5. **Verify deployment:**
+
+   ```bash
+   docker compose ps
+   docker compose logs -f
+   curl https://avatar.example.com/api/health
+   ```
+
+## Troubleshooting
+
+### "bind source path does not exist" error
+
+Old containers from previous deployment. Solution:
+
+```bash
+docker compose down --volumes --remove-orphans
+docker compose up -d
+```
+
+### Templates not downloading
+
+```bash
+rm -rf .avatar-templates/
+octopize-avatar-deploy --output-dir /app/avatar --verbose
+```
+
+## Development
+
+```bash
+# Clone
+git clone https://github.com/octopize/avatar-deployment
+cd avatar-deployment/deployment-tool
+
+# Install dependencies
+just install
+
+# Run tests
+just test-all
+
+# Run locally
+just run-interactive-local
+```

{octopize_deploy_tool-0.1.0 → octopize_deploy_tool-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "octopize.deploy_tool"
-version = "0.1.0"
+version = "0.3.0"
 description = "Deployment configuration tool for Octopize Avatar platform"
 readme = "README.md"
 requires-python = ">=3.13"
@@ -38,7 +38,7 @@ dev = [
 ]
 
 [project.scripts]
-octopize-avatar-deploy = "octopize_avatar_deploy.configure:main"
+octopize-deploy-tool = "octopize_avatar_deploy.configure:main"
 
 [project.urls]
 Homepage = "https://octopize.io"

{octopize_deploy_tool-0.1.0 → octopize_deploy_tool-0.3.0}/src/octopize_avatar_deploy/configure.py

@@ -30,6 +30,8 @@ import yaml
 from jinja2 import Environment, FileSystemLoader
 
 from octopize_avatar_deploy.download_templates import (
+    REQUIRED_DOCKER_FILES,
+    REQUIRED_TEMPLATE_FILES,
     LocalTemplateProvider,
     download_templates,
 )
@@ -187,7 +189,9 @@ class DeploymentConfigurator:
 
             output_path = self.output_dir / output_name
             output_path.parent.mkdir(parents=True, exist_ok=True)
-            output_path.write_text(rendered)
+            # Ensure trailing newline for pre-commit end-of-file-fixer
+            content = rendered if rendered.endswith("\n") else rendered + "\n"
+            output_path.write_text(content)
 
             self.printer.print_success(f"Generated: {output_path}")
         except Exception as e:
@@ -215,13 +219,32 @@ class DeploymentConfigurator:
             "authentik/octopize-avatar-blueprint.yaml",
         )
 
-        # Copy docker-compose.yml from templates (it may be templated in the future)
+        # Copy docker-compose.yml from templates
         docker_compose_src = self.templates_dir / "docker-compose.yml"
         docker_compose_dst = self.output_dir / "docker-compose.yml"
         if docker_compose_src.exists():
             shutil.copy2(docker_compose_src, docker_compose_dst)
             self.printer.print_success(f"Generated: {docker_compose_dst}")
 
+        # Copy authentik custom templates (email templates)
+        custom_templates_src = self.templates_dir / "authentik" / "custom-templates"
+        custom_templates_dst = self.output_dir / "authentik" / "custom-templates"
+        if custom_templates_src.exists():
+            custom_templates_dst.mkdir(parents=True, exist_ok=True)
+            for template_file in custom_templates_src.glob("*.html"):
+                shutil.copy2(template_file, custom_templates_dst / template_file.name)
+            self.printer.print_success(f"Copied: email templates to {custom_templates_dst}")
+
+        # Copy authentik branding files
+        branding_src = self.templates_dir / "authentik" / "branding"
+        branding_dst = self.output_dir / "authentik" / "branding"
+        if branding_src.exists():
+            branding_dst.mkdir(parents=True, exist_ok=True)
+            for branding_file in branding_src.glob("*"):
+                if branding_file.is_file():
+                    shutil.copy2(branding_file, branding_dst / branding_file.name)
+            self.printer.print_success(f"Copied: branding files to {branding_dst}")
+
         self.printer.print()
         self.printer.print_success("Configuration files generated successfully!")
 
@@ -263,7 +286,7 @@ class DeploymentConfigurator:
         # Check for existing state and prompt to resume or restart
         if self.state and self.state.has_started() and not self.state.is_complete():
             if interactive:
-                self.state.print_status()
+                self.state.print_status(self.printer)
                 self.printer.print_header("")
                 response = self.input_gatherer.prompt_yes_no(
                     "Resume from where you left off?", default=True
@@ -481,16 +504,19 @@ class DeploymentRunner:
         Returns:
             True if templates are available, False otherwise
         """
-        from octopize_avatar_deploy.download_templates import REQUIRED_FILES
-
         if not self.templates_dir.exists():
             if self.verbose:
                 self.printer.print_error(f"Templates directory not found: {self.templates_dir}")
             return False
 
-        # Check for required files
+        # Check for required template files
         missing_files = []
-        for filename in REQUIRED_FILES:
+        for filename in REQUIRED_TEMPLATE_FILES:
+            if not (self.templates_dir / filename).exists():
+                missing_files.append(filename)
+
+        # Check for required docker files
+        for filename in REQUIRED_DOCKER_FILES:
             if not (self.templates_dir / filename).exists():
                 missing_files.append(filename)
 
@@ -501,8 +527,9 @@ class DeploymentRunner:
                 )
             return False
 
+        total_files = len(REQUIRED_TEMPLATE_FILES) + len(REQUIRED_DOCKER_FILES)
         if self.verbose:
-            self.printer.print_success(f"Found all {len(REQUIRED_FILES)} required template files")
+            self.printer.print_success(f"Found all {total_files} required template files")
 
         # Validate template version compatibility
         return self._validate_template_version()

octopize_deploy_tool-0.3.0/src/octopize_avatar_deploy/defaults.yaml

@@ -0,0 +1,47 @@
+version: 1.0.0
+images:
+  api: 2.47.0
+  web: 0.52.0
+  pdfgenerator: 0.2.3
+  seaweedfs: 0.4.0
+  authentik: 2025.12.3
+email:
+  provider: aws
+  smtp:
+    host: email-smtp.eu-west-3.amazonaws.com
+    port: '587'
+    use_tls: 'true'
+    start_tls: 'false'
+    verify: 'true'
+    sender_email: noreply@octopize.io
+telemetry:
+  enabled: true
+  endpoint_url: https://s3.fr-par.scw.cloud
+  region: fr-par
+application:
+  use_console_logging: 'false'
+  log_level: INFO
+  sentry_enabled: 'true'
+  email_authentication: 'true'
+presets:
+  default:
+    description: Production-ready configuration with telemetry and monitoring
+    application:
+      use_console_logging: 'false'
+      sentry_enabled: 'true'
+    telemetry:
+      enabled: true
+  dev-mode:
+    description: Development mode with console logging, no external services
+    application:
+      use_console_logging: 'true'
+      sentry_enabled: 'false'
+    telemetry:
+      enabled: false
+  airgapped:
+    description: Air-gapped deployment without external monitoring or telemetry
+    application:
+      use_console_logging: 'false'
+      sentry_enabled: 'false'
+    telemetry:
+      enabled: false