minor fixes

Author: SARFEX

.env.example

@@ -3,6 +3,9 @@ PORT=8080
 # Host port mapping for docker-compose (optional)
 HOCUSPOCUS_PORT=8080
 
+# Published Docker image used by docker-compose (pin to a release if desired)
+FOCUS_COMPASS_IMAGE=ghcr.io/focus-compass/focus-compass-sync-server:latest
+
 # Optional: strong random token.
 # If omitted, the server starts in setup mode and the first visit to '/' can
 # generate a token that will be persisted to ./data/auth.json.
@@ -39,4 +42,4 @@ YJS_GC=true
 
 # Optional: GitHub repo used for update checks in the admin UI.
 # Format: owner/repo
-UPDATE_REPO=focus-compass/server
+UPDATE_REPO=focus-compass/focus-compass-sync-server

.github/workflows/publish-docker.yml

@@ -0,0 +1,60 @@
+name: Publish Docker Image
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=raw,value=edge,enable=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
+            type=sha,format=short,prefix=sha-,enable=${{ github.ref_type == 'branch' }}
+            type=ref,event=tag
+            type=semver,pattern={{version}},value=${{ github.ref_name }},enable=${{ startsWith(github.ref, 'refs/tags/v') }}
+            type=semver,pattern={{major}}.{{minor}},value=${{ github.ref_name }},enable=${{ startsWith(github.ref, 'refs/tags/v') }}
+            type=raw,value=latest,enable=${{ startsWith(github.ref, 'refs/tags/v') }}
+          labels: |
+            org.opencontainers.image.title=Focus Compass Sync Server
+            org.opencontainers.image.description=Real-time collaboration server based on Hocuspocus/Yjs with SQLite persistence
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@10e90e3645eae34f1e60eeb005ba3a3d33f178e8 # v6
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

AGENTS.md

@@ -22,7 +22,7 @@ Notes:
 - npm is the expected package manager (`package-lock.json` is present).
 
 Docker:
-- Start: `docker compose up -d --build` (logs: `docker compose logs -f`)
+- Start: `docker compose up -d` (logs: `docker compose logs -f`)
 - Stop: `docker compose down` (wipe volume: `docker compose down -v`, destructive)
 
 Smoke checks:

Dockerfile

@@ -16,15 +16,14 @@ FROM node:24-alpine
 
 WORKDIR /app
 ENV NODE_ENV=production
+LABEL org.opencontainers.image.source="https://github.com/focus-compass/focus-compass-sync-server"
+LABEL org.opencontainers.image.description="Real-time collaboration server based on Hocuspocus/Yjs with SQLite persistence"
 
 COPY --from=deps --chown=node:node /app/node_modules ./node_modules
 COPY --chown=node:node package*.json ./
 COPY --chown=node:node src ./src
 
-# Create data directory
-RUN mkdir -p /app/data && chown -R node:node /app
-
-USER node
+RUN mkdir -p /app/data
 
 EXPOSE 8080
 

README.md

