Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,36 @@ After changing hostname or ports:
2. Access the UI at: `http://${HOST}:${ARCHON_UI_PORT}`
3. Update your AI client configuration with the new hostname and MCP port

### Custom Domain Access

To access Archon via custom domains (useful for reverse proxy setups or local network access):

```bash
# Add to your .env file
VITE_ALLOWED_HOSTS=archon.lan

# Multiple domains (comma-separated)
VITE_ALLOWED_HOSTS=archon.lan,archon.local,myserver.lan
```

**Common Use Cases:**
- **Local Network Access**: Access from other devices using `archon.lan` or similar
- **Reverse Proxy**: Using Caddy, nginx with custom domains
- **mDNS/Bonjour**: Setting up `.local` hostnames

**Example Caddy Configuration:**
```caddyfile
archon.lan {
tls internal
reverse_proxy 192.168.1.100:3737
}
```

**Important**: After adding `VITE_ALLOWED_HOSTS`, restart the frontend:
```bash
docker compose restart archon-frontend
```

## 🔧 Development

### Quick Start
Expand Down
38 changes: 38 additions & 0 deletions docs/docs/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,50 @@ LOGFIRE_ENABLED=false # true=Logfire logging, false=standard loggin

# Service Discovery (automatically set for Docker)
# SERVICE_DISCOVERY_MODE=docker_compose

# Custom Domain Configuration (Optional)
VITE_ALLOWED_HOSTS=archon.lan # For custom domains
# VITE_ALLOWED_HOSTS=archon.lan,archon.local # Multiple domains
```

<Admonition type="tip" title="Configuration Options">
- **API Keys**: Set through the Settings page UI instead of environment variables
- **Logging**: Use `LOGFIRE_ENABLED=true/false` to toggle between standard and enhanced logging
- **Zero Setup**: Standard logging works perfectly without any additional configuration
- **Custom Domains**: Use `VITE_ALLOWED_HOSTS` for local network access or reverse proxy setups
</Admonition>

### 2. Custom Domain Configuration

For accessing Archon via custom domains (useful for local network access or reverse proxy setups):

```bash
# Single custom domain
VITE_ALLOWED_HOSTS=archon.lan

# Multiple domains (comma-separated)
VITE_ALLOWED_HOSTS=archon.lan,archon.local,myserver.lan
```

<Admonition type="info" title="Common Use Cases">
- **Local Network Access**: Access from other devices using `archon.lan` or similar
- **Reverse Proxy**: Using Caddy, nginx, or similar with custom domains
- **mDNS/Bonjour**: Setting up `.local` hostnames for easy discovery
</Admonition>

**Example Caddy Configuration:**
```caddyfile
archon.lan {
tls internal
reverse_proxy 192.168.1.100:3737
}
```

<Admonition type="warning" title="Restart Required">
After adding `VITE_ALLOWED_HOSTS`, restart the frontend container:
```bash
docker compose restart archon-frontend
```
</Admonition>

### Unified Logging Architecture
Expand Down
2 changes: 1 addition & 1 deletion docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ export default {
title: 'Archon',
logo: {
alt: 'Archon Logo',
src: 'logo-neon.png',
src: 'img/logo-neon.png',
},
items: [
{
Expand Down
156 changes: 34 additions & 122 deletions docs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ const ReactFlowDiagram = ({ reactFlowInstance, lucideIcons }) => {
style={{ background: '#8b5cf6', border: '2px solid #8b5cf6' }}
/>
<img src="/img/Python-logo-notext.svg" alt="Python" className={styles.pythonIcon} />
<img src="/logo-neon.png" alt="Archon" className={styles.archonIcon} />
<img src="/img/logo-neon.png" alt="Archon" className={styles.archonIcon} />
<div className={styles.archonText}>
<h3>{data.label}</h3>
<p>{data.subtitle}</p>
Expand Down
Binary file added docs/static/img/logo-neon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.