A collection of simple operations to support server administration tasks of (multiple) hosted Aam Digital instances. (e.g. bulk search & replace in config files, statistics of entities across instances, ...)
This is not secured with authentication and should be deployed with other security measures in place.
Have a look at the instructions in the ndb-setup repo for deployment and usage through an SSH tunnel. Alternatively, the master build can be pulled from docker hub.
Once deployed visit localhost:3000/api to see the available endpoints and their description.
The endpoints which work across multiple instances iterate over all organisations listed in credentials.json.
Further adjustments might have to be done in the .env file.
Database migrations can be run via the CLI to apply bulk transformations across all (or selected) instances.
npm run build
npm run cli -- migrate --help
npm run cli -- migrate run latest-config-formats --dry-runThe CLI reads credentials from src/assets/credentials.json (same file as the HTTP service).
Org names in credentials.json can be set via the optional name field and used with --org.
See src/migration/README.md for developer documentation on adding new migrations.
Also refer to the overall developer system guide: aam-services/docs/developer.
If facing issues with local self-signed certificates, you can set an environment variable NODE_TLS_REJECT_UNAUTHORIZED=0 to disable ssl certificate validation.
Do not do this anywhere except the local dev environment for simple testing.