MaDgIK
/
uoa-repository-manager-service
13
2
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated documentation

This commit is contained in:
Antonis Lempesis 2024-03-11 10:50:21 +01:00
parent cb8c68e8f9
commit 62aa87bd86
1 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,8 +1,23 @@
# uoa-repository-manager-service (Provide backend)
# uoa-repository-manager-service (OpenAIRE Provide backend)
## Introduction
OpenAIRE PROVIDE is the content gateway service of OpenAIRE, where data providers are invited to connect scholarly content with OpenAIRE. OpenAIRE PROVIDE allows repositories, data archives, journals, aggregators, CRIS systems, to enter the OpenAIRE and European Open Science (EOSC) ecosystem and be accessible by millions of researchers, research institutes and networks, research funders, policy makers and citizens. OpenAIRE PROVIDE lowers any technological barriers, by supporting a series of integrations, therefore, enabling its users to visually access OpenAIRE's services that are responsible for the data harvesting process. There are four distinctive steps from the initial express of interest for OpenAIRE PROVIDE to the actual content availability on OpenAIRE and EOSC. The steps indicate the important subservices of OpenAIRE that perform the following functionalities: Validation of data sources with the OpenAIRE guidelines (via the OpenAIRE Validator) Registration of data sources to OpenAIRE and global interlinked networks provides links to content for text and data mining, view history of validations, status of harvesting Enrichment of metadata information that describes the data sources to be available through OpenAIRE. Subscribe and view/receive notifications to enrich the metadata or the content of the data source (via the OpenAIRE Broker) View usage statistics of Open research impact by subscribing to the OpenAIRE UsageCounts service; view aggregated, cleaned usage stats for repository access and broaden your mechanisms for impact assessment.
## Architecture
[...]
## Bulding
- Run **git clone** and then **cd uoa-repository-manager-service**.
- Build the app with: `mvn clean install`
## Configuration
- create application.yaml by adjusting the following properties:
## Install and run:
[copy and edit application.yaml from production/beta]
## Deployment
- install postgres
- Run the app with: `java -jar ./target/uoa-repository-manager-service.jar --spring.config.location=application.yaml`
## misc
### Install and run:
- Run **git clone** and then **cd uoa-repository-manager-service**.
- Provide all not-set or redacted configurations, inside the **src/main/resources/application.yml** file.
- Build the app with: `mvn clean install`
@ -13,16 +28,3 @@
- Access it through this url: http://localhost:8480/uoa-repository-manager-service/swagger-ui/index.html
- In order to request data from most endpoints, you have to be a "REGISTERED_USER", otherwise you will get a 403 error code.
- In order to be a registered user, you have to run the [UI-service](https://code-repo.d4science.org/MaDgIK/uoa-repository-manager-ui) , in the same machine, at the same time and login through a browser, using the following url: http://localhost:8480/uoa-repository-manager-service/openid_connect_login
## Introduction
## Architecture
## Bulding
## Deployment
## Installation
## Configuration
## Security
## Maintenance
## Recovery
## References