RISE

https://risedocs.fairsketch.com/
Admin
RISE is a comprehensive business management platform for service professionals to manage clients,...
Tokens:85,396
Snippets:849
Trust Score:7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start Docker Compose for SSL

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Starts the Docker containers for the SSL certificate setup. Run this command from the /home/ubuntu/ssl directory. The --build flag forces a rebuild of the images.

```bash
cd /home/ubuntu/ssl && sudo docker-compose up --build
```

--------------------------------

### Register installation hook

Source: https://risedocs.fairsketch.com/doc/view/51-available-functions-for-plugins

Registers an installation hook that is triggered when the plugin is about to install. Use this to validate the purchase code and run necessary SQL queries. The example creates a database table using the plugin's database prefix.

```php
register_installation_hook("My_Plugin", function ($item_purchase_code) {
  //validate purchase code if you wish
  if (!validate_purchase_code($item_purchase_code)) {
      echo json_encode(array("success" => false, 'message' => "Invalid purchase code"));
      exit();
  }
  

//run necessary sql queries 
$db = db_connect('default');
$db_prefix = get_db_prefix();
$db->query("SET sql_mode = ''");
$db->query("CREATE TABLE IF NOT EXISTS `" . $db_prefix . "plugin_table` (
    `id` int(11) NOT NULL AUTO_INCREMENT,
    `title` TEXT CHARACTER SET utf8 COLLATE utf8_unicode_ci NOT NULL ,
    `deleted` tinyint(1) NOT NULL DEFAULT '0',
    PRIMARY KEY (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci AUTO_INCREMENT=1 ;");
});
```

--------------------------------

### Install Intl extension

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Installs the Intl extension.

```dockerfile
RUN apt-get install -y libicu-dev &&     docker-php-ext-install intl
```

--------------------------------

### Install ZipArchive extension

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Installs the ZipArchive extension.

```dockerfile
RUN apt-get install -y libzip-dev &&     docker-php-ext-install zip
```

--------------------------------

### Install Docker and Docker Compose on EC2

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Run these commands on the EC2 instance to install Docker, Docker Compose, and Docker Buildx, and to start and enable the Docker service. The usermod command adds the current user to the docker group.

```bash
sudo apt update
```

```bash
sudo apt upgrade 
```

```bash
sudo apt install docker.io -y 
```

```bash
sudo systemctl start docker 
```

```bash
sudo systemctl enable docker
```

```bash
sudo usermod -aG docker $USER 
```

```bash
sudo apt install docker-compose -y 
```

```bash
sudo apt install docker-buildx 
```

--------------------------------

### Install PHP extensions

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Installs the mysqli, pdo, and pdo_mysql PHP extensions.

```dockerfile
RUN docker-php-ext-install mysqli pdo pdo_mysql
```

--------------------------------

### Install IMAP extension

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Installs the IMAP extension with kerberos and SSL support.

```dockerfile
RUN apt-get install -y libc-client-dev libkrb5-dev &&     docker-php-ext-configure imap --with-kerberos --with-imap-ssl &&     docker-php-ext-install imap
```

--------------------------------

### Run docker-compose up

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Navigates to the docker directory and runs docker-compose to build and start the containers in detached mode.

```bash
cd /home/ubuntu/rise_public_site/docker && sudo docker-compose up --build -d
```

--------------------------------

### Installation URL

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

URL to open in a web browser to complete the installation of RISE CRM.

```text
https://yourdomain.com
```

--------------------------------

### Install GD extension

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Installs the GD extension with freetype and jpeg support.

```dockerfile
RUN apt-get update &&     apt-get install -y libfreetype6-dev libjpeg62-turbo-dev libpng-dev &&     docker-php-ext-configure gd --with-freetype --with-jpeg &&     docker-php-ext-install -j$(nproc) gd
```

--------------------------------

### Create required directories

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Create the required directories for the RISE CRM installation.

```bash
mkdir -p /home/ubuntu/rise_db /home/ubuntu/rise_public_site /home/ubuntu/letsencrypt
```

--------------------------------

### Show general settings option with app_hook_general_settings_extension

Source: https://risedocs.fairsketch.com/knowledge_base/view/52-available-hooks-for-plugins

Example of showing an option in general settings. The callback renders a setting block and loads a view from the plugin's Views directory.

```php
app_hooks()->add_action('app_hook_general_settings_extension', function() {
    //show settings
    //show a setting block (<div class="form-group">)
    //check .../app/Views/settings/general.php for better ideas
    echo view("My_Plugin\Views\setting");
});
```

