SensorThings Enhanced API Node

Installation / Deploy

curl -fsSL https://raw.githubusercontent.com/Mario-35/Stean/main/scripts/stean.sh -o stean.sh && chmod +x stean.sh && ./stean.sh

STEAN configuration

after install : (if localhost) http://localhost:8029/ show the documentation http://localhost:8029/i (any word after will show first install)

The configuration.json file must be found by the api in the configuration folder if the file not exist the api redirect you to th first install page to create that file with your firs service :

You can create manually your configuration.json file :

{
    // admin must be in configuration file
    "admin": {
        "name": "admin",
        "ports": {
            "http": 8029, // http port
            "tcp": 9000, // tcp port for mqtt
            "ws": 1883 // web socket
        },
        // postgresSql Connection // with admin rights (create database rights and user ...)
        "pg": {
            "host": "localhost",
            "port": 5432,
            "user": "postgres",
            "password": "password", // ADMIN password (with rights to create DB)
            "database": "postgres",
            "retry": 2
        }
    },
    "myService": { // service name        
        "name": "myService", // name of the service SAME as key name
        "port": 8037, // not used
        // postgresSql Connection 
        "pg": {
            "host": "localhost",
            "port": 5432,
            "user": "myname", // user to create
            "password": "myPass",
            //  name of the database (if not exit a blank database will be create)
            "database": "myservice",
            "retry": 2
        },
        "apiVersion": "v1.1", // model version 1.0 ou 1.1
        "date_format": "DD/MM/YYYY hh:mi:ss", // date format in jsons
        "nb_page": 200, // pagination number by page
        // list of alias name
        "alias": [
            ""
        ],
        // etensions of the service
        "extensions": [
            "base", // SensorThings core
            "multiDatastream", // SensorThings Multidatastream Extension
            "lora", // Lora Extension
            "logs", // Logs Extension
            "file" // File csv serve Extension
            "users" // Users Extension
        ],
        "options": [
            "highPrecision", // float8 will be used instead of float4
            "canDrop", // database can be destroy (usefull in testing phose)
            "stripNull",  // null value are not visible,
            "forceHttps" // force api to add s to http of this service,
        ]
    }, 
    "myServiceNumber2": {
        ...
    }
}

use on local windows as production (for testing) use : script as install.ps1

for developper

1. Fork/Clone : https://github.com/Mario-35/Stean.git
2. Install dependencies : npm install
3. Fire up Postgres WITH Postgis on the default ports
4. Make configuration.json file or use first install (the file will be automatically create)
5. npm run dev for dev, npm run build (vs script package.json)
6. If database not exists the program create it. note that db test is automaticly create

Want to use this with docker