From 7c4370bc22e19440fc9fa2718f5f17afbf7d9e35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Mu=CC=88ller?= Date: Wed, 21 Oct 2020 16:43:01 +0300 Subject: [PATCH] Improve markdown --- .../examples/ocis_external_konnectd/README.md | 44 ++++++++------ .../examples/ocis_oc10_backend/README.md | 26 ++++---- deployments/examples/ocis_traefik/README.md | 19 +++--- .../ocis/deployment/ocis_external_konnectd.md | 60 ++++++++++++------- docs/ocis/deployment/ocis_oc10_backend.md | 41 +++++++++---- docs/ocis/deployment/ocis_traefik.md | 33 +++++++--- 6 files changed, 143 insertions(+), 80 deletions(-) diff --git a/deployments/examples/ocis_external_konnectd/README.md b/deployments/examples/ocis_external_konnectd/README.md index 14e74879c8..df15492f48 100644 --- a/deployments/examples/ocis_external_konnectd/README.md +++ b/deployments/examples/ocis_external_konnectd/README.md @@ -4,45 +4,51 @@ - Clone ocis repository - ```git clone https://github.com/owncloud/ocis.git``` + `git clone https://github.com/owncloud/ocis.git` - Copy example sub folder for ocisnode to /opt - ```cp deployment/examples/ocis_external_konnectd/ocisnode /opt/``` + + `cp deployment/examples/ocis_external_konnectd/ocisnode /opt/` - Overwrite OCIS_DOMAIN and IDP_DOMAIN in .env with your-ocis.domain.com and your-idp.domain.com - ``` - sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocisnode/.env - sed -i 's/idp.domain.com/your-idp.domain.com/g' /opt/ocisnode/.env - ``` + + `sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocisnode/.env` + + `sed -i 's/idp.domain.com/your-idp.domain.com/g' /opt/ocisnode/.env` - Change into deployment folder - ```cd /opt/ocisnode``` + + `cd /opt/ocisnode` - Start application stack - ```docker-compose up -d``` + + `docker-compose up -d` ## Setup on idp server - Clone ocis repository - ```git clone https://github.com/owncloud/ocis.git``` + `git clone https://github.com/owncloud/ocis.git` - Copy example sub folder for idpnode to /opt - ```cp deployment/examples/ocis_external_konnectd/idpnode /opt/``` + + `cp deployment/examples/ocis_external_konnectd/idpnode /opt/` - Overwrite OCIS_DOMAIN and IDP_DOMAIN in .env with your-ocis.domain.com and your-idp.domain.com - ``` - sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/idpnode/.env - sed -i 's/idp.domain.com/your-idp.domain.com/g' /opt/idpnode/.env - ``` + + `sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/idpnode/.env` + + `sed -i 's/idp.domain.com/your-idp.domain.com/g' /opt/idpnode/.env` - Overwrite redirect uri with your-ocis.domain.com in identifier-registration.yml - ``` - sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/idpnode/config/identifier-registration.yml - ``` + + `sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/idpnode/config/identifier-registration.yml + ` - Change into deployment folder - ```cd /opt/idpnode``` + + `cd /opt/idpnode` - Start application stack - ```docker-compose up -d``` \ No newline at end of file + + `docker-compose up -d` diff --git a/deployments/examples/ocis_oc10_backend/README.md b/deployments/examples/ocis_oc10_backend/README.md index 05ec5692a5..235ce9fea6 100644 --- a/deployments/examples/ocis_oc10_backend/README.md +++ b/deployments/examples/ocis_oc10_backend/README.md @@ -4,25 +4,27 @@ - Clone ocis repository - ```git clone https://github.com/owncloud/ocis.git``` + `git clone https://github.com/owncloud/ocis.git` - Copy example folder to /opt - ```cp deployment/examples/ocis_oc10_backend /opt/``` + `cp deployment/examples/ocis_oc10_backend /opt/` - Overwrite OCIS_DOMAIN and OC10_DOMAIN in .env with your-ocis.domain.com and your-oc10.domain.com - ``` - sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocis_oc10_backend/.env - sed -i 's/oc10.domain.com/your-oc10.domain.com/g' /opt/ocis_oc10_backend/.env - ``` + + `sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocis_oc10_backend/.env` + + `sed -i 's/oc10.domain.com/your-oc10.domain.com/g' /opt/ocis_oc10_backend/.env` - Overwrite redirect uris with your-ocis.domain.com and your-oc10.domain.com in identifier-registration.yml - ``` - sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocis_oc10_backend/ocis/identifier-registration.yml - sed -i 's/oc10.domain.com/your-oc10.domain.com/g' /opt/ocis_oc10_backend/ocis/identifier-registration.yml - ``` + + `sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocis_oc10_backend/ocis/identifier-registration.yml` + + `sed -i 's/oc10.domain.com/your-oc10.domain.com/g' /opt/ocis_oc10_backend/ocis/identifier-registration.yml` - Change into deployment folder - ```cd /opt/ocis_oc10_backend``` + + `cd /opt/ocis_oc10_backend` - Start application stack - ```docker-compose up -d``` + + `docker-compose up -d` diff --git a/deployments/examples/ocis_traefik/README.md b/deployments/examples/ocis_traefik/README.md index a154a2bb21..e8c804b871 100644 --- a/deployments/examples/ocis_traefik/README.md +++ b/deployments/examples/ocis_traefik/README.md @@ -4,23 +4,24 @@ - Clone ocis repository - ```git clone https://github.com/owncloud/ocis.git``` + `git clone https://github.com/owncloud/ocis.git` - Copy example folder to /opt - ```cp deployment/examples/ocis_traefik /opt/``` + + `cp deployment/examples/ocis_traefik /opt/` - Overwrite OCIS_DOMAIN in .env with your.domain.com - ```sed -i 's/ocis.domain.com/your.domain.com/g' /opt/ocis_traefik/.env``` + + `sed -i 's/ocis.domain.com/your.domain.com/g' /opt/ocis_traefik/.env` - Overwrite redirect uri with your.domain.com in identifier-registration.yml - ```sed -i 's/ocis.domain.com/your.domain.com/g' /opt/ocis_traefik/config/identifier-registration.yml``` + + `sed -i 's/ocis.domain.com/your.domain.com/g' /opt/ocis_traefik/config/identifier-registration.yml` - Change into deployment folder - ```cd /opt/ocis_traefik``` + + `cd /opt/ocis_traefik` - Start application stack - ```docker-compose up -d``` - - - + `docker-compose up -d` diff --git a/docs/ocis/deployment/ocis_external_konnectd.md b/docs/ocis/deployment/ocis_external_konnectd.md index 855182aa47..5d079c4f15 100644 --- a/docs/ocis/deployment/ocis_external_konnectd.md +++ b/docs/ocis/deployment/ocis_external_konnectd.md @@ -28,67 +28,87 @@ ocis and konnectd running on linux nodes behind traefik as reverse proxy * Server running Ubuntu 20.04 is public availible with a static ip address * Two A-records for both domains are pointing on the servers ip address * Create user + `$ sudo adduser username` + * Add user to sudo group + `$ sudo usermod -aG sudo username` + * Add users pub key to `~/.ssh/authorized_keys` * Setup ssh to permit authorisation only by ssh key * Install docker + `$ sudo apt install docker.io` + * Add user to docker group + `$ sudo usermod -aG docker username` + * Install docker-compose via - `$ sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose` (docker compose version 1.27.4 as of today) + + `$ sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose` + + (docker compose version 1.27.4 as of today) * Make docker-compose executable + `$ sudo chmod +x /usr/local/bin/docker-compose` + * Environment variables for OCIS Stack are provided by .env file ### Setup on ocis server - Clone ocis repository - ```git clone https://github.com/owncloud/ocis.git``` + `git clone https://github.com/owncloud/ocis.git` - Copy example sub folder for ocisnode to /opt - ```cp deployment/examples/ocis_external_konnectd/ocisnode /opt/``` + + `cp deployment/examples/ocis_external_konnectd/ocisnode /opt/` - Overwrite OCIS_DOMAIN and IDP_DOMAIN in .env with your-ocis.domain.com and your-idp.domain.com - ``` - sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocisnode/.env - sed -i 's/idp.domain.com/your-idp.domain.com/g' /opt/ocisnode/.env - ``` + + `sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocisnode/.env` + + `sed -i 's/idp.domain.com/your-idp.domain.com/g' /opt/ocisnode/.env` - Change into deployment folder - ```cd /opt/ocisnode``` + + `cd /opt/ocisnode` - Start application stack - ```docker-compose up -d``` + + `docker-compose up -d` ### Setup on idp server - Clone ocis repository - ```git clone https://github.com/owncloud/ocis.git``` + `git clone https://github.com/owncloud/ocis.git` - Copy example sub folder for idpnode to /opt - ```cp deployment/examples/ocis_external_konnectd/idpnode /opt/``` + + `cp deployment/examples/ocis_external_konnectd/idpnode /opt/` - Overwrite OCIS_DOMAIN and IDP_DOMAIN in .env with your-ocis.domain.com and your-idp.domain.com - ``` - sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/idpnode/.env - sed -i 's/idp.domain.com/your-idp.domain.com/g' /opt/idpnode/.env - ``` + + `sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/idpnode/.env` + + `sed -i 's/idp.domain.com/your-idp.domain.com/g' /opt/idpnode/.env` - Overwrite redirect uri with your-ocis.domain.com in identifier-registration.yml - ``` - sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/idpnode/config/identifier-registration.yml - ``` + + `sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/idpnode/config/identifier-registration.yml + ` - Change into deployment folder - ```cd /opt/idpnode``` + + `cd /opt/idpnode` - Start application stack - ```docker-compose up -d``` + + `docker-compose up -d` + ### Stack On both nodes, a traefik dokcer container is terminating ssl and forwards the http requests to the services. The nodes are named according to their services. diff --git a/docs/ocis/deployment/ocis_oc10_backend.md b/docs/ocis/deployment/ocis_oc10_backend.md index 170e7008da..15b945f149 100644 --- a/docs/ocis/deployment/ocis_oc10_backend.md +++ b/docs/ocis/deployment/ocis_oc10_backend.md @@ -27,47 +27,62 @@ ocis and oc10 running as docker containers behind traefik as reverse proxy * Server running Ubuntu 20.04 is public availible with a static ip address * Two A-records for both domains are pointing on the servers ip address * Create user + `$ sudo adduser username` + * Add user to sudo group + `$ sudo usermod -aG sudo username` + * Add users pub key to `~/.ssh/authorized_keys` * Setup ssh to permit authorisation only by ssh key * Install docker + `$ sudo apt install docker.io` + * Add user to docker group + `$ sudo usermod -aG docker username` + * Install docker-compose via - `$ sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose` (docker compose version 1.27.4 as of today) + + `$ sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose` + + (docker compose version 1.27.4 as of today) * Make docker-compose executable + `$ sudo chmod +x /usr/local/bin/docker-compose` + * Environment variables for OCIS Stack are provided by .env file ### Setup on server - Clone ocis repository - ```git clone https://github.com/owncloud/ocis.git``` + `git clone https://github.com/owncloud/ocis.git` - Copy example folder to /opt - ```cp deployment/examples/ocis_oc10_backend /opt/``` + `cp deployment/examples/ocis_oc10_backend /opt/` - Overwrite OCIS_DOMAIN and OC10_DOMAIN in .env with your-ocis.domain.com and your-oc10.domain.com - ``` - sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocis_oc10_backend/.env - sed -i 's/oc10.domain.com/your-oc10.domain.com/g' /opt/ocis_oc10_backend/.env - ``` + + `sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocis_oc10_backend/.env` + + `sed -i 's/oc10.domain.com/your-oc10.domain.com/g' /opt/ocis_oc10_backend/.env` - Overwrite redirect uris with your-ocis.domain.com and your-oc10.domain.com in identifier-registration.yml - ``` - sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocis_oc10_backend/ocis/identifier-registration.yml - sed -i 's/oc10.domain.com/your-oc10.domain.com/g' /opt/ocis_oc10_backend/ocis/identifier-registration.yml - ``` + + `sed -i 's/ocis.domain.com/your-ocis.domain.com/g' /opt/ocis_oc10_backend/ocis/identifier-registration.yml` + + `sed -i 's/oc10.domain.com/your-oc10.domain.com/g' /opt/ocis_oc10_backend/ocis/identifier-registration.yml` - Change into deployment folder - ```cd /opt/ocis_oc10_backend``` + + `cd /opt/ocis_oc10_backend` - Start application stack - ```docker-compose up -d``` + + `docker-compose up -d` ### Stack diff --git a/docs/ocis/deployment/ocis_traefik.md b/docs/ocis/deployment/ocis_traefik.md index 7313a64110..77fa681393 100644 --- a/docs/ocis/deployment/ocis_traefik.md +++ b/docs/ocis/deployment/ocis_traefik.md @@ -24,41 +24,60 @@ ocis running on a hcloud node behind traefik as reverse proxy * Server running Ubuntu 20.04 is public availible with a static ip address * Two A-records for both domains are pointing on the servers ip address * Create user + `$ sudo adduser username` + * Add user to sudo group + `$ sudo usermod -aG sudo username` + * Add users pub key to `~/.ssh/authorized_keys` * Setup ssh to permit authorisation only by ssh key * Install docker + `$ sudo apt install docker.io` + * Add user to docker group + `$ sudo usermod -aG docker username` + * Install docker-compose via - `$ sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose` (docker compose version 1.27.4 as of today) + + `$ sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose` + + (docker compose version 1.27.4 as of today) * Make docker-compose executable + `$ sudo chmod +x /usr/local/bin/docker-compose` + * Environment variables for OCIS Stack are provided by .env file ### Setup on server - Clone ocis repository - ```git clone https://github.com/owncloud/ocis.git``` + `git clone https://github.com/owncloud/ocis.git` - Copy example folder to /opt - ```cp deployment/examples/ocis_traefik /opt/``` + + `cp deployment/examples/ocis_traefik /opt/` - Overwrite OCIS_DOMAIN in .env with your.domain.com - ```sed -i 's/ocis.domain.com/your.domain.com/g' /opt/ocis_traefik/.env``` + + `sed -i 's/ocis.domain.com/your.domain.com/g' /opt/ocis_traefik/.env` - Overwrite redirect uri with your.domain.com in identifier-registration.yml - ```sed -i 's/ocis.domain.com/your.domain.com/g' /opt/ocis_traefik/config/identifier-registration.yml``` + + `sed -i 's/ocis.domain.com/your.domain.com/g' /opt/ocis_traefik/config/identifier-registration.yml` - Change into deployment folder - ```cd /opt/ocis_traefik``` + + `cd /opt/ocis_traefik` - Start application stack - ```docker-compose up -d``` + + `docker-compose up -d` + ### Stack The application stack contains two containers. The first one is a traefik proxy which is terminating ssl and forwards the requests to the internal docker network. Additional, traefik is creating a certificate that is stored in `acme.json` in the folder `letsencrypt` inside the users home directory.