Skip to content
This repository has been archived by the owner on Dec 5, 2023. It is now read-only.

EOEPCA-archive/um-login-service

Repository files navigation

Contributors Forks Stargazers Issues MIT License Build


End of Life Notice

This repository has archived due to being replaced by a User Management solution based on Keycloak available at:



* Logo

um-login-service

*
* Explore the docs » *
* Report Bug * · * Request Feature

Table of Contents

Built With

About

This building block serves as a baseline for the Login Service used in EOEPCA's project. It uses default docker images for its main components, except for the LDAP configuration, which points to the latest stable build of the EOEPCA/um-login-persistence building block. It makes use of Gluu's kubernetes solution for a VM installation.

This diagram gives a basic approach to the components of the building block:
Basic Diagram

More detailed information can be found on the building block's documentation: Login Service Documentation

Getting Started

To get a local copy up and running follow these simple steps.

Installation

  1. Get into EOEPCA's development environment (installation details)
vagrant ssh
  1. Clone the repo
git clone https://github.com/EOEPCA/um-login-service.git
  1. Explore local directory
cd um-login-service

Configuration file

File located under src/config/generate.json.

The parameters that are accepted, and their meaning, are as follows:

  • hostname: Hostname given to the service.
  • country_code: 2-letter country code for the configuration of the server
  • state: State for the configuration of the server
  • city: City for the configuration of the server
  • admin_pw: Password upon installation for admin user
  • ldap_pw: Password for admin in LDAP
  • email: Email of the owner of the platform
  • org_name: Organization name of the owner of the platform
  • gluu_config_adapter: Internal config adapter for the images. Currently only "kubernetes" is supported
  • ldap_type: Internal config adaptar for the database. Currently only "opendj" is supported
  • redis_pw: Password for Redis instance.

Documentation

The component documentation can be found at https://eoepca.github.io/um-login-service/.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the Apache-2.0 License. See LICENSE for more information.

Contact

EOEPCA mailbox - [email protected]

Project Link: https://github.com/EOEPCA/um-login-service

Acknowledgements