diff --git a/README.md b/README.md index 002a491..db913eb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # TXS - Keycloak -Sistema de autenticación basado en Keycloak, que permite que un usuario que acceda a cualquier servicio de TXS / EDUCATIC pueda cambiar de servicio sin necesidad de volver a autenticarse, facilitando la integración. +Sistema de autenticación basado en Keycloak, que permite a los usuarios de TXS / EDUCATIC cambiar de servicio sin necesidad de volver a autenticarse, facilitando la integración. ## Instalación y ejecución @@ -8,13 +8,15 @@ El proyecto solamente necesita un motor de contenedores (actualmente Docker) y q ### Crear el espacio de trabajo -Copia el contenido de este repositorio sobre el directorio de instalación de tu preferencia. Los scripts están preparados para trabajar desde `/opt`, por lo que si escoges instalar en otra ubicación, deberás modificar los ficheros `docker-compose.yaml`, `certbot/certbot-keycloak.service` y `certbot/certbot-keycloak.sh` a conveniencia. +Copia el contenido de este repositorio sobre el directorio de instalación de tu preferencia. + +> Los scripts están preparados para trabajar desde `/opt`, por lo que si escoges instalar en otra ubicación, deberás modificar los ficheros `docker-compose.yaml`, `certbot/certbot-keycloak.service` y `certbot/certbot-keycloak.sh` a conveniencia. ### Configuración #### Keycloak -El servicio de _Keycloak_ se inicia con `docker-compose`. +El servicio de _Keycloak_ se inicia con `docker-compose`, pero hay configurar algunos parámetros. Antes de la ejecución, rellena las variables de configuración necesarias. Hay una plantilla de ejemplo en `.env-sample`. Utiliza esa plantilla como base y guárdala con el nombre `.env`. Dentro encontrarás las variables de configuración que se utilizan en el fichero de `docker-compose`. Ajústalas como corresponda.