Installing ApiOpenStudio is quick and easy!
There are a few ways to install ApiOpenStudio, depending on your requirements. Check the options below.
Local developers setup
Docker with reverse proxy
This is an ideal setup if you want to develop on ApiOpenStudio on a PC or laptop. It uses the latest docker images for Core/Admin and a MariadDB instance (using a persistent docker volume for the DB data).
See https://github.com/naala89/apiopenstudio_reverse_proxy.
Detailed installation instructions are details are available on the wiki: https://wiki.apiopenstudio.com/install/docker/reverse-proxy
Docker & git clone
This is a setup for developers who want to work on ApiOpenStudio Core/Admin code, or create custom processors/plugins.
A docker compose file configuration and volume mounted code, along with full instructions are available at https://github.com/naala89/apiopenstudio_docker_dev.
Detailed installation instructions are details are available on the wiki: https://wiki.apiopenstudio.com/en/install/docker/core-developer-environment
Vhost
Clone the repositories and setup the DB, Core & Admin on your local machine using a vhost setup and Git or Composer to download and maintain the codebases.
See the Wiki pages at: https://wiki.apiopenstudio.com/en/install/apiopenstudio
Dev/Stage/Prod server setup
Docker on separate servers for Core/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.
Docker on a single server for Core/Admin
his docker setup is designed for users of ApiOpenStudio on a single production server, allows full https traffic, and is suitable for small-medium projects in production. It removes the need to set up separate servers for admin and api. It uses the ApiOpenStudio, ApiOpenStudio Admin, Traefik and MariaDB docker images.
Full installation instructions are details are available on the wiki: https://wiki.apiopenstudio.com/install/docker/reverse-proxy
Setup with OS native Apache/Nginx
Clone the repositories and setup the DB, Core & Admin on your local machine using a vhost setup and Git or Composer to download and maintain the codebases. This gives you more control and freedom over your setup, however it comes at the cost of potential complexity and maintenance.
See the Wiki pages at: https://wiki.apiopenstudio.com/en/install/apiopenstudio