{"type":"doc","content":[{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"This guide provides instructions for deploying NMIS Suite with NMIS 9 and commercial Modules with optional Apache reverse proxy configuration. The solution can be deployed either with a containerized MongoDB instance or configured to use an external MongoDB server.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Prerequisites","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Access to the internet to pull the latest, this is currently :v1.0 container image","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Docker Engine (20.10.0 or newer)","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Minimum Resource Requirements","type":"text"}]},{"type":"paragraph","content":[{"text":"*please note these are a bare minimum, and resource requirements for production environments will depend upon the number of nodes being monitored ","type":"text","marks":[{"type":"em"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RAM: 2GB dedicated for the NMIS container","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Storage:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1GB for container image (840MB image size + buffer)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Additional storage for logs and data (recommend minimum 10GB)","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Network: Active internet connection for pulling images and updates","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Additional Requirements for Full Stack (Docker Compose)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MongoDB Container:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Additional 1GB RAM minimum","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"10GB storage for database files","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Total system RAM: 4GB minimum","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Deployment Steps","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Docker Compose","type":"text"}]},{"type":"paragraph","content":[{"text":"Please refer to the section ‘Using your own configuration’ below if you wish to take and use the default configs from the container to modify and then m ount in or just your own","type":"text","marks":[{"type":"em"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Pull the NMIS image:","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"docker pull public.ecr.aws/n2x4v8j4/firstwave/nmis9_omk:v1.0","type":"text"}]},{"type":"orderedList","attrs":{"order":2},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create ","type":"text"},{"text":"docker-compose.yaml","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"yaml"},"content":[{"text":"version: '3.4'\n\nservices:\n mongo:\n image: mongo:4.4\n restart: always\n healthcheck:\n test: echo 'db.runCommand(\"ping\").ok' | mongo mongo:27017/test --quiet\n interval: 60s\n timeout: 60s\n retries: 5\n start_period: 60s\n environment:\n MONGO_INITDB_ROOT_USERNAME: root\n MONGO_INITDB_ROOT_PASSWORD: example\n volumes:\n - mongo_data:/var/lib/mongodb\n networks:\n - backend\n\n nmis:\n image: public.ecr.aws/n2x4v8j4/firstwave/nmis9_omk:v1.0\n restart: always\n environment:\n NMIS_DB_USERNAME: root\n NMIS_DB_PASSWORD: example\n NMIS_DB_SERVER: mongo\n NMIS_SERVER_NAME: example-host-1\n depends_on:\n mongo:\n condition: service_healthy\n volumes:\n - log_data:/usr/local/nmis9/logs\n - var_data:/usr/local/nmis9/var\n - conf_data:/usr/local/nmis9/conf\n - database_data:/usr/local/nmis9/database\n# You can mount your own config files into volumes in the container but \n# you must ensure that the db config details match whats in this compose file\n# - ./app_conf/Config.nmis:/usr/local/nmis9/conf/Config.nmis\n# - ./app_conf/opCommon.json:/usr/local/omk/conf/opCommon.json\n# - ./app_conf/opLicense.json:/usr/local/omk/conf/opLicense.json\n ports:\n - \"8080:8080\"\n - \"8042:8042\"\n networks:\n - backend\n\nnetworks:\n backend:\n\nvolumes:\n log_data:\n var_data:\n conf_data:\n database_data:\n mongo_data:","type":"text"}]},{"type":"orderedList","attrs":{"order":3},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Start the services:","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"docker compose up --file docker-compose.yaml","type":"text"}]},{"type":"orderedList","attrs":{"order":4},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Monitor deployment:","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"docker compose ps\ndocker compose logs -f","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Connecting to the application ","type":"text"}]},{"type":"paragraph","content":[{"text":"Once the container is running, go to ","type":"text"},{"text":"http://your.ip.or.localhost:8080/cgi-nmis9/nmiscgi.pl","type":"text","marks":[{"type":"link","attrs":{"href":"http://your.ip.or.localhost:8080/cgi-nmis9/nmiscgi.pl"}}]},{"text":" to reach the NMIS application","type":"text"}]},{"type":"paragraph","content":[{"text":"To reach the rest of the modules, go to ","type":"text"},{"text":"http://your.ip.or.localhost:8042/omk","type":"text","marks":[{"type":"link","attrs":{"href":"http://your.ip.or.localhost:8042/omk"}}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"To connect when using a reverse proxy see below.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Using your own configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"The container already persists the /conf directory and the three files below.","type":"text"}]},{"type":"paragraph","content":[{"text":"The easiest way to use your own configuartion with docker is to mount in your own. The items you will mainly want to mount in will be:","type":"text"}]},{"type":"paragraph","content":[{"text":"Config.nmis","type":"text"}]},{"type":"paragraph","content":[{"text":"opCommon.json","type":"text"}]},{"type":"paragraph","content":[{"text":"and opLicense.json","type":"text"}]},{"type":"paragraph","content":[{"text":"But you can extend this to any file you want which is used by the nmis system, to do this:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"create a directory named app_conf (if you didn’t before) in the same directory you created the compose file in:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"mkdir -p appconf\ncd appconf\nsudo cp /path/to/Config.nmis .\nsudo cp /path/to/opCommon.json .\nsudo cp /path/to/opLicense.json .","type":"text"}]},{"type":"orderedList","attrs":{"order":2},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"uncomment out the app_conf volume mounts in the compose file","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Restart the the containers","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"If you wish to use the default configs that work out of the box with the containers, and modify them, you can copy them from the containers to your local machine.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"make the appconf directory to store them in, where you will mount them from later","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"exec into your container and copy the configuration files to a directory on your host machine:","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"docker exec -it bash -c \"mkdir -p /tmp/configs && cp /usr/local/nmis9/conf/Config.nmis /usr/local/omk/conf/opCommon.json /usr/local/omk/conf/opLicense.json /tmp/configs/\"\ndocker cp :/tmp/configs/. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Replace ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" with your actual container name (likely \"nmis\" based on your compose file).","type":"text"}]},{"type":"paragraph","content":[{"text":"The command:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Creates a temporary directory inside the container","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copies all three config files to that directory","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Uses ","type":"text"},{"text":"docker cp","type":"text","marks":[{"type":"code"}]},{"text":" to copy the files from the container to your host at ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"If you need to find your container name first, you can run:","type":"text"}]},{"type":"paragraph","content":[{"text":"docker ps | grep nmis","type":"text","marks":[{"type":"code"}]}]},{"type":"orderedList","attrs":{"order":3},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"once you have the default configs in the appconf dir - uncomment out the appconf volume mounts in the compose file and restart the container stack","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Apache Reverse Proxy Configuration (Optional)","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Prerequisites","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Apache2 with required modules (if using reverse proxy):","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"mod_ssl","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"mod_proxy","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"mod_proxy_http","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"mod_headers","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SSL certificates (if using HTTPS)","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enable required Apache modules:","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"sudo a2enmod ssl proxy proxy_http headers\nsudo systemctl restart apache2","type":"text"}]},{"type":"orderedList","attrs":{"order":2},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create virtual host configuration, using the following template, substituting your domain name for ","type":"text"},{"text":"nmis.example.com","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"apache"},"content":[{"text":"# /etc/apache2/sites-available/nmis.conf\n\n ServerName nmis.example.com\n Redirect permanent / \n\n\n\n ServerName nmis.example.com\n \n SSLEngine on\n SSLCertificateFile /etc/ssl/certs/nmis.crt\n SSLCertificateKeyFile /etc/ssl/private/nmis.key\n \n # Security headers\n Header always set Strict-Transport-Security \"max-age=31536000; includeSubDomains\"\n Header always set X-Frame-Options \"SAMEORIGIN\"\n Header always set X-XSS-Protection \"1; mode=block\"\n Header always set X-Content-Type-Options \"nosniff\"\n \n # Logging configuration\n ErrorLog ${APACHE_LOG_DIR}/nmis_error.log\n CustomLog ${APACHE_LOG_DIR}/nmis_access.log combined\n \n ProxyPreserveHost On\n \n # NMIS Web Interface\n ProxyPass / \n ProxyPassReverse / \n \n # OMK Interface\n ProxyPass /omk/ \n ProxyPassReverse /omk/ \n","type":"text"}]},{"type":"orderedList","attrs":{"order":3},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enable virtual host:","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"sudo a2ensite nmis.conf\nsudo systemctl reload apache2","type":"text"}]},{"type":"orderedList","attrs":{"order":4},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To connect to the the application:","type":"text"},{"type":"hardBreak"},{"text":"Once the container is running, go to https://","type":"text"},{"text":"nmis.example.com","type":"text","marks":[{"type":"strong"}]},{"text":"/omk to reach the NMIS application","type":"text"}]},{"type":"paragraph","content":[{"text":"To reach the rest of the modules, go to https://","type":"text"},{"text":"nmis.example.com","type":"text","marks":[{"type":"strong"}]},{"text":"/omk ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Common Issues and Troubleshooting","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"MongoDB Connection Issues:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Verify MongoDB container: ","type":"text"},{"text":"docker compose ps","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check MongoDB logs: ","type":"text"},{"text":"docker compose logs mongo","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Verify credentials in environment variables","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Apache Proxy Issues:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check Apache error logs: ","type":"text"},{"text":"tail -f /var/log/apache2/error.log","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Verify SSL certificate paths and permissions","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check SELinux policies if applicable","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Security Considerations","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Change default passwords:","type":"text"}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MongoDB root password","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"NMIS admin credentials","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"**","type":"text"},{"text":"Important - to change the mongo password - please change it in the mongo database before changing any configurations or environment variables","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"docker exec -it container_name mongo -u root -p example","type":"text"}]},{"type":"paragraph","content":[{"text":"use admin","type":"text"},{"type":"hardBreak"},{"text":"db.changeUserPassword(\"root\", \"new_password\")","type":"text"},{"type":"hardBreak"},{"text":"exit","type":"text"}]},{"type":"orderedList","attrs":{"order":2},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SSL/TLS Configuration:","type":"text"}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use strong SSL protocols (TLSv1.2+)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Regularly update SSL certificates","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Implement proper cipher suites","type":"text"}]}]}]},{"type":"orderedList","attrs":{"order":3},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Network Security:","type":"text"}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Implement proper firewall rules","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Regular security updates","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Maintenance","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Backup Strategy:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"# Backup MongoDB data\ndocker compose exec mongo mongodump --out /backup\n\n# Backup configuration files\ntar -czf nmis_config_backup.tar.gz app_conf/","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Updates:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"# Pull latest images\ndocker compose pull\n\n# Restart services\ndocker compose down\ndocker compose up -d","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Advanced Configuration","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"External MongoDB","type":"text"}]},{"type":"paragraph","content":[{"text":"To use an external MongoDB instance:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Remove the ","type":"text"},{"text":"mongo","type":"text","marks":[{"type":"code"}]},{"text":" service from docker-compose.yaml","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update NMIS environment variables with external MongoDB details","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ensure proper network connectivity and authentication","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Custom Networking","type":"text"}]},{"type":"paragraph","content":[{"text":"For enhanced security:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use custom network ranges","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Implement network segmentation","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add additional security layers (WAF, IDS)","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Support and Resources","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"NMIS Documentation: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://docs.community.firstwave.com/wiki/spaces/NMIS/pages/3165689241"}},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Docker Documentation: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://docs.docker.com"}},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MongoDB Documentation: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://docs.mongodb.com"}},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Apache Documentation: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://httpd.apache.org/docs/"}},{"text":" ","type":"text"}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported