2.1 KiB
Installation
npm install
Generate server certificates
From within the config/ directory:
openssl genrsa -out key.pem
openssl req -new -key key.pem -out csr.pem
openssl x509 -req -days 9999 -in csr.pem -signkey key.pem -out cert.pem
rm csr.pem
Configuration
Ensure the config file in config/ matches your details.
The SSH key used must be the correct format, e.g. generated with:
ssh-keygen -m PEM -t rsa -C "your@email.address"
Running the server
node bin/server.js config/prod.json
The server generates a lot of JSON data about every request. This is easier for a human to handle if they have bunyan installed ("npm install -g bunyan"), and instead:
node bin/server.js config/prod.json | bunyan
Endpoints
GET /*
This is where all the front-end code goes. All files will be served as-is as found in that directory (by default a symlink to app/dist). The default is static/index.html. There is no authentication; all files are public.
GET /api/login
Call this endpoint to begin the login cycle. It will redirect you to the SSO login page: an HTTP 302, with a Location header.
GET/POST/PUT/DELETE/HEAD /api/*
All calls will be passed through to cloudapi. For these calls to succeed, they MUST provide an X-Auth-Token header, containing the token returned from SSO.
Interaction cycle
client --- GET /api/login --------> this server <-- 302 Location #1 ----
client --- GET <Location #1> --> SSO server <-- 302 with token query arg
From now on call this server as if it were a cloudapi server (using cloudapi paths), except prefixing any path with "/api". Also always provide the X-Auth-Token.
For example, to retrieve a list of packages:
client --- GET /api/my/packages --> this server <-- 200 JSON body ------
The most useful cloudapi endpoints to begin with will be ListPackages, GetPackage, ListImages, GetImage, ListMachines, GetMachine, CreateMachine and DeleteMachine (see cloudapi docs).