PiGation #

PiGation is a WebServer and front end for running an irrigation system on the raspberry pi.

PiGation lets you configure garden beds and lights associate those features with general IO pins on your Rapsberry PI.

Pigation is written in Dart and easy to install.

Start by installing Dart on your raspberry PI.

Once Dart is installed you can install PiGation.

dart pub global activate pigation

Now run the pigation installer. This will install pigation into /opt/pigation.

As part of the install you need to decide if you will use HTTP or HTTPS to access PiGation. If you want to use HTTPS then your PI must be exposed on the internate (using NAT) with both port 80 and 443 open.

If you don't understand how to configure NAT then just choose HTTP.

sudo pig

This is a complete web server with a builtin letsencrypt client that obtains certs and serves static content.

The web server deploys a static web site and includes a single live end point /booking

The web server is deployed as a single executable that contains the static content!

The static content is packed into the web server executable using the 'dcli pack' command.

When you start the webserver it:

• unpacks the static content
• obtains a HTTPS certificate from LetsEncrypt (including doing auto renews)
• Listens on http and https ports
• Serves index.html and a varity of associated file times.
• Exposes a single live end point '/booking' that sends an email when called with valid parameters.

To build/deploy the IHAServer you need to create your static content and create the config file under the project:

Build/Deploy #

Target system #

On the target system create: /opt/handyman

Change the permissions so that you have access:

sudo chown <me>:<me> /opt/handyman

Dev system #

The build/deploy process is controlled by tool/build.yaml

Configure your build.yaml

Example

target_server:  handyman.com
target_directory: /opt/handyman
scp_command: scp

Run tool/build.dart

Once the build has run it will have copied a single exe deploy to the target system in /opt/handyman.

Login to the target system and run:

cd /opt/handyman
sudo ./deploy

Update your DNS A record to point to your new system.

You are now live.

configuration #

The config.yaml file is used to configure the server.

You will need two config.yaml files, one for development and one for the release environment:

The following is a sample for your production environment <project root>/release/config.yaml

password: XXXXXXXXXXX
path_to_static_content: /opt/handyman/www_root
path_to_lets_encrypt_live: /opt/pigation/letsencrypt/live
fqdn: ivanhoehandyman.com.au
domain_email: bsutton@onepub.flutter-io.cn
https_port: 443
http_port: 80
production: true
binding_address: 0.0.0.0
logger_path: /var/log/pigserver.log

The following is a sample for your development environment

<project root>/config/config.yaml

gmail_app_username: bsutton@onepub.flutter-io.cn
gmail_app_password: XXXXXXXXXXX
path_to_static_content: /home/bsutton/git/pigation/www_root
path_to_lets_encrypt_live: /opt/pigation/letsencrypt/live
fqdn: squarephone.biz
domain_email: bsutton@onepub.flutter-io.cn
https_port: 10443
http_port: 1080
production: false
binding_address: 0.0.0.0
logger_path: console

READ THIS !!!

production setting

The production setting in config.yaml, controls whether we obtain a live or staging Lets Encrypt certificate.

This is important as the production flag controls whether we get a staging or live Lets Encrypt certificate. Lets Encrypt has very strict rate limits on the number of certificates it will issue to a production system (5 per 48 hrs?) so if you get something wrong (your http port isn't open) you can end up not being able to get a live certificate for 48 hrs.

Development #

Within you development environement you are likely to be behind a NAT. To test the cert aquistion and renewal you will need to forward port 443 and 80 from your local router to your development box.

You will need a DNS server with a real domain name and an A record that points to your router's public IP.

On Linux, you will need to make the server use ports above 1024 (you can only listen to ports below 1024 if you are root - not recommended for dev).

I suggest: 80 -> 8080 443 -> 8443

You will need to change the config/config.yaml port settings to match the port numbers you choose.

You should generally test using a staging certificate until you are certain your configuration and NAT are set up correctly.

Run the service locally #

To debug the pig server you can simply launch bin/pig.dart --server.dart in your favourite IDE.

Build on the PI #

dart pub global activate dcli
git clone https://github.com/bsutton/pig_server.git
dcli compile bin/pig.dart
sudo bin/pig --install

Edit the config.yaml and add contents as follows making the necessary changes:

password: <hashed passwrod>
path_to_static_content: /opt/pigation/www_root
path_to_lets_encrypt_live: /opt/pigation/letsencrypt/live
fqdn: ivanhoehandyman.com.au
domain_email: bsutton@onepub.flutter-io.cn
https_port: 443
http_port: 80
use_https: false
production: false
binding_address: 0.0.0.0
logger_path: /var/log/pig_server.log

cd pig_server
dart pub get
tool/build.dart
dcli compile bin/pig.dart
# install and start the web server.
sudo bin/pig