@@ -37,30 +37,76 @@ Hocuspocus is a WebSocket backend based on CRDT (Conflict-free Replicated Data T
 # 1. Copy example env file (optional)
 cp .env.example .env
 
-# 2. Start server
-docker-compose up -d
+# 2. Recommended for production: pin a release image in .env
+# FOCUS_COMPASS_IMAGE=ghcr.io/focus-compass/focus-compass-sync-server:0.0.1
 
-# 3. View logs
-docker-compose logs -f
+# 3. Start server
+docker compose up -d
 
-# 4. Check status
+# 4. View logs
+docker compose logs -f
+
+# 5. Check status
 docker ps
 
 # Stop server
-docker-compose down
+docker compose down
 
 # Full cleanup (including data)
-docker-compose down -v
+docker compose down -v
 ```
 
-### Run Locally
+This compose file already uses the published GHCR image by default. `latest` is fine for trying the project quickly, but for production deployments you should pin `FOCUS_COMPASS_IMAGE` to a concrete release tag.
+
+If you prefer not to use Compose, you can run the same image directly:
+
+### Run Published Docker Image Directly
+
+Published image URL:
+
+```text
+ghcr.io/focus-compass/focus-compass-sync-server
+```
+
+Try the latest published release:
+
+```bash
+docker run -d \
+  --name focus-compass-sync-server \
+  -p 8080:8080 \
+  -v focus-compass-data:/app/data \
+  -e HOCUSPOCUS_TOKEN=your-secret-token \
+  ghcr.io/focus-compass/focus-compass-sync-server:latest
+```
+
+Production example with a pinned release:
 
 ```bash
-# Install dependencies
-npm install
+docker run -d \
+  --name focus-compass-sync-server \
+  -p 8080:8080 \
+  -v focus-compass-data:/app/data \
+  -e HOCUSPOCUS_TOKEN=your-secret-token \
+  ghcr.io/focus-compass/focus-compass-sync-server:0.0.1
+```
 
-# Start server
-npm start
+Compose example using the published image:
+
+```yaml
+services:
+  focus-compass:
+    image: ghcr.io/focus-compass/focus-compass-sync-server:latest
+    restart: unless-stopped
+    ports:
+      - "8080:8080"
+    environment:
+      PORT: 8080
+      HOCUSPOCUS_TOKEN: your-secret-token
+    volumes:
+      - focus-compass-data:/app/data
+
+volumes:
+  focus-compass-data:
 ```
 
 The server will be available at `ws://localhost:8080`.
@@ -173,6 +219,34 @@ Server outputs logs like:
 2. **Add Redis** - For scaling to multiple instances.
 3. **Configure Auth** - Protect access to documents.
 4. **Backup** - Regularly backup the SQLite database.
+5. **Pin Docker versions** - Use a fixed image tag (`:0.0.1`) for production instead of `:latest`.
+
+Resource limits are intentionally not encoded in the default compose file, because support differs across runtimes and Compose implementations. Set CPU/memory limits in the platform that actually runs the container.
+
+## Docker Publishing
+
+This repository includes a GitHub Actions workflow at `.github/workflows/publish-docker.yml` that publishes images to GHCR.
+
+Main branch pushes publish mutable development tags:
+
+- `ghcr.io/focus-compass/focus-compass-sync-server:edge`
+- `ghcr.io/focus-compass/focus-compass-sync-server:sha-<commit>`
+
+Version tag pushes such as `v0.0.1` publish release tags:
+
+- `ghcr.io/focus-compass/focus-compass-sync-server:v0.0.1`
+- `ghcr.io/focus-compass/focus-compass-sync-server:0.0.1`
+- `ghcr.io/focus-compass/focus-compass-sync-server:0.0`
+- `ghcr.io/focus-compass/focus-compass-sync-server:latest`
+
+Release flow:
+
+```bash
+git tag v0.0.1
+git push origin v0.0.1
+```
+
+After the first publish, check the package visibility in GHCR. GitHub's container registry defaults new packages to private until you explicitly make them public.
 
 ## MCP (Model Context Protocol)
 

docker-compose.yml

@@ -1,9 +1,7 @@
-version: '3.8'
-
 services:
   hocuspocus-sync:
-    # Build image from current directory using Dockerfile
-    build: .
+    # Published Docker image (override in .env if you want to pin a version)
+    image: ${FOCUS_COMPASS_IMAGE:-ghcr.io/focus-compass/focus-compass-sync-server:latest}
 
     # Container name for convenience
     container_name: hocuspocus_server
@@ -23,9 +21,9 @@ services:
       NODE_OPTIONS: "--max-old-space-size=768"
       PORT: 8080
       # Optional (see .env.example). If omitted, the server starts in setup mode.
-      HOCUSPOCUS_TOKEN: ${HOCUSPOCUS_TOKEN}
+      HOCUSPOCUS_TOKEN: ${HOCUSPOCUS_TOKEN:-}
       # Optional. If omitted, MCP is disabled until enabled from the admin UI.
-      MCP_TOKEN: ${MCP_TOKEN}
+      MCP_TOKEN: ${MCP_TOKEN:-}
       DB_PATH: ${DB_PATH:-./data/db.sqlite}
       IMAGES_DIR: ${IMAGES_DIR:-./data/images}
       BACKUP_DIR: ${BACKUP_DIR:-./data/backups}
@@ -51,16 +49,6 @@ services:
       retries: 3
       start_period: 40s
 
-    # Resource limits to prevent excessive consumption
-    deploy:
-      resources:
-        limits:
-          cpus: '1.0'
-          memory: 1G
-        reservations:
-          cpus: '0.25'
-          memory: 256M
-    
     # Logging configuration
     logging:
       driver: "json-file"

package.json

@@ -15,7 +15,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/focus-compass/server.git"
+    "url": "git+https://github.com/focus-compass/focus-compass-sync-server.git"
   },
   "keywords": [
     "hocuspocus",
@@ -29,9 +29,9 @@
   "author": "Focus Masters",
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/focus-compass/server/issues"
+    "url": "https://github.com/focus-compass/focus-compass-sync-server/issues"
   },
