streamline and document examples

2020-12-07 08:27:06 +01:00
parent e8ebd1a173
commit 2b18b3526d
36 changed files with 854 additions and 1285 deletions
@@ -1 +1,17 @@
-OCIS_DOMAIN=ocis.domain.com
+# If you're on a internet facing server please comment out following line.
+# It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates.
+INSECURE=true
+
+### Traefik settings ###
+# Domain of Traefik, where you can find the dashboard. Defaults to "traefik.owncloud.test"
+TRAEFIK_DOMAIN=
+# Basic authentication for the dashboard. Defaults to user "admin" and password "admin"
+TRAEFIK_BASIC_AUTH_USERS=
+# Email address for obtaining LetsEncrypt certificates, needs only be changed if this is a public facing server
+TRAEFIK_ACME_MAIL=
+
+### oCIS settings ###
+# oCIS version. Defaults to "latest"
+OCIS_DOCKER_TAG=
+# Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test"
+OCIS_DOMAIN=
@@ -1,2 +1,6 @@
-Please refer to [our documentation](https://owncloud.github.io/ocis/deployment/ocis_traefik/)
+---
+document this deployment example in docs/ocis/deployment/owncloud10_with_ocis_web.md
+---
+
+Please refer to [our documentation](https://owncloud.github.io/ocis/deployment/owncloud10_with_ocis_web/)
 for instructions on how to deploy this scenario.
@@ -0,0 +1 @@
+identifier-registration.yaml
@@ -0,0 +1,41 @@
+---
+
+# OpenID Connect client registry.
+clients:
+  - id: phoenix
+    name: OCIS
+    application_type: web
+    insecure: yes
+    trusted: yes
+    redirect_uris:
+      - https://ocis.owncloud.test/
+      - https://ocis.owncloud.test/oidc-callback.html
+      - https://ocis.owncloud.test/oidc-silent-redirect.html
+    origins:
+      - https://ocis.owncloud.test
+
+  - id: ocis-explorer.js
+    name: oCIS Graph Explorer
+    trusted: yes
+    insecure: yes
+
+  - id: xdXOt13JKxym1B1QcEncf2XDkLAexMBFwiT9j6EfhhHFJhs2KM9jbjTmf8JBXE69
+    secret: UBntmLjC2yYCeHwsyj73Uwo9TAaecAetRwMw0xYcvNL9yRdLSUi0hUAHfvCHFeFh
+    name: ownCloud desktop app
+    application_type: native
+    insecure: true
+
+  - id: e4rAsNUSIUs0lF4nbv9FmCeUkTlV9GdgTLDH1b5uie7syb90SzEVrbN7HIpmWJeD
+    secret: dInFYGV33xKzhbRmpqQltYNdfLdJIfJ9L5ISoKhNoT9qZftpdWSP71VrpGR9pmoD
+    name: ownCloud Android app
+    application_type: native
+    redirect_uris:
+      - oc://android.owncloud.com
+
+  - id: mxd5OQDk6es5LzOzRvidJNfXLUZS2oN3oUFeXPP8LpPrhx3UroJFduGEYIBOxkY1
+    secret: KFeFWWEZO9TkisIQzR3fo7hfiMXlOpaqP8CFuTbSHzV1TUuGECglPxpiVKJfOXIx
+    name: ownCloud iOS app
+    application_type: native
+    redirect_uris:
+      - oc://ios.owncloud.com
+      - oc.ios://ios.owncloud.com
@@ -1,18 +0,0 @@
---
-# OpenID Connect client registry.
-clients:
-  - id: phoenix
-    name: OCIS
-    application_type: web
-    insecure: yes
-    trusted: yes
-    redirect_uris:
-      - http://ocis.domain.com/
-      - https://ocis.domain.com/
-      - http://ocis.domain.com/oidc-callback.html
-      - https://ocis.domain.com/oidc-callback.html
-      - http://ocis.domain.com/oidc-silent-redirect.html
-      - https://ocis.domain.com/oidc-silent-redirect.html
-    origins:
-      - http://ocis.domain.com
-      - https://ocis.domain.com
@@ -1,73 +1,105 @@
+---
 version: "3.7"

 services:
-
  traefik:
-    image: "traefik:v2.2"
-    container_name: "traefik"
+    image: "traefik:v2.3"
    networks:
-      - ocisnet
+      default:
+        aliases:
+          - ${OCIS_DOMAIN:-ocis.owncloud.test}
    command:
-      - "--providers.docker=true"
-      - "--providers.docker.exposedbydefault=false"
-      - "--entrypoints.web.address=:80"
-      - "--entrypoints.websecure.address=:443"
-      - "--serverstransport.insecureskipverify=true"
-      # Ocis certificate resolver
-      - "--certificatesresolvers.ocis.acme.tlschallenge=true"
-      - "--certificatesresolvers.ocis.acme.caserver=https://acme-v02.api.letsencrypt.org/directory"
-      - "--certificatesresolvers.ocis.acme.email=user@${OCIS_DOMAIN}"
-      - "--certificatesresolvers.ocis.acme.storage=/letsencrypt/acme-ocis.json"
+      #- "--log.level=DEBUG"
+      - "--certificatesResolvers.http.acme.email=${TRAEFIK_ACME_MAIL:-'example@example.org'}"
+      - "--certificatesResolvers.http.acme.storage=/certs/acme.json"
+      - "--certificatesResolvers.http.acme.httpChallenge.entryPoint=http"
+      - "--api.dashboard=true"
+      - "--entryPoints.http.address=:80"
+      - "--entryPoints.https.address=:443"
+      - "--providers.docker.endpoint=unix:///var/run/docker.sock"
+      - "--providers.docker.exposedByDefault=false"
    ports:
      - "80:80"
      - "443:443"
-      - "8080:8080"
    volumes:
-      - "letsencrypt:/letsencrypt"
      - "/var/run/docker.sock:/var/run/docker.sock:ro"
-
-  ocis:
-    container_name: ocis
-    image: owncloud/ocis:latest
-    ports:
-      - 9200:9200
-    hostname: ocis
-    networks:
-      - ocisnet
-    volumes:
-      - ./config:/etc/ocis
-    environment:
-      OCIS_DOMAIN: ${OCIS_DOMAIN}
-      PROXY_TLS: "false"
-      PROXY_HTTP_ADDR: 0.0.0.0:9200
-      PROXY_OIDC_ISSUER: https://${OCIS_DOMAIN}
-      PROXY_OIDC_INSECURE: "true"
-      KONNECTD_ISS: https://${OCIS_DOMAIN}
-      KONNECTD_IDENTIFIER_REGISTRATION_CONF: "/etc/ocis/identifier-registration.yml"
-      KONNECTD_TLS: 1
-      GRAPH_OIDC_ENDPOINT: https://${OCIS_DOMAIN}
-      PHOENIX_OIDC_AUTHORITY: https://${OCIS_DOMAIN}
-      PHOENIX_OIDC_METADATA_URL: https://${OCIS_DOMAIN}/.well-known/openid-configuration
-      PHOENIX_WEB_CONFIG_SERVER: https://${OCIS_DOMAIN}
-      STORAGE_OIDC_ISSUER: https://${OCIS_DOMAIN}
-      STORAGE_TRANSFER_EXPIRES: 86400
-      STORAGE_FRONTEND_PUBLIC_URL: https://${OCIS_DOMAIN}
-      STORAGE_DATAGATEWAY_PUBLIC_URL: https://${OCIS_DOMAIN}/data
-      STORAGE_LDAP_IDP: https://${OCIS_DOMAIN}
+      - "certs:/certs"
    labels:
      - "traefik.enable=true"
-      - "traefik.http.services.ocis.loadbalancer.server.port=9200"
-      - "traefik.docker.network=ocisnet"
-      - "traefik.protocol=https"
-      # ssl config
-      - "traefik.http.routers.ocis.rule=Host(`${OCIS_DOMAIN}`)"
-      - "traefik.http.routers.ocis.entrypoints=websecure"
-      - "traefik.http.routers.ocis.tls.certresolver=ocis"
-      # http -> https forwarding
-      - "traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https"
-      - "traefik.http.routers.ocis-redirs.rule=Host(`${OCIS_DOMAIN}`)"
-      - "traefik.http.routers.ocis-redirs.entrypoints=web"
-      - "traefik.http.routers.ocis-redirs.middlewares=redirect-to-https"
+      - "traefik.http.routers.traefik.entrypoints=http"
+      - "traefik.http.routers.traefik.rule=Host(`${TRAEFIK_DOMAIN:-traefik.owncloud.test}`)"
+      - "traefik.http.middlewares.traefik-auth.basicauth.users=${TRAEFIK_BASIC_AUTH_USERS:-admin:$apr1$4vqie50r$YQAmQdtmz5n9rEALhxJ4l.}" # defaults to admin:admin
+      - "traefik.http.middlewares.traefik-https-redirect.redirectscheme.scheme=https"
+      - "traefik.http.routers.traefik.middlewares=traefik-https-redirect"
+      - "traefik.http.routers.traefik-secure.entrypoints=https"
+      - "traefik.http.routers.traefik-secure.rule=Host(`${TRAEFIK_DOMAIN:-traefik.owncloud.test}`)"
+      - "traefik.http.routers.traefik-secure.middlewares=traefik-auth"
+      - "traefik.http.routers.traefik-secure.tls=true"
+      - "traefik.http.routers.traefik-secure.tls.certresolver=http"
+      - "traefik.http.routers.traefik-secure.service=api@internal"
+    restart: always

-networks:
-  ocisnet:
+  ocis:
+    image: owncloud/ocis:${OCIS_DOCKER_TAG:-latest}
+    entrypoint:
+      - /bin/sh
+      - -c
+      - | # as long as https://github.com/owncloud/product/issues/15 is open we need this step to template konnectd config
+        cp /config/identifier-registration.dist.yaml /config/identifier-registration.yaml
+        sed -i 's/ocis.owncloud.test/${OCIS_DOMAIN:-ocis.owncloud.test}/g' /config/identifier-registration.yaml
+        ocis server
+    networks:
+      default:
+    environment:
+      # general config
+      OCIS_DOMAIN: ${OCIS_DOMAIN:-ocis.owncloud.test}
+      OCIS_LOG_LEVEL: error
+      # proxy config
+      PROXY_AUTOPROVISION_ACCOUNTS: "true"
+      PROXY_OIDC_INSECURE: "${INSECURE:-false}"
+      PROXY_OIDC_ISSUER: https://${OCIS_DOMAIN:-ocis.owncloud.test}
+      PROXY_TLS: "false"
+      # phoenix config
+      PHOENIX_OIDC_AUTHORITY: https://${OCIS_DOMAIN:-ocis.owncloud.test}
+      PHOENIX_OIDC_METADATA_URL: https://${OCIS_DOMAIN:-ocis.owncloud.test}/.well-known/openid-configuration
+      PHOENIX_WEB_CONFIG_APPS: files,draw-io,markdown-editor,media-viewer
+      PHOENIX_WEB_CONFIG_SERVER: https://${OCIS_DOMAIN:-ocis.owncloud.test}
+      # storage config
+      STORAGE_DATAGATEWAY_PUBLIC_URL: https://${OCIS_DOMAIN:-ocis.owncloud.test}/data
+      STORAGE_FRONTEND_PUBLIC_URL: https://${OCIS_DOMAIN:-ocis.owncloud.test}/
+      STORAGE_OIDC_ISSUER: https://${OCIS_DOMAIN:-ocis.owncloud.test}
+      STORAGE_METADATA_ROOT:  /opt/ocis-metadata
+      STORAGE_DRIVER_OCIS_ROOT: /opt/ocis-storage
+      # store config
+      STORE_DATA_PATH: /opt/ocis-store
+      # settings config
+      SETTINGS_DATA_PATH: /opt/ocis-settings
+      # idp config
+      KONNECTD_ISS: https://${OCIS_DOMAIN:-ocis.owncloud.test}
+      KONNECTD_TLS: 'false'
+    volumes:
+      - ./config:/config
+      - ocis-storage:/opt/ocis-storage
+      - ocis-metadata:/opt/ocis-metadata
+      - ocis-store:/opt/ocis-store
+      - ocis-settings:/opt/ocis-settings
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.routers.ocis.entrypoints=http"
+      - "traefik.http.routers.ocis.rule=Host(`${OCIS_DOMAIN:-ocis.owncloud.test}`)"
+      - "traefik.http.middlewares.ocis-https-redirect.redirectscheme.scheme=https"
+      - "traefik.http.routers.ocis.middlewares=ocis-https-redirect"
+      - "traefik.http.routers.ocis-secure.entrypoints=https"
+      - "traefik.http.routers.ocis-secure.rule=Host(`${OCIS_DOMAIN:-ocis.owncloud.test}`)"
+      - "traefik.http.routers.ocis-secure.tls=true"
+      - "traefik.http.routers.ocis-secure.tls.certresolver=http"
+      - "traefik.http.routers.ocis-secure.service=ocis"
+      - "traefik.http.services.ocis.loadbalancer.server.port=9200"
+    restart: always
+
+volumes:
+  certs:
+  ocis-storage:
+  ocis-metadata:
+  ocis-store:
+  ocis-settings: