From a39e1916a2bd0874ad95a07b18454575c02847b3 Mon Sep 17 00:00:00 2001 From: nichlaes Date: Fri, 17 Nov 2023 16:27:46 +0100 Subject: [PATCH] formatting --- docs/admin/guides/add_service.md | 7 +++++-- docs/admin/guides/add_user.md | 8 +++++--- docs/admin/guides/hosting_site_without_https.md | 3 ++- docs/admin/trial.md | 13 +++++++++---- 4 files changed, 21 insertions(+), 10 deletions(-) diff --git a/docs/admin/guides/add_service.md b/docs/admin/guides/add_service.md index 4e7961802..95a69854c 100644 --- a/docs/admin/guides/add_service.md +++ b/docs/admin/guides/add_service.md @@ -4,9 +4,12 @@ !!! Pre-requisite You should read the documentation about the already available [services](../services.md) -This guide will show you how to add more services. In the following example we will be adding **mongodb** as a service, but this could be used for other services as well. +This guide will show you how to add more services. +In the following example we will be adding **mongodb** as a service, +but this could be used for other services as well. -:fontawesome-solid-circle-info: **Adding other services requires more RAM and CPU power. Please make sure the host machine meets the hardware requirements for running all the services.** +:fontawesome-solid-circle-info: **Adding other services requires more RAM and CPU power.** +**Please make sure the host machine meets the hardware requirements for running all the services.** ## 1. Add the configuration diff --git a/docs/admin/guides/add_user.md b/docs/admin/guides/add_user.md index d986f7240..436918cfe 100644 --- a/docs/admin/guides/add_user.md +++ b/docs/admin/guides/add_user.md @@ -2,9 +2,10 @@ This page will guide you on, how to add more users to the DTaas. Please do the following: + !!! important -Make sure to replace **** and **** -Select a port that is not already being used by the system. + Make sure to replace **** and **** + Select a port that is not already being used by the system. ## 1. Setup a new workspace @@ -48,8 +49,9 @@ vi DTaaS/servers/config/gateway/dynamic/fileConfig.yml Now add the new route and service for the user. + !!! important -foo.com should be replaced with your own domain. + foo.com should be replaced with your own domain. ```yml http: diff --git a/docs/admin/guides/hosting_site_without_https.md b/docs/admin/guides/hosting_site_without_https.md index 43e017db7..192fe05ab 100644 --- a/docs/admin/guides/hosting_site_without_https.md +++ b/docs/admin/guides/hosting_site_without_https.md @@ -1,3 +1,4 @@ # Hosting site without https -The default setup is http. In order to host your site without https, please also see the [reverse proxy section on the overview page](../overview.md#reverse-proxy). +The default setup is http. In order to host your site without https, +please also see the [reverse proxy section on the overview page](../overview.md#reverse-proxy). diff --git a/docs/admin/trial.md b/docs/admin/trial.md index 42f798b68..39b419bc5 100644 --- a/docs/admin/trial.md +++ b/docs/admin/trial.md @@ -1,7 +1,7 @@ # Trial Installation To try out the software, you can install it on Ubuntu Server 22.04 -Operating System. The setup requires a +Operating System. The setup requires a machine which can spare 16GB RAM, 8 vCPUs and 50GB Hard Disk space to the vagrant box. A successful installation will create a setup @@ -42,8 +42,10 @@ for getting the Gitlab OAuth application details. ## Install + !!! note - While installing you might encounter multiple dialogs asking, which services should be restarted. Just click **OK** to all of those. + While installing you might encounter multiple dialogs asking, + which services should be restarted. Just click **OK** to all of those. Run the following scripts. @@ -52,12 +54,14 @@ wget https://raw.githubusercontent.com/INTO-CPS-Association/DTaaS/feature/distri bash single-script-install.sh ``` + !!! warning This test installation has default credentials and is thus highly insecure. ## Post install -After the install-script. Please change **foo.com** and [Gitlab OAuth](#2-gitlab-oauth-application) details +After the install-script. Please change **foo.com** +and [Gitlab OAuth](#2-gitlab-oauth-application) details to your local settings in the following files. ```txt @@ -70,7 +74,8 @@ to your local settings in the following files. Now when you visit your domain, you should be able to login through your OAuth Provider and be able to access the DTaas web UI. -If you can following all the screenshots from [user website](../user/website/index.md). Everything is correctly setup. +If you can following all the screenshots from [user website](../user/website/index.md). +Everything is correctly setup. ## References