-  "homepage": "https://github.com/focus-compass/server#readme",
+  "homepage": "https://github.com/focus-compass/focus-compass-sync-server#readme",
   "dependencies": {
     "@hocuspocus/extension-logger": "^3.4.0",
     "@hocuspocus/extension-sqlite": "^3.4.0",

src/index.html

@@ -2361,7 +2361,7 @@ <h2>Backups</h2>
           <span>Telegram</span>
         </a>
 
-        <a href="https://github.com/focus-compass/server" target="_blank" rel="noopener noreferrer" title="GitHub">
+        <a href="https://github.com/focus-compass/focus-compass-sync-server" target="_blank" rel="noopener noreferrer" title="GitHub">
           <svg xmlns="http://www.w3.org/2000/svg" width="64" height="64" shape-rendering="geometricPrecision" text-rendering="geometricPrecision" image-rendering="optimizeQuality" fill-rule="evenodd" clip-rule="evenodd" viewBox="0 0 640 640" aria-hidden="true">
             <path d="M319.988 7.973C143.293 7.973 0 151.242 0 327.96c0 141.392 91.678 261.298 218.826 303.63 16.004 2.964 21.886-6.957 21.886-15.414 0-7.63-.319-32.835-.449-59.552-89.032 19.359-107.8-37.772-107.8-37.772-14.552-36.993-35.529-46.831-35.529-46.831-29.032-19.879 2.209-19.442 2.209-19.442 32.126 2.245 49.04 32.954 49.04 32.954 28.56 48.922 74.883 34.76 93.131 26.598 2.882-20.681 11.15-34.807 20.315-42.803-71.08-8.067-145.797-35.516-145.797-158.14 0-34.926 12.52-63.485 32.965-85.88-3.33-8.078-14.291-40.606 3.083-84.674 0 0 26.87-8.61 88.029 32.8 25.512-7.075 52.878-10.642 80.056-10.76 27.2.118 54.614 3.673 80.162 10.76 61.076-41.386 87.922-32.8 87.922-32.8 17.398 44.08 6.485 76.631 3.154 84.675 20.516 22.394 32.93 50.953 32.93 85.879 0 122.907-74.883 149.93-146.117 157.856 11.481 9.921 21.733 29.398 21.733 59.233 0 42.792-.366 77.28-.366 87.804 0 8.516 5.764 18.473 21.992 15.354 127.076-42.354 218.637-162.274 218.637-303.582 0-176.695-143.269-319.988-320-319.988l-.023.107z"/>
           </svg>
@@ -2779,7 +2779,7 @@ <h2>Backups</h2>
       return status;
     }
 
-    const DEFAULT_UPDATE_REPO = "focus-compass/server";
+    const DEFAULT_UPDATE_REPO = "focus-compass/focus-compass-sync-server";
 
     function normalizeUpdateRepo(raw) {
       let s = String(raw || "").trim();

src/server.js

@@ -39,7 +39,7 @@ const appVersion = (String(process.env.APP_VERSION ?? "").trim() || packageVersi
 
 const updateRepo =
   String(process.env.UPDATE_REPO ?? process.env.GITHUB_UPDATE_REPO ?? "").trim() ||
-  "focus-compass/server";
+  "focus-compass/focus-compass-sync-server";
 
 const DB_PATH = process.env.DB_PATH ?? "./data/db.sqlite";
 const IMAGES_DIR = process.env.IMAGES_DIR ?? "./data/images";