--------------------------------

### Add attachment to email (invoice PDF example)

Source: https://risedocs.fairsketch.com/knowledge_base/view/52-available-hooks-for-plugins

Shows how to add an attachment to an email, using an invoice PDF as an example. It retrieves invoice data, prepares the PDF, and sets the attachment in email options.

```php
//add attachment
```

```php
//showing demo of sending an invoice pdf
```

```php
$invoice_data = get_invoice_making_data(invoice_id);
```

```php
$attachement_url = prepare_invoice_pdf($invoice_data, "send_email");
```

```php
$email_options["attachments"] = array(array("file_path" => $attachement_url));
```

--------------------------------

### register_installation_hook

Source: https://risedocs.fairsketch.com/doc/view/51-available-functions-for-plugins

Registers an installation hook for a plugin. This function is called when the plugin is about to install, allowing you to run SQL queries or validate the purchase code.

```APIDOC
## register_installation_hook

### Description
Registers an installation hook. When the plugin is about to install, this function is triggered. Execute required SQL queries or purchase code validation here.

### Parameters
- **plugin_name** (string) - Required - The name of the plugin (e.g., "My_Plugin").
- **callback** (callable) - Required - A function that receives the purchase code as an argument.

### Callback Parameters
- **$item_purchase_code** (string) - The purchase code provided during installation.

### Example
```php
register_installation_hook("My_Plugin", function ($item_purchase_code) {
    //validate purchase code if you wish
    if (!validate_purchase_code($item_purchase_code)) {
        echo json_encode(array("success" => false, 'message' => "Invalid purchase code"));
        exit();
    }
    //run necessary sql queries
    $db = db_connect('default');
    $db_prefix = get_db_prefix();
    $db->query("SET sql_mode = ''");
    $db->query("CREATE TABLE IF NOT EXISTS `" . $db_prefix . "plugin_table` (
        `id` int(11) NOT NULL AUTO_INCREMENT,
        `title` TEXT CHARACTER SET utf8 COLLATE utf8_unicode_ci NOT NULL,
        `deleted` tinyint(1) NOT NULL DEFAULT '0',
        PRIMARY KEY (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci AUTO_INCREMENT=1 ;");
});
```
```

--------------------------------

### Add admin settings menu item with app_filter_admin_settings_menu

Source: https://risedocs.fairsketch.com/knowledge_base/view/52-available-hooks-for-plugins

Adds an item to the admin settings menu under the 'setup' group. The callback receives the settings menu array and must return it with the new item appended.

```php
app_hooks()->add_filter('app_filter_admin_settings_menu', function($settings_menu) {
    $settings_menu["setup"][] = array("name" => "my_plugin_setting", "url" => "my_plugin/setting");
    return $settings_menu;
});
```

--------------------------------

### Configure CSP rules for YouTube and Google Analytics

Source: https://risedocs.fairsketch.com/doc/view/167-enable-content-security-policy-csp

Example configuration for app/Config/ContentSecurityPolicy.php to allow YouTube iframe content and Google Analytics. Update these values to customize CSP rules.

```php
public $scriptSrc = ['self', 'https://www.google-analytics.com/', 'https://www.googletagmanager.com/'];
```

```php
public $imageSrc = ['self', 'https://www.google-analytics.com/', 'https://www.googletagmanager.com/', 'https://www.youtube.com/'];
```

```php
public $connectSrc = ['self', 'https://www.google-analytics.com/'];
```

```php
public $frameSrc = ['self', "https://www.youtube.com/"];
```

--------------------------------

### Call plugin library

Source: https://risedocs.fairsketch.com/knowledge_base/view/50-common-working-processes-in-plugins

Instantiate the plugin library using its fully qualified namespace.

```php
$my_plugin_library = new \My_Plugin\Libraries\My_Plugin_Library();
```

--------------------------------

### Get source URL of file via app_filter_get_source_url_of_file

Source: https://risedocs.fairsketch.com/knowledge_base/view/52-available-hooks-for-plugins

Gets the source URL of a file for preview. The filter provides file_info; extract the file_id and return the URL from your storage integration.

```php
app_hooks()->add_filter('app_filter_get_source_url_of_file', function ($data) {
    //check get_source_url_of_file() function on .../app/Helpers/app_files_helper.php for better ideas
    $file_info = get_array_value($data, "file_info");

    $file_id = get_array_value($file_info, "file_id");
    return \Your_Storage_Integration\Libraries\Your_Storage_Integration::get_source_url_of_file($file_id);
});
```

--------------------------------

### Create docker-compose.yml for SSL Certificate with Nginx and Certbot

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Create this docker-compose.yml file at /home/ubuntu/ssl/docker-compose.yml to set up an Nginx container and a Certbot container for obtaining an SSL certificate. Replace yourdomain.com and your-email@example.com with your actual domain and email. The Nginx container serves the ACME challenge and returns 404 for other requests, while Certbot uses the webroot method to obtain the certificate.

```yaml
version: '3.8'
```

```yaml
services:
  nginx:
    image: nginx:latest
    container_name: rise_nginx
    restart: always
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - ./certbot/www:/var/www/certbot
      - ./certbot/conf:/etc/letsencrypt
    networks:
      - rise_network
    command: >
      /bin/sh -c "echo 'server {
        listen 80;
        server_name yourdomain.com;

        location /.well-known/acme-challenge/ {
          root /var/www/certbot;
        }

        location / {
          return 404;
        }
      }' > /etc/nginx/conf.d/default.conf && nginx -g 'daemon off;'"

  certbot:
    image: certbot/certbot
    container_name: certbot
    volumes:
      - ./certbot/www:/var/www/certbot
      - ./certbot/conf:/etc/letsencrypt
    entrypoint: "/bin/sh -c 'certbot certonly --webroot -w /var/www/certbot --email your-email@example.com -d yourdomain.com --agree-tos --no-eff-email && exit 0'"
    depends_on:
      - nginx
    networks:
      - rise_network

networks:
  rise_network:
```

--------------------------------

### Show content in signup view with app_hook_signup_extension

Source: https://risedocs.fairsketch.com/knowledge_base/view/52-available-hooks-for-plugins

Renders custom content in the sign-up view. Use this action to display additional elements on the registration page.

```php
app_hooks()->add_action('app_hook_signup_extension', function() {
    //show something
});
```

--------------------------------

### XML Declaration

Source: https://risedocs.fairsketch.com/doc/view/165

The XML declaration line used at the start of the Facturae template.

```xml
<?xml version="1.0" encoding="UTF-8"?>
```

--------------------------------

### Create and call plugin library class

Source: https://risedocs.fairsketch.com/doc/view/50-common-working-processes-in-plugins

Define a plugin library class and instantiate it with the fully qualified namespace. Place the file in the plugin's Libraries directory.

```php
<?php

namespace My_Plugin\Libraries;

class My_Plugin_Library {
    //your methods
}
```

```php
$my_plugin_library = new \My_Plugin\Libraries\My_Plugin_Library();
```

--------------------------------

### Enable development mode in .env

Source: https://risedocs.fairsketch.com/doc/view/59-error-debugging-and-troubleshooting

Add this content to a .env file in the root directory to enable development mode. Delete the .env file after debugging.

```ini
CI_ENVIRONMENT = development
```

--------------------------------

### Apache .htaccess rewrite rules

Source: https://risedocs.fairsketch.com/knowledge_base/view/47-remove-index-php-from-site-url

Apache .htaccess file to place in the server root where RISE is installed. Requires mod_rewrite to be enabled on Apache.

```apache
RewriteEngine On  
 RewriteCond %{REQUEST_FILENAME} !-f  
RewriteCond %{REQUEST_FILENAME} !-d  
RewriteRule ^(.*)$ index.php/$1 [L]
```

--------------------------------

### Insert notification setting

Source: https://risedocs.fairsketch.com/knowledge_base/view/52-available-hooks-for-plugins

Adds a notification setting to the notification_settings table during plugin installation. On deactivation, use register_deactivation_hook() to set deleted=1 and register_activation_hook() to revert.

```sql
INSERT INTO `notification_settings` (`event`, `category`, `enable_email`, `enable_web`, `notify_to_team`, `notify_to_team_members`, `notify_to_terms`, `deleted`) VALUES
('your_notification_key', 'your_category', 0, 0, '', '', '', 0);
```

--------------------------------

### Enable CSP in app/Config/App.php

Source: https://risedocs.fairsketch.com/doc/view/167-enable-content-security-policy-csp

Set this property in app/Config/App.php to enable Content Security Policy for the application.

```php
public $CSPEnabled = true;
```

--------------------------------

### Create docker folder

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Creates a 'docker' folder inside the RISE CRM directory and changes into it.

```bash
mkdir docker && cd docker
```

--------------------------------

### Stop Docker Compose after SSL

Source: https://risedocs.fairsketch.com/doc/view/159-install-rise-to-aws-ec2

Stops and removes the Docker containers after the certificate installation is complete. Exit the running container with Ctrl+C before executing this command.

```bash
cd /home/ubuntu/ssl && sudo docker-compose down
```

--------------------------------

### Load plugin asset with base_url and PLUGIN_URL_PATH

Source: https://risedocs.fairsketch.com/doc/view/50-common-working-processes-in-plugins

Load a plugin asset (e.g., CSS) by combining base_url() with PLUGIN_URL_PATH and the plugin's asset path.

```php
<link rel='stylesheet' type='text/css' href='" . base_url(PLUGIN_URL_PATH . "My_Plugin/assets/css/my_plugin_styles.css") . "' />
```

--------------------------------

### Save general settings option with app_hook_general_settings_save_data

Source: https://risedocs.fairsketch.com/knowledge_base/view/52-available-hooks-for-plugins

Example of saving a general settings option. The callback retrieves the posted value using the request service.

```php
app_hooks()->add_action('app_hook_general_settings_save_data', function () {
    $request = \Config\Services::request();
    $your_setting_value = $request->getPost("your_setting");
```

--------------------------------

### Insert payment method into payment_methods table

Source: https://risedocs.fairsketch.com/knowledge_base/view/52-available-hooks-for-plugins

SQL statement to add a payment method to the payment_methods table during plugin installation. The settings field is empty and deleted is 0.

```sql
INSERT INTO `payment_methods` (`title`, `type`, `description`, `online_payable`, `available_on_invoice`, `minimum_payment_amount`, `settings`, `deleted`) VALUES ('Payment method name', 'payment_method_name', 'Payment method description', 1, 0, 0, '', 0);
```

--------------------------------

### Define PLUGIN_CUSTOM_STORAGE constant on pre_system

Source: https://risedocs.fairsketch.com/knowledge_base/view/52-available-hooks-for-plugins

Defines the PLUGIN_CUSTOM_STORAGE constant on the pre_system event. This is the first step to enable custom storage integration.

```php
Events::on('pre_system', function () {
    if (!defined('PLUGIN_CUSTOM_STORAGE')) {
        define('PLUGIN_CUSTOM_STORAGE', TRUE);
    }
});
```

--------------------------------

### Prepare query of getting notify_to users

Source: https://risedocs.fairsketch.com/knowledge_base/view/52-available-hooks-for-plugins

Adds a filter to modify the WHERE query for fetching notify_to users. The $data variable contains event, user_id, options, and notify_to_terms. The hook should return an array of WHERE query strings.

```php
app_hooks()->add_filter('app_filter_create_notification_where_query', function ($where_queries_from_hook, $data) {
    //prepare WHERE query and return
    //check ...app/Models/Notifications_model.php > function create_notification() for better ideas

    /*
    The $data variable has this key values:
    "event" => Event key (your_notification_key).
    "user_id" => Which user created the notification. If it's 0, then it's created by the app.
    "options" => It contains another array of available notification item ids. Check ...app/Models/Notifications_model.php > function create_notification() for better ideas.
    "notify_to_terms" => Notify to terms array as selected in notification setting for this event. Like array("team_members", "team", "project_members").
    */

    $where_queries_from_hook[] = "YOUR QUERIES";
    return $where_queries_from_hook;
});
```

--------------------------------

### Call plugin model

Source: https://risedocs.fairsketch.com/knowledge_base/view/50-common-working-processes-in-plugins

Instantiate the plugin model using its fully qualified namespace.

```php
$My_Plugin_Model = new \My_Plugin\Models\My_Plugin_Model();
```

--------------------------------

### Add notification config hook

Source: https://risedocs.fairsketch.com/knowledge_base/view/52-available-hooks-for-plugins

Adds a filter to configure notification events. The hook receives an array of events and should return it with the new event key. The example shows adding a 'your_notification_key' event with notify_to recipients and an info callback.

```php
app_hooks()->add_filter('app_filter_notification_config', function ($events_of_hook) {
    $notification_link = function () {
        return array("url" => get_uri("notification_link"));
    };

    $events_of_hook["your_notification_key"] = array( //check ...app/Helpers/notifications_helper.php > function get_notification_config() for better ideas
        "notify_to" => array("recipient"), //check available values below
        "info" => $notification_link
    );

    return $events_of_hook;
});
```
Tokens:
Raw