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
First, copy the line below and paste on your prompt to clone the repository:
git clone -b api-client-integrated https://github.com/arthurcadore/capacita-sig-cloud
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-cloud
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
To start the application container, first of all, configure the .env file located at ./api directory, the file has the following structure:
EMAIL=SEU-EMAIL
PASSWORD=SUA-SENHA
NOMELOCAL=SUA-LOCALIZACAO
Change SEU-EMAIL with your email address, SUA-SENHA with your password, and NOMELOCAL with the zone name that you have configured in the sig-cloud website.
Once you have configured the .env file, you can run the command below to start the container by 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.
Once the container is up and running, you can access the application sig-cloud website.
By default, the CLI access to the container is closed, so nobody can access it externally, only by the application web Page on cloud.
To access the application command line, for debugging, first loggin into host device using SSH or another method, then use the command below:
docker exec -it sigCloud-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.
Once the application has started, the ./logs will be generated by container volume mapping, and the sig-cloud logs will be writing directly to these files. For illustration, in the diagram below (tree command), the new directory and files are exposed.
.
├── api
│ ├── find-aplicacao
│ └── find-token
├── auth
├── docker
│ ├── Dockerfile
│ ├── installDocker.sh
│ └── startup.sh
├── docker-compose.yml
├── LICENSE
├── logs
│ └── eponadapter.log
├── README.md
└── src
└── eponadapter.jar
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.