Quick Start: Installing and Configuring XM-EXE in 10 Minutes
This quick-start guide walks you through installing and configuring XM-EXE so you can run it in about 10 minutes. Assumes a modern Windows or Linux machine with administrative privileges and internet access.
1) Preparation (1 minute)
- System requirements: 64-bit CPU, 4 GB RAM, 200 MB free disk, network access.
- Dependencies: Ensure you have a recent package manager (apt, yum, Homebrew) or Windows installer support. On Windows, enable PowerShell 7+ if available.
2) Download XM-EXE (2 minutes)
- Windows: Download the latest installer from the official XM-EXE releases page and save to Downloads.
- Linux (deb/RPM or binary): Use curl/wget. Example (binary):
bash
curl -Lo xm-exe https://example.com/xm-exe/latest/xm-exe-linux-amd64 chmod +x xm-exe sudo mv xm-exe /usr/local/bin/
3) Install (2 minutes)
- Windows: Double-click the installer and follow prompts (Accept license, choose install path).
- Debian/Ubuntu:
bash
sudo dpkg -i xm-exe*.deb sudo apt-get install -f
- RHEL/CentOS:
bash
sudo rpm -ivh xm-exe-*.rpm
- Generic binary: already moved to /usr/local/bin above.
4) Initial Configuration (2 minutes)
- Create a minimal config file at ~/.xm-exe/config.yml:
yaml
server: host: 0.0.0.0 port: 8080 auth: enabled: true api_key: “REPLACE_WITH_YOURKEY” logging: level: info
- Generate an API key (replace placeholder) using the built-in command:
bash
xm-exe generate-key
Copy the key into config.yml.
5) Start the Service (1 minute)
- Systemd (Linux):
bash
sudo systemctl enable –now xm-exe sudo journalctl -u xm-exe -f
- macOS/Linux (foreground):
bash
xm-exe –config ~/.xm-exe/config.yml
- Windows: Start via Services or Start Menu shortcut.
6) Verify and Test (1 minute)
- Check the health endpoint:
bash
curl -H “Authorization: Bearer YOUR_API_KEY” http://localhost:8080/health
Expected response: {“status”:“ok”}
- Access web UI: http://localhost:8080 (use API key when prompted).
7) Next Steps (optional)
- Secure with HTTPS: obtain a TLS certificate (Let’s Encrypt or your CA) and update config.yml:
yaml
server: tls: cert: /path/to/fullchain.pem key: /path/to/privkey.pem
- Configure firewall to allow only required ports.
- Add monitoring and backups per your environment.
If you want, tell me your OS and I’ll provide exact commands tailored to it.
Leave a Reply