Oktav.IO

General Requirements

• Node.JS
• NPM
• MongoDB
• Redis
• pilight-daemon

Setup Oktav.IO

Configuration

Copy .env.example to .env and make your configurations there.

Oktav.IO Application

• HOST - Defaults to OS hostname, or localhost.
• PORT - Defaults to random.
• COOKIE_HASH - (Required) 32-char long hash for cookies
• COOKIE_NAME - (Required) Name for chookie

Redis

• REDIS_HOST - Defaults to 127.0.0.1
• REDIS_PORT - Defaults to
• REDIS_PASSWORD - Defaults to null
• REDIS_PARTITION - (Required)

MongoDB

• MONGO_URL - (Required) For example: mongodb://127.0.0.1:27017/ (dont forget the trailing slash)
• MONGO_DB - (Required)
• MONGO_USER - Defaults to null
• MONGO_PASS - Defaults to null

Pilight

• PILIGHT_SKIP - Defaults to false
• PILIGHT_HOST - (Required, if skip is not set to True)
• PILIGHT_PORT - (Required, if skip is not set to True)

Additional configurations

• SKIP_DOTENV - Skip loading .env-file
• TESTING - Used by tests
• COMMENCE_TESTING - Used by tests

Install packages

To install node packages required to run the application, other than general requirements, execute the following command in the project root.

npm install

Add initial User

You wont get far unless you have an account that can login and add/update/delete stuff. Whilst logged in you can create more users.

node bin/createUser

Starting

npm start will start the application but will also exit the application if you close your terminal window.

A good way to start applications and keeping them alive is to use PM2. Follow the installation guide and then run pm2 start oktavio.js.

API

Users

• POST /api/users/login
• GET /api/users/logout
• POST /api/users
• PUT /api/users
• DELETE /api/users
• GET /api/users
• GET /api/users/:id

Devices

• POST /api/devices
• PUT /api/devices
• GET /api/devices
• GET /api/devices/{id}
• DELETE /api/devices
• POST /api/devices/{id}/activate
• POST /api/devices/{id}/deactivate

Modes

• POST /api/modes
• PUT /api/modes
• GET /api/modes
• GET /api/modes/{id}
• DELETE /api/modes
• POST /api/modes/{id}/activate

Schedules

• POST /api/schedules
• PUT /api/schedules
• GET /api/schedules
• GET /api/schedules/{id}
• DELETE /api/schedules