Server Setup

Configure MUXI Server and start deploying formations.

What You'll Do

1. Initialize Configuration

   Run the init command to generate your config and authentication keys:

   muxi-server init

   This creates:

   • ~/.muxi/server/config.yaml - Server configuration
   • Authentication keys for secure API access

   ✓ Created config at ~/.muxi/server/config.yaml
   ✓ Generated authentication key: MUXI_e8f3a9b2
   
   Your API credentials:
     Key ID:     MUXI_e8f3a9b2
     Secret Key: sk_9f2e8d7c6b5a4e3f2d1c0b9a8e7f6d5c
   
   Save these credentials - you'll need them to connect from the CLI.

   Save your secret key now - it's only shown once. You'll need it to connect from the CLI.

   [[/step ]

   [[step Review Your Configuration]]

   Open the generated config:

   cat ~/.muxi/server/config.yaml

   The defaults work for most setups:

   server:
     port: 7890              # MUXI's default port
     host: 0.0.0.0           # Accept connections from anywhere
   
   auth:
     enabled: true           # Always enabled for security
     keys:
       - id: MUXI_e8f3a9b2
         secret: sk_...
   
   formations:
     port_range: [8000, 9000]  # Ports for your formations
     auto_restart: true        # Restart crashed formations
   
   logging:
     level: info
     format: json

   Common adjustments:

   Setting	When to Change
   server.host: 127.0.0.1	Localhost only (dev)
   logging.level: debug	Troubleshooting
   formations.port_range	If ports conflict

2. Start the Server

   muxi-server start

   MUXI Server v1.0.0
   ━━━━━━━━━━━━━━━━━━━━
   Listening on :7890
   Auth: enabled
   Formations: ready
   
   Server is running. Press Ctrl+C to stop.

   Run in background (production):

   # macOS/Linux with systemd
   sudo systemctl enable muxi-server
   sudo systemctl start muxi-server
   
   # Or with the built-in daemon mode
   muxi-server start --daemon

3. Verify It's Running

   curl http://localhost:7890/health

   {"status": "healthy", "version": "1.0.0"}

   Or check the status:

   muxi-server status

   MUXI Server Status
   ━━━━━━━━━━━━━━━━━━
   Status:     running
   Port:       7890
   Uptime:     2m 34s
   Formations: 0 running

4. Connect Your CLI

   Now configure the CLI to talk to your server. You'll need the credentials from Step 1:

   muxi profiles add local

   Server URL: http://localhost:7890
   Key ID: MUXI_e8f3a9b2
   Secret Key: sk_9f2e8d7c6b5a4e3f2d1c0b9a8e7f6d5c
   
   ✓ Profile 'local' saved
   ✓ Set as default profile

   Test the connection:

   muxi server list

   No formations deployed yet. Deploy your first with: muxi deploy

You're Ready!

Your server is configured and the CLI is connected. Next steps:

Troubleshooting

server:
  port: 7891  # Different port

Need Help?

• Full Configuration Reference
• Authentication Details
• Troubleshooting Guide