kaliware/auth-ms repository overview

Kaliware Auth-MS - Docker Configuration

The kaliware/auth-ms is a Docker image for the authentication microservice built with Spring Boot. It provides authentication capabilities and integrates with other microservices in a distributed architecture. Below are the configurations and dependencies needed to run the service.

Dependencies

• Config Server (kaliware/config-server): The auth-ms relies on kaliware/config-server for centralized configuration management. Make sure the config-server is up and running before starting the auth-ms.
• Database (PostgreSQL): The authentication service requires a PostgreSQL database to store user data. The database must be configured and accessible.
• Redis: Redis is used for caching or session management. Ensure that a Redis instance is running and accessible.

Configuration Parameters

The following environment variables can be configured for the auth-ms:

• CONFIG_SERVER_HOST (Required): The URL of the kaliware/config-server. This specifies where to fetch the configuration properties.
• PREFER_IP_ADDRESS (Default: true): Determines if the service should prefer using IP addresses for registration.
• DATASOURCE_URL (Required): JDBC URL for the PostgreSQL database connection.
• DATASOURCE_USERNAME (Required): Username for the database.
• DATASOURCE_PASSWORD (Required): Password for the database.
• DATASOURCE_SCHEME (Default: user_ms): Database schema used for the service.
• REDIS_HOST (Required): Hostname of the Redis server.
• REDIS_PASSWORD (Optional): Password for authenticating with Redis.
• REDIS_PORT (Default: 6379): Port for the Redis server.
• JAVA_OPTS (Optional): Java options for configuring memory and other JVM settings.

Steps to Run

1. Start the Config Server: Ensure that the config-server is running and accessible.
2. Set Up the Database: The PostgreSQL database should be set up and accessible.
3. Start the Redis Server: Redis should be running and configured correctly.
4. Build and Run the Auth-MS: Build the Docker image and run the container.
5. Access the Authentication Service: The service should be accessible at http://localhost:8080.

With these configurations, the auth-ms will use the config-server for its settings and interact with the database and Redis for authentication functionalities.