Skip to content

Commit

Permalink
Updated references to items that got changed
Browse files Browse the repository at this point in the history
  • Loading branch information
BelleNottelling committed Mar 26, 2024
1 parent 6e76e7f commit 3f0fe2f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
20 changes: 11 additions & 9 deletions pages/docs/server-managers/cwp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,40 @@
title: CWP and FOSSBilling
---

import { Callout } from 'nextra-theme-docs'
import { Callout } from "nextra-theme-docs";

# Integrating FOSSBilling with CWP

## Configuring CWP

FOSSBilling is integrated with CWP (Control Web Server) using it's API. We will briefly describe how to setup the CWP API, however if needed you can view the [CWP API documentation](https://docs.control-webpanel.com/docs/developer-tools/api-manager/configuration).

1. First, login to your CWP server and navigate to the `API Manger` module (CWP Settings -> Api Manager)
2. Click on the `Allow new API access` button
3. Give the API key a friendly name (such as FOSSBilling), generate an API key (Key code), and enter your FOSSBilling server IP in the `IP Origin` field.
* You may optionally enter `%` to allow any IP address to connect to your CWP API, however this is discouraged for security reasons.
- You may optionally enter `%` to allow any IP address to connect to your CWP API, however this is discouraged for security reasons.
4. Leave the `Format Request` option set to `JSON`
5. Assign the following permissions to the API key (as of FOSSBilling 0.4.0):
1. **Account**: `Add`,`Update`,`Delete`,`List`,`Suspend`,`Unsuspend`
2. **Account Details**: `List`
3. **Account Package Change**: `Update`
4. **Change Password**: `Update`
1. **Account**: `Add`,`Update`,`Delete`,`List`,`Suspend`,`Unsuspend`
2. **Account Details**: `List`
3. **Account Package Change**: `Update`
4. **Change Password**: `Update`
6. Copy the API key you've generated and save the changes.

## Adding a CWP server to FOSSBilling

1. Login to your admin panel.
2. Go to `Configuration` -> `Hosting plans and servers` from within the side panel.
2. Go to `System` -> `Hosting plans and servers` from within the navigation bar.
3. Go to the "New server" tab and fill out the name, hostname, and IP address, and nameservers for your server.
4. Select the `Server manager` drop down and select CWP from the drop down.
5. Enter the API key you created in the previous steps
6. Click the add server button to save your settings and add the server to FOSSBilling.

## Hosting plans with CWP and FOSSBilling

<Callout type='info'>
Attempting to use a hosting plan with a name such as "Plan 1" won't work correctly, instead it should be named "Plan1".
<Callout type="info">
Attempting to use a hosting plan with a name such as "Plan 1" won't work
correctly, instead it should be named "Plan1".
</Callout>

Due to technical limitations between FOSSBilling and CWP, FOSSBilling cannot create hosting packages automatically. Because of this, you should first create the hosting plans (packages) you want to use from withing CWP and define the limitations and capabilities you want it to have there, as FOSSBilling will be unable to change or define them.
Expand Down
5 changes: 3 additions & 2 deletions pages/docs/server-managers/hestiacp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ title: HestiaCP and FOSSBilling
## Configuring HestiaCP

Before you can setup the HestiaCP server manager, you need to first whitelist your FOSSBilling server's IP address inside of HestiaCP, and create a access key to use.
[Here](https://hestiacp.com/docs/server-administration/rest-api.html#i-m-unable-to-connect-to-the-api) is their documentation for the whitelisting the IP address.
[Here](https://hestiacp.com/docs/server-administration/rest-api.html#i-m-unable-to-connect-to-the-api) is their documentation for the whitelisting the IP address.
[here](https://hestiacp.com/docs/user-guide/account.html#api-access-keys) is where they talk about creating the access key.

A note on permissions: When creating the access key inside HestiaCP, you only need to assign "billing" permissions for the key you create.

## Adding a HestiaCP server to FOSSBilling

1. Login to your admin panel.
2. Go to `Configuration` -> `Hosting plans and servers` from within the side panel.
2. Go to `System` -> `Hosting plans and servers` from within the navigation bar.
3. Go to the "New server" tab and fill out the name, hostname, and IP address, and nameservers for your server.
4. Select the `Server manager` drop down and select HestiaCP from the drop down.
5. Enter the access key ID and secret key you created within HestiaCP.
Expand Down

0 comments on commit 3f0fe2f

Please sign in to comment.