From IBM® MQ 9.3.5, you can run the mqweb server
that hosts the IBM MQ Console and REST API in a stand-alone IBM MQ Web Server installation.
Before you begin
The stand-alone IBM MQ Web Server is available only on
Linux®.
Before you can configure the mqweb server, you must install the IBM MQ Web Server by following the steps in Installing the stand-alone IBM MQ Web Server.
About this task
Follow the procedure in this task to create and configure a new mqweb server that runs in a
stand-alone IBM MQ Web Server installation. You can configure
more than one mqweb server to run in a stand-alone IBM MQ Web Server installation by repeating this procedure.
Procedure
- Create the IBM MQ Web Server data
directory.
The data directory is used to store the configuration and log files for the
mqweb server that runs the IBM MQ Console and REST API. You can use any directory that you choose as the
IBM MQ Web Server data directory.
The user ID that
you use to start the mqweb server must be granted read and write access to the data
directory.
- Set the MQ_OVERRIDE_DATA_PATH environment variable to the data
directory that you created in step 1.
For example, if you chose to use
/var/mqweb as your
IBM MQ Web Server data directory, issue the following
command:
export MQ_OVERRIDE_DATA_PATH=/var/mqweb
- Use the setmqenv command to set up the IBM MQ environment.
Change to the
bin directory of the
IBM MQ Web Server
installation directory, then issue the following
command:
. setmqenv -s
- Use the crtmqdir command to create the IBM MQ directories and files, in the data directory. The files
that are created include a template definition for the mqweb server.
Issue the following
command:
crtmqdir -s -f
- Optional: If this mqweb server is the first that you created to run with this
installation of the stand-alone IBM MQ Web Server, use the
mqlicense command to review and accept the IBM MQ license.
You must run this command as a user
that has write access to the IBM MQ Web Server installation
directory.
For example, issue the following command to view the
IBM MQ license:
mqlicense
- Optional: To migrate an existing mqweb server to run in the newly configured
stand-alone IBM MQ Web Server installation, complete the
following steps:
- Back up your existing mqweb server configuration.
- Restore the files into the
MQ_OVERRIDE_DATA_PATH/web/installations/MQWEBINST directory,
where MQ_OVERRIDE_DATA_PATH is the IBM MQ Web Server data directory that you created in step 1.
For more information, see
Backing up and restoring your mqweb server configuration.
Note: Some features of the
IBM MQ Console and
REST API are not available in a stand-alone
IBM MQ Web Server installation. If you migrate a mqweb server from an
IBM MQ installation to a stand-alone
IBM MQ Web Server installation, these features cannot be used after
migration. For more information about the restrictions that apply in a stand-alone
IBM MQ Web Server installation, see
The IBM MQ Console and REST API.
What to do next
Configure the mqweb server by following the steps that are described in Basic configuration for the mqweb server.