From e1cef7ab11783839e1d901802029989336684444 Mon Sep 17 00:00:00 2001 From: Martin Weise <martin.weise@tuwien.ac.at> Date: Tue, 1 Nov 2022 01:12:03 +0100 Subject: [PATCH] Added the links --- docker-compose.yml | 2 +- docs/operation.md | 27 +++++++++++++++++++++++++++ docs/operation/index.md | 5 ----- docs/operation/production.md | 9 --------- mkdocs.yml | 4 +--- swagger/Dockerfile | 2 ++ swagger/nginx.conf | 2 +- 7 files changed, 32 insertions(+), 19 deletions(-) create mode 100644 docs/operation.md delete mode 100644 docs/operation/index.md delete mode 100644 docs/operation/production.md diff --git a/docker-compose.yml b/docker-compose.yml index 55a2995..dda77ac 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -9,4 +9,4 @@ services: container_name: dbrepo-docs hostname: dbrepo-docs ports: - - "80:80" \ No newline at end of file + - "8080:8080" \ No newline at end of file diff --git a/docs/operation.md b/docs/operation.md new file mode 100644 index 0000000..2cc3df4 --- /dev/null +++ b/docs/operation.md @@ -0,0 +1,27 @@ +--- +hide: + +- navigation + +--- + +# Operation + +!!! abstract "Abstract" + + We compiled a short [getting started guide](/getting-started) that quickly allows a stand-alone test-deployment of the infrastructure on your server without the need of infrastructure configuration. + +## External Systems + +We thought the easiest way to make documentation of the endpoints available was through the interactive in-code +documentation of Swagger: + +* [Analyse Service](https://dbrepo2.ec.tuwien.ac.at/docs/analyse) +* [Authentication Service](https://dbrepo2.ec.tuwien.ac.at/docs/authentication) +* [Container Service](https://dbrepo2.ec.tuwien.ac.at/docs/container) +* [Database Service](https://dbrepo2.ec.tuwien.ac.at/docs/database) +* [Identifier Service](https://dbrepo2.ec.tuwien.ac.at/docs/identifier) +* [Metadata Service](https://dbrepo2.ec.tuwien.ac.at/docs/metadata) +* [Query Service](https://dbrepo2.ec.tuwien.ac.at/docs/query) +* [Table Service](https://dbrepo2.ec.tuwien.ac.at/docs/table) +* [Units Service](https://dbrepo2.ec.tuwien.ac.at/docs/units) \ No newline at end of file diff --git a/docs/operation/index.md b/docs/operation/index.md deleted file mode 100644 index 2ec4629..0000000 --- a/docs/operation/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Operation - -!!! abstract "Abstract" - - We compiled a short [getting started guide](/getting-started) that quickly allows a stand-alone test-deployment of the infrastructure on your server without the need of infrastructure configuration. \ No newline at end of file diff --git a/docs/operation/production.md b/docs/operation/production.md deleted file mode 100644 index c74e2c6..0000000 --- a/docs/operation/production.md +++ /dev/null @@ -1,9 +0,0 @@ -# Production - -!!! bug "Alpha-release software" - - Currently, the database repository is in an alpha-release and not considered secure enough to hold sensitive data. Enroll into our [mailing list](https://lists.univie.ac.at/mailman/listinfo/fairdata_dbrepo) and be notified every 2-3 months with progress of the software. - -!!! info "Friendly users" - - We always welcome friendly users who want to deploy the database repository on their premises and provide continious feedback and create bug reports. We also take their improvement inquiries to improve the software quality. Please [contact](/contact) us. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 4de0e0c..bad9f23 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,9 +14,7 @@ nav: - Home: index.md - getting-started.md - system.md - - Operation: - - operation/index.md - - operation/production.md + - operation.md - publications.md - contact.md extra_css: diff --git a/swagger/Dockerfile b/swagger/Dockerfile index dc6a268..f67922d 100644 --- a/swagger/Dockerfile +++ b/swagger/Dockerfile @@ -33,5 +33,7 @@ COPY ./api-query.yaml ./docs/query/api.yaml COPY ./api-table.yaml ./docs/table/api.yaml COPY ./api-units.yaml ./docs/units/api.yaml +EXPOSE 8080 + # generate RUN bash /app/docker-build.sh \ No newline at end of file diff --git a/swagger/nginx.conf b/swagger/nginx.conf index 4120561..eb21d39 100644 --- a/swagger/nginx.conf +++ b/swagger/nginx.conf @@ -46,7 +46,7 @@ http { } server { - listen 80 default_server; + listen 8080 default_server; server_name _; root /usr/share/nginx/html/; index index.html index.htm; -- GitLab