Updated README.md

This commit is contained in:
2023-09-10 19:52:19 -04:00
parent b25535ba5f
commit e5570785db

View File

@@ -12,22 +12,13 @@ This module requires VirtFusion v1.7.3 or higher as this is what it's based on.
1. Download the latest release from the [releases](https://github.com/EZSCALE/virtfusion-whmcs-module/releases) page. 1. Download the latest release from the [releases](https://github.com/EZSCALE/virtfusion-whmcs-module/releases) page.
2. Extract the contents of the archive and upload the modules folder to your WHMCS installation directory. 2. Extract the contents of the archive and upload the modules folder to your WHMCS installation directory.
## Configuration
You'll need to configure the following constraints in your `configuration.php` file.
This is only temporary and will be replaced with pulling the token from the database in the future.
```php
// VirtFusion API URL
const VIRTFUSION_API_URL = "https://your-virtfusion-url.com/api/v1";
// VirtFusion API Token
const VIRT_TOKEN = "your-virtfusion-token";
```
## What does this module change? ## What does this module change?
This module changes the following things: This module changes the following things:
- Adds configurable options to the product configuration page to allow the user to select the operating system and add - Adds configurable options to the product configuration page to allow the user to select the operating system and add
a ssh key to the initial deployment. a ssh key to the initial deployment.
## TODO
- [ ] Add post checkout checks to ensure the user has selected an operating system and added a ssh key.