Skip to content

INSTALL.md

Latest commit

 

History

History
138 lines (95 loc) · 3.6 KB

INSTALL.md

File metadata and controls

138 lines (95 loc) · 3.6 KB

ITP Install

This guide describes how to install the interoperability test platform.

Install

  1. Download the install.sh script from ITP Github repository.

    curl -o install.sh https://raw.githubusercontent.com/gsmainclusivetechlab/interop-test-platform/develop/install.sh
chmod a+x install.sh

  2. Run the install.sh script.

    ./install.sh interop

  3. We the installation is done, you should see something like this:

    💻 The installation of the Interoperability Test Platform is finished! ✅

Some information about your environment:
🌐 interop console: http://localhost
👤 username: superadmin@gsma.com
🔑 password: <REDACTED>

MySQL database and credential:
🗄️ database: interop-db
👤 username: interop-user
🔑 password: <REDACTED>
🔑 rootpass: <REDACTED>

➡️  More information about the project on GitHub Repository:
🌐 https://github.com/gsmainclusivetechlab/interop-test-platform

Management

  1. See if ITP is running.

    cd interop
docker-compose ps

    Result:

    Name                     Command                   State                                             Ports
Name                     Command                   State                                             Ports
Name                     Command                   State                                             Ports
-----------------------------------------------------------------------------------------------------------------------------------------------------
interop_app_1       docker-php-entrypoint /usr ...   Up (healthy)     0.0.0.0:80->8080/tcp,:::80->8080/tcp, 0.0.0.0:443->8443/tcp,:::443->8443/tcp,9000/tcp
interop_mailhog_1   MailHog                          Up               1025/tcp, 0.0.0.0:8086->8025/tcp,:::8086->8025/tcp
interop_mysqldb_1   docker-entrypoint.sh mysqld      Up (healthy)     3306/tcp, 33060/tcp
interop_queue_1     docker-php-entrypoint /usr ...   Up (unhealthy)   8080/tcp, 9000/tcp
interop_redis_1     docker-entrypoint.sh redis ...   Up               6379/tcp

  2. Start ITP.

    cd interop
docker-compose up -d

    Result:

    Starting interop_mailhog_1 ... done
Starting interop_mysqldb_1 ... done
Starting interop_redis_1   ... done
Starting interop_app_1     ... done
Starting interop_queue_1   ... done

  3. Stop ITP.

    cd interop
docker-compose stop

    Result:

    Stopping interop_app_1     ... done
Stopping interop_queue_1   ... done
Stopping interop_mysqldb_1 ... done
Stopping interop_redis_1   ... done
Stopping interop_mailhog_1 ... done

Uninstall

  1. Removing ITP.

    ⚠️ This will remove ITP and all data.

    cd interop
docker-compose down --rmi all -v
cd .. && rm -rf interop

Q/A and Troubleshooting

Q: ❌ docker is required.

A: Install Docker.

Q: ❌ docker-compose is required.

A: Install docker-compose.

Q: ❌ mkdir: cannot create directory ‘interop’: File exists

A: You have started the Install process already.

  1. If the installation has succeeded, check if ITP is Running. If not, try to Start ITP.
  2. If the installation has failed, try to Uninstall and the Install ITP again.

Q: Installation has failed for any reason.

A: Try to Uninstall and then Install again.