Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.41 KB

registration.md

File metadata and controls

39 lines (26 loc) · 1.41 KB

Application Registration

How to register an application

To register an ALTLab application with the deployment server:

  1. Check the application registry to select an unused ports and unused UID/GID!
  2. SSH into the altlab-gw server.
  3. cd into /opt/deploy.altlab.dev.
  4. Generate a secret key for the app: sudo python3 generate-secret.py {app_name}.
  5. This will create a key file at {app_name}.key. Use this key as the app secret when sending a POST request to that app's endpoint. (See the API notes.)
  6. Update app/configuration.py by adding code to run the deployment script for the app.
  7. Update docs/application-registry.tsv by adding the name, ports, and UID/GID for your application.

Existing applications

The application registry is a spreadsheet that contains the following fields:

Application

This is the {app_name} as registered in app/configuration.py.

UID/GID

The Unix User ID and Group ID. Both the user ID and the group ID should be the same integer, and kept consistent on both altlab-gw and whichever servers have the application deployed.

The integer should be greater than 60000.

Listening on...

The hostname and port being used by the application. The port should be based on the UID/GID (same last 3 decimal digits).