xRegistry Implementation

Implementation of the xRegistry spec. A live version is available at https://xregistry.soaphub.org?ui too.

Still a work-in-progress so check the todo list for what's missing, but let us know via issues if something seems wrong.

To run the server (with an embedded mysql DB):

# You need to have Docker installed

docker run -ti -p 8080:8080 ghcr.io/xregistry/xrserver-all

The xr and xrserver CLIs are available as:

• a container images
• or as stand-alone executables
  • Note that the stand-alone xrserver does not have any database built-in so either use the xrsever-all container image (which has both the xrserver command the a MYSQL instance built-in) or run your own MYSQL DB manually.

Please see the simple doc-store script to see how to quickly stand-up and load an xRegistry server for experimentation. Lots more samples/docs are needed...

To build and run it locally:

# You need to have Docker installed

# Build, test and run the xreg server (creates a new DB each time):
$ make

or to run the server w/o creating a new DB (no testing either):
$ make start

Then explore it with:

# In a browser go to:  http://localhost:8080?ui

# Or access the APIs programmatically, e.g.:
$ curl http://localhost:8080
$ curl http://localhost:8080?inline

Developers

See misc/Dockefile-dev for the minimal things you'll need to install. Useful Makefile targets:

- make              : build all, test and run the server (alias for 'all')
- make all          : build all, test and run the server (reset the DB)
- make run          : build server and run it (no tests, reset the DB)
- make start        : build server and run it (no tests, do not reset the DB)
- make test         : build all, images and run tests, don't run server
- make clean        : erase all build artifacts, stop mysql. Basically, reset
- make server       : build the server
- make cmds         : build the exes (server and CLIs)
- make image        : build the all container images
- make push         : push the container images to a container registry
- make mysql        : just start mysql as a container container
- make mysql-client : run the mysql client, for testing
- make testdev      : build dev container image, and build/test/run everything
                      to make sure the minimal dev install requirements
                      haven't changed