Overview

Thank you for using 2Moons Deployment Module. If you have any questions, please feel free to send us an email at support@gamerpath.net.

This documentation assumes you have some basic to intermediate knowledge of PHP. We can help integrate the Deployment Module in your PHP application as a custom work, get in touch!

So let's start with the Deployment Module script/admin installation first, follow the steps given below:

Installation

    Note: Please don't upload the downloaded (.zip) file directly onto your server, instead only upload the contents of the deployment-module folder. The other folders are useful during the actual integration into your application, which we recommend you do first on your local machine only.

  1. Copy/Upload all the files and folders which are inside the folder (deployment-module) to your web server using cPanel,Plesk or FTP, if you want to install the Deployment Module on your root domain (like example.com) then you need to upload the files directly in your root directory (/public_html/) or if you want to install the Deployment Module in a subfolder (like example.com/deployment-module), then upload it in a folder (/public_html/deployment-module/).
  2. The file "config.php" (present inside includes) and "install" folder must have write permissions, so just give the folders write permission (i.e 777).
  3. Once you are done with the above steps, go to your hosting control panel and create a mysql database, database user and grant relevant permissions to user for this database.
  4. Now go to the URL where you have uploaded the Deployment Module like www.yoursite.com/ or www.yoursite.com/deployment-module

Minimum Requirements

  1. You should now see the minimum system requirements checklist - If there are any issues with the checklist, you will need to fix that before you can proceed to the next step.

    image03

  2. If everything is good, click next to proceed with the installation.

Verifying License

    Where can I find my license code? please read this.
  1. Here you have to enter your Username, Item License code and Email Address.

  2. Then click Verify, After successful verification you should see this page.

    image04

  3. Click next.

Database Details

  1. Enter your database host, database user, database password and database name. If the database you have entered does not exist, the system will try to create it. This might not work when your webhost does not allow creation of new databases. In that case only use the database you have created in earlier step.

    image05

  2. Then click Create, If everything goes well, you should see this page.

    image06

  3. Click next.

Finish Installation

Congratulations! The Deployment Module is successfully installed.

image07

  1. Now you can click on the "Login" button and log yourself in, using the default email (i.e admin@admin.com) and password (i.e admin1234).

  2. Once you are logged into the Panel, find Change password & email from the account dropdown located on the menu, then change your email and password to something more secure.

  3. Even though the Deployment Module installer will get locked automatically after the installation, it is recommended that you remove the "install" folder. You can always re-upload it, if you wish to re-install in the future.

Auto Updater (experimental)

The deployment module includes an auto updater services working in two different phase.
If you are currently in the phase of installing for the first time the deployment module on your server, the service will propose you to go to the store and download the latest version.
Now, let's take the example where the deployment-module is already installed and some games are up and running.

Now, let's take the example where the deployment-module is already installed and some games are up and running. It will not redirect you to the store, but it will redirect you to a secured page where you can with one click on a button automatically install the next deployment module version without risk of breaking your website if you have kept the original files.

  1. To do so, we need to generate a secret key that will be used each time we want to access the auto-updater service. You can for example go here and generate a custom password.

  2. Open the Config.ini available in the root of your website and edit the misc[UPDATER-SECRET-KEY] key with your own generated secret-key.

SendInBlue Mail Service Setup

Note

Your game will not be able to send account verifications and lost passwords emails if you are not using the SendinBlue service. The free service (no credit card required) allow you to send 300 mails daily which is more then enough for a start.

Transactional email is a type of automated email between a sender and a recipient. It differs from marketing email in that transactional email is triggered by events, interactions, or preferences within a service or application rather than by a company’s marketing campaign. They are often used for receipts and confirmations emails, lost password emails etc...

  1. Register an verify your account at Send in Blue

  2. Click on your username in the top right menu and go to SMTP & API

  3. Find your V3 api key and insert it into the Config.ini file in the misc[SENDINBLUE-KEY] field. Your api key should start with xkeysib-XXXXXXXX

  4. Click again on your username in the top right menu and go to Senders and IP

  5. You can create new senders or use the existent one and add it to the Config.ini file in the misc[CONTACT-EMAIL] field. The sender email is used to send outgoing emails.

  6. Optional: Login onto your server and navigate to your domain path where you will have to install the SendinBlue dependencies using composer as follow
    $ composer require sendinblue/api-v3-sdk "7.x.x"
    $ composer install

  Next (Plesk Configuration) ❯


Please mail us your feedback at support@gamerpath.net