This API enables simple management of a Jidoteki system.
In combination with the jidoteki-admin, it is possible to use the REST API to:
- Upload and validate a license file
- Upload a software update package
- View the status of a software update
- View and update network settings
- View and update application settings
- Retrieve compressed log files
- Retrieve version and changelog of the system
- Reboot the system
- PicoLisp 32-bit or 64-bit v3.1.10.2+
- Git
- UNIX/Linux development/build tools (gcc, make/gmake, etc..)
- Stunnel4 (for HTTPS only)
- (optional)
jidoteki-admindeployment in/opt/jidoteki/admin/
- Type
maketo pull and compile the dependencies - Type
./run.lto launch the HTTP listener - View the API documentation at:
http://enterprise.vm:8080orhttps://enterprise.vm:8443
The API does not need to run as root.
If using the jidoteki-admin, it requires sudo access to commands in /opt/jidoteki/admin/bin, write access to /opt/jidoteki/admin/home/sftp/uploads, and read access to files in /opt/jidoteki/admin/etc/.
It is possible to specify a few environment variables at runtime.
There is only one API version (1), but this makes it possible to load a completely different set of API endpoints, ex: JIDO_API_VERSION=2 ./run.l.
The default port for the HTTP listener is 8080.
By default, only the HTTP listener will be launched. If you want to start an HTTPS server as well, you can set JIDO_WITH_SSL=true.
It will launch an stunnel4 process on port 8443, so ensure an enterprise.pem SSL certificate exists in the same directory as stunnel.conf.
The name of the stunnel binary. On CentOS it's stunnel, but on Debian it's stunnel4. Defaults to stunnel4.
The full path to the Admin application. In most cases it refers to /opt/jidoteki/admin/, but it may be different depending on the application.
See the API Documentation.
If you find any bugs or issues, please create an issue.
If you want to improve this application, please make a pull-request.
Copyright (c) 2015-2016 Alexander Williams, Unscramble [email protected]