authoring
v0.1.67
Published
ioAuthoring project for Eclipse IoFog @ iofog.org Copyright (C) 2018 Edgeworx, Inc.
Downloads
7
Readme
IO Authoring Setup
1. Install ioauthoring
sudo npm install -g --unsafe-perm authoring
or
sudo npm install -g --unsafe-perm @iofog/ioauthoring (developer's version)
2. Start ioauthoring
sudo ioauthoring start
Usage
1. To view help menu
sudo ioauthoring help
2. To view version and license
sudo ioauthoring version
Logs
- Log files are located at './node_modules/ioauthoring-logs/'
- Log files are rotated on daily basis
- If number of log files exceeds 90, oldest log file will be swapped with the newest file
System Requirements (Recommended)
- Processor: 64 bit Dual Core or better
- RAM: 2 GB
- Hard Disk: 10 GB
Platforms Supported
- Ubuntu
- macOS Sierra
- Windows
Configuration Management
1. To list configurations
sudo ioauthoring config -list
2. To add a configuration
sudo ioauthoring config -add <key> <value>
Note: Configuration keys can be one of following
- port
- fog_controller_port
- fog_controller_ip_address
- fog_controller_protocol
To setup fog-controller configurations, do following steps:
sudo ioauthoring config -add fog_controller_port 54421
sudo ioauthoring config -add fog_controller_ip_address 127.0.0.1
sudo ioauthoring config -add fog_controller_protocol http
To setup HTTPS for ioauthoring, do following steps:
sudo ioauthoring config -add port 54521
sudo ioauthoring config -add ssl_key 'path_to_your_sertificates/key.pem'
sudo ioauthoring config -add intermediate_cert 'path_to_your_sertificates/gs_intermediate_ca.crt'
sudo ioauthoring config -add ssl_cert 'path_to_your_sertificates/certificate.pem'
sudo ioauthoring config -add fog_controller_port 54421
sudo ioauthoring config -add fog_controller_ip_address 127.0.0.1
sudo ioauthoring config -add fog_controller_protocol https
sudo ioauthoring config -add self_signed_certs true (if provided certs are self signed, skip this step otherwise)
Do not forget to update FogController configs and add certificates under /etc/iofog/ on the machine where fog agent is running!
3. To remove a configuration
sudo ioauthoring config -remove <key>
- ioauthoring update:
sudo ioauthoring stop
sudo npm update -g --unsafe-perm authoring
sudo ioauthoring start
or
sudo ioauthoring stop
sudo npm update -g --unsafe-perm @iofog/ioauthoring (developer's version)
sudo ioauthoring start