j1-template 2021.1.5 → 2021.1.10

data/lib/starter_web/_config.yml

@@ -53,7 +53,7 @@ environment:                            production
 # ------------------------------------------------------------------------------
 #   Sets the build version of J1 Template Gem
 #
-version:                                2021.1.5
+version:                                2021.1.10
 
 # version
 # ------------------------------------------------------------------------------
@@ -593,9 +593,9 @@ defaults:
       layout:                           page
       author:                           J1 Team
 
-#     robots:
-#       index:                          true
-#       follow:                         true
+      robots:
+        index:                          false
+        follow:                         false
 
       analytics:                        false
       advertising:                      false
@@ -632,9 +632,9 @@ defaults:
       layout:                           post
       author:                           J1 Team
 
-#     robots:
-#       index:                          true
-#       follow:                         true
+      robots:
+        index:                          false
+        follow:                         false
 
       analytics:                        false
       advertising:                      false
@@ -671,9 +671,9 @@ defaults:
       layout:                           post
       author:                           J1 Team
 
-#     robots:
-#       index:                          true
-#       follow:                         true
+      robots:
+        index:                          false
+        follow:                         false
 
       analytics:                        false
       advertising:                      false
@@ -706,6 +706,10 @@ defaults:
       layout:                           post
       author:                           Wikipedia
 
+      robots:
+        index:                          false
+        follow:                         false
+
       analytics:                        false
       advertising:                      false
       comments:                         false
@@ -741,6 +745,10 @@ defaults:
       layout:                           page
       sitemap:                          false
 
+      robots:
+        index:                          false
+        follow:                         false
+
 # ==============================================================================
 # 6. LAYOUT configuration
 #

data/lib/starter_web/_data/_defaults/private.default.yml

@@ -0,0 +1,119 @@
+# ------------------------------------------------------------------------------
+# ~/_data/private.yml
+# The private.yml file is used to set sensitive private data used by
+# J1 components to configure security and authentication settings
+#
+# Product/Info:
+# https://jekyll.one
+#
+# Copyright (C) 2019 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# See: https://github.com/jekyll-one-org/j1_template/blob/master/LICENSE
+# ------------------------------------------------------------------------------
+# NOTE:
+#   As this file contains very confidential data, a productive private.yml
+#   file should ALWAYS be excluded from ANY source published to the public
+#   (e.g. a repo at Github)
+# ------------------------------------------------------------------------------
+
+
+# ==============================================================================
+# GLOBAL settings
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+global:
+
+  # used by J1 to encrypt cookies
+  session_secret:                       <your-secret-string>
+
+
+# ==============================================================================
+# MODULE settings
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+modules:
+
+  # J1 Webhook
+  # NOTE:
+  # ----------------------------------------------------------------------------
+  webhook:
+
+    comment:
+      name:                             <your-config-name>
+      user:                             <your-gh-user>
+      repo:                             <your-gh-repo>
+      server_url:                       <your-gh-webhook-url>
+
+    secret:                             <your-gh-secret>                        # secret used at GH Webhooks
+    payload_url:                        <your-payload-url>                      # payload url (e.g channel at smee.io)
+
+
+# ==============================================================================
+# # J1 Utility Server
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+util_srv:
+
+  oauth:
+
+    # GH OAuth settings used for J1 Control Center (NetlifyCMS) for the
+    # external OAuth client (base_url)
+    # --------------------------------------------------------------------------
+    comment:
+      name:                           <your-config-name>
+      user:                           <your-gh-user>
+      user_url:                       <your-user-url>
+      strategy:                       members
+      members:                        all
+
+    site_url:                         http://localhost:41010
+    site_redirect_url:                http://localhost:41010/auth/github/callback
+    client_scope:                     repo, user
+    client_id:                        <your-client-id>
+    client_secret:                    <your-client-secret>
+
+
+# ==============================================================================
+# MIDDLEWARE settings
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+middleware:
+
+  # OAuth settings (J1 Auth Client)
+  # ----------------------------------------------------------------------------
+  oauth:
+
+    # --------------------------------------------------------------------------
+    # DISQUS credentials
+    # ==========================================================================
+    disqus:
+
+      # J1 Auth client (mode APP, development system)
+      # ------------------------------------------------------------------------
+      comment:
+        name:                           <your-disqus-config-name>
+        user:                           <your-disqus-user>
+
+      client_url:                       http://localhost:41010
+      client_redirect_url:              http://localhost:41010/auth/disqus/callback
+      client_id:                        <your-disqus-client-id>
+      client_secret:                    <your-disqus-client-secret>
+
+    # --------------------------------------------------------------------------
+    # GITHUB credentials
+    # ==========================================================================
+    github:
+
+      # J1 Auth client (mode APP, development system)
+      # ------------------------------------------------------------------------
+      comment:
+        name:                           <your-gh-config-name>
+        user:                           <your-gh-user>
+        org:                            <your-gh-org>
+        strategy:                       members
+        members:                        all
+
+      client_url:                       http://localhost:41010
+      client_redirect_url:              http://localhost:41010/auth/github/callback
+      client_id:                        <your-gh-client-id>
+      client_secret:                    <your-gh-client-secret>
+
+# ------------------------------------------------------------------------------
+# END

