We recommend running nevisAdapt on a system with at least 4 CPU cores and 8 GB of RAM.
If you use the extended version of the Geolocation database (which also includes the GPS coordinates), it is recommended that you allocate at least 5 GB memory for the nevisAdapt service. The size of the database file should be less than 500 MB.
The installation of the nevisAdapt service includes the following software packages:
|nevisAdapt service||- Contains an embedded Tomcat servlet container.- Contains the database schema.|
|nevisAdapt AuthStates||Contains the AuthStates DeviceCookieAuthState and NevisAdaptAuthState.|
Install all software packages with the user "nauser " and the group "nbgroup". As a precondition, this user and group must exist.
File system layout
The table below describes the layout of the nevisAdapt file system:
|/opt/nevisadapt/||Read-only base directory of the installation, owned by the user "nevisdetect" and group "nevisdetect".||Installation directory|
|/opt/nevisadapt/util/util.sh||Helper script used during the post-install- and pre-remove-phase of the package.|
|/opt/nevisadapt/bin/nevisadapt-exec.jar||Executable jar file.|
|/opt/nevisadapt/bin/nevisadapt-exec.conf||Link to /var/opt/nevisadapt/conf/nevisadapt-exec.conf|
|/var/opt/nevisadapt/||Read/write directory of the installation, owned by the user "nevisdetect" and group "nevisdetect".||Spool directory|
|/var/opt/nevisadapt/logs/nevisadapt.stdout||The system redirects stdout to this file.|
|/var/opt/nevisadapt/conf/nevisadapt.properties||nevisAdapt service configuration file.|
|/var/opt/nevisadapt/conf/riskscore-mapping.properties||Configuration file for the risk score mapping.|
|/var/opt/nevisadapt/conf/nevisadapt-exec.conf||Configuration file for the init.d service.|
|/var/opt/nevisadapt/conf/logback.xml||logback configuration file.|
|/var/opt/nevisadapt/conf/role-to-permission.properties||Role-to-permission mapping file.|
Software package installation - nevisAdapt service
To install the nevisAdapt service, proceed with the next steps.
The installation of the nevisAdapt plug-in is described further below.
- Execute the following commands to install the component's software package:
rpm -i nevisadapt-<version>.noarch.rpm
rpm -i nevisdetectcl-<version>.noarch.rpm
During the installation, the following happens:
Registration of the component as
init.dservice with the name
Creation of the spool directory structure (if not already existing).
Extraction of the following files from the file
- Administer the component with the following commands:
service nevisadapt start
service nevisadapt status
service nevisadapt stop
service nevisadapt restart
The configuration of the runtime environment of a service is located in the file nevisadapt-exec.conf.
The following sample code block illustrates the installation of the nevisAdapt service:
Installation of the nevisAdapt service
# variables used by the exec /opt/nevisadapt/bin/nevisadapt-exec.jar used by init.d
JAVA_OPTS="-Xmx1024M -XX:+UseConcMarkSweepGC -Dlogback.configurationFile=/var/opt/nevisadapt/conf/logback.xml"
# variables used by the application i.e. logback and spring
Uninstalling the software package
To uninstall the nevisAdapt components, run the following commands:
rpm -e nevisadapt-<version>.noarch
rpm -e nevisdetectcl-<version>.noarch
During the uninstalling process, the service is stopped and deregistered. The spool directory is not modified, so a subsequent installation will have the same configuration.
Considerations for Kubernetes deployment
nevisAdapt requires the real source IP addresses of the login attempts in order to determine various risk factors such as geolocation or blacklisting. The ingress must be able to provide this data by populating the X-Original-Forwarded-For request header.
Internal Kubernetes services
If the container orchestration happens with first-party services, enable the PROXY protocol in NGINX (described in Accepting the PROXY Protocol) and add the following command to the setup configuration for the ingress rules:
proxy_set_header X-Original-Forwarded-For $proxy_protocol_addr;
Kubernetes deployment with nevisAdmin4
If the container orchestration happens with nevisAdmin4, add a new
NGINX Ingress Settings to the
nevisProxy Instance under Advanced Settings / Additional Settings.
Add a new annotation with the key
nginx.ingress.kubernetes.io/configuration-snippet and value
proxy_set_header X-Original-Forwarded-For $proxy_protocol_addr;.