uoa-user-management/README.md

54 lines
2.8 KiB
Markdown
Raw Normal View History

# Uoa User Management
2024-09-27 13:08:37 +02:00
Uoa User Management is a service which communicates with Role Management and provides method to invite userDetails to be
members or managers of an OpenAIRE entity
## Configuration
Check first [authorization-library](https://code-repo.d4science.org/MaDgIK/authorization-library#stateless).
You have to set at least one or both spring profile (html, registry)
### External URLs
user-management.developers= # Required (html) - URL of Developers portal (Deprecated)
user-management.developers-api= # Required (html) - URL of Developers API (Deprecated)
user-management.login-url= # Required (html) - URL for Login Action
user-management.role-management= # Required (registry) - URL of Role Management API
### Mail
user-management.mail.host # Required (html, registry) - Mail host name
user-management.mail.port # Required (html, registry) - Mail port
user-management.mail.from # Required (html, registry) - From email address
user-management.mail.protocol # Required (html, registry) - Mail protocol
user-management.mail.defaultEncoding # Required (html, registry) - Default Encoding - default value: UTF-8
user-management.mail.sslProtocols # Optional - If ssl Protocols are needed (comma separated)
user-management.mail.auth # Required (html, registry) (boolean) - If authentication is required for mail account - default value: false
user-management.mail.username # Required (html, registry) (if auth = true) - Username of mail account
user-management.mail.password # Required (html, registry) (if auth = true) - Password of mail account
### Google
user-management.google.key # Required (html) - Google site key for Recaptcha
user-management.google.secret # Required (html) - Google secret key for Recaptcha
### Datasource configuration
user-management.datasource.url # Required (html, registry) - jdbc URL to the database
user-management.datasource.username # Optional - Database userDetails if needed
user-management.datasource.password # Optional - Database userDetails password if needed
### LDAP Configuration
user-management.ldap.address # Required (html) - LDAP Host address
user-management.ldap.baseDN # Required (html) - LDAP base domain
user-management.ldap.adminDN # Required (html) - LDAP admin domain
user-management.ldap.password # Required (html) - LDAP admin password
user-management.ldap.port # Required (html) - LDAP Host port
## Run
Check [Spring boot Documentation](https://code-repo.d4science.org/MaDgIK/Documentation/wiki/Spring-boot) (need Login)