Metalnx is a web application designed to work alongside iRODS. It is a graphical user interface and serves as a client that authenticates to an existing iRODS Zone.

The preferred method of deployment is via Docker.

docker-compose.yml

services:

  metalnx:
    image: irods/metalnx:latest
    restart: always
    volumes:
      - ./metalnx-configuration:/etc/irods-ext
    ports:
      - 80:8080

Metalnx will be available on port 80 of the docker host machine at /metalnx.

This configuration could be supplemented with an nginx (or other) reverse-proxy to put Metalnx port 80 (and the subpath /metalnx) behind https on 443.

Examples of the configuration can be found in docker-test-framework/etc/irods-ext.

Configuration of the application can change many things about how Metalnx looks and behaves.

• Pre-defined zone information
• Features to display
• Theming with custom logo and/or CSS

The majority of configuration is handled with the required metalnx.properties file. It controls the optional behaviors and customizations with the exception of theming (custom images, banners, css, messages).

Theming via assets is controlled by the required metalnxConfig.xml file. The provided file will cause the default theme and messages to be utilized.

Create a copy of the default docker-test-framework/etc/irods-ext directory and update metalnx.properties and metalnxConfig.xml, and then run a container with the new configuration, probably with --add-host information due to Docker:

docker run -d \
  -p 8080:8080 \
  -v `pwd`/mylocal-irods-ext:/etc/irods-ext \
  --add-host hostcomputer:172.17.0.1 \
  --name metalnx \
  irods/metalnx:latest

To map a local directory with SSL certificates (self-signed or from a CA), the container will look in /tmp/cert:

 -v `pwd`/mylocal-certs:/tmp/cert \

The login screen should appear when requested in a web browser:

http://x.x.x.x:8080/metalnx

Or...

From source, the package will 'just build':

make

This will result in a new Docker image named myimages/metalnx:latest on your machine.

If you're deploying your own image (built just above):

docker run -d \
  -p 8080:8080 \
  -v `pwd`/mylocal-irods-ext:/etc/irods-ext \
  --add-host hostcomputer:172.17.0.1 \
  --name metalnx \
  myimages/metalnx:latest

More documentation can be found in the Docs directory.

Copyright © 2018 University of North Carolina at Chapel Hill; 2015 Dell EMC.

This software is provided under the BSD-3 License.