OADA Reference API Server
This project is a reference implementation of an OADA-conformant API server. It can be used to host easily run your own OADA instance, or for comparison when creating an OADA-conformant API implementation.
The repository and releases come with configurations for easily running with docker-compose.
For information on
the various micro-services comprising this reference implementation,
Running a release
cd folder/containing/release/docker-compose # Will pull the corresponding release images from dockerhub DOMAIN=yourdomain.com docker-compose up -d
Running from the git
If you want to contribute, or do other development type things, you can run the server straight from this codebase.
git clone https://github.com/OADA/server.git cd server # Running up the first time will automatically build the docker images DOMAIN=yourdomain.com docker-compose up -d
Note that running from the git is not recommended for production use.
If you need to migrate an OADA v2 instance,
or are making a new installation but for some reason
are averse to managing your own configuration,
To modify the docker-compose configuration of your OADA instance,
you can simply create a
in the same directory as the
Any settings in this override file will be merged with ours
when running docker-compose.
Additionally, there are various configuration environment variables available. Some important ones are:
- DOMAIN: set to the domain name of your API server
- EXTRA_DOMAINS: Additional domains to serve
- DEBUG: set the namespace(s) enabled in debug
Rather than trying to always remember to set your environment variables,
you probably want to use a .env file for things like