Added license, updated README

37d266a0 · Martin Weise · d8600461 · 37d266a0 · 37d266a0 · 37d266a0
Commit 37d266a0 authored 3 years ago by Martin Weise
--- a/.gitlab/license.svg
+++ b/.gitlab/license.svg
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="97" height="20">
+    <linearGradient id="b" x2="0" y2="100%">
+        <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+        <stop offset="1" stop-opacity=".1"/>
+    </linearGradient>
+    <mask id="anybadge_1">
+        <rect width="97" height="20" rx="3" fill="#fff"/>
+    </mask>
+    <g mask="url(#anybadge_1)">
+        <path fill="#555" d="M0 0h53v20H0z"/>
+        <path fill="#008080" d="M53 0h44v20H53z"/>
+        <path fill="url(#b)" d="M0 0h97v20H0z"/>
+    </g>
+    <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
+        <text x="27.5" y="15" fill="#010101" fill-opacity=".3">license</text>
+        <text x="26.5" y="14">license</text>
+    </g>
+    <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
+        <text x="76.0" y="15" fill="#010101" fill-opacity=".3">CC-BY</text>
+        <text x="75.0" y="14">CC-BY</text>
+    </g>
+</svg>
\ No newline at end of file
--- a/LICENSE
+++ b/LICENSE
--- a/README.md
+++ b/README.md
-[![pipeline status](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/pipeline.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master) [![coverage report](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/coverage.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master)
+[![pipeline status](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/pipeline.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master)
+[![coverage report](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/coverage.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master)
+[![license](.gitlab/license.svg)](http://creativecommons.org/licenses/by/4.0/)
-# FAIR Data Austria Services
+# FAIR Data Austria Database Repository
-## Install
-Pull the latest dev/master images on your client through:
-```bash
-docker login https://docker.martinweise.at
-> Username: fda
-> Password: fda-docker
-```
-The `dev` branch images have suffix `:latest` (=optional), to pull them execute the following
-```bash
-docker pull docker.martinweise.at/fda-analyse-service:latest
-docker pull docker.martinweise.at/fda-discovery-server:latest
-docker pull docker.martinweise.at/fda-gateway-service:latest
-docker pull docker.martinweise.at/fda-database-managing-service:latest
-docker pull docker.martinweise.at/fda-container-managing-service:latest
-docker pull docker.martinweise.at/fda-query-service:latest
-docker pull docker.martinweise.at/fda-table-service:latest
-docker pull docker.martinweise.at/fda-ui:latest
-```
-The `master` branch images have suffix `:stable`, they are pulled similar:
-```bash
-docker pull docker.martinweise.at/fda-analyse-service:stable
-...
-```
-Note: the domain martinweise.at is private and I do not own any of these images, it is just a necessary condition for Docker to pull from a (private, non-public) remote repository! The domain should of course be changed before release!
 ## Build
-Everything is handled by compose, just build it by running:
+Everything is handled by Docker Compose, just build it by executing:
 ```bash
 docker-compose build
 ```
-Local development minimum requirements:
- Ubuntu 18.04 LTS
- Apache Maven 3.0.0
- OpenJDK 11.0.0
-Local deployment minimum versions:
- Docker Engine 20.10.0
- Docker Compose 1.28.0
-## Deployment
-The pipeline is set-up to build and test all commits. A commit to dev or master branch triggers additional jobs.
-### Development
-A commit to `dev` triggers the following pipeline. It deploys the docker images to the docker registry hosted on the fda-runner server and deploys it also to a test server (fda-deployment) at TU Wien. 
-![pipeline dev](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-docs/-/raw/master/figures/fda-pipeline-dev.png)
-### Production
-A commit to `master` triggers the following pipeline. It deploys the docker images to the docker registry hosted on the fda-runner server and deploys it also to a production server tbd.
-![pipeline master](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-docs/-/raw/master/figures/fda-pipeline-prod.png)
 ## Start
-Now start all services by running:
+After build, the system can be started by executing:
 ```bash
-docker-compose up
+docker-compose up -d
 ```
-### Troubleshooting
+## Development
-##### FDA Runner
-Hosted at TU Wien 128.130.202.89, only accessible from TU-Network
+Local development minimum requirements:
-**Important**
-Different MTU for HPC Cluster, edit for Docker to work with bridge mode the `/etc/docker/daemon.json`:
-```bash
-{
-    "mtu": 1450
-}
-```
-##### Virtual Machine
+- Ubuntu 18.04 LTS (RPM-based operating systems are also tested)
+- Apache Maven 3.0.0
+- OpenJDK 11.0.0
-Ubuntu 20.04 LTS
+The backend endpoints are accessible in the browser:
-Use openjdk-11...openjdk-8 does not work.
+- [Image Endpoint](http://localhost:9091/swagger-ui/)
+- [Container Endpoint](http://localhost:9091/swagger-ui/)
+- [Database Endpoint](http://localhost:9092/swagger-ui/)
+- [Query Endpoint](http://localhost:9093/swagger-ui/)
+- [Table Endpoint](http://localhost:9094/swagger-ui/)
-Do not use maven provided my Ubuntu 20.4 LTS. It cannot handle those injections spring-boot wants it to do.
+The frontend is accessible in the browser:
-It says: WARNING: An illegal reflective access operation has occurred
+- [FAIR Portal](http://localhost:3000)
-WARNING: Illegal reflective access by com.google.inject.internal.cglib.core.$ReflectUtils$1 (file:/usr/share/maven/lib/guice.jar) to method java.lang.ClassLoader.defineClass(java.lang.String,byte[],int,int,java.security.ProtectionDomain)
-Install maven from Apache Org.:
+Other:
-Download maven e.g. 3.6.3
+- [Discovery Endpoint](http://localhost:9090/) (Eureka)
+- [Gateway Endpoint](http://localhost:9095/swagger-ui/) (Webflux)
-```bash
+## Deployment
-wget https://www-us.apache.org/dist/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.tar.gz -P /tmp
-```
-Untar downloaded file to /opt
+Local deployment minimum versions:
-```bash
+- Docker Engine 20.10.0
-sudo tar xf /tmp/apache-maven-*.tar.gz -C /opt
+- Docker Compose 1.28.0
-```
-Install the alternative version for the mvn in your system
+# Contribute
-```bash
+Contributions are always welcome and encouraged, simply fork the repository and contact [Andreas Rauber](http://www.ifs.tuwien.ac.at/~andi/).
-sudo update-alternatives --install /usr/bin/mvn mvn /opt/apache-maven-3.6.3/bin/mvn 363
-```
-Check if your configuration is ok. You may use your current or the 3.6.3 whenever you wish, running the command below.
+# License
-```bash
+This work is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/)
-sudo update-alternatives --config mvn
\ No newline at end of file
-```