EOEPCA's User profile
Explore the docs »
Report Bug · Request Feature

• Table of Contents
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Configuration
• Documentation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

• Python
• PyTest
• YAML
• Travis CI

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

This is an example of how to list things you need to use the software and how to install them.

• Docker
• Python

1. Get into EOEPCA's development environment

vagrant ssh

3. Clone the repo

git clone https://github.com/EOEPCA/um-user-profile.git

4. Change local directory

cd template-service

The User Profile building block gets all its configuration from the file located under src/config/WEB_config.json. The parameters that are accepted, and their meaning, are as follows:

• sso_url: hostname or IP of the Auth Server.
• title: Title that will be seen when navigating to the web interface
• scopes: Scopes used for the internal OAUTH client. Currently, the required are: "openid", "email" and "user_name"
• client_id: Client ID used for the internal OAUTH client.
• client_secret: Client secret for the corresponding client_id.
• redirect_uri: Redirect URI configured in the client, which should point to this service's callback URL.
• post_logout_redirect_uri: Redirect URI for post logout of a user.
• base_uri: Base URI for all requests against the web server
• oauth_callback_path: Callback path for the end of a succesful oauth flow.
• logout_endpoint: Endpoint for the logout of a currently logged in user.
• service_host: Host to listen on (localhost, 0.0.0.0, etc..)
• service_port: Port to listen on for the web server
• protected_attributes: Attributes that the user can see about their profiles, but not edit
• blacklist_attributes: Attributes that the user can not see or edit.
• separator_ui_attributes: Separator used for multi-level attributes
• color_web_background: Color used for the background of the web, in HEX.
• color_web_header: Color used for the header of the web, in HEX.
• logo_alt_name: Alternative name for logo of the web
• logo_image_path: Path to logo of the web
• color_header_table: Color used for the header of any table
• color_text_header_table: Color used for the content of any table
• color_button_modify: Color used for the modify button
• use_threads: Toggle threads for requests. Enabling this in production is recommended
• debug_mode: Toggle debug mode, which enables a debug web interface, more errors and logs.

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

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

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

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

EOEPCA mailbox - [email protected]

Project Link: https://github.com/EOEPCA/um-user-profile

• README.md is based on this template by Othneil Drew.