Skip to content

Commit

Permalink
submodule update; closing #323 by updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
suculent committed Mar 24, 2022
1 parent 9527465 commit 2ba2205
Show file tree
Hide file tree
Showing 22 changed files with 25 additions and 25 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Currently the platform supports building firmware for Arduino, PlatformIO (also

* Device registration endpoint while storing device data using CouchDB server and Redis session-store.

* API is a back-end data provider (security agent) for RTM Admin Console Application.
* API is a back-end data provider (security agent) for Management Console Application.

* Provides control to a dockerized build servers and pushes new firmware versions to client applications (FCM push) and devices (MQTT).

Expand Down Expand Up @@ -175,7 +175,7 @@ Use your favourite service and log-sender agent. Tested successfully with [Logz.

* FQDN – Fully Qualified Domain Names (if you're testing on localhost, configure conf/config.json to set `debug: { allow_http_login: true }` )
* api.yourdomain.com – THiNX API
* console.yourdomain.com – THiNX RTM Console
* console.yourdomain.com – THiNX Management Console

* [Mailgun](https://mailgun.com) account (recently added)
* [Rollbar](https://rollbar.com) integration
Expand All @@ -187,7 +187,7 @@ Use your favourite service and log-sender agent. Tested successfully with [Logz.
* [Slack](https://slack.com) integration
* [Crisp.chat](https://crisp.chat) integration

# Remote THiNX Management (RTM) Console
# Management Console

You need to **BUILD YOUR OWN CONSOLE** Docker image, because the build injects various static variables specific for your environment (e.g. API Keys) into HTML on build (see .circleci/config.yml for list of required build-args until this is documented).

Expand Down Expand Up @@ -229,7 +229,7 @@ It's perfectly possible to run multiple instances of THiNX in Swarm. Just keep i

## GitHub Webhook support

You can direct your GitHub web-hooks to <https://thinx.cloud:9001/> after adding a valid deploy key from GitHub to THiNX RTM.
You can direct your GitHub web-hooks to <https://thinx.cloud:9001/> after adding a valid deploy key from GitHub to THiNX.

## Endpoints

Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/apienv.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for managing Environment variables securely. */
/** This THiNX Device Management API module is responsible for managing Environment variables securely. */

var Globals = require("./globals");
var rollbar = Globals.rollbar();
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/apikey.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for managing API Keys.
/** This THiNX Device Management API module is responsible for managing API Keys.
This is the new version that will use Redis only. */

var Globals = require("./globals.js");
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/audit.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* This THiNX-RTM API module is responsible for audit logging.
* This THiNX Device Management API module is responsible for audit logging.
*/

const Globals = require("./globals.js");
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/auth.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* This THiNX-RTM MQTT Authentication Helper
* This THiNX MQTT Authentication Helper
* used by disaster recovery among others.
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/builder.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for managing builds and should be offloadable to another server. */
/** This THiNX Device Management API module is responsible for managing builds and should be offloadable to another server. */

var Globals = require("./globals.js");
var app_config = Globals.app_config();
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/buildlog.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for build logging. */
/** This THiNX Device Management API module is responsible for build logging. */

const Globals = require("./globals.js");
const app_config = Globals.app_config();
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/deployment.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* This THiNX-RTM API module is responsible for managing deployments for each device.
* This THiNX Device Management API module is responsible for managing deployments for each device.
*/

var fs = require("fs-extra");
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/device.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for managing devices. */
/** This THiNX Device Management API module is responsible for managing devices. */

var Globals = require("./globals.js");

Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/devices.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for managing userlib records. */
/** This THiNX Device Management API module is responsible for managing userlib records. */

var Globals = require("./globals.js");
var prefix = Globals.prefix();
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/messenger.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for managing MQTT communication. */
/** This THiNX Device Management API module is responsible for managing MQTT communication. */

// specific imports
const base64 = require("base-64");
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/owner.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for managing userlib records. */
/** This THiNX Device Management API module is responsible for managing userlib records. */

var Globals = require("./globals.js");
var app_config = Globals.app_config();
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/repository.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* This THiNX-RTM API module is responsible for managing repositories.
* This THiNX Device Management API module is responsible for managing repositories.
*/

var Globals = require("./globals.js");
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/rsakey.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for managing RSA Keys. */
/** This THiNX Device Management API module is responsible for managing RSA Keys. */

let Globals = require("./globals.js");

Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/sanitka.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for input value sanitation. */
/** This THiNX Device Management API module is responsible for input value sanitation. */

module.exports = class Sanitka {

Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/sources.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for managing Sources. */
/** This THiNX Device Management API module is responsible for managing Sources. */

var Globals = require("./globals.js");
var app_config = Globals.app_config();
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/statistics.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* This THiNX-RTM API module is responsible for aggregating daily statistics.
* This THiNX Device Management API module is responsible for aggregating daily statistics.
*/

const Globals = require("./globals.js");
Expand Down
2 changes: 1 addition & 1 deletion lib/thinx/transfer.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** This THiNX-RTM API module is responsible for device transfer management. */
/** This THiNX Device Management API module is responsible for device transfer management. */

var Globals = require("./globals.js");
var app_config = Globals.app_config();
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "thinx",
"version": "1.5.743",
"description": "THiNX IoT RTM API",
"description": "THiNX IoT Device Management API",
"bugs": {
"url": "https://github.com/suculent/thinx-device-api/issues"
},
Expand Down
2 changes: 1 addition & 1 deletion services/console
2 changes: 1 addition & 1 deletion static/gdpr.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<!-- BEGIN HEAD -->
<head>
<meta charset="utf-8" />
<title>THiNX RTM Console | General Data Protection Regulation</title>
<title>THiNX | General Data Protection Regulation</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta content="width=device-width, initial-scale=1" name="viewport" />
<meta content="THiNX Cloud General Data Protection Regulation" name="description" />
Expand Down
2 changes: 1 addition & 1 deletion thinx.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// file deepcode ignore UseCsurfForExpress: API cannot use CSRF

/*
* This THiNX-RTM API module is responsible for responding to devices and build requests.
* This THiNX Device Management API module is responsible for responding to devices and build requests.
*/

let start_timestamp = new Date().getTime();
Expand Down

0 comments on commit 2ba2205

Please sign in to comment.