data/lib/starter_web/_data/j1_config.yml

@@ -140,6 +140,7 @@ cookies:
   app_session:                          j1.app.session
   user_session:                         j1.user.session
   user_state:                           j1.user.state
+  user_consent:                         j1.user.consent
 
 
 # ==============================================================================
@@ -161,7 +162,7 @@ cookies:
 #   NOTE: Used for developent mode ONLY
 #   NOTE: See ~/packages/300_template_src/_layouts/default.html
 # ------------------------------------------------------------------------------
-flicker_timeout:                        250
+flicker_timeout:                        150
 
 # ------------------------------------------------------------------------------
 # HTML PrettyPrint
@@ -386,15 +387,15 @@ comments:
   provider:                             disqus
 
   disqus:
-    short_name:                         '<your-site-short-name>'
+    short_name:                         '<your-site-id>'
 
-# facebook:
+# facebook:                                                                     # currently NOT supported
 #   appid:                              123
 #   num_posts:                          5
 #   width:                              580
 #   colorscheme:                        light
 
-# custom:
+# custom:                                                                       # currently NOT supported
 #   custom_data:
 
 # ------------------------------------------------------------------------------
@@ -410,8 +411,8 @@ analytics:
   google:
     tracking_id:                        '<your-tracking-id>'
 
-  custom:
-    custom_data:
+# custom:                                                                       # currently NOT supported
+#   custom_data:
 
 # ------------------------------------------------------------------------------
 # ADVERTISING settings
@@ -422,26 +423,28 @@ analytics:
 advertising:
   enabled:                              false
   provider:                             google
+
   google:
     publisher_id:                       '<your-publisher-id>'
-  custom:
-    custom_data:
+
+# custom:                                                                       # currently NOT supported
+#   custom_data:
 
 # ------------------------------------------------------------------------------
-# TRANSLATOR settings
+# TRANSLATOR settings (currently NOT supported)
 #
 # Set 'enabled' to false to turn translators off globally
 # Set 'provider' to the translation provider you want to use
 #
-translation:
-  enabled:                              false
-  provider:                             google
-
-  google:
-    layout:                             default
-    meta_data:                          [google-translate-customization]
-    page_language:                      en
-    translation_languages:              [all]
+# translation:
+#   enabled:                              false
+#   provider:                             google
+#
+#   google:
+#     layout:                             default
+#     meta_data:                          [google-translate-customization]
+#     page_language:                      en
+#     translation_languages:              [all]
 
 # ------------------------------------------------------------------------------
 # SHARING settings (currently NOT supported)

data/lib/starter_web/_data/modules/cookieconsent.yml

@@ -27,6 +27,7 @@ settings:
 
   enabled:                            true
   show_cookie_icon:                   true
+  reloadPageOnChange:                 true
 
 # ------------------------------------------------------------------------------
 # END config

data/lib/starter_web/_data/modules/defaults/cookieconsent.yml

@@ -26,16 +26,17 @@ defaults:
 
   enabled:                              false
 
-  autoShowDialog:                       true                                    # disable autoShowModal on the privacy policy and legal notice pages, to make these pages readable
-  language:                             en                                      # the language, in which the modal is shown. Default navigator.language
-  languages:                            [en, de]                                # supported languages, defaults to first language in array (en)
-  contentURL:                           /assets/data/cookieconsent              # this URL must contain the dialogs content in the needed languages
-  cookieName:                           j1.user.consent                         # the name of the cookie in which the configuration is stored as JSON
-  cookieStorageDays:                    365                                     # the duration the cookie configuration is stored on the client
+  autoShowDialog:                       true                                    # show consent dialog if NO consent cookie found
+  language:                             en                                      # language of the modal is shown. Default: navigator.language
+  languages:                            [en, de]                                # supported languages, defaults to FIRST language defined by languages
+  contentURL:                           /assets/data/cookieconsent              # dialogs content for all languages
+  cookieName:                           j1.user.consent                         # name of the consent cookie
+  cookieStorageDays:                    365                                     # duration the consent cookie is stored
+  postSelectionCallback:                j1.adapter.cookieConsent.cbCookie       # currently hardcoded
 
