Overseer Web App - michaelfdeberry/overseer GitHub Wiki

Introduction

The Overseer Standalone Web App is a JavaScript application that works in the browser without needing a remote backend.

Differences from server daemon version.

1. Data Storage

The configuration data is persisted in the browsers local and indexedDb storage systems. This means that each browser that the app is accessed from requires its own configuration. While currently not supported, there are plans to support exporting and importing data to ease configuration.

2. Client Certificates

All request are made from through the browser so supporting client certificate is not needed. As long as the browser is configured to access the site the Overseer Client should be able to access it as well.

3. Requires CORS

Since Overseer will be accessing the APIs through the browser CORS will need to be enabled to allow. See the following documentation about how to enabled it.

Hosting

The Overseer Web App is just a static website, and there is a vast number of way to host such a website. If none of the options below are suitable for your needs please create an issue and, if possible, assistance will be provided.

Hosting On Octopi, Raspi, etc.

  1. Install NGINX

    sudo apt-get nginx

  2. Open the configuration file

    nano /etc/nginx/sites-available/default

  3. Add or replace the contents of the file with the configuration below.

    server {
        listen        9000;
    
        location / {
            root        /home/pi/overseer-webapp;
            index       index.html;
            try_files   $uri /index.html =404;
        }
    }
    

Note: This will configure the web app on port 9000 with files for the app in the /home/pi/overseer-webapp directory. Please update the root path and the port to fit your needs.

  1. Restart NGINX

    sudo service nginx restart

    The Overseer web app will be available at http://<DEVICE_HOST_NAME>:9000/ or http://<DEVICE_IP_ADDRESS>:9000/