There are multiple ways to install ApiOpenStudio.
This is a simple docker-compose instance for quickly setting up and running ApiOpenStudio Core and Admin. It is designed for users of ApiOpenStudio in a local setting.
It uses Traefik as a reverse proxy, along with naala89/apiopenstudio and naala89/apiopenstudio_admin Docker images.
Visit Reverse Proxy for full instructions.
This is a simple docker-compose instance for local developers. It is designed for the developers of ApiOpenStudio Core and Admin.
It is the slowest docker instance, because it volume mounts all Api and Admin code, requires git checkouts of core and admin and runs behind and Nginx reverse proxy.
Visit Core Developer Environment for full instructions.
With this solution, you will either clone the repository code, or create a composer project. See the following pages for setup:
Docker installation makes the easiest method, using pre-prepared docker images at naala89/apiopenstudio and naala89/apiopenstudio_admin.
This is the most resilient method, because it decouples all traffic and computation of the admin instance from the Core API. Although there is an increased cost of running two servers, it also comes with the additional flexibility of easy expansion when entering and enterprise phase of transforming to a cluster network.
This setup runs both admin and core on a sungle server, behind a Traefik reverse proxy.
This is the cheapest method of running a production ApiOpenStudio instance because it only run on a single server. However, it comes at the cost of lack of flexibilty of future explansion into a cluster network, and the server has to run all traffic and computations for admin and core.
See ApiOpenStudio Reverse Proxy for installation instructions.
With this solution, you will either clone the repository code, or create a composer project. See the following pages for setup: