Revision as of 07:52, 30 June 2016 by Martin.schneider (talk | contribs) (Move to

How to set up an external login page for App Suite

Who should read this document

This document is written for web developers who would like to create a custom login mask for the OX App Suite. The login mask can reside on an external server i. e., not directly located in the domain of the Open-Xchange machines. It is also intended for administrators who install and maintain Open-Xchange services.


The Open-Xchange HTTP API (Form login) has a function to create a session from external.

The full detailed explanation how the HTML form is used and errors can be handled can be found here:

OX Session Formlogin

Redirect to custom login

Users can still access the original product login site. If this is not wanted the following Apache configuration for your VirtualHost can be used to redirect all requests to your custom login page:

RewriteEngine On
RewriteRule ^/appsuite/signin /custom-login.html [R]

Since 7.8.0 it can be configured directly in /opt/open-xchange/etc/as-config.yml

# Override certain settings
    host: all
    loginLocation: ''

Note: you need to have the right syntax (like leading spaces) in the .yml file.

Setting custom login as logout location

If users should be directed to the custom login form after logout from App Suite the following property can be set globally somewhere in /opt/open-xchange/etc/settings/. Either create a new properties file or add the option in any existing one. For more complex setups e.g. with different brands please check out how to set this property in context or user scope which is explained here.


For cases where only one custom login page exists for all users it's also recommended to set

logoutLocation: ''

in /opt/open-xchange/etc/as-config.yml. This setting takes effect for example if an autologin session is expired. as-config.yml itself defines settings in dependence of the hostname configured for the Open-Xchange access.