How To: Add Custom HTTPS Certificate

Advanced

Overview

Starting in firmware v4.2 a custom HTTPS certificate may be uploaded to the meter and used for local HTTPS webserver access. This does not affect the proxy-server access (e.g., https://eGauge9999.d.egauge.net , https://eGauge9999.egaug.es or https://egauge9999.egauge.io).

Prerequisites

Only EG4xxx model meters may be used with custom HTTP certificates.
The certificate must be a single file containing the private key and full chain and certificate in PEM format.

Warning

eGauge Systems CANNOT provide certificate files or assist with certificate generation.
NEVER share your private key or certificate file. The private key is like a password and must never be shared.

Instructions

Step 1: If you're using the ‘Classic Interface’, click on ‘View’ then select ‘Modern user-interface’. Otherwise you can skip to Step 2.

Step 2: Click on the hamburger menu in the upper left-hand corner and navigate to Setup → Network → Web-server

Step 3: Click Upload HTTPS certificate, then Click the ‘Upload’ button, then click where it says ‘Filename’ and choose the certificate files to upload. This must contain the private key and full chain in the same .pem file.

Step 4: If successful, you will be redirected back to the main page and see a confirmation at the bottom of the page the certificate was updated. However, if there was a problem with the certificate, you will receive an error message at the bottom of the screen.

Troubleshooting and Tips

Certificate File Format

The certificate file must be in .pem format and contain the private key and full chain. It should have a single BEGIN PRIVATE KEY stanza, and one or more BEGIN CERTIFICATE stanzas. For example, a certificate may look similar to this (note: this example uses random data; it will not function as a certificate).

Creating certificate file example

Most certificate services provide separate certificate and key files and the private key needs to be concatenated with the certificate. For example, Lets Encrypt as of this writing provides several files: cert.pem, chain.pem, fullchain.pem, privkey.pem, and README. The example below show obtaining a Lets Encrypt certificate and creating the pem file to upload to eGauge. The file egauge-cert.pem will contain the contents of privkey.pem followed by fullchain.pem and can be uploaded to the eGauge meter.

root@localhost:~# certbot certonly -q \
                  --dns-cloudflare \
                  --dns-cloudflare-credentials ~/.secrets/cloudflare.ini \
                  -d meter-name.example.com

root@localhost:~# cd /etc/letsencrypt/live/meter-name.example.com

root@localhost:/etc/letsencrypt/live/meter-name.example.com# ls
cert.pem  chain.pem  fullchain.pem  privkey.pem  README

root@localhost:/etc/letsencrypt/live/meter-name.example.com# cat privkey.pem fullchain.pem > egauge-cert.pem

guide
steps