The project is abandoned. I'd like to continue it, but there is no financial motivation. And I don't use it for my pesonal needs as well. I'd be happy to find a paid work to continue the project development. Alas, I cannot do it for free, because ~~I'm greedy~~ I need money to live.

NOTE

It's a very early development stage for a FusionPBX api using laravel.

Installation

Introduction

It's assumed you follow FusionPBX installation manual and have your Debian server running.

The API will be accessible at your server under port 444 (you are free to change it)

The main steps would be:

Fix adminer notice (optional)
Install additional packaged
Get the API code and place it to your server
Update .env file
Add nginx virtual host
Setup firewall
Get and upload apple VOIP push certificate

Fix adminer notice (optional)

nano /var/www/fusionpbx/app/adminer/index.php

Replace function permanentLogin() { with function permanentLogin($j = false) {

Install additional packages

Install nodejs

curl -sL https://deb.nodesource.com/setup_7.x | sudo -E bash -
sudo apt-get install -y nodejs php7.0-mbstring build-essential

Install composer

curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer

Install Laravel socket dependencies

For Debian

apt-get install libzmq3-dev php-pear pkg-config supervisor php7.0-dev
pecl install zmq-beta
touch /etc/php/7.0/cli/conf.d/21-zeromq.ini
echo extension=zmq.so > /etc/php/7.0/cli/conf.d/21-zeromq.ini

Install API project files

# cd /var/www
# git clone git@github.com:gruz/fusionpbx-api.git laravel-api
# cd laraverl-api
# composer update
# cp .env.example .env
# chown -R www-data:www-data laravel-api

Update .env file

Next manually copy database credentials from /etc/fusionpbx/config.php to /var/www/laravel-api/.env

sudo -u www-data php artisan key:generate
sudo -u www-data php artisan migrate
sudo -u www-data php artisan passport:install

The latest command will generate key pairs.

Copy-paste the generated secrets and IDs into your .env file like this

PERSONAL_CLIENT_ID=1
PERSONAL_CLIENT_SECRET=mR7k7ITv4f7DJqkwtfEOythkUAsy4GJ622hPkxe6
PASSWORD_CLIENT_ID=2
PASSWORD_CLIENT_SECRET=FJWQRS3PQj6atM6fz5f6AtDboo59toGplcuUYrKL

Change MOTHERSHIP_DOMAIN domain in .env to your domain.

Add nginx virtual host

Edit /etc/nginx/sites-available/fusionpbx and add code like this (note port 444 which you can change here and in the firewall section)

server {
        listen 444;
        server_name fusionpbx;
        ssl                     on;
        ssl_certificate         /etc/ssl/certs/nginx.crt;
        ssl_certificate_key     /etc/ssl/private/nginx.key;
        ssl_protocols           TLSv1 TLSv1.1 TLSv1.2;
        ssl_ciphers             HIGH:!ADH:!MD5:!aNULL;

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

        access_log /var/log/nginx/access.log;
        error_log /var/log/nginx/error.log;

        client_max_body_size 80M;
        client_body_buffer_size 128k;

        location / {
                root /var/www/laravel-api/public;
                index index.php;
                try_files $uri $uri/ /index.php?$query_string;
        }


        location ~ \.php$ {
                fastcgi_pass unix:/var/run/php/php7.0-fpm.sock;
                #fastcgi_pass 127.0.0.1:9000;
                fastcgi_index index.php;
                include fastcgi_params;
                fastcgi_param   SCRIPT_FILENAME /var/www/laravel-api/public$fastcgi_script_name;
        }

        # Disable viewing .htaccess & .htpassword & .db
        location ~ .htaccess {
                deny all;
        }
        location ~ .htpassword {
                deny all;
        }
        location ~^.+.(db)$ {
                deny all;
        }
}

Restart server

# service nginx restart

Setup firewall

Allow your port in Firewall

# iptables -A INPUT -p tcp --dport 444 --jump ACCEPT
# iptables -A INPUT -p tcp --dport 8080 --jump ACCEPT

Now we want to make firewal respect your port setting after reboot.

Save current rules to a file

# iptables-save > /etc/iptables.up.rules

Create a boot file

# nano /etc/network/if-pre-up.d/iptables

with contents

#!/bin/sh
/sbin/iptables-restore < /etc/iptables.up.rules

Make it executable

chmod +x /etc/network/if-pre-up.d/iptables

Get and upload apple VOIP push certificate

This is needed to send push notifications to wakeup Apple devices. Get the certificate at Apple Developer Portal and place it to resources/certs/VOIP.pem

Edit .env file and place the path to the cert file as well as password if you have it setup.

Search for VOIP_APPLE_CERT_PATH and VOIP_APPLE_CERT_PASSPHRASE in your .env file.

Setup and run socket server

For production site create configuration suppressing output

cat <<EOF > /etc/supervisor/conf.d/laravel-ratchet.conf
[program:laravel-ratchet]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/laravel-api/artisan ratchet:serve --driver=IoServer -q
autostart=true
autorestart=true
user=www-data
numprocs=1
redirect_stderr=true
stdout_logfile=/var/www/laravel-api/storage/logs/ratchet.log
EOF

For dev site use the same config except the -q key

cat <<EOF > /etc/supervisor/conf.d/laravel-ratchet.conf
[program:laravel-ratchet]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/laravel-api/artisan ratchet:serve --driver=IoServer
autostart=true
autorestart=true
user=www-data
numprocs=1
redirect_stderr=true
stdout_logfile=/var/www/laravel-api/storage/logs/ratchet.log
EOF

Enable and start

sudo supervisorctl reread
sudo supervisorctl update
supervisorctl start laravel-ratchet:*

Check it's working

If you open https://yoursite.com:444 (note HTTPS!) you should see something like

{"title":"FusionPBX API","version":"0.0.1"}

Update

# cd /var/www/laravel-api/

Switch to www-data user

# su -m -l www-data

Don't care when you get -su: /root/.bash_profile: Permission denied. Just ignore.

Install additional OS packages added after the initial setup at some point. Check you have all packages installed.

Install Laravel socket dependencies (added 2017-07-07 21:41:49)

Open additional ports

Follow Setup firewall

Enable ratchet server

Follow Setup and run socket server

Get latest files

$ git pull

Update composer to get new added packages and remove unneeded ones

composer update

Run laravel migration

$ php artisan migrate

Check .env.example file for new entries (compare it with your current file). If there are new lines at the bottom, then update your .env file with the new files.

Check if your certificates (like VOIP push cert) are in place.

Documenations

Check this repository wiki

nbhatti/fusionpbx-api