Raspberry PI installation

DreamFactory has been tested for install on Raspberry Pi 4 with 4GB of ram using the Raspberry Pi lite OS 64bit (Bookworm release 12). The install process focuses on an Nginx web server with MySql as the default database (the site is published on port 80 of the localhost). This guide provides instructions for downloading, installing and running the necessary packages to host DreamFactory.

Update pre-installed packages

sudo apt update
sudo apt upgrade -y

Install PHP and Dependencies

First, install the lsb-release package which is needed for PHP installation (likely installed by default):

sudo apt install lsb-release

Add the PHP repository:

curl https://packages.sury.org/php/apt.gpg | sudo tee /usr/share/keyrings/suryphp-archive-keyring.gpg >/dev/null

Create the source file:

echo "deb [signed-by=/usr/share/keyrings/suryphp-archive-keyring.gpg] https://packages.sury.org/php/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/sury-php.list

Update the package list:

sudo apt update

Install required system packages:

sudo apt-get install git curl zip unzip

Install PHP 8.3 and required extensions:

sudo apt-get install -y php8.3-common \
    php8.3-xml \
    php8.3-cli \
    php8.3-curl \
    php8.3-mysqlnd \
    php8.3-sqlite \
    php8.3-soap \
    php8.3-mbstring \
    php8.3-zip \
    php8.3-bcmath \
    php8.3-dev \
    php8.3-ldap \
    php8.3-pgsql \
    php8.3-interbase \
    php8.3-gd \
    php8.3-sybase

Install Nginx and PHP-FPM:

sudo apt-get install -y nginx php8.3-fpm

Configuring PHP-FPM

You will need a text editor for this task. The instructions use Nano which comes installed on RPi.

Edit the php-fpm php.ini file:
```
sudo nano /etc/php/8.3/fpm/php.ini
```
Find the line that reads ;cgi.fix_pathinfo=1
Change it to read cgi.fix_pathinfo=0
Save and exit (Ctrl+x, Y, Enter)

Installing Additional Dependencies

Install MongoDB dependencies and extension:

sudo apt-get install php8.3-dev php-pear build-essential libssl-dev libcurl4-openssl-dev pkg-config
sudo pecl install mongodb
sudo sh -c 'echo "extension=mongodb.so" > /etc/php/8.3/mods-available/mongodb.ini'
sudo phpenmod mongodb

Accept all the defaults for mongodb unless you have specific reasons not to. The defaults are all proven to currently work.

Add MongoDB extension to PHP configuration:

Edit the php.ini file:
```
sudo nano /etc/php/8.3/fpm/php.ini
```
Add the line extension=mongodb at the bottom of the file (without a preceding semicolon)

Installing Composer

Set up Composer:

cd ~
mkdir bin
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"

php composer-setup.php --install-dir=/home/<youruserhere>/bin --filename=composer

After installing Composer, restart your terminal or log out and back in to ensure the changes take effect.

Installing MariaDB

Install MariaDB server (this will be out default MySQL database):

sudo apt-get install mariadb-server -y

Configuring MariaDB

Log into MariaDB as root:
```
sudo mysql -uroot
```

Set the root password and create the DreamFactory database:

ALTER USER 'root'@'localhost' IDENTIFIED BY '<Your password here>';

FLUSH PRIVILEGES;

CREATE DATABASE dreamfactory;

Create a user to interface with the DB (default is dfadmin:dfadmin) and give them appropriate permissions:

CREATE USER 'dfadmin'@localhost IDENTIFIED BY 'dfadmin';

GRANT ALL PRIVILEGES ON dreamfactory.* TO 'dfadmin'@localhost IDENTIFIED BY 'dfadmin';

FLUSH PRIVILEGES;

The user you create for the DreamFactory DB will need to be used when setting up DreamFactory, the default is dfadmin:dfadmin

Installing DreamFactory

Create and set up the DreamFactory directory (change dfuser to your user):
```
sudo mkdir /opt/dreamfactory
sudo chown -R dfuser /opt/dreamfactory
```

Clone the DreamFactory repository and install dependencies:

cd /opt/dreamfactory/
git clone https://github.com/dreamfactorysoftware/dreamfactory.git ./
composer install --no-dev --ignore-platform-reqs

Configure the environment:
```
php artisan df:env
```
If you are following this guide choose option "1" for mysql (mariadb).

Fill in your first and last name, email, phone number and create user login credentials for the Web UI (this password must be 16 characters or longer)

Edit the .env file:

nano .env

Uncomment (remove the ##) the two lines that read:
```
##DB_CHARSET=utf8
##DB_COLLATION=utf8_unicode_ci
```

Set the following values:

APP_DEBUG=true
APP_LOG_LEVEL=debug
DF_INSTALL=rpi

Run the DreamFactory setup:
```
php artisan df:setup
```

Set proper permissions (change dfuser to your user):

sudo chown -R www-data:dfuser storage/ bootstrap/cache/
sudo chmod -R 2775 storage/ bootstrap/cache/

Clear the cache:
```
php artisan cache:clear
```

Setting up Nginx Config

cd /etc/nginx/sites-available/
sudo cp default default.bak
sudo nano default

Remove all the contents located in default and replace them with:

# Default API call rate -> Here is set to 1 per second, and is later defined in the location /api/v2 section
limit_req_zone $binary_remote_addr zone=mylimit:10m rate=1r/s;

server {
    listen 80 default_server;
    listen [::]:80 default_server ipv6only=on;
    root /opt/dreamfactory/public;
    index index.php index.html index.htm;
    
    add_header X-Frame-Options "SAMEORIGIN";
    add_header X-XSS-Protection "1; mode=block";
    
    gzip on;
    gzip_disable "msie6";
    gzip_vary on;
    gzip_proxied any;
    gzip_comp_level 6;
    gzip_buffers 16 8k;
    gzip_http_version 1.1;
    gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;

    location / {
        try_files $uri $uri/ /index.php?$args;
    }

    error_page 404 /404.html;
    error_page 500 502 503 504 /50x.html;

    location = /50x.html {
        root /usr/share/nginx/html;
    }

    location ~ \.php$ {
        try_files $uri =404;
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        fastcgi_pass unix:/var/run/php/php8.3-fpm.sock;
        fastcgi_index index.php;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }

    location ~ /\.ht {
        deny all;
    }

    location ~ /web.config {
        deny all;
    }

    #By default we will limit login calls here using the limit_req_zone set above. The below will allow 1 per second over a
    # 5 seconds (so 5 in 5 seconds)from a single IP  before returning a 429 too many requests. Adjust as needed.
    location /api/v2/user/session {
        try_files $uri $uri/ /index.php?$args;
        limit_req zone=mylimit burst=5 nodelay;
        limit_req_status 429;
    }

    location /api/v2/system/admin/session {
        try_files $uri $uri/ /index.php?$args;
        limit_req zone=mylimit burst=5 nodelay;
        limit_req_status 429;
    }
}

Restart Nginx and PHP

sudo systemctl restart nginx php8.3-fpm.service

Access your new DreamFactory instance

After the services are restarted your web server should be ready to access. Go ahead and in your preferred browser type in the ip address of your Raspberry Pi and you should see the login page of the DreamFactory Web UI. To find your ip address on Raspberry Pi easily type in the command line hostname -I

Update pre-installed packages​

Install PHP and Dependencies​

Configuring PHP-FPM​

Installing Additional Dependencies​

Installing Composer​

Installing MariaDB​

Configuring MariaDB​

Installing DreamFactory​

Setting up Nginx Config​

Access your new DreamFactory instance​