Skip to content
This repository was archived by the owner on Jun 9, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
credentials.json
src/assets/credentials.json

# compiled output
/dist
/node_modules
Expand Down
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Aam Digital admin utilities

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, ...)

## Usage

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](https://github.com/Aam-Digital/ndb-setup/blob/master/admin/README.md) for deployment and usage through an SSH tunnel.
Expand All @@ -13,10 +15,26 @@ Once deployed visit `localhost:3000/api` to see the available endpoints and thei
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.

## Migrations (CLI)

Database migrations can be run via the CLI to apply bulk transformations across all (or selected) instances.

```bash
npm run build
npm run cli -- migrate --help
npm run cli -- migrate run latest-config-formats --dry-run
```

The 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`](src/migration/README.md) for developer documentation on adding new migrations.

## Development

### Setup to run locally

Also refer to the overall developer system guide: [aam-services/docs/developer](https://github.com/Aam-Digital/aam-services/blob/main/docs/developer/README.md).

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.
Do _not_ do this anywhere except the local dev environment for simple testing.
Loading
Loading