The purpose of this installation guide is to provide information on installing and configuring licensing for MapleNet™. While it would be beneficial to have some prior knowledge and experience in working with container engines, specifically the Docker container engine, the information in this guide will guide you through the entire installation process, including loading, running and stopping Docker containers.
You must have a Container Engine installed to run the MapleNet container.
The instructions in this guide are given using the Docker Container Engine. For more information, see https://docs.docker.com/engine.
For information on supported Windows, Linux, and Mac platforms see https://docs.docker.com/engine/install.
Return to the top of the MapleNet Installation and Setup Guide.
To install Docker Desktop for Windows, go to https://docs.docker.com/docker-for-windows/install/, and download Docker Desktop for Windows. You will need to sign in with a valid Docker ID to do this. Note: Running docker requires HyperV, the Windows hypervisior, be enabled. If HyperV is not enabled, as part of the install process you will be asked to enable it and restart your computer.
Follow the instructions provided on the page to install Docker Desktop for Windows.
To install Docker on Linux:
To install Docker Engine - Community for Linux, go to https://docs.docker.com/engine/install/
Scroll down the page to the Server table and find your Linux configuration in the table.
Click on the link for your configuration.
Follow instructions on the page.
To install Docker Desktop for Mac, go to https://docs.docker.com/docker-for-mac/install/, and download Docker Desktop for Mac. You will need to sign in with a valid Docker ID to do this.
Follow the instructions provided on the page to install Docker Desktop for Mac.
For Windows installation instructions, read this section.
To install MapleNet 2022.1 on your Windows operating system using a network license, read and complete the following tasks.
Double-click MapleNet2022.1WindowsX64Installer.exe from where you downloaded the file.
NOTE
Return to the top of the MapleNet Installation and Setup Guide.
For Macintosh® installation instructions, read this section.
To install MapleNet 2022.1 on your Macintosh operating system, read and complete the following tasks:
Double-click MapleNet2022.1MacInstaller.dmg from where you downloaded the file, then double-click MapleNet 2022.1 Installer.app.
NOTE
Return to the top of the MapleNet Installation and Setup Guide.
To install MapleNet 2022.1 on your 64-bit Linux® operating system, read and complete the following tasks.
Run MapleNet2022.1LinuxX64Installer.run from where you downloaded the file.
NOTE
Note: FlexNet, the license management software used in MapleNet, requires Linux systems to be LSB 3.0 compatible, which may require the additional installation of some additional packages. If you are receiving the "Error detecting HostID" error message when trying to activate MapleNet on Linux, please ensure that the appropriate packages are installed.
Return to the top of the MapleNet Installation and Setup Guide.
Before starting the Windows Network version of MapleNet 2022.1, you must obtain your license file and start the license manager by completing the following tasks.
Network licenses for MapleNet and other Maplesoft products are registered using the Network Tools program.
MapleNet 2022.1 requires a MapleNet 2022.1 license file to operate. License files for earlier versions of MapleNet do not work with MapleNet 2022.1. To obtain your license file, you must use the Maple Network Tools activation program or activate off-line by following the instructions at http://www.maplesoft.com/contact/webforms/offlineactivation/. Ensure that you can connect to the Internet as activation requires an Internet connection. If your computer does not have an Internet connection, please contact Maplesoft customer service.
The C:\Program Files\Maple Network Tools\FLEXlm\11.13.1.2\windows directory contains license manager daemons (lmgrd and maplelmg) required to run MapleNet, as well as utilities to assist you in installing and configuring FlexNet Publisher for your system.
If you intend to use a Novell® server, see Novell Networks.
To set up and start the license manager daemons on a Windows Network Server:
Service Name | Enter a name for the service (optional) |
Path to the lmgrd.exe file | C:\Program Files\Maple Network Tools\FLEXlm\11.13.1.2\windows\lmgrd.exe |
Path to the license file | C:\Program Files\Maple Network Tools\activate\MapleNet2022.lic |
Path to the debug log file: Enter the path to the directory containing the debug log file. You must create this file manually (log.txt is the manually created file in the example below), as it is not automatically generated. | C:\Program Files\Maple Network Tools\FLEXlm\11.13.1.2\windows\log.txt |
You can now use MapleNet 2022.1.
To run multiple Maplesoft products (including MapleNet), you must place all license files in the same directory. If you have other FlexNet Publisher license files stored in one central location, you can store your Maplesoft product license files there as well.
Complete the following tasks:
Using Windows Explorer, move all of the license files to a common directory, for example, C:\Program Files\Maple Network Tools\activate.
Service Name | Enter a name for the service (optional) |
Path to the lmgrd.exe file | C:\Program Files\Maple Network Tools\FLEXlm\11.13.1.2\windows\lmgrd.exe |
Path to the license file Note: The path to the license file should not contain a terminating backslash | C:\Program Files\Maple Network Tools\activate |
Path to the debug log file: Enter the path to the directory containing the debug log file. You must create this file manually (log.txt is the manually created file in the example below), as it is not automatically generated. | C:\Program Files\Maple Network Tools\FLEXlm\11.13.1.2\windows\log.txt |
You can now use your network licensed Maplesoft products.
FlexNet Publisher does not run on Novell or IPX/SPX. Follow these instructions to install the license manager on any network that is exclusively a Novell environment.
Return to the top of the MapleNet Installation and Setup Guide.
Before starting the macOS® Network version of MapleNet 2022.1, you must obtain your license file and start the license manager by completing the following tasks.
Network licenses for MapleNet and other Maplesoft products are registered using the Network Tools program.
MapleNet 2022.1 requires a MapleNet 2022.1 license file to operate. License files for earlier versions of MapleNet do not work with MapleNet 2022.1. To obtain your license file, you must use the Maple Network Tools activation program or activate off-line by following the instructions at http://www.maplesoft.com/contact/webforms/offlineactivation/. Ensure that you can connect to the Internet as activation requires an Internet connection. If your computer does not have an Internet connection, please contact Maplesoft customer service.
Before you can use MapleNet 2022.1, you must start the license server. It is recommended that you do not run lmgrd as root because any process run by root is a potential security risk.
./lmgrd -c license_file_path -l debug_log &
where license_file_path is the full path and filename of the network license file (by default, /Users/<username>/Maple Network Tools/activate/MapleNet2022.lic), and debug_log is the name of a file to which debugging information is written. The -l option (letter l, not the number 1 (one)) creates the file.
If you have any problems starting the license server in the system boot up files, refer to http://www.flexerasoftware.com.
You can now use MapleNet 2022.1.
To run multiple Maplesoft products (including MapleNet), you must place all license files in the same directory. If you have other FlexNet Publisher license files stored in one central location, you can store your Maplesoft product license files there as well.
Complete the following tasks:
Go to the location of the FlexNet Publisher utilities that are currently being used. For MapleNet 2022.1, the default location is /Users/<username>/Maple Network Tools/FLEXlm/11.13.1.2/. Enter the command:
./lmdown
Copy all the MapleNet network license files to /Users/<username>/Maple Network Tools/activate.
Note: Point to the directory only, not an actual license file.
./lmgrd -c license_file_path -l debug_log
where license_file_path is the full path to the directory containing the license files and debug_log is the name of a file to which debugging information is written. The -l option (letter l, not the number 1 (one)) creates the file.
You can now use your network licensed Maplesoft products.
Return to the top of the MapleNet Installation and Setup Guide.
Before starting the Linux Network version of MapleNet 2022.1, you must obtain your license file and start the license manager by completing the following tasks.
Network licenses for MapleNet and other Maplesoft products are registered using the Network Tools program.
MapleNet 2022.1 requires a MapleNet 2022.1 license file to operate. License files for earlier versions of MapleNet do not work with MapleNet 2022.1. To obtain your license file, you must use the Maple Network Tools activation program or activate off-line by following the instructions at http://www.maplesoft.com/contact/webforms/offlineactivation/. Ensure that you can connect to the Internet as activation requires an Internet connection. If your computer does not have an Internet connection, please contact Maplesoft customer service.
Before you can use MapleNet 2022.1, you must start the license server. It is recommended that you do not run lmgrd as root because any process run by root is a potential security risk.
Using the C Shell
To start the license manager daemon (lmgrd), enter the following command at the prompt,
./lmgrd -c license_file_path -l debug_log & |
where license_file_path is the full path and filename of the network license file (by default, $HOME/MapleNetworkTools/activate/MapleNet2022.lic) and debug_log is the name of a file to which debugging information is written. The -l option (letter l, not the number 1 (one)) creates the file.
Using the Korn or Bourne Shell
To start the license manager daemon (lmgrd), enter the following command at the prompt:
nohup lmgrd -c license_file_path -l debug_log 2>&1 & |
Run Daemons on Startup
To have the daemons run on startup, edit the appropriate boot script (such as /etc/rc.boot, /etc/rc.local, or /etc/rc2.d/Sxxxx). For example, if you run lmgrd as a boot startup script, you can run it as a regular user by using the following su command at the prompt:
su username -c \'umask 022; lmgrd_path -c license_file_path -l log_path\' |
where username is a non-privileged user; lmgrd_path is the correct path to the lmgrd file, license_file_path is the full path of the network license file (by default, $HOME/MapleNetworkTools/activate/MapleNet2022.lic), and log_path is the debug log file path. It is recommended that the network license file be called MapleNet2022.lic.
Help for Starting the License Server
If you have any problems starting the license server in the UNIX system boot up files, refer to http://www.flexerasoftware.com/.
You can now use MapleNet 2022.1.
To run multiple Maplesoft products (including MapleNet), you must place all license files in the same directory. If you have other FlexNet Publisher license files stored in one central location, you can store Maplesoft product license files there as well.
Complete the following tasks:
Go to the location of the FlexNet Publisher utilities that are currently being used. For MapleNet 2022.1, the default location is /usr/local/MapleNetworkTools/FLEXlm/11.13.1.2/. Enter the command:
./lmdown |
Copy all of the MapleNet network license files to one folder, for example, $HOME/MapleNetworkTools/activate.
Note: Point to the directory only, not an actual license file.
./lmgrd -c license_file_path -l debug_log
where license_file_path is the full path to the directory containing the license files and debug_log is the name of a file to which debugging information is written. The -l option (letter l, not the number 1 (one)) creates the file.
You can now use your network licensed Maplesoft products.
Return to the top of the MapleNet Installation and Setup Guide.
After you have installed MapleNet, next you must load the MapleNet image into Docker, from the MapleNet-2022.1.tar file.
To load the MapleNet image:
docker load --input $TARFILE |
Where $TARFILE is the path to the MapleNet-2022.1.tar file
Note: Loading the Docker image may take several minutes.
docker images |
You are now ready to start MapleNet.
Return to the top of the MapleNet Installation and Setup Guide.
To start MapleNet, run the following Docker command:
docker run --mount type=bind,source=$LICENSEFILE,target=/maple/license/license.dat,readonly --publish $HOSTPORT:8080 --rm maplesoft/maplenet:$IMAGETAG |
Where $LICENSEFILE is the path to your MapleNet license file (license.dat). For example, in the license subdirectory of your MapleNet installation directory, $HOSTPORT is the port on the host machine on which MapleNet accepts connections, and $IMAGETAG is the tag of the MapleNet Docker image created by the installer.
Note: If $LICENSEFILE contains spaces, then you must enclose the path in quotation marks. For example, source="C:\Program Files\MapleNet\MapleNet 2022.1\license.dat".
For more information on using the docker run command, see https://docs.docker.com/engine/reference/commandline/run/
Alternatively, you can specify MapleNet options using a docker compose (YAML) file:
version: "3.7"
services:
maplenet:
image: maplesoft/maplenet:$IMAGETAG
ports:
- "$HOSTPORT:8080"
volumes:
- type: "bind"
source: "$LICENSEFILE"
target: "/maple/license/license.dat"
read_only: true
The command used to deploy MapleNet in this case is:
docker stack deploy maplenet --compose-file <path to above file> |
To view the MapleNet landing page, in a web browser, type http://$HOSTADDRESS:8080, where $HOSTADDRESS is the ip address or machine name of the machine running the Docker container, and press Enter.
For more information on the docker stack command, see https://docs.docker.com/engine/reference/commandline/stack/
For more information on docker compose files, see https://docs.docker.com/compose/gettingstarted/
Return to the top of the MapleNet Installation and Setup Guide.
To stop the MapleNet Server:
docker container ls |
to list your running containers. Find the running MapleNet server container ID in the list.
docker stop $CONTAINERID |
Where $CONTAINERID is the MapleNet container ID found in the previous step.
For more information on the docker stop command see https://docs.docker.com/engine/reference/commandline/stop/
Return to the top of the MapleNet Installation and Setup Guide.
Platform | RAM | Hard Disk |
Windows 10 Pro, Enterprise, or Education | 8 GB | 10 GB |
Note: Hyper-V must be enabled.
Platform | RAM | Hard Disk |
Red Hat Enterprise Linux 7.7, 8 | 8 GB | 10 GB |
SUSE Linux Enterprise Desktop 15 | 8 GB | 10 GB |
Ubuntu 20.04 LTS, 21.10 | 8 GB | 10 GB |
Vendor | CPU | Operating System | Version | RAM | Hard Disk |
Apple | 64-bit Intel | macOS | 10.15, 11, 12 | 8 GB | 10 GB |
Apple | ARM64 | macOS | 11, 12 | 8 GB | 10 GB |
Return to the top of the MapleNet Installation and Setup Guide.
Resource | Description |
MapleNet Installation Guide | System requirements and installation instructions for MapleNet. The MapleNet Installation Guide is available in the Install.html file located either on your MapleNet installation DVD or the folder where you installed MapleNet. |
MapleNet Administrator Guide | Instructions for using environment variables to configure the MapleNet server. Security issues are also discussed. |
MapleNet Services Guide | Outline of MapleNet services. Information on limitations of services provided as well as a summary of MapleNet API endpoints. |
MapleNet API Programming Guide | A detailed description of the MapleNet API with examples. |
For additional resources visit https://www.maplesoft.com/site_resources
To request customer support or technical support, visit https://www.maplesoft.com/support
Maplesoft welcomes your feedback. For comments related to the MapleNet product documentation, contact doc@maplesoft.com.
Return to the top of the MapleNet Installation and Setup Guide.
Maple, MapleNet, Maplet and Maplesoft are trademarks of Waterloo Maple Inc.
Microsoft and Windows are registered trademarks of Microsoft Corporation.
Docker is a registered trademark of Docker Inc.
Java and all Java-based marks are trademarks or registered trademarks of Oracle and/or its affiliates.
All other brand names or product names are trademarks or registered trademarks of their respective companies.
Return to the top of the MapleNet Installation and Setup Guide.