The API and web-interface module built with PHP, running on a LAMP stack environment built using Docker Compose or Edgebox Compose. It consists of the following:

• PHP
• Apache
• MySQL
• phpMyAdmin (not available when using ws)

PHP version is:

• 8.1

It can be upgraded by editing the Dockerfile in the bin folder (please open a PR).

• Clone this repository on your local computer, on your edgebox working folder (eg: ~/edgebox/)
• configure .env as needed
• Run the docker-compose up -d.

git clone https://github.com/edgebox-iot/api.git
cd api/
cp sample.env .env
// modify sample.env as needed
docker-compose up -d
// visit localhost

Your API LAMP stack is now ready!! You can access it via http:https://localhost.

To run it on the context of edgebox-iot/ws:

• Clone this repository on your local computer, on your edgebox working folder (eg: ~/edgebox/)
• Navigate to the ws folder (eg: ~/edgebox/ws)
• Run ./ws -b.
• Run ./ws -s

cd ~/edgebox
git clone https://githib.com/edgebox-iot/ws.git
git clone https://github.com/edgebox-iot/api.git
cd ws/
./ws -b
./ws -s
// visit api.edgebox

Your API LAMP stack is now ready and running behind Edgebox proxy service!! You can access it via http:https://api.edgebox.

This package comes with default configuration options. You can modify them by creating .env file in your root directory. To make it easy, just copy the content from sample.env file and update the environment variable values as per your need.

There are following configuration variables available and you can customize them by overwritting in your own .env file.

PHPVERSION Is used to specify which PHP Version you want to use. Defaults always to latest PHP Version.

PHP_INI Define your custom php.ini modification to meet your requirments.

DOCUMENT_ROOT

It is a document root for Apache server. The default value for this is ./www. All your sites will go here and will be synced automatically.

VHOSTS_DIR

This is for virtual hosts. The default value for this is ./config/vhosts. You can place your virtual hosts conf files here.

Make sure you add an entry to your system's hosts file for each virtual host.

APACHE_LOG_DIR

This will be used to store Apache logs. The default value for this is ./logs/apache2.

DATABASE Define which MySQL or MariaDB Version you would like to use.

MYSQL_DATA_DIR

This is MySQL data directory. The default value for this is ./data/mysql. All your MySQL data files will be stored here.

MYSQL_LOG_DIR

This will be used to store Apache logs. The default value for this is ./logs/mysql.

Apache is configured to run on port 80. So, you can access it via http:https://localhost.

By default following modules are enabled.

• rewrite
• headers

If you want to enable more modules, just update ./bin/webserver/Dockerfile. You can also generate a PR and we will merge if seems good for general purpose. You have to rebuild the docker image by running docker-compose build and restart the docker containers.

You can connect to web server using docker-compose exec command to perform various operation on it. Use below command to login to container via ssh.

docker-compose exec webserver bash

By default following extensions are installed.

• mysqli
• pdo_sqlite
• pdo_mysql
• mbstring
• zip
• intl
• mcrypt
• curl
• json
• iconv
• xml
• xmlrpc
• gd

If you want to install more extensions, just update ./bin/api-ws/Dockerfile. You can also generate a PR and it will be merged if it seems good for general purpose. You have to rebuild the docker image by running docker-compose build and restart the docker containers.

phpMyAdmin is configured to run on port 8080. Use following default credentials.

http:https://localhost:8080/
username: root
password: tiger

If running on the context of edgebox proxy service, it is available at http:https://pma.edgebox instead.

The projects includes a web interface that is meant to be used either in the local network or via the myedge.app tunnel.

It is a early version and lots of the functionality is not yet working.

The interface is built using bootstrap / saas, using html5 and css best practices. It is based on soft-ui-dashboard by CreativeTim and uses twig templating. Some screenshots: