This is a setup designed for developers local environments. It mounts to code inside the container volumes, allowing the programmer to edit the code directly and immediately see the results. It is design to maintain a persistent database, provides an email container for full end-to-end testing, and optionally serves the phpdoc.
Note:
There are additional containers for node and composer, for convenience. This means you will not need to install composer, node or npm on the host machine.
cd /my/development/directory
git clone git@gitlab.com:apiopenstudio/apiopenstudio.git
git clone git@gitlab.com:apiopenstudio/apiopenstudio_admin.git
git clone git@gitlab.com:apiopenstudio/apiopenstudio_docker_dev.git
cd /my/development/directory/apiopenstudio
cp example.docker-dev.settings.yml docker-dev.settings.yml
cd /my/development/directory/apiopenstudio_admin
cp example.settings.yml settings.yml
brew install mkcert nss
mkcert -install
cd /my/development/directory/apiopenstudio_docker_dev
mkdir certs
cd certs
mkcert -cert-file apiopenstudio.local.crt -key-file apiopenstudio.local.key "*.apiopenstudio.local"
cp "$(mkcert -CAROOT)/rootCA.pem" ca.crt
Configure the /etc/hosts for your domains. Add the following lines to your hosts file:
127.0.0.1 admin.apiopenstudio.local
127.0.0.1 api.apiopenstudio.local
cp example.env .env
Edit .env:
APP_NAME = The name of you application.PHP_VERSION (7.4, 8.0, 8.1)
docker-compose.yml: composer:2.0.8WITH_XDEBUG (true / false) - Build the PHP container with xDebug enabled.WITH_MEMCACHED (true / false) - Build the PHP container with Memcached enabled.WITH_REDIS (true / false) - Build the PHP container with Redis enabled.API_CODEBASE - Full path to the API code on your host machine, e.g. /my/development/directory/apiopenstudio.API_DOMAIN - The domain of your APIADMIN_CODEBASE - Full path to the admin site code on your host machine, e.g. /my/development/directory/apiopenstudio_admin.ADMIN_DOMAIN - The domain of your admin site.PHPDOC_DOMAIN - (optional) The domain of the phpdoc site if you want to host it.MYSQL_HOST - The host of the Database.MYSQL_DATABASE - The name of the database.MYSQL_USER - The database user.MYSQL_PASSWORD - The password for the database user.Add the following line to /etc/hosts:
127.0.0.1 phpdoc.apiopenstudio.local
Uncomment the following line from .env
PHPDOC_DOMAIN=phpdoc.apiopenstudio.local
Uncomment the phpdoc containers in docker-compose.yml:
docker-composer up -d
docker-composer down
Because the DB will not be available outside of the docker network, you will need to run the install script from within the API docker:
docker exec -it apiopenstudio-php bash
cd api/
./bin/aos-install
The API, admin and php containers are configured to display the server logs in this docker directory:
./logs/admin/
./logs/api/
./logs/php/
Your Composer dependencies require a PHP version ">= 8.1.0".This usually occurs when you are running when the composer image is a mismatch for the PHP version you are using.
In .env:
PHP_VERSION=8.0
In docker-compose.yml file:
composer:
image: composer:2.1.11
In .env:
PHP_VERSION=8.1
In docker-compose.yml file:
composer:
image: composer:latest
In .env:
PHP_VERSION=8.2
In docker-compose.yml file:
composer:
image: composer:latest
You will need to delete the composer.lock file and vendor/ directory from your local ApiOpenStudio instance. and restart your containers with:
docker-compose down
docker-compose up --build