Merge pull request #844 from Yacht-sh/develop

Develop

Author: wickedyoda

Docker-Compose-Files/Docker-compose_windows.yml

@@ -1,5 +1,3 @@
----
-version: "3"
 services:
   yacht:
     container_name: yacht
@@ -9,7 +7,7 @@ services:
     volumes:
       - yacht:/config
       - /var/run/docker.sock:/var/run/docker.sock
-    image: yacht-sh/yacht:main
+    image: ghcr.io/yacht-sh/yacht:latest
 
 volumes:
   yacht:

Docker-Compose-Files/docker-compose-MAC-Linux.yml

@@ -1,4 +1,3 @@
-version: '3'
 services:
   yacht:
     container_name: yacht
@@ -13,6 +12,6 @@ services:
       - PUID=0
       - PGID=0
       - COMPOSE_DIR=/compose
-    image: yacht-sh/yacht:main
+    image: ghcr.io/yacht-sh/yacht:latest
 volumes:
   yacht:

Docker-Compose-Files/docker-compose-w-traefik.yml

@@ -1,16 +1,13 @@
-### Use are your own risk, has not been tested by staff. 
-
----
-version: "3"
+### Example only. Validate labels, entrypoints, and certificate resolver values for your Traefik setup.
 
 networks:
   traefik_network:
-    external:
-      name: web
+    name: web
+    external: true
 
 services:
   yacht:
-    image: yacht-sh/yacht:main
+    image: ghcr.io/yacht-sh/yacht:latest
     restart: unless-stopped
     networks:
       - traefik_network
@@ -35,4 +32,4 @@ services:
       - "traefik.http.routers.yacht.tls=true"
       - "traefik.http.routers.yacht.tls.certresolver=dns"
       - "traefik.http.routers.yacht.tls.domains[0].main=domain.tld"
-      - "traefik.http.routers.yacht.tls.domains[0].sans=*.domain.tld"
+      - "traefik.http.routers.yacht.tls.domains[0].sans=*.domain.tld"

docs/ci-cd.md

@@ -12,20 +12,21 @@ Agent image:
 
 - `ghcr.io/<owner>/yacht-agent`
 
-## Branch Workflows
+## Workflow
 
-### Develop
+Current image publishing uses:
 
-Workflow:
-
-- `.github/workflows/docker-image.yml`
+- `.github/workflows/build.yml`
 
 Trigger:
 
 - push to `develop`
+- push to `master`
 - manual dispatch
 
-Verification stages:
+## Verification Stages
+
+Before publishing, the workflow verifies:
 
 - frontend install
 - frontend lint
@@ -40,39 +41,22 @@ Verification stages:
 - agent Bandit scan
 - agent pip-audit
 
-Publish stages:
+## Publish Tags
+
+On `develop`:
 
 - `yacht:dev-latest`
-- `yacht:<YYYYMMDD-HHMMSS>`
+- `yacht:dev-<YYYYMMDD-HHMMSS>`
 - `yacht-agent:dev-latest`
-- `yacht-agent:<YYYYMMDD-HHMMSS>`
-
-### Master
-
-Workflow:
-
-- `.github/workflows/build.yml`
-
-Trigger:
-
-- push to `master`
-- manual dispatch
+- `yacht-agent:dev-<YYYYMMDD-HHMMSS>`
 
-Publish stages:
+On `master`:
 
 - `yacht:latest`
 - `yacht:<YYYYMMDD-HHMMSS>`
 - `yacht-agent:latest`
 - `yacht-agent:<YYYYMMDD-HHMMSS>`
 
-## Manual Builds
-
-Workflow:
-
-- `.github/workflows/manual-build.yml`
-
-This workflow can build either image from a provided ref or tag and publish it to GHCR.
-
 ## Supply Chain Metadata
 
 Current Docker build jobs enable:
@@ -82,8 +66,9 @@ Current Docker build jobs enable:
 
 ## Authentication
 
-The workflows publish with:
+The workflows log in to GHCR with:
 
-- `GITHUB_TOKEN`
+- `GHCR_USERNAME` and `GHCR_TOKEN` when provided
+- otherwise `github.actor` and `GITHUB_TOKEN`
 
 There is no Docker Hub publishing path in the current repo configuration.

docs/installation.md

@@ -88,3 +88,25 @@ The repo also includes additional compose examples under:
 - `Docker-Compose-Files/docker-compose-w-traefik.yml`
 
 Review those files before use. They are examples, not guarantees of current production readiness.
+
+## Traefik Compose Notes
+
+The current Traefik example assumes:
+
+- image: `ghcr.io/yacht-sh/yacht:latest`
+- internal Yacht service port: `8000`
+- reverse proxy target protocol: `http`
+- external Traefik Docker network named `web`
+
+Why port `8000` is correct:
+
+- the container starts FastAPI behind the bundled `nginx.conf`
+- nginx listens on `8000` inside the container
+- Traefik should route to that internal nginx listener, not directly to uvicorn
+
+Before using the example, replace:
+
+- `yacht.domain.tld`
+- `domain.tld`
+- `dns` certificate resolver name
+- `./config` if you want a different persistent config path