naala89/apiopenstudio_admin repository overview

⁠naala89/apiopenstudio_admin

This creates and uploads a docker image for the production use of ApiOpenStudio Admin.

It contains:

• Nginx
• PHP 8.1
• The tagged version of ApiOpenStudio Admin
• composer
• node
• npm

⁠Getting Started

This container contains a full working Nginx/PHP server and ApiOpenStudio Admin. It requires a separate instance of ApiOpenStudio Core to connect with, and can be quickly installed on a bare-bones production server in minutes to have a fully functioning ApiOpenStudio Admin instance.

Note: There should not be a running instance of Apache or Nginx on the server, otherwise the incoming port 80/443 requests will not get directed to the Docker container.

⁠Prerequisites

In order to run this container you'll need docker installed.

• Windows⁠
• OS X⁠
• Linux⁠

You will also need a running instance of ApiOpenStudio core installed on a SEPARATE server.

• ApiOpenStudio Docker⁠

⁠Usage

⁠Useful File Locations

• /etc/nginx/nginx.conf - The main Nginx config file.
• /etc/nginx/sites-enabled/default - The Nginx site config file.
• /etc/php/8.1/{cli,fpm}/php.ini - PHP configuration.
• /var/www/html/install.sh - Install composer, npm and gulp dependencies.

⁠Example

# Download and configure the settings file.
sudo mkdir -p /data/apiopenstudio_admin
sudo curl https://raw.githubusercontent.com/naala89/apiopenstudio_admin/master/example.settings.yml --output /data/apiopenstudio_admin/settings.yml

# Update the settings.yml file

# Start the ApiOpenStudio Admin container
sudo docker run -d --name apiopenstudio-admin \
-p 80:80 \
-p 443:443 \
--mount type=bind,source=/data/apiopenstudio_admin/settings.yml,target=/var/www/html/settings.yml \
--mount type=bind,source=/path/to/ssl.crt,target=/etc/nginx/certs/apiopenstudio_admin.crt \
--mount type=bind,source=/path/to/ssl.key,target=/etc/nginx/certs/apiopenstudio_admin.key \
naala89/apiopenstudio_admin:<tag>

# SSH into the container
docker exec -it apiopenstudio-admin bash

# Install the dependencies.
./install.sh

⁠Detailed instructions

Visit the ApiOpenStudio wiki⁠ for full instructions and downloading/configuration of the settings.yml file.

⁠Find Us

• www.apiopenstudio.com⁠
• Wiki⁠
• GitHub⁠
• GitLab (ApiOpenStudio Core)⁠
• GitLab (ApiOpenStudio Admin)⁠

⁠Versioning

This image automatically built from tags on the master branch at GitLab (ApiOpenStudio Admin)⁠.

Version tags (i.e. naala89/apiopenstudio_admin:1.0) references the version of the image and the tag of the release.

Version tags of master & develop (i.e. naala89/apiopenstudio_admin:master) references the latest version on the branch.

The latest tag is most recent built image and should not be used to pull the latest tagged version.

⁠Authors

• John Avery - John - GitLab⁠

⁠License

This project is licensed under the MIT License - see the LICENSE.md⁠ file for details.