Skip to content

UX: copy-safe Docker command in error modal (follow-up to #442) #443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
TimothiousAI wants to merge 1 commit into from
Closed

UX: copy-safe Docker command in error modal (follow-up to #442) #443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ This new vision for Archon replaces the old one (the agenteer). Archon used to b
**Full Docker Mode (Recommended for Normal Archon Usage)**

```bash
docker compose up --build -d
# or, to match a previously used explicit profile:
Comment on lines 80 to 81
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Good addition; verify that default profile brings up all “core” services

The new default command is sensible and aligns with the modal. Please just verify that running without an explicit profile actually launches Server, MCP, Agents, and UI as documented below. If some of those services are gated behind Compose profiles, the docs should call that out to avoid partial startups.

Run this quick check to see which services are profile-gated in your Compose files:

🏁 Script executed:

#!/bin/bash
# List compose files and show services that declare profiles
fd -t f -a --hidden --exclude node_modules --exclude dist --exclude build 'compose|docker-compose' |
while read -r f; do
  echo "---- $f ----"
  rg -n -C2 -H '^(services:| *profiles:| *container_name:| *image:| *build:)' "$f"
done
# Also ensure expected core services are present
rg -n -H -C1 'archon-(server|ui|mcp|agents)' --type yml

Length of output: 4590

Docs update: Explicitly call out Compose profiles for core services

The default command docker compose up --build -d will only start services that have no profiles defined. In our setup, all of the core services—Server, MCP, Agents, and UI—are gated behind Compose profiles, so running without --profile will not launch them. Please update the README to either:

  • Instruct users to include the appropriate profiles: 
    # Start all core services
docker compose up --profile backend --profile frontend --build -d
  • Or recommend the convenience “full” profile if you’ve defined one: 
    # Start everything in one go
docker compose up --profile full --build -d

Impacted services in docker-compose.yml (all declare profiles:):

  • archon-server (profiles: ["backend", "full"])
  • archon-mcp   (profiles: ["backend", "full"])
  • archon-agents (profiles: ["backend", "full"])
  • archon-frontend (profiles: ["frontend", "full"])

Ensure the README snippet near lines 80–81 is updated accordingly so users don’t accidentally start only the unprofiled “docs” service:

- docker compose up --build -d
+ # To bring up Server, MCP, Agents, and UI:
+ docker compose up --profile backend --profile frontend --build -d
🤖 Prompt for AI Agents 
In README.md around lines 80 to 81, the existing "docker compose up --build -d"
instruction can start only unprofiled services (e.g., docs) while our core
services are behind Compose profiles; update the snippet to tell users to
include profiles or use a "full" profile—either instruct to run docker compose
up --profile backend --profile frontend --build -d to start backend and frontend
services, or recommend docker compose up --profile full --build -d if a combined
profile exists; mention that archon-server, archon-mcp, archon-agents use
["backend","full"] and archon-frontend uses ["frontend","full"] so omitting
profiles will not start them.

docker compose --profile full up --build -d
# or
make dev-docker # (Alternative: Requires make installed )
Expand Down
13 changes: 9 additions & 4 deletions archon-ui-main/src/components/BackendStartupError.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,16 @@ export const BackendStartupError: React.FC = () => {
After fixing the issue in your .env file, recreate the Docker containers:
</p>
<code className="block mt-2 p-2 bg-black/70 rounded text-red-100 font-mono text-sm">
docker compose down && docker compose up -d
docker compose down && docker compose up --build -d
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Make the “copy-safe” command actually shell-agnostic (avoid &&)

The chained “down && up …” fails in older Windows PowerShell (v5) and some terminals. A single, equivalent rebuild command works across shells and still achieves your intent (rebuild, recreate, and clean orphans):

-                  docker compose down && docker compose up --build -d
+                  docker compose up --build -d --force-recreate --remove-orphans

Also adjust the explanatory note below to reflect “recreate via up” rather than “down/up”.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
docker compose down && docker compose up --build -d
docker compose up --build -d --force-recreate --remove-orphans
🤖 Prompt for AI Agents 
In archon-ui-main/src/components/BackendStartupError.tsx around line 52, the
displayed “copy-safe” command uses a shell-specific && chain ("docker compose
down && docker compose up --build -d") which breaks in older PowerShell and some
terminals; replace it with a single, shell-agnostic command such as "docker
compose up --build -d --force-recreate --remove-orphans" to rebuild and recreate
containers and clean orphans, and update the explanatory note below to say
“recreate via up (uses --force-recreate and --remove-orphans)” instead of
referring to “down/up”.

</code>
<p className="text-red-300 text-xs mt-2">
Note: Use 'down' and 'up', not 'restart' - containers need to be recreated to load new environment variables
</p>
<div className="text-red-300 text-xs mt-2">
<p>Note:</p>
<p>• Use 'down' and 'up' (not 'restart') so new env vars are picked up.</p>
<p>• If you originally started with a specific profile (backend, frontend, or full),</p>
<p>&nbsp;&nbsp;run the same profile again:</p>
<br />
<code className="bg-black/50 px-1 rounded">docker compose --profile full up --build -d</code>
</div>
</div>

<div className="flex justify-center pt-4">
Expand Down