How to deploy Admin
- Esther Saurí
- Irene Hernandez
Pre-Requirements
Deploy other docker instances
Gataca Connect deployed
Gataca Certify deployed
Note: at least one of these components must be deployed, but it is not necessary that both components are deployed
Get Docker image
To deploy Admin, it’s necessary to get access to the Admin docker image. If you have no access to it, please contact Gataca.
docker pull gatacaid/gataca-admin:[VERSION]Deploying Admin Panel
Due to the security is one of our main concerns, these are the rules to secure communications:
Internal communications (internal network) SHOULD be encrypted, but it’s not mandatory.
External communication (public) SHOULD be encrypted, using a valid certificate.
Deploy container
To deploy Gataca Admin, it must be done using the docker image provided in the previous step. There are many ways to deploy the component using docker: docker daemon, docker compose, orchestrator…However, this documentation shows how to do it using docker directly.
So, to deploy the service, it’s necessary to execute the following command.
docker run -d
--name Gataca-Admin
-p 443:443
-e ADMIN_SERVER_NAME=admin.gataca.io
-e CREDENTIALS_SERVER=https://certify.gataca.io
-e CONNECT_SERVER=https://connect.gataca.io
-e DISABLE_SSL=YES
-v [path-to-certificates]:/certificates
gatacaid/gataca-admin:[VERSION]This command launches the container using the following parameters:
Parameter | Description |
|---|---|
-d | Launches the container in background mode. If this parameter is not set up, the terminal instead of exit the process, continue showing the container logs. |
--name | Set up the name of the container in the machine deployed. |
-p | Map the external and internal ports. By default, this service is running using SSL (443), so to map the service to a SSL port it could be done as in the example [443:443]. However, if the service is not running with SSL, the port by default is 80. So, the map used is [80:80].
|
-v path-to-certificates | This parameters allows the image to receive files from the host. In this case, Admin use this mechanism to obtain the certificates used in the SSL channel. Although, Gataca recommends to deploy the service using a SSL channel (443), it’s possible also to deploy the service without SSL. In that case, this parameter is not necessary. |
The table above shows the parameters to launch the container through Docker, but also it’s necessary to configure the service internally. To do this, Gataca uses environment variables shown below.
Variable | Description |
|---|---|
| URL of the subdomain where the service is deployed |
| URL of the Gataca Certify service has been deployed. |
| URL of the Gataca Connect service has been deployed. |
| [Optional] It should be YES or NO. By default, the value is NO.
|
Once the command to launch the instance is executed, if the configuration has been set correctly, this web portal could be accessed by the ADMIN_SERVER_NAME (Using https or http, depending on the configuration).