Introduction

The EmonScripts build scripts can be used to build a fully fledged emonCMS installation on debian based operating systems, including: installation of LAMP server and related packages, redis, MQTT, emonCMS core, emonCMS modules, and if applicable, emonhub & RaspberryPi support for serial port, and WiFi access point.

We use EmonScripts to build the pre-built emonSD SD card image for the Raspberry Pi. If you prefer to build your own or customise the installation using EmonScripts directly is a good approach.

The installation process is carried out by a series of scripts that install each required component. These can be explored here: https://github.com/openenergymonitor/EmonScripts/tree/master/install.

It is strongly recommended that you dedicate a single device (NUC/VM/Pi) to emoncms. Using it alongside other software can prove problematic.

Before starting, please review the EmonScripts issue list for any new issues that might affect your build. We try to list new issues and notes from recent builds there that might be useful or required to complete a successful build: https://github.com/openenergymonitor/EmonScripts/issues.

Building Your Own - Base OS Preparation

sudo echo $USER' ALL=(ALL) NOPASSWD: ALL' | sudo tee /etc/sudoers.d/$USER && sudo chmod 0440 /etc/sudoers.d/$USER

Install the EmonCMS Installation Scripts

Pull the script from GitHub (note if you wish to pull the script from master change the path). If you want to install the master branch

wget https://raw.githubusercontent.com/openenergymonitor/EmonScripts/stable/install/init.sh
chmod +x init.sh && ./init.sh

The init script automatically calls the main script. At this point you will be offered the option to configure the installation process.

Output from init.sh is displayed on screen and also stored in the user’s home directory ~/init.sh.log. Output from main.sh is also displayed on screen and stored in the user’s home directory ~/main.sh.log.

If you are on a RaspberryPi or EmonPi you can usually just proceed.

Be patient, the install process takes some time.

Configure install

The default configuration is specifically for the RaspberryPi platform and Raspbian Buster image. To run the installation on a different distribution, you may need to change the configuration to reflect the target environment, e.g. set emonSD_pi_env=0

To edit the configuration (standard file paths):

cd /opt/openenergymonitor/EmonScripts/install/
nano config.ini

user=[YOUR_UBUNTU_USERNAME]
emonSD_pi_env=0

install_emonhub=false

install_emoncms_emonpi_modules=false
install_firmware=false
install_emonpilcd=false
install_emonsd=false
install_wifiap=false

#emoncms_emonpi_modules[config]=stable
#emoncms_emonpi_modules[wifi]=stable
#emoncms_emonpi_modules[setup]=stable

./main.sh

Run Scripts Individually

It is possible to run the scripts individually for a single part of the stack. These are not guaranteed to be a complete solution (some folders may not be created for instance).

Post Install - Settings

If you have used EmonCMS before, you may need to edit the settings to suit your local setup. This is now an ini file called settings.ini in /var/www/emoncms/.

Post Install - First Use

To access EmonCMS go to the IP of your machine, in your browser. This Guide will help you set your system up.

At the initial user screen, you need to select Register and create a user - this will be the admin user.

If you are migrating from an old system, export your data from the old system and import the data to the new system (after registering a user). This will require you to login as the original user.

Standard Setup Filepaths