wardenenv/images#719 - Add PHP-SPX image build

[bap14]

Adds a new SPX image build. Adjusts Nginx configuration to route requests to the SPX container (similar to Xdebug), and prevents Varnish from caching SPX requests.

[bap14]

@navarr I was having issues with cookies not being respected; however, it could have been because of Varnish caching the requests. This line shouldn't need to be there.

[MagePsycho]

What's the status of this PR? @navarr

[navarr]

@MagePsycho held up until at minimum I fix PHP images not building

[ihor-sviziev]

@bap14, is there instruction how to use this image? :)

[bap14]

@ihor-sviziev Not yet; however, now that the image is there it can move forward in being a toggled feature for projects.

[bgorski]

For anyone interested, to make SPX in Warden work now, you can add or modify the .warden/warden-env.yml file in your project and add the following things:

x-volumes: &volumes
  - ${WARDEN_SSL_DIR}/rootca/certs:/etc/ssl/warden-rootca-cert:ro
  - ${WARDEN_COMPOSER_DIR}:/home/www-data/.composer:cached
  - .${WARDEN_WEB_ROOT:-}/:/var/www/html:cached
  - bashhistory:/bash_history
  - sshdirectory:/home/www-data/.ssh

x-extra_hosts: &extra_hosts
  - ${TRAEFIK_DOMAIN}:${TRAEFIK_ADDRESS:-0.0.0.0}
  - ${TRAEFIK_SUBDOMAIN:-app}.${TRAEFIK_DOMAIN}:${TRAEFIK_ADDRESS:-0.0.0.0}

services:
  php-spx:
    hostname: "${WARDEN_ENV_NAME}-php-spx"
    image: ${WARDEN_IMAGE_REPOSITORY}/php-fpm${WARDEN_SVC_PHP_IMAGE_SUFFIX:-}:${PHP_VERSION:-7.4}-spx
    environment:
      - TRAEFIK_DOMAIN
      - TRAEFIK_SUBDOMAIN
      - SSH_AUTH_SOCK=${SSH_AUTH_SOCK_PATH_ENV:-/tmp/ssh-auth.sock}
      - NODE_VERSION=${NODE_VERSION:-12}
      - COMPOSER_VERSION=${COMPOSER_VERSION:-1}
      - COMPOSER_MEMORY_LIMIT=-1
      - HISTFILE=/bash_history/.bash_history
      - CHOWN_DIR_LIST=${CHOWN_DIR_LIST:-}
    volumes: *volumes
    extra_hosts: *extra_hosts

where x-volumes and x-extra_hosts are taken from environments/includes/php-fpm.base.yml in your warden installation (the ones above work for 0.15.0) and php-spx is a new container that will handle all requests that have SPX enabled.

In order to enable SPX in your requests, add the following cookies or URL params:

• SPX_ENABLED with a value of 1
• SPX_KEY with "warden" (without quotation marks) as the value.

To go to your SPX web UI, just use the following URL: https://yourproject.test/?SPX_UI_URI=/ where yourproject.test matches the domain you use for your project.

I'm not sure how long it will work this way, since I guess that some easier method of enabling SPX will get added to Warden in the future, but hopefully it will save someone some time setting this up for as long as there's no better way.

[monteshot]

Please notice the following:
wardenenv/warden#820 (comment)