RAD Documentation

Logging In

Access to the application is handled through a secure sign-on system. Upon your first visit, you will be prompted to log in with your Google credentials.

The Main Dashboard

After logging in, you will land on the Deployments page. This is your main dashboard, providing a comprehensive overview of all module deployments. You will see a list of all the modules you have personally deployed ("My Deployments").

Navigating the Dashboard

• Search: A search bar is located at the top of the page, allowing you to quickly find specific deployments. You can search by a module's name, its deployment ID, or the associated project ID.
• Create New Deployment: To deploy a new module, click the Create New button. This will take you to the module selection screen.
• Deployment List: The main area of the page lists your deployments with key information such as the module name, status, creation date, and associated project ID. You can click on any deployment to view more details.
• Pagination: If there are many deployments, you can navigate through the pages using the controls at the bottom of the list.

Deploying a Module

The core functionality of the application is to deploy pre-built modules. This process is designed to be straightforward.

Selecting a Module

1. From the Deployments page, click the Create New button.
2. You will be taken to the module selection page, which is divided into two categories: Platform Modules and Partner Modules.
3. Browse the available modules. Each module card displays its name, a brief description, and the credit cost to deploy it.
4. Click on the card of the module you wish to deploy.

Configuring the Deployment

After selecting a module, you will be taken to the provisioning page, where you need to configure the deployment.

• Configuration Form: A form will be displayed with a series of fields. These are the variables required to deploy the module, such as project IDs, regions, or other specific settings.
• Fill out the Form: Complete all the required fields with the appropriate information for your deployment.
• Submit: Once you have filled out the form, click the Submit button. The application will display module dependencies and validate your inputs and, if your credit balance is sufficient, begin the deployment process.

You will be redirected back to the Deployments page, where you can monitor the status of your new deployment.

Billing

The Billing page allows you to manage your credits, subscriptions, and view your spending history. You can access it from the main navigation menu.

Subscription Tiers

This tab displays all available subscription tiers. You can subscribe to a tier to receive a recurring amount of credits.

Credit Transactions

This tab provides a detailed history of all your credit transactions.

Project Costs

This tab shows you the ongoing costs associated with your deployed projects, deducted from your credit balance. It helps you monitor your spending over time.

Monthly Invoices

Here you can view and download your monthly invoices for your records.

Send Message

This section provides forms for contacting support or inviting new users to the platform.

Managing Your Profile

The Profile page allows you to manage your personal information and settings.

Profile Information

This section displays your basic profile information, including your name, email address, and profile picture, as provided by the authentication system.

Email Notification Settings

You can control which email notifications you receive from the application. You can toggle notifications for deployments and billing.

Deleting Your Account

At the bottom of the page, you will find an option to permanently delete your account. This action is irreversible and will remove all your data from the platform.

Partner Settings

If you are a partner user, this section allows you to connect your GitHub account to the platform.

GitHub Token

Provide a GitHub personal access token with the necessary permissions to read your repositories.

GitHub Repository

Once the token is saved, you can select the specific repository that contains your partner modules. This will populate the Partner Modules tab on the module deployment page.

Private Mode

When private mode is enabled, partner users can see all cost and invoice data, just like an admin. When disabled, they can only see data for their own deployments.

Publishing Modules

The "Publish" tab allows partners to select and publish modules for deployment. The publish tab displays a list of modules available for publishing from the configured GitHub repository.

Administration

Administrators have access to a special Admin page for configuring global settings.

Admin Settings

This page allows administrators to set up the foundational configurations for the platform. This includes Platform GitHub Integration, Mailbox Credentials and Other Global Variables.

Billing

Administrators have an expanded view of the Billing page, with additional tabs for managing the platform's finances and users.

Subscription Tiers Management

This tab allows administrators to create, edit, and manage the subscription tiers offered to users.

User Credits

This tab provides a list of all users on the platform. Administrators can view user information, edit user details, and search for specific users.

Project Costs and Revenue

This tab provides an aggregated view of the costs incurred by all projects across the platform and the total revenue generated from project deployments.

Credit Settings

This page contains forms for awarding credits to users, either individually or in bulk, and for managing other credit-related settings.

Global Settings

Deployment Scope

The Enable Folder Scope option controls the scope of deployments and queries.

Enabling Credits

The Enable Credits setting controls the credit system.

Enabling Subscription

The Enable Subscription option controls the visibility of subscription-related features.

Private Mode

The "Private Mode" option controls data visibility and user onboarding.

Retention Period

The "Retention Period" setting determines how long deployment history is kept.

Cleanup Now

The "Run Cleanup Now" button manually triggers the deployment cleanup process.

Cleanup Schedule

The Cloud Scheduler is an infrastructure-level component that provides a reliable, periodic "pulse" or trigger.

Enable Notification

The "Enable Notification" checkbox controls whether email notifications are sent for deployment events.

Support email and mail server email accounts

The Mail Server Email and its password are the credentials used to send all emails from the application. The Support Email is the address that receives emails sent from the "Send Message" form on the Help page.