One-Click Installation

UVDesk Initialization:

Overview:

This guide will walk you through initializing UVDesk on your AWS instance in just one click. The setup process is streamlined using our custom script, designed for ease of use and efficiency. Before starting the script, ensure the minimum requirement is met.

Pro Tip: We recommend associating an AWS Elastic IP with your instance before running the setup. This prevents your IP address from changing when the instance is stopped and restarted.

Step 1: Access Your AWS Instance

1. Launch Your AWS EC2 Instance:

• Choose your desired AWS EC2 instance type. (Recommended: t3a.small / t3.small)
• Once the instance is running, connect to it via SSH.

2. Connect to the Instance:

• Open your terminal (Mac/Linux) or use an SSH client (e.g., PuTTY for Windows).
• Run the following SSH command:

• When prompted for the login, enter:
  

3. Run the Initialization Script:

• To initiate the installation, run the following command:

• Note: This script automates the entire installation process. While it runs, ensure your terminal remains active, and do not close the session. The script may take up to 10-20 seconds to complete. The script will random generate new credentials for all the necessity.

Step 2: Instance Set Up and Installation 

1. Completion Confirmation:

• Once the installation is finished, you will see a summary on the screen that includes all credentials.

2. Access the Web Interface:

• Open your web browser and navigate to http://<your-public-ip> :

• You will be greeted by the welcome screen.

Step 3: Finalizing Installation  

1. Welcome:

• Click Let’s Begin to start.

2. System Requirement:

• The installer will auto-detect all the requirement is met. You shall see all requirement are ticked as we pre-configured the instance for you. Click “Proceed” to go to next step.

3. Database Configuration:

• Get the database credentials from the summary of initialization script earlier and fill up the database settings, as below.

Server: 127.0.0.1
Port: 3306
Server Version: 11.5
Username: root
Password: (the root credential generated in Step 1)
Database: uvdeskdb

• Once done, press ‘Proceed‘.

4. Admin Details:

• Fill up all fields accordingly as per your business needs.
• Take note of the email and password as you will use them to log into UVDesk Admin Panel.

5. Installation:

• Click “Install Now” to start the installation. Once installation is done, you will be welcomed with the links to your knowledgebase and admin panel.

• Once the setup is complete, you will see the final “Congratulations” screen as below.

• Navigate to http://<your-public-ip>/scp/login.php and login with the Administrator credentials you entered in the “Admin User” section earlier.

Step 4: Post Installation – Recommended by UVDesk

1. Set APP_ENV to Prod

• Go to your instance SSH command prompt and run the following command at root

Important Notes:

• Mail Sending Blockage:
  AWS may have email-sending restrictions in place by default. Before using the instance for email sending, submit a request to AWS to lift the restriction on outbound email traffic.