diff --git a/README.md b/README.md index 3d557341ace95ea01aef30586e2cc1db9124dd38..1fde55325b7c626ff08179ba7411a8e01816aeee 100644 --- a/README.md +++ b/README.md @@ -4,77 +4,56 @@ # FAIR Data Austria Database Repository -## Build +## Deployment -Local development minimum requirements: - -- Ubuntu 18.04 LTS (Rocky Linux is also supported) -- Apache Maven 3.0.0 -- OpenJDK 11.0.0 -- Docker Engine 20.10.0 -- Docker Compose 1.28.0 - -Everything is handled by compose, just build it by running: - -```bash -docker-compose build -``` +Download the Docker Compose template and the environment file: -## Run - -To use the citation service you need to provide a -[Zenodo API token](https://zenodo.org/account/settings/applications/tokens/new/). Create a `.env` file at the project -root. A sample file is available at `.env.example` - -```bash -ZENODO_API_KEY= -API=http://fda-gateway-service:9095 +```console +$ curl -o docker-compose.yml https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml +$ curl -o .env https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example ``` -Add to your `/etc/hosts` for executing the tests: +Start the Docker containers: -```bash -172.29.0.6 fda-gateway-service +```console +$ docker compose up -d +$ docker compose logs -f ``` ## Development -The backend endpoints are accessible in the browser: +### Build -- [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/) +Local development minimum requirements: -The frontend is accessible in the browser: +- Ubuntu 18.04 LTS (Rocky Linux is also supported) +- Apache Maven 3.0.0 +- OpenJDK 11.0.0 +- Docker Engine 20.10.0 +- Docker Compose 1.28.0 -- [FAIR Portal](http://localhost:3000) -- [Query Endpoint Management Portal](http://localhost:15672) (username=guest, password=guest) +Everything is handled by compose, just build it by running: -Other: +```console +$ docker-compose build --parallel +``` -- [Discovery Endpoint](http://localhost:9090/) (Eureka) -- [Gateway Endpoint](http://localhost:9095/swagger-ui/) (Webflux) +A more detailed description on how +to get started is available at our documentation +website: [https://dbrepo-docs.ossdip.at/getting-started/](https://dbrepo-docs.ossdip.at/getting-started/) -Hosts: +### Run -```bash -# FDA PUBLIC -172.29.0.2 fda-gateway-service -172.29.0.3 fda-broker-service -172.29.0.4 fda-discovery-service -172.29.0.5 fda-metadata-db -172.29.0.6 fda-search-service -172.29.0.7 fda-units-service -172.29.0.8 fda-container-service -172.29.0.9 fda-database-service -172.29.0.10 fda-analyse-service -172.29.0.11 fda-table-service -172.29.0.12 fda-query-service +Copy and *optionally* edit the environment: +```console +$ cp .env.unix .env +$ docker compose -f ./docker-compose.prod.yml up -d +$ docker compose -f ./docker-compose.prod.yml logs -f ``` +Once the services are started, open [http://localhost:3000](http://localhost:3000). + ## Contribute Contributions are always welcome and encouraged, simply fork the repository and