Updated Home (markdown) authored by Michael J Pearson's avatar Michael J Pearson
...@@ -39,7 +39,9 @@ When you define a bip, you are defining the characteristics of a [directed graph ...@@ -39,7 +39,9 @@ When you define a bip, you are defining the characteristics of a [directed graph
When a message is received from a web hook, incoming email or generated from a trigger, it appears on a bips graph from the 'source' node. The source data is then normalized into a JSON structure and 'exported' via RabbitMQ for consumption as 'imports' by adjacent nodes. This pipeline continues until all nodes have been visited. When a message is received from a web hook, incoming email or generated from a trigger, it appears on a bips graph from the 'source' node. The source data is then normalized into a JSON structure and 'exported' via RabbitMQ for consumption as 'imports' by adjacent nodes. This pipeline continues until all nodes have been visited.
Prior to consumption, imports can be modified in different ways. These modifications are called 'transforms', or ['personalizations'](https://bip.uservoice.com/knowledgebase/articles/502740-personalizing-your-integrations) in the UI. As a message is pushed through a graph, an object is built containing exports from visited nodes which can be plucked out and re-assembled using [JSONPath](http://goessner.net/articles/JsonPath) A node in a bip usually represents a [Remote Procedure Call](https://en.wikipedia.org/wiki/Remote_procedure_call) (RPC) on an external service and are generally referred to as 'actions'.
Prior to consumption by an action, imports can be modified in different ways. These modifications are called 'transforms', or ['personalizations'](https://bip.uservoice.com/knowledgebase/articles/502740-personalizing-your-integrations) in the UI. As a message is pushed through a graph, an object is built containing exports from visited nodes which can be plucked out with [JSONPath](http://goessner.net/articles/JsonPath). Using these JSONPath expressions and a simple [templating system](https://github.com/bipio-server/bipio/wiki/Transforms-And-Templates), imports can be composed as you like.
#### A note on files #### A note on files
...@@ -67,7 +69,7 @@ The API uses [HTTP Basic Authentication](http://en.wikipedia.org/wiki/Basic_acce ...@@ -67,7 +69,7 @@ The API uses [HTTP Basic Authentication](http://en.wikipedia.org/wiki/Basic_acce
`curl http://admin:4a4b27ec88763a3c371916d2e23a2000@bipio.local:5000/rest/bip/637658bb-eb15-4d59-9e0e-abb39021e40e` `curl http://admin:4a4b27ec88763a3c371916d2e23a2000@bipio.local:5000/rest/bip/637658bb-eb15-4d59-9e0e-abb39021e40e`
When you set up BipIO for the first time, take note of the generated token for your primary account. If a token has been misplaced, run `tools/token_regen.js {account uuid}` to regenerate a token for the target account uuid. When you set up bip.io for the first time, take note of the generated token for your primary account. If a token has been misplaced, run `tools/token_regen.js {account uuid}` to regenerate a token for the target account uuid.
You can expose an account UUID by shelling into mongodb and running the appropriate query against the `accounts` collection. You can expose an account UUID by shelling into mongodb and running the appropriate query against the `accounts` collection.
...@@ -146,7 +148,7 @@ GET /rest/domain?page=1&page_size=10&order_by=recent ...@@ -146,7 +148,7 @@ GET /rest/domain?page=1&page_size=10&order_by=recent
Configuration files can be found under `/config/{environment}.json` where environment is the shell export NODE_ENV. If NODE_ENV can not be found as an environment variable, `development` will be used. Configuration files can be found under `/config/{environment}.json` where environment is the shell export NODE_ENV. If NODE_ENV can not be found as an environment variable, `development` will be used.
The first time you setup bipio via `make install`, it will ask you some questions which populate into the config json file. The template for this file is [`config.json-dist`](https://github.com/bipio-server/bipio/blob/master/config/config.json-dist) The first time you setup bip.io via `make install`, it will ask you some questions which populate into the config json file. The template for this file is [`config.json-dist`](https://github.com/bipio-server/bipio/blob/master/config/config.json-dist)
#### Variables #### Variables
...@@ -206,7 +208,7 @@ The first time you setup bipio via `make install`, it will ask you some question ...@@ -206,7 +208,7 @@ The first time you setup bipio via `make install`, it will ask you some question
### A Note on SMTP Bip Endpoints ### A Note on SMTP Bip Endpoints
Bipio is not an SMTP Relay, Smart Host or 'Email Service' but rather an API provider that supports an SMTP transport. We do not suggest binding your custom domain MX to Bipio unless it is a dedicated subdomain. Set your subdomain CNAME/MX as {username}.bip.io. For more info, see the [domains](https://github.com/bipio-server/bipio/wiki/Domains) section. bip.io is not an SMTP Relay, Smart Host or 'Email Service' but rather an API provider that supports an SMTP transport. We do not suggest binding your custom domain MX to bip.io unless it is a dedicated subdomain. Set your subdomain CNAME/MX as {username}.bip.io. For more info, see the [domains](https://github.com/bipio-server/bipio/wiki/Domains) section.
SMTP Bips rely on Haraka and some custom plugins which you can find in the [contrib repository ](https://github.com/bipio-server/bipio-contrib/tree/master/haraka) SMTP Bips rely on Haraka and some custom plugins which you can find in the [contrib repository ](https://github.com/bipio-server/bipio-contrib/tree/master/haraka)
... ...
......