Configure access to applications in maintenance mode

Last updated:
Edit on GitHub

When you enable maintenance mode for an application, visitors see a maintenance page and can’t access the application. To enable access to an application in maintenance mode, you can allowlist IP addresses as follows.

Define gateway IP addresses

All requests go through the AWS VPC network. To fetch real IP addresses for all defined application, in the needed deploy file, define gateway IP addresses. Example:

x-real-ip: &real-ip
    real-ip:
        from:
            - 10.0.0.0/8 # AWS VPC network

x-frontend-auth: &frontend-auth
    <<: *real-ip

groups:
    EU:
        region: EU
        applications:
            boffice:
                application: backoffice
                endpoints:
                    backoffice.de.spryker.com:
                        store: DE
                        primal: true
                        <<: *frontend-auth
                    backoffice.at.spryker,com:
                        store: AT
                        <<: *frontend-auth
            Yves:
                application: yves
                endpoints:
                    www.de.spryker.com:
                        store: DE
                        <<: *frontend-auth
                    www.at.spryker.com:
                        store: AT
                        <<: *frontend-auth
            ...

For more information about the deploy file configuration, see groups: applications:.

Define allowlisted IP addresses

To allow access from particular IP addresses, define them in the needed deploy file. Example:

version: 1.0

docker:
    maintenance:
        enabled: true
        whitelist:
          ips:
              - 192.158.1.38
              - 192.0.2.1

For more information about the deploy file configuration, see docker: maintenance: whitelist: ips:.

Deploy the changes

Deploy the application with the updated configuration by following one of the following docs:

Now you can access the applications from the 192.158.1.38 and 192.0.2.1 IP addresses.