openiod-connect-pull-v1 v1.0.3

openiod-connect-pull-v1

This generic module is used by 'processor' modules. The instructions as described in the processor modules can overrule (parts of) the following documentation.

Install

Dependencies

Nodejs

Application

This module is used as a executor of process which act like a stand-alone service.

The structure of the application directory tree looks like this:

• {applicationname}
  • {processname}
    • processor
    • controller
  • {configdir}
    • {configfile}.json

This tree structure is generated by the following instructions

• mkdir {applicationname}
• mkdir {applicationname}/{configdir} (keep this folder save)
• cp {yourconfigfile} {applicationname}/{configdir}/. (see 'Create config file' below)
• cd {applicationname}
• Get the needed process using git or zipped download
  • git:
    • git clone https://github.com/openiod/openiod-connect-pull-{processname}.git
  • zip:
    • wget https://github.com/openiod/openiod-connect-pull-{processname}/archive/main.zip
    • unzip main.zip
• cd openiod/openiod-connect-pull-{processname}
• npm install

Available processes are:

• v2j - openiod-connect-pull-v2j

Create config file

Keep the config file save because it can contain secret tokens or other important data!

• cd {applicationname}/{configdir}
• create a new config file? Copy the example from within the processname folder:
  • cp ../openiod-connect-pull-{processname}/openiod-config-example.json ./{servicename}.json
• or copy your own configfile into this folder
  • cp {yourconfigfile.json} ./{servicename}.json
• Edit the json configfile according to your service, source and target

run

cd {applicationname}/{processname}

Usage: node index OPTIONS...

Options:

• -v, --version output the version number
• -c, --config type Path to config file
• -s, --service type Name of the configfile
• -p, --processpath type Path to processor and controller
• -h, --help display help for command

e.g.:

• node index -h (get help info)
• node index -c '{configdir}' -s '{servicename}' -p 'openiod-connect-pull-{processname}'

license

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.along with this program.
If not, see https://www.gnu.org/licenses/.