rslim087/profile-management

By rslim087

Updated 10 months ago

Image
0

113

Authentication Microservice

This Docker image provides an authentication microservice with user management functionality. It allows users to sign up, sign in, sign out, and update their profile information. It uses JSON Web Tokens (JWT) for authentication.

Version 2.0.0 Update

In version 2.0.0, the Authentication Microservice has been updated to include MySQL integration. It now relies on environment variables to establish a connection with a MySQL database for storing and retrieving user data.

docker run -p 3003:3003 -e MYSQL_HOST=<mysql_host> -e MYSQL_PORT=<mysql_port> -e MYSQL_USER=<mysql_user> -e MYSQL_PASSWORD=<mysql_password> -e MYSQL_DATABASE=<mysql_database> authentication-microservice

Usage

To run a container from this image, use the following command:

docker run -p 3003:3003 authentication-microservice

The microservice will be accessible at http://localhost:3003.

API Endpoints
  • POST /api/signup: Sign up a new user.
  • POST /api/signin: Sign in an existing user.
  • POST /api/signout: Sign out the currently authenticated user.
  • GET /api/protected: Example of a protected route that requires authentication.
  • PUT /api/update: Update the profile information of the authenticated user.

Environment Variables

This microservice does not require any environment variables to be set.

Volumes

This microservice does not use any volumes.

Docker Network

To enable communication between the Authentication microservice and other microservices or applications, ensure that the containers are connected to the same Docker network. You can achieve this by following these steps:

  1. Create a Docker network:
docker network create my-network
  1. Run the Authentication microservice container with the --network flag:
docker run --network my-network -p 3003:3003 authentication-microservice
  1. Run other microservice or application containers on the same network:
docker run --network my-network -p 4000:4000 ecommerce-ui

By connecting the containers to the same Docker network, they can communicate with each other using their container names as hostnames.

Building the Image

If you want to build the Docker image yourself, follow these steps:

  1. Clone the repository containing the application code.
  2. Navigate to the directory where the Dockerfile is located.
  3. Run the following command to build the image:
docker build -t authentication-microservice .

This command will build the Docker image using the provided Dockerfile and tag it as authentication-microservice.

Contributing

If you would like to contribute to this project, please follow the guidelines in the CONTRIBUTING.md file.

License

This project is licensed under the MIT License.

Support

If you encounter any issues or have questions regarding this Docker image or the Authentication microservice, please open an issue on the GitHub repository.

Docker Pull Command

docker pull rslim087/profile-management