UCRM - How to Use Ports in UCRM

Overview


This article will guide users in how to use the different ports in the UCRM application.

Table of Contents


  1. Using Ports in UCRM
  2. How to Set Up the Ports for the First Run
  3. How to Change Ports Later
    1. Edit the ports in the UCRM docker container 
    2. Edit the ports in the UCRM app
  4. Related Articles

Using Ports in UCRM


Back to Top

UCRM is installed as a local application on a WISP server. The installation uses docker container which exposes two ports:

  • Server port: your UCRM is accessible on this port.
  • Server suspension port: the suspended (walled garden) page is accessible on this port and this port will also be used in the Firewall/NAT rules on your routers. Note: all requests from non-paying customers are redirected to this port.

It is a WISP's responsibility to ensure that no other service is listening on the same port numbers as specified by UCRM. You can set these ports during the installation of UCRM or you can change these ports anytime in the future. See the guide below.

Note that typically you will not need to handle the ports and just confirm the usage of the default ports 80 and 81 during the first run of UCRM.

How to Set Up the Ports for the First Run


Back to Top

During the first installation of UCRM a WISP is asked whether or not they agree with using port 80 as the Server port and port 81 as the Server suspension port. For example if there is no other service listening on these ports within the same server the UCRM is installed on. If not, WISP can optionally use ports 8080 and 8081 respectively.

How to Change Ports Later


Back to Top

In some cases, you may find that using the default ports (80, 81) is impossible and you will need to change them. These are the two steps to follow to do so:

Step 1 - Edit the ports in the UCRM docker container

First, you have to ensure that the UCRM docker container is listening on the proper port number on your server. You will need to set it up in your docker setting file. Follow these steps to do so:

  1. Go to /home/ucrm on the server UCRM is running on
  2. Backup your docker-compose.yml
  3. Open docker-compose.yml
  4. Change these ports to those you need in web_app section.

    For example: If you need to open port 8080 you would use 8080:80. If you need port 80 to be opened, you would use 80:80
  1. Save the file and restart docker containers using these commands:
cd /home/ucrm
sudo docker-compose up -d

Step 2 - Edit the ports in UCRM app

Now you can access UCRM. Note that you must use the new port number in the url, i.e. http://localhost:8080 if you changed the port to 8080 in the previous step.

  1. Go to UCRM System > Settings > Application.
  2. Provide new port numbers for Server port and Server suspension port.
  3. Save the form.

This will set up the port numbers inside the UCRM app, as well as updating your router Firewall/NAT rules.

Note: in the case of EdgeOS you must edit the Firewall/NAT rules manually. To learn how to do so, read our UCRM - Setting Up Network Devices article. 

Related Articles


Back to Top

Powered by Zendesk