mirror of
https://github.com/lordmathis/llamactl.git
synced 2025-11-06 09:04:27 +00:00
55 lines
2.7 KiB
Markdown
55 lines
2.7 KiB
Markdown
# Llamactl Documentation
|
|
|
|
Welcome to the Llamactl documentation! **Management server and proxy for multiple llama.cpp instances with OpenAI-compatible API routing.**
|
|
|
|
|
|
|
|
## What is Llamactl?
|
|
|
|
Llamactl is designed to simplify the deployment and management of llama-server instances. It provides a modern solution for running multiple large language models with centralized management.
|
|
|
|
## Why llamactl?
|
|
|
|
🚀 **Multiple Model Serving**: Run different models simultaneously (7B for speed, 70B for quality)
|
|
🔗 **OpenAI API Compatible**: Drop-in replacement - route requests by model name
|
|
🌐 **Web Dashboard**: Modern React UI for visual management (unlike CLI-only tools)
|
|
🔐 **API Key Authentication**: Separate keys for management vs inference access
|
|
📊 **Instance Monitoring**: Health checks, auto-restart, log management
|
|
⚡ **Smart Resource Management**: Idle timeout, LRU eviction, and configurable instance limits
|
|
💡 **On-Demand Instance Start**: Automatically launch instances upon receiving OpenAI-compatible API requests
|
|
💾 **State Persistence**: Ensure instances remain intact across server restarts
|
|
|
|
**Choose llamactl if**: You need authentication, health monitoring, auto-restart, and centralized management of multiple llama-server instances
|
|
**Choose Ollama if**: You want the simplest setup with strong community ecosystem and third-party integrations
|
|
**Choose LM Studio if**: You prefer a polished desktop GUI experience with easy model management
|
|
|
|
## Key Features
|
|
|
|
- 🚀 **Easy Setup**: Quick installation and configuration
|
|
- 🌐 **Web Interface**: Intuitive web UI for model management
|
|
- 🔧 **REST API**: Full API access for automation
|
|
- 📊 **Monitoring**: Real-time health and status monitoring
|
|
- 🔒 **Security**: Authentication and access control
|
|
- 📱 **Responsive**: Works on desktop and mobile devices
|
|
|
|
## Quick Links
|
|
|
|
- [Installation Guide](getting-started/installation.md) - Get Llamactl up and running
|
|
- [Configuration Guide](getting-started/configuration.md) - Detailed configuration options
|
|
- [Quick Start](getting-started/quick-start.md) - Your first steps with Llamactl
|
|
- [Managing Instances](user-guide/managing-instances.md) - Instance lifecycle management
|
|
- [API Reference](user-guide/api-reference.md) - Complete API documentation
|
|
|
|
|
|
## Getting Help
|
|
|
|
If you need help or have questions:
|
|
|
|
- Check the [Troubleshooting](user-guide/troubleshooting.md) guide
|
|
- Visit the [GitHub repository](https://github.com/lordmathis/llamactl)
|
|
- Review the [Configuration Guide](getting-started/configuration.md) for advanced settings
|
|
|
|
## License
|
|
|
|
MIT License - see the [LICENSE](https://github.com/lordmathis/llamactl/blob/main/LICENSE) file.
|