UCRM - Installation Guide

 Overview


Welcome to the UCRM Installation guide. UCRM can be deployed as a docker image on your own server. Please, choose your system from the Table of Contents below and follow the instructions for an easy install.

Table of Contents


  1. Ubuntu 16.04 (LTS)
  2. Debian 8.4
  3. Windows & OS X
  4. Custom Installation Configuration
  5. Initial UCRM Setup
  6. Related Articles

Ubuntu 16.04 (LTS)


Back to Top

Run this single command to install the docker, pull the UCRM image and install it in the default configuration mode. If you need to define custom ports or docker subnets, read the Installation guide for advanced users below.:

curl -fsSL https://raw.githubusercontent.com/U-CRM/billing/master/install.sh > /tmp/ucrm_install.sh && sudo bash /tmp/ucrm_install.sh 
NOTE:

By default, the installation script ensures that the application data (database, pictures, invoices, encryption key, etc.) will be stored outside the docker container (/home/ucrm/data). This will enable you to backup that data and more importantly, this will enable you to perform any future UCRM upgrades without any data loss

If you want to define your custom parameters for the installation, proceed to the Custom Installation Configuration below.

When the installation is done, proceed to the Initial UCRM Setup.


Debian 8.4


Back to Top

Run these commands to download and run the installation script which will install the docker, then pull the UCRM image and start it.

su root
apt-get update
apt-get install curl -y
curl -fsSL https://raw.githubusercontent.com/U-CRM/billing/master/install.sh > /tmp/ucrm_install.sh && bash /tmp/ucrm_install.sh
NOTE:

By default, the installation script ensures that the application data (database, pictures, invoices, encryption key, etc.) will be stored outside the docker container (/home/ucrm/data). This will enable you to backup that data and more importantly, this will enable you to perform any future UCRM upgrades without any data loss.

If you want to define your custom parameters for the installation, proceed to the Custom Installation Configuration below.

When the installation is done, proceed to the Initial UCRM Setup.


Windows & OS X


Back to Top

Unfortunately, Docker does not provide full support for these systems. Thus, we can't ensure smooth backups and upgrades. At this moment we recommend to install VirtualBox with latest version of Ubuntu and then follow the Ubuntu instructions above.


Custom Installation Configuration


Back to Top

By default, UCRM is configured with ports 80, 443 for web application and 81 for suspended clients' redirection and with few other default parameters. If you want to configure your custom installation, you can append some or all of these parameters:

  • --http-port, for example: 8080
  • --https-port, for example: 8443
  • --suspension-port, for example: 8081
  • --netflow-port, for example: 2055
  • --version, for example: 2.6.0
  • --subnet, for example: 192.168.80.1/24
  • --subnet-internal, for example: 192.168.90.1/24
  • --ucrm-user, for example: ucrm 

Example of UCRM installation with ports 8080 / 8443 / 8081:

Ubuntu 16.04 (LTS)

curl -fsSL https://raw.githubusercontent.com/U-CRM/billing/master/install.sh > /tmp/ucrm_install.sh
sudo bash /tmp/ucrm_install.sh --http-port 8080 --https-port 8443 --suspension-port 8081

Debian 8.4

su root
apt-get update
apt-get install curl -y
curl -fsSL https://raw.githubusercontent.com/U-CRM/billing/master/install.sh > /tmp/ucrm_install.sh
bash /tmp/ucrm_install.sh --http-port 8080 --https-port 8443 --suspension-port 8081
NOTE:

You can change ports at any time, see this guide:UCRM - How to Use Ports in UCRM. Additionally, to learn how to configure docker subnets, please see this article: UCRM - Customizing Docker Subnet


Initial UCRM Setup


Back to Top

  • When installed with default ports, UCRM can be found at http://localhost/.
  • As of version 2.6.0, for the first login you need to use the initial credentials generated as soon as the installation script finishes. The installation script output will look like this:
Initial login information:
Username: admin
Password: wd3e71k

The initial credentials can be also viewed in /home/ucrm/docker-compose.env file.

  • You will be asked to set up your own password to proceed to the initial UCRM setup wizard.

Related Articles


Back to Top

UCRM Billing - Install UCRM Cloud using DigitalOcean

UCRM - How to Use Ports in UCRM

UCRM - Customizing Docker Subnet