Linux-API

A modern, secure REST API server for Linux system monitoring and management. Built with FastAPI and designed for production use.

🚀 Features

• System Monitoring: Real-time CPU, memory, disk, and network statistics
• Process Management: View running processes and system load
• User Management: Role-based access control (admin/user)
• Secure Authentication: API key-based authentication with bcrypt hashing
• Rate Limiting: Built-in rate limiting to prevent abuse
• Interactive Documentation: Auto-generated OpenAPI/Swagger docs
• Easy Deployment: Run manually, via pip, or as a systemd service

📋 See full feature list

📦 Installation

Quick Install with pip

pip install linux-api
linux-api

From Source

git clone https://github.com/Ivole32/Linux-API.git
cd Linux-API
pip install .

📚 Documentation

Comprehensive guides for different deployment scenarios:

• 📖 Manual Hosting Guide - Run directly from source
• 📖 pip Installation Guide - Install as a Python package
• 📖 systemd Service Guide - Run as a background service

🌐 Demo & API Docs

• Live Demo: http://67.207.74.82/docs
• Interactive API Documentation: Available at /docs endpoint when running

🛠️ Requirements

• OS: Linux only
• Python: 3.11 or newer
• Privileges: sudo required for ports below 1024

🔒 Security Notes

• Admin API key is generated on first startup - save it securely
• All endpoints (except / and /docs) require authentication
• Rate limiting is enforced per endpoint
• Use a dedicated user account for production deployments

🤝 Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

📄 License

This project is licensed under the terms specified in the repository.

💬 Support

• Issues: GitHub Issues
• PyPI: https://pypi.org/project/linux-api/
• Support the project: ☕ Buy me a coffee on Ko-fi

---

Made with ❤️ by Ivole32