Skip to content

Latest commit

 

History

History
109 lines (68 loc) · 3.41 KB

README.md

File metadata and controls

109 lines (68 loc) · 3.41 KB

Intelbras's SIG Application with Docker

Prerequisites Before you begin, ensure you have the following packages installed on your system:

  • Git version 2.34.1
  • Docker version 24.0.6, build ed223bc
  • Docker Compose version v2.21.0

Getting Started:

First, copy the line below and paste on your prompt to clone the repository:

git clone https://github.com/arthurcadore/capacita-sig

If you don't have installed the package Git yet, do it before try to clone the respository!

Navigate to the project directory:

cd ./capacita-sig

If you don't have Docker (and Docker-compose) installed on your system yet, it can be installed by run the following commands (Script for Ubuntu 22.04):

./docker/installDocker.sh

If you had to install docker, please remember to reboot you machine to grant user privileges for docker application.

In sequence, configure the environment variables for the application container, you can do this by edditing the docker-compose.yml file:

    environment:
      - DATABASE_IP=database
      - DATABASE_USER=youruser
      - DATABASE_PASS=yourpassword

Here, you need to configure the IP-address of your database, user and password. If you wanna to save in database externally, just point the new database IP-address.

Once you had configured the database user/password, go to ./database/setup.sql file to match this parameters in the script that will configure the database container.

-- Create a new user with the password specified:
CREATE USER youruser WITH PASSWORD 'yourpassword';

-- Alter ownership of the 'imn' database to youruser:
ALTER DATABASE imn OWNER TO youruser;

-- Allow your user to connect from any host
ALTER USER youruser WITH SUPERUSER;

Change all youruser strings with your username, and all yourpassword strings with your password.

Start Application's Container:

Run the command below to start docker-compose file:

docker compose up &

The "&" character creates a process id for the command inputed in, with means that the container will not stop when you close the terminal.

Access Application:

Once the container is up and running, you can access the application at the http://127.0.0.1:8081, as defined in the docker-compose.yml file.

By default, the CLI access to the container is closed, so nobody can access it externally, only the application web Page.

To access the application command line, first loggin into host device using SSH or another method, then use the command below:

docker exec -it sig-capacita bash

The command above will start a bash process in the application container, that with the -it (interative) flag will display the prompt to user.

To exit from container's command line interface, use the command exit.

Access Application database:

By default, docker-compose.yml comes with a port mapping to expose the PostgreSQL port from database's container externally. The default port to PostgreSQL DB (which is the same that is mapped externally by default) is 5432.

So, to access the application database you can use any SQL client software, as HeidiSQL for example, the credentials are configured in ./database/setup.sql.

Stop Container:

To stop the running container, use the following command:

docker-compose down

This command stops and removes the containers, networks, defined in the docker-compose.yml file.