Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/monero-integrations/monerowhmcs

WHMCS for Monero
https://github.com/monero-integrations/monerowhmcs

addon monero monero-daemon monero-integrations monero-wallet payment-gateway wallet-rpc whmcs whmcs-admin-panel

Last synced: 2 months ago
JSON representation

WHMCS for Monero

Awesome Lists containing this project

README 

        
# MoneroWHMCS

A WHMCS Payment Gateway for accepting Monero



## Dependencies

This plugin is rather simple but there are a few things that need to be set up beforehand.



* A web server! Ideally with the most recent versions of PHP and mysql



* The Monero wallet-cli and Monero wallet-rpc tools found [here](https://getmonero.org/downloads/)



* [WHMCS](https://www.whmcs.com/)

This Monero plugin is a payment gateway for WHMCS



## Step 1: Activating the plugin

* Downloading: First of all, you will need to download the plugin.  If you wish, you can also download the latest source code from GitHub. This can be done with the command `git clone https://github.com/monero-integrations/monerowhmcs.git` or can be downloaded as a zip file from the GitHub web page.



* Put the plugin in the correct directory: You will need to copy `monero.php` and the folder named `monero` from this repo/unzipped release into the WHMCS Payment Gateways directory. This can be found at `whmcspath/modules/gateways/`



* Activate the plugin from the WHMCS admin panel: Once you login to the admin panel in WHMCS, click on "Setup -> Payments -> Payment Gateways". Click on "All Payment Gateways". Then click on the "Monero" gateway to activate it.



* Enter a Module Secret Key.  This can be any random text and is used to verify payments.  



* Enter the values for Wallet RPC Host, Wallet RPC Port, Username, and Password (these are from monero-wallet-rpc below).  Optionally enter a percentage discount for all invoices paid via Monero.



* Optionally install the addon module to disable WHMCS fraud checking when using Monero. You will need to copy the folder `addons/moneroenable/` from this repo/unzipped release into the WHMCS Addons directory. This can be found at `whmcspath/addons/`.  



* Activate the Monero Enabler addon from the WHMCS admin panel: Click on "Setup -> Addon Modules". Find "Monero Enabler" and click on "Activate". Click "Configure" and choose the Monero Payment Gateway in the drop down list. Check the box for "Enable checking for payment method by module" and click "Save Changes".



## Step 2: Get a Monero daemon to connect to



### Option 1: Running a full node yourself



To do this: start the Monero daemon on your server and leave it running in the background. This can be accomplished by running `./monerod` inside your Monero downloads folder. The first time that you start your node, the Monero daemon will download and sync the entire Monero blockchain. This can take several hours and is best done on a machine with at least 4GB of ram, an SSD hard drive (with at least 15GB of free space), and a high speed internet connection.



### Option 2: Connecting to a remote node

The easiest way to find a remote node to connect to is to visit [moneroworld.com](https://moneroworld.com/#nodes) and use one of the nodes offered. It is probably easiest to use node.moneroworld.com:18089 which will automatically connect you to a random node.



## Step 3: Setup your Monero wallet-rpc



* Setup a Monero wallet using the monero-wallet-cli tool. If you do not know how to do this you can learn about it at [getmonero.org](https://getmonero.org/resources/user-guides/monero-wallet-cli.html)



* Start the Wallet RPC and leave it running in the background. This can be accomplished by running `./monero-wallet-rpc --rpc-bind-port 18082 --rpc-login username:password --log-level 2 --wallet-file /path/walletfile` where "username:password" is the username and password that you want to use, separated by a colon and  "/path/walletfile" is your actual wallet file. If you wish to use a remote node you can add the `--daemon-address` flag followed by the address of the node. `--daemon-address node.moneroworld.com:18089` for example.



## Info on server authentication

It is recommended that you specify a username/password with your wallet rpc. This can be done by starting your wallet rpc with `monero-wallet-rpc --rpc-bind-port 18082 --rpc-login username:password --wallet-file /path/walletfile` where "username:password" is the username and password that you want to use, separated by a colon. Alternatively, you can use the `--restricted-rpc` flag with the wallet rpc like so `./monero-wallet-rpc --testnet --rpc-bind-port 18082 --restricted-rpc --wallet-file wallet/path`.



## Donating Me

XMR Address : `44krVcL6TPkANjpFwS2GWvg1kJhTrN7y9heVeQiDJ3rP8iGbCd5GeA4f3c2NKYHC1R4mCgnW7dsUUUae2m9GiNBGT4T8s2X`