Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fabriziosalmi authored Sep 4, 2024
1 parent e895f42 commit 79ec31e
Showing 1 changed file with 0 additions and 19 deletions.
19 changes: 0 additions & 19 deletions docs/lxc_autoscale_api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,11 @@

## Summary

- **[Installation](#installation)**: Instructions for installing the LXC AutoScale API on your Proxmox host.
- **[Routes](#routes)**: Detailed descriptions of available API endpoints, including examples of how to use them.
- **[Logs](#logs)**: Information on where to find and how to interpret the logs generated by the API service.
- **[Examples](examples/README.md)**: Ensure your containers are running optimally based on real-time conditions.
- **[Best Practices and Tips](#best-practices-and-tips)**: Recommendations for effectively using the API in various scenarios.

## Installation

Installing the LXC AutoScale API on your Proxmox host is straightforward and can be done in a few simple steps. This section outlines the installation process, whether you're setting up the full LXC AutoScale ML package or just the API component.

### Installing the Full LXC AutoScale ML Package

To install the complete LXC AutoScale ML package, which includes the API, run the following command:

```bash
curl -sSL https://raw.githubusercontent.com/fabriziosalmi/proxmox-lxc-autoscale/main/install.sh | bash
```

This command will download and execute the installation script, setting up everything you need to start using LXC AutoScale ML and its API.

After installation, ensure that the API service is running and accessible on your network.

---

## Routes

The LXC AutoScale API provides a range of endpoints that allow you to interact with your Proxmox host programmatically. Below is a comprehensive list of available routes, along with examples of how to use each one.
Expand Down

0 comments on commit 79ec31e

Please sign in to comment.