Server

Installing the Backend and Admin panel on your server

In order to watch the video tutorial for this section please head to the customer panel at: https://support.ridy.io

Connect To Server

The application's server hosting requirement is a VPS with 4GB of memory. It is recommended to have only Ridy installed on the server without any other websites. Once you have purchased the server, you can access the VPS's Terminal interface using the credentials provided by your hosting provider. Typically, this includes the server address and the root user's password.

Installation

The recommended deployment solution for the server-side is Docker. Once Docker is installed on your server, you can easily run the server-side of the application by executing a single command.

Install Docker

To install Docker and Docker Compose, you can refer to the official Docker documentation, which provides detailed instructions based on your server's operating system. Follow the specific documentation provided by Docker for your server's OS to ensure a proper installation of both Docker and Docker Compose:

Run backend

Now that Docker is installed, navigate to the root folder of your server by using the command cd /root. From there, you can proceed to install Ridy's server-side by executing the following command:

wget -qO- https://uploads.ridy.io/docker-compose-flutter.yaml > docker-compose.yaml && docker compose up -d

After a few seconds, Docker will start up all the required services, and you should be able to access the dashboard by using your IP address and port 4003.

Configuration

You can access the dashboard on your server from port 4003. (eg. http://x.x.x.x:4003/)

In case the server doesn't respond to port 4003 (Which can't be opened in the browser), The reason could be the server's firewall. To fix this refer to FAQ.

When you open the dashboard for the first time, you will be presented with a Configuration wizard. Below are the details of the steps explained in the wizard:

Wizard

Purchase Code

After purchasing from Codecanyon, you should have received a purchase code titled "Purchase Confirmation" in your email. In the Configuration wizard, you will need to enter this code to verify your purchase.

Google Maps API Key

This API key is to be retrieved from the Google Developers console. For the server API key Distance Matrix API API is required and for the dashboard key Google Maps Javascript SDK & Static Maps API are required.

Make sure that the billing account is enabled for the project from which you retrieved the keys. Enabling the billing account is crucial for the proper functioning of the app.

Firebase Admin SDK

In the Firebase project, navigate to the Project Settings and locate the Service Accounts section. Click on the Generate Private Key button to obtain the private key in JSON format. Then, upload this JSON file using the provided upload panel.

After uploading the Firebase project private key, return to your server's terminal and enter the following command:

docker compose down
docker compose up -d

You can now open the admin panel address in your browser, and instead of the configuration page, you will be greeted with the login page. Simply use the default admin/admin username and password to log in.

Setup SMS Provider

Once the admin panel is running please head to Management->SMS Providers and create one SMS provider and enter the API keys that you would retrieve by registering on their website. Doing this is crucial for OTP message sending capability of the mobile apps for login and phone number verification.

Last updated