ogticrd / xroad-members

Repositorio que reúne las herramientas necesarias para incluirse como miembro de la Plataforma Única de Interoperabilidad del Estado Dominicano en la versión 7.2 o superior

Repositorio de miembros de la Plataforma Única de Interoperabilidad del Estado Dominicano

Indice

1. 🏠 Introducción
2. 📃 Requisitos
3. 👷‍♂️ Instalación
4. 🧰 Configuración
5. 💻 Crear subsistema
6. ✍️ Crear servicio
7. 🤝 Otorgar acceso

Otros

1. Notas Adicionales
2. Desinstalación

Introducción a XRoad y la Plataforma Única de Interoperabilidad

X-Road es un marco de interoperabilidad diseñado para permitir la comunicación segura entre sistemas diferentes en entornos gubernamentales y empresariales. X-Road ayuda a superar los desafíos que supone la interoperabilidad entre entidades facilitando la comunicación segura entre ellos y brindando un mecanismo estándar para el intercambio de datos.

Esta documentación apoyará a las entidades en la instalación, configuración e inscripción como miembro de la Plataforma Única de Interoperabilidad. Una vez completado estos pasos podrá hacer uso de la misma y disfrutar de todos sus beneficios.

Requisitos

Antes de iniciar debe asegurarse que cumple con los siguientes requisitos:

• Servidor virtual con Ubuntu 22.04 LTS (al menos 2-4cpu, 3-4GB RAM, +20GB SSD)
• Subdominio público (ss1.dominio.de.la.institucion - ej: ss1.ogtic.gob.do)
• El servidor debe poder acceder a internet
• El servidor debe poder ser accedido desde internet por los puertos: 5500, 5577
• El servidor debe poder ser accedido desde la red local por los puertos: 443, 4000

Instalación

Aprovechamos la tecnología de contenedores para realizar el despliegue del servidor de seguridad.

1. Necesitaremos docker y docker compose. Procederemos a instalarlo mediante la herramienta "snap":

sudo snap install docker

2. Descargamos este mismo repositorio con el siguiente comando:

git clone https://github.com/opticrd/xroad-members.git

3. Accedemos al directorio del repositorio que acabamos de descargar:

cd xroad-members

4. Creamos nuestro archivo de configuración a partir del archivo plantilla que se encuentra en el repositorio:

cp .env.example .env

5. Editamos la configuración (con nano, vim o el editor de su preferencia):

nano .env

En este archivo encontrará las configuraciones básicas a realizar. Debe cambiar al menos el PIN y el Password del usuario administrador. Si cambia el nombre de usuario no debe usar "xroad" por ser un usuario existente utilizado para tareas del sistema.

6. Por último, procedemos a lanzar la aplicación:

sudo docker-compose up -d

Si todo se ejecutó satisfactoriamente debería poder entrar a la interfaz de la aplicación desde un navegador web entrando a subdominio:4000.

Con esto queda completado el proceso de instalación. El próximo paso es configurar e incluirse como miembro de la plataforma.

Ir a la guía de configuración

Notas Adicionales:

• Si luego de completar el proceso no puede ver la intefaz de inicio de sesión en el navegador mostrado en el último paso de la guía de instalación, diríjase a la sesión de problemas frecuentes.
• En caso de que necesite revertir todo el proceso de instalación puede ir a la guía de desinstalación.

Desinstalación

En caso de que necesite revertir todo el proceso de instalación se puede realizar eliminando el contenedor desplegado en la instalación y adicionalmente borrar los volumenes donde se encuentran todos los archivos de configuración y los datos que había recopilado en la plataforma hasta el momento.

Primero debe buscar el directorio (o carpeta) donde descargó el repositorio al momento de la instalación. Una vez entre al directorio del repositorio descargado debe encontrar el archivo "docker-compose.yml". En ese caso está listo para proceder con la desintalación con los siguientes comandos:

sudo docker-compose down -v;

Con esto ha quedado completamente eliminado del sistema el componente técnico de la Plataforma Única de Interoperabilidad.