Custom tenant selection in production

In production, tenant selection is handled by the Neos gateway.

The endpoint consumed by your tenant selection page is described in tenant selection endpoint configuration.

If TenantSelection__Endpoint__IncludeTenantStatus=true (default), each tenant item returned by GET ./tenant-selection/tenants contains:

isDisabled: true when tenant status is not Active, otherwise false
isAvailable: true when data persistence state is Running, otherwise false

If TenantSelection__Endpoint__IncludeTenantStatus=false, these properties are omitted.

If you created your own custom tenant selection webpage and want to deploy it, you'll need to create a specific docker image for the Neos gateway.

By default, the Neos gateway docker image contains the default tenant selection files in the /app/tenant-selection folder.

To override this folder with your own implementation, you can create a dockerfile like the following :

# syntax=docker/dockerfile:1.24

ARG NEOS_VERSION=latest
FROM "harbor.hexanet.fr:8443/neos/gateway:${NEOS_VERSION}"
ARG NEOS_VERSION

COPY ./my-custom-tenant-selection-directory /app/tenant-selection

USER 1001

Warning

Because the image is based on the Neos gateway image, make sure that you use the same version as the one in your deployed environment.

In the values of the Neos Helm chart, you can then specify which image / tag / pull secret to use under the gateway section.

Table of Contents

Custom tenant selection in production

Warning