https://github.com/irods-contrib/metalnx-web
Metalnx Web Application
https://github.com/irods-contrib/metalnx-web
administration docker irods metadata-management metalnx-web
Last synced: about 2 months ago
JSON representation
Metalnx Web Application
- Host: GitHub
- URL: https://github.com/irods-contrib/metalnx-web
- Owner: irods-contrib
- License: bsd-3-clause
- Created: 2016-06-06T22:09:55.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2025-03-24T21:17:38.000Z (2 months ago)
- Last Synced: 2025-03-24T22:24:41.777Z (2 months ago)
- Topics: administration, docker, irods, metadata-management, metalnx-web
- Language: JavaScript
- Homepage: https://metalnx.github.io/
- Size: 9.62 MB
- Stars: 37
- Watchers: 10
- Forks: 36
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Roadmap: roadmap.md
Awesome Lists containing this project
- awesome-repositories - irods-contrib/metalnx-web - Metalnx Web Application (JavaScript)
README
Metalnx is a web application designed to work alongside [iRODS](https://irods.org). 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.
## Deploying Packaged Metalnx via docker-compose
docker-compose.yml
```
version: '3'
services:
metalnx:
image: irods/metalnx:latest
restart: always
volumes:
- ./metalnx-configuration:/etc/irods-ext
ports:
- 80:8080
```
and then the `./metalnx-configuration/metalnx.properties` file requires rodsadmin iRODS connection credentials.
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 metalnx-configuration can be found in [docker-test-framework/etc/irods-ext](./docker-test-framework/etc/irods-ext).
## Deploying Packaged Metalnx via Docker Hub directly
### Prepare the application
[Configuration](CONFIGURATION.md) of the default application can change many things about how Metalnx looks and behaves.
- Configuration of Zone information, and features to display
- Theming with custom CSS/Logo
Create a copy of the default [docker-test-framework/etc/irods-ext](./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...
## Building Metalnx
From source, the package will 'just build':
```
make
```
This will result in a new Docker image named `myimages/metalnx:latest` on your machine.
## Deploying Built Metalnx
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 information
More documentation can be found in the [Docs](docs) directory.
### Copyright and License
Copyright © 2018-2021 University of North Carolina at Chapel Hill; 2015-2017, Dell EMC.
This software is provided under the [BSD-3 License](LICENSE.md).