-  reloadPageOnChange:                   false                                   # reload current page if any user settings has been changed
-  xhr_data_element:                     consent-data                            # container for the language-specific consent modal taken from /assets/data/cookieconsent.html
-  whitelisted:                          [ "/pages/public/legal/en/privacy" ]    # pages no consent issued
+  reloadPageOnChange:                   false                                   # reload current page if user settings has been changed
+  xhr_data_element:                     consent-data                            # container for the language-specific consent modal (taken from /assets/data/cookieconsent.html)
+  whitelisted:                          [ /pages/public/legal/en/privacy ]      # pages NO consent issued, currently NOT supported
 
   consent_modal_title:
     de:                                 Ihre Privatsphäre

data/lib/starter_web/_data/modules/defaults/themer.yml

@@ -143,6 +143,7 @@ about_config:
 defaults:
 
   enabled:                              false
+
   retries:                              30                                      # retry to load theme list from API
   saveToCookie:                         true
   debug:                                false
@@ -151,7 +152,7 @@ defaults:
   menu_icon_color:                      "#9E9E9E"
   menu_icon_size:                       mdi-sm
   cssThemeLink:                         bootstrapTheme
-  defaultCssFile:                       https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css
+  defaultCssFile:                       https://cdn.jsdelivr.net/npm/bootstrap@4.6.0/dist/css/bootstrap.min.css
   bootswatchApiUrl:                     https://bootswatch.com/api
   bootswatchApiVersion:                 4
   loadFromBootswatch:                   true

data/lib/starter_web/_data/private.default.yml

@@ -0,0 +1,119 @@
+# ------------------------------------------------------------------------------
+# ~/_data/private.yml
+# The private.yml file is used to set sensitive private data used by
+# J1 components to configure security and authentication settings
+#
+# Product/Info:
+# https://jekyll.one
+#
+# Copyright (C) 2019 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# See: https://github.com/jekyll-one-org/j1_template/blob/master/LICENSE
+# ------------------------------------------------------------------------------
+# NOTE:
+#   As this file contains very confidential data, a productive private.yml
+#   file should ALWAYS be excluded from ANY source published to the public
+#   (e.g. a repo at Github)
+# ------------------------------------------------------------------------------
+
+
+# ==============================================================================
+# GLOBAL settings
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+global:
+
+  # used by J1 to encrypt cookies
+  session_secret:                       <your-secret-string>
+
+
+# ==============================================================================
+# MODULE settings
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+modules:
+
+  # J1 Webhook
+  # NOTE:
+  # ----------------------------------------------------------------------------
+  webhook:
+
+    comment:
+      name:                             <your-config-name>
+      user:                             <your-gh-user>
+      repo:                             <your-gh-repo>
+      server_url:                       <your-gh-webhook-url>
+
+    secret:                             <your-gh-secret>                        # secret used at GH Webhooks
+    payload_url:                        <your-payload-url>                      # payload url (e.g channel at smee.io)
+
+
+# ==============================================================================
+# # J1 Utility Server
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+util_srv:
+
+  oauth:
+
+    # GH OAuth settings used for J1 Control Center (NetlifyCMS) for the
+    # external OAuth client (base_url)
+    # --------------------------------------------------------------------------
+    comment:
+      name:                           <your-config-name>
+      user:                           <your-gh-user>
+      user_url:                       <your-user-url>
+      strategy:                       members
+      members:                        all
+
+    site_url:                         http://localhost:41010
+    site_redirect_url:                http://localhost:41010/auth/github/callback
+    client_scope:                     repo, user
+    client_id:                        <your-client-id>
+    client_secret:                    <your-client-secret>
+
+
+# ==============================================================================
+# MIDDLEWARE settings
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+middleware:
+
+  # OAuth settings (J1 Auth Client)
+  # ----------------------------------------------------------------------------
+  oauth:
+
+    # --------------------------------------------------------------------------
+    # DISQUS credentials
+    # ==========================================================================
+    disqus:
+
+      # J1 Auth client (mode APP, development system)
+      # ------------------------------------------------------------------------
+      comment:
+        name:                           <your-disqus-config-name>
+        user:                           <your-disqus-user>
+
+      client_url:                       http://localhost:41010
+      client_redirect_url:              http://localhost:41010/auth/disqus/callback
+      client_id:                        <your-disqus-client-id>
+      client_secret:                    <your-disqus-client-secret>
+
+    # --------------------------------------------------------------------------
+    # GITHUB credentials
+    # ==========================================================================
+    github:
+
+      # J1 Auth client (mode APP, development system)
+      # ------------------------------------------------------------------------
+      comment:
+        name:                           <your-gh-config-name>
+        user:                           <your-gh-user>
+        org:                            <your-gh-org>
+        strategy:                       members
+        members:                        all
+
+      client_url:                       http://localhost:41010
+      client_redirect_url:              http://localhost:41010/auth/github/callback
+      client_id:                        <your-gh-client-id>
+      client_secret:                    <your-gh-client-secret>
+
+# ------------------------------------------------------------------------------
+# END