j1-template 2021.0.2 → 2021.0.7

data/assets/themes/j1/core/fonts/materialdesign_icons/license.md

@@ -1,97 +0,0 @@
-Copyright (C) 2014, Austin Andrews (http://materialdesignicons.com/),
-with Reserved Font Name Material Design Icons.
-
-Copyright (C) 2014, Google (http://www.google.com/design/)
-uses the license at https://github.com/google/material-design-icons/blob/master/LICENSE
-
-This Font Software is licensed under the SIL Open Font License, Version 1.1.
-This license is copied below, and is also available with a FAQ at:
-http://scripts.sil.org/OFL
-
-
------------------------------------------------------------
-SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
------------------------------------------------------------
-
-PREAMBLE
-The goals of the Open Font License (OFL) are to stimulate worldwide
-development of collaborative font projects, to support the font creation
-efforts of academic and linguistic communities, and to provide a free and
-open framework in which fonts may be shared and improved in partnership
-with others.
-
-The OFL allows the licensed fonts to be used, studied, modified and
-redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded, 
-redistributed and/or sold with any software provided that any reserved
-names are not used by derivative works. The fonts and derivatives,
-however, cannot be released under any other type of license. The
-requirement for fonts to remain under this license does not apply
-to any document created using the fonts or their derivatives.
-
-DEFINITIONS
-"Font Software" refers to the set of files released by the Copyright
-Holder(s) under this license and clearly marked as such. This may
-include source files, build scripts and documentation.
-
-"Reserved Font Name" refers to any names specified as such after the
-copyright statement(s).
-
-"Original Version" refers to the collection of Font Software components as
-distributed by the Copyright Holder(s).
-
-"Modified Version" refers to any derivative made by adding to, deleting,
-or substituting -- in part or in whole -- any of the components of the
-Original Version, by changing formats or by porting the Font Software to a
-new environment.
-
-"Author" refers to any designer, engineer, programmer, technical
-writer or other person who contributed to the Font Software.
-
-PERMISSION & CONDITIONS
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of the Font Software, to use, study, copy, merge, embed, modify,
-redistribute, and sell modified and unmodified copies of the Font
-Software, subject to the following conditions:
-
-1) Neither the Font Software nor any of its individual components,
-in Original or Modified Versions, may be sold by itself.
-
-2) Original or Modified Versions of the Font Software may be bundled,
-redistributed and/or sold with any software, provided that each copy
-contains the above copyright notice and this license. These can be
-included either as stand-alone text files, human-readable headers or
-in the appropriate machine-readable metadata fields within text or
-binary files as long as those fields can be easily viewed by the user.
-
-3) No Modified Version of the Font Software may use the Reserved Font
-Name(s) unless explicit written permission is granted by the corresponding
-Copyright Holder. This restriction only applies to the primary font name as
-presented to the users.
-
-4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
-Software shall not be used to promote, endorse or advertise any
-Modified Version, except to acknowledge the contribution(s) of the
-Copyright Holder(s) and the Author(s) or with their explicit written
-permission.
-
-5) The Font Software, modified or unmodified, in part or in whole,
-must be distributed entirely under this license, and must not be
-distributed under any other license. The requirement for fonts to
-remain under this license does not apply to any document created
-using the Font Software.
-
-TERMINATION
-This license becomes null and void if any of the above conditions are
-not met.
-
-DISCLAIMER
-THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
-OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
-DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
-OTHER DEALINGS IN THE FONT SOFTWARE.

data/assets/themes/j1/modules/lunrSearch/js/lunr_search.min.js

@@ -1,17 +0,0 @@
-/*
- # -----------------------------------------------------------------------------
- # ~/assets/themes/j1/modules/lunr/js/jquery.lunr.search.js
- # jQuery plugin to use with J1LunrSearch
- #
- # Product/Info:
- # https://jekyll.one
- #
- # Copyright (C) 2021 Juergen Adams
- #
- # J1 Template is licensed under the MIT License.
- # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
- # -----------------------------------------------------------------------------
- # TODO:
- # -----------------------------------------------------------------------------
-*/
-"use strict";!function(t){var e=function(t){var e=t.match(/(\d+)/g);return new Date(e[0],e[1]-1,e[2])},n=function(){function n(e,n){this.$elem=e,this.$results=t(n.results),this.indexDataUrl=n.indexUrl,this.template=this.compileTemplate(t(n.template)),this.titleMsg=n.titleMsg,this.emptyMsg=n.emptyMsg,this.onAfterResultShow=n.onAfterResultShow,this.initialize()}return n.prototype.initialize=function(){var e=this;this.loadIndexData(function(n){e.docs=t.map(n.docs,e.createEntry),e.index=lunr.Index.load(n.index),e.populateSearchFromQuery(),e.bindKeypress()})},n.prototype.compileTemplate=function(t){var e=t.text();return Mustache.parse(e),function(t,n){return Mustache.render(e,t,n)}},n.prototype.loadIndexData=function(e){t.getJSON(this.indexDataUrl,e)},n.prototype.createEntry=function(n,r){var s=t.extend({id:r+1},n);return n.date&&t.extend(s,{date:e(n.date),pubdate:function(){return dateFormat(e(n.date),"yyyy-mm-dd")},displaydate:function(){return dateFormat(e(n.date),"mmm dd, yyyy")}}),s},n.prototype.bindKeypress=function(){var t,e,n,r=this,s=this.$elem.val();this.$elem.bind("keyup",(t=function(){var t=r.$elem.val();t!==s&&r.search(t),s=t},n=Array.prototype.slice,function(){var r=n.call(arguments),s=this;clearTimeout(e),e=setTimeout(function(){t.apply(s,r)},100)}))},n.prototype.search=function(e){var n=this.docs;if(e.length<3)this.$results.hide().empty();else{var r=t.map(this.index.search(e),function(e){return t.grep(n,function(t){return t.id===parseInt(e.ref,10)})[0]});this.displayResults(r),this.onAfterResultShow()}},n.prototype.displayResults=function(t){var e=this.$results;e.empty(),0===t.length?e.append(this.emptyMsg):(this.titleMsg&&0!==this.titleMsg.length&&e.append(this.titleMsg),e.append(this.template({docs:t}))),e.show()},n.prototype.populateSearchFromQuery=function(){var t=new URI(window.location.search.toString()).search(!0);t.hasOwnProperty("q")&&(this.$elem.val(t.q),this.search(t.q.toString()))},n}();t.fn.lunrSearch=function(e){return e=t.extend({},t.fn.lunrSearch.defaults,e),new n(this,e),this},t.fn.lunrSearch.defaults={indexUrl:"/assets/data/lunr-index.json",results:"#search-results",template:"#search-results-template",titleMsg:"<h1>Search results<h1>",emptyMsg:"<p>Nothing found.</p>",onAfterResultShow:function(){}}}(jQuery);

data/assets/themes/j1/modules/twemoji/js/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 Twitter, Inc and other contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

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

@@ -1,171 +0,0 @@
-# ------------------------------------------------------------------------------
-#  ~/_data/modules/defaults/jekyll_search.yml
-#  Default configuration settings for J1 SimpleJekyllSearch module
-#
-#  Product/Info:
-#  https://jekyll.one
-#
-#  Copyright (C) 2021 Juergen Adams
-#
-#  J1 Template is licensed under the MIT License.
-#  See: https://github.com/jekyll-one/J1 Template/blob/master/LICENSE
-# ------------------------------------------------------------------------------
-
-# ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
-#
-about_config:
-  title:                                J1LunrSearch
-  scope:                                Default settings
-  location:                             _data/modules/defaults/lunr_search.yml
-
-# ------------------------------------------------------------------------------
-# J1LunrSearch settings
-#
-#   enabled
-#   ----------------------------------------------------------------------------
-#   Enables|Disables the use of J1 Search Manager
-#
-#   values:                         boolean (true|false)
-#   default:                        false
-#
-#   placement
-#   ----------------------------------------------------------------------------
-#   Enables|Disables the console log
-#
-#   values:                         boolean (true|false)
-#   default:                        false
-#
-#   target
-#   ----------------------------------------------------------------------------
-#   The ID used for the bootstrap theme css file
-#
-#   values:                         string
-#   default:                        bootstrapTheme
-#
-#   searchInput
-#   ----------------------------------------------------------------------------
-#   If true, a cookie will be saved with the currently selected theme
-#
-#   values:                         boolean (true|false)
-#   default:                        true
-#
-#   resultsOutput
-#   ----------------------------------------------------------------------------
-#   TBD
-#
-#   values:                         string
-#   default:
-#
-#   resultsContainer
-#   ----------------------------------------------------------------------------
-#   TBD
-#
-#   values:                         string
-#   default:
-#
-#   indexData
-#   ----------------------------------------------------------------------------
-#   TBD
-#
-#   values:                         string
-#   default:
-#
-#   resultTemplate
-#   ----------------------------------------------------------------------------
-#   TBD
-#
-#   values:                         string
-#   default:
-#
-#   resultLimit
-#   ----------------------------------------------------------------------------
-#   TBD
-#
-#   values:                         string
-#   default:
-#
-#   minSearchItemLen
-#   ----------------------------------------------------------------------------
-#   TBD
-#
-#   values:                         string
-#   default:
-#
-#   searchFuzzy
-#   ----------------------------------------------------------------------------
-#   TBD
-#
-#   values:                         string
-#   default:
-#
-#   searchExlude
-#   ----------------------------------------------------------------------------
-#   TBD
-#
-#   values:                         string
-#   default:
-#
-# ------------------------------------------------------------------------------
-
-# ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
-#
-about_config:
-
-  title:                                J1LunrSearch
-  scope:                                Default settings
-  location:                             _data/modules/defaults/jekyll_search.yml
-
-# ------------------------------------------------------------------------------
-# Default settings
-#
-defaults:
-
-  enabled:                              false
-  placement:                            navbar
-  target:                               _blank
-
-  excludes:                             [ /assets/*, /apps/*, /log/* , /node_modules/*, '/*\.htm*/' ]
-  stopwords:                            /assets/themes/j1/modules/lunrSearch/stopwords.txt
-  stopwords_locale:                     de
-  strip_index_html:                     false
-  min_length:                           3
-  date_format:                          mmm dd, yyyy
-
-  module_dir:                           /assets/themes/j1/modules/lunrSearch/js
-  index_dir:                            /assets/data
-  index_name:                           lunr-index.json
-  index_file:                           /assets/data/lunr-index.json
-
-  search_input:                         '#search-query'                         # '#jss-input'
-  results:                              '#search-results'                       # selector for containing search results element
-  template:                             '#search-results-template'              # selector for Mustache.js template
-  titleMsg:                                                                     # '<h1>Search results<h1>' message attached in front of results (can be empty)
-  emptyMsg:                                                                     # '<p>Nothing found.</p>' # shown message if search returns no results
-
-
-  # search_input:                         jss-input
-  # results_output:                       jss-panel
-  # results_container:                    jss-results
-  # index_data:                           /assets/data/search.json
-  # result_limit:                         1000
-  # result_truncate:                      100
-  # no_results_text:                      The search has no results
-  # min_search_item_len:                  5
-  # search_fuzzy:                         false
-  # search_exlude:                        [ Impress ]
-  # result_template: >
-  #                                       <li>
-  #                                         <div>
-  #                                           <h4 class="result-item"> <a href="{url}" target="{target}">{title} - {tagline}</a> </h4>
-  #                                           <p class="result-group-item-text">{excerpt}</p>
-  #                                           <p class="result-group-item-text small text-muted mb-3">
-  #                                             <i class="mdi mdi-calendar-blank mdi-18px mr-1"></i>{date}
-  #                                             <i class="mdi mdi-tag mdi-18px ml-2 mr-1"></i>{tags}
-  #                                           </p>
-  #                                         </div>
-  #                                       </li>
-
-# ------------------------------------------------------------------------------
-# END config

data/lib/starter_web/_plugins/simple_search_filter.rb

@@ -1,32 +0,0 @@
-# ------------------------------------------------------------------------------
-# ~/_plugins/simple_search_filter.rb
-# Liquid filter's to be used with JekyllSimple Search
-#
-# Product/Info:
-# http://jekyll.one
-#
-# Copyright (C) 2021 Juergen Adams
-#
-# J1 Template is licensed under the MIT License.
-# See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
-# ------------------------------------------------------------------------------
-
-module Jekyll
-  module CharFilter
-    def remove_chars(input)
-      input.gsub! '\\','\'
-      input.gsub! /\t/, '    '
-      input.strip_control_and_extended_characters
-    end
-  end
-end
-
-Liquid::Template.register_filter(Jekyll::CharFilter)
-
-class String
-  def strip_control_and_extended_characters()
-    chars.each_with_object("") do |char, str|
-      str << char if char.ascii_only? and char.ord.between?(32,126)
-    end
-  end
-end

data/lib/starter_web/collections/posts/public/featured/_posts/_includes/documents/unsplash-badge.asciidoc

@@ -1,31 +0,0 @@
-++++
-<a style="background-color:rgba(0, 0, 0, 0.3);color:white;text-decoration:none;padding:4px 6px;font-family:-apple-system, BlinkMacSystemFont, &quot;San Francisco&quot;, &quot;Helvetica Neue&quot;, Helvetica, Ubuntu, Roboto, Noto, &quot;Segoe UI&quot;, Arial, sans-serif;font-size:12px;font-weight:bold;line-height:1.2;display:inline-block;border-radius:3px" href="https://unsplash.com/@bel2000a?utm_medium=referral&amp;utm_campaign=photographer-credit&amp;utm_content=creditBadge" target="_blank" rel="noopener noreferrer" title="Download free do whatever you want high-resolution photos from Belinda Fewings">
-  <span style="display:inline-block;padding:2px 3px">
-    <svg xmlns="http://www.w3.org/2000/svg" style="height:12px;width:auto;position:relative;vertical-align:middle;top:-2px;fill:white" viewBox="0 0 32 32">
-      <title>unsplash-logo</title>
-      <path d="M10 9V0h12v9H10zm12 5h10v18H0V14h10v9h12v-9z"></path>
-    </svg>
-  </span>
-  <span style="display:inline-block;padding:2px 3px">Belinda Fewings</span>
-</a>
-++++
-
-++++
-<div class="attic__badge">
-  <a class="attic__badge_unsplash"
-    href="https://unsplash.com/@bel2000a?utm_medium=referral&amp;utm_campaign=photographer-credit&amp;utm_content=creditBadge"
-    target="_blank"
-    rel="noopener noreferrer"
-    title="Download free do whatever you want high-resolution photos from Belinda Fewings">
-    <span class="attic__badge_unsplash_icon">
-      <svg xmlns="http://www.w3.org/2000/svg"
-    	  class="attic__badge_unsplash_icon-size"
-        viewBox="0 0 32 32">
-        <title>unsplash-logo</title>
-        <path d="M10 9V0h12v9H10zm12 5h10v18H0V14h10v9h12v-9z"></path>
-      </svg>
-    </span>
-    <span class="attic__badge_unsplash_text">Belinda Fewings</span>
-  </a>
-</div>
-++++

data/lib/starter_web/collections/posts/public/series/_posts/_includes/documents/100-docker-using-shared-folders.asciidoc

@@ -1,430 +0,0 @@
-[[readmore]]
-== Docker smooth on Windows
-
-[role="mb-3"]
-image::{page-imagesdir}/windows_docker_banner.1280x500.png[{{page.title}}]
-
-In general, two incarnations of Docker for Windows are available:
-
-* Legacy solution: *Docker Toolbox*
-* Native solution: *Docker for Windows*
-
-Before the native version of Docker *Docker for Windows* was available,
-a *cross-platform* solution called *Docker Toolbox* could be used.
-*Docker Toolbox* is a bundle of *current* Docker software based on
-*Docker Machine* combined with the *Docker Engine* bundled with
-*VirtualBox* as a Hypervisor to run Linux boxes as virtual machines
-on Windows.
-
-What the Docker team recomments: Update to the newer package, if possible.
-This should be discussed, especially for Windows, in more detail ...
-
-[WARNING]
-====
-*The Docker Team mentions the following about Docker Toolbox:*
-
-Docker Toolbox is for *older Windows* systems (or *Apple MacOS* versions)
-that *does not meet* the requirements of the *native* Docker version.
-====
-
-Docker won't never run *natively* on Windows. The *Container Technology*
-used by Docker depends on *Linux* (at least on a Unix flavour of the host
-operating system). For all non-Linux (or Unix) platforms, a *Hypervisor* is
-needed to make it possible to run the needed *Linux OS* for Docker.
-
-Yes, Windows support a *native* Hypervisor layer: `Hyper-V`. Using the Windows
-component `Hyper-V`, any operating system can be run as *virtual machines* on
-Windows. But it should be kept in mind: the Hypervisor layer is *always* needed;
-as well as for the so-called the *native* Docker version on Windows. But:
-real *native* Docker versions does *not* need a Hypervisor layer; they run
-containers direcly on the host OS! This should be kept on mind.
-
-They are some pittfals using *Docker for Windows* if you go for:
-
-* Stability - found quite often issues running containers on *Docker for Windows*.
-If you're  not a Windows specialist, it is hard to findout issues for `Hyper-V`
-, the VM and|or both.
-* Flexibility - it is *NOT* possible to use the Hypervisor `Hyper-V` in
-parallel to *VirtualBox* as an alternative
-* Incompatibility - on some Windows installations, and for sure they met the
-requirements of the *native* Docker version, the installaton was *NOT*
-successful and Docker fails to start
-
-Again: the software included in the *Docker Toolbox* are *current* versions.
-The latest Toolbox contains:
-
-* the Docker Engine Docker, version 18.03.0-ce, build 0520e24302
-* the Docker Machine, version 0.14.0, build 89b8332
-* the Docker Composer, version 1.20.1, build 5d8c71b2
-* a current MINGW64-based GNU bash, version 4.4.19(2)-release (x86_64-pc-msys)
-
-For all the people having their (IT) roots on Unix respectively Linux, the
-*Docker Toolbox* is the better solution on Windows (for now). No need to go
-for the Windows Hypervisor `Hyper-V` - Oracle *VirtualBox* can be used
-instead; as quite often used for testing and development.
-
-Let's have a look how to *Manage Linux on Windows*, to use Docker on the
-Windows platform.
-
-== Installing Docker Toolbox
-
-As discussed ealier, *Docker Toolbox* is using *VirtualBox* for the
-Hypervisor to create the Linux VMs needed. To get the latest version,
-install VirtualBox first (Docker Toolbox includes a installer package
-for VBox but not nessesarily at their latets version).
-
-Go for the link:{virtualbox-install-on-windows}[VirtualBox Download Page]
-and select under *VirtualBox 5.x.y platform packages* the latest version
-for Windows (Windows hosts). Install the package - the installation process
-is quite simple supported by an build in installer wizard.
-
-If done, go for the installation of the Toolbox. A current package can be
-retrieved from link:{docker-install-toolbox-on-windows}[Docker Documents].
-The page includes all the info needed to install the software.
-
-NOTE: For the installation of the *Docker Toolbox*, please deselect the
-installation of *VirtualBox* included as the software has been already
-installed.
-
-NOTE: The commandline interface used by *Docker Toolbox* is based on
-*Git MSYS-git UNIX tools*. If you have *Git* installed already for your
-Windows host, please deselect the installation of *Git* included.
-
-*Docker Toolbox* comes with *NO* graphical user interface (GUI). To manage
-Docker, the included GNU bash of the *Git MSYS-git UNIX tools* shoud be used.
-A very first version of a (native) Docker UI on Windows is *Kitematic*,
-currently in a alpha version included.
-
-ifdef::backend-html5[]
-.Docker UI Kinematic on Windows
-lightbox::docker-windows-kinematic-alpha[ 800, {docker-windows-kinematic-alpha-data} ]
-endif::[]
-
-TIP: You should check *Kitematic*. If started for *Docker Toolbox* on Windows,
-change (the Hypervisor) to Virtualbox.
-
-For Windows users a commandline interface to manage a complex system like
-Docker may sound a bit stone age. It's not for good reasons:
-
-* the knowlegde of the base Docker commands is essential to understand the
-Container Technology better
-
-* Blalal blaaa
-
-
-
-== Manage Linux on Windows
-
-VirtualBox is a greate piece of software for desktop and workstation
-virtualization. A huge number of IT specialist and developers are using VB
-for: testing and development environments. Sometimes for production
-environments – if it's applicable.
-
-One good idea for VirtualBox is, if you are Web|App developer for Linux you
-can keep *Windows* as your primary OS - yeah, yeah those people are living on
-our planet! One can install a Linux distribution of choice in VirtualBox VM
-and reap both benefits of Windows as primary OS and Linux as a server
-platform for good reasons.
-
-=== Create a Linux VM
-
-lorem:sentences[5]
-
-lorem:sentences[3]
-
-
-=== Sharing Data
-
-For (real) native Docker installations, it is easy to share data between then
-host OS and containers managed by Docker. It is simple this:
-
-[source, sh]
-----
-docker run --rm \
-  --volume=$PWD:/srv/jekyll \
-  -p 35729:35729 -p 40000:40000 \
-  -it jekyll-one/j1:latest \
-  j1 serve --incremental --livereload
-----
-
-The container, instructed by `--volume=$PWD:/srv/jekyll` shares the
-filesystem of the host - the *native* way to bring in data into a
-container for processing. In the example a static Jekyll Web is created
-by J1 Template (j1), served by the ports 35729 for livereload and 40000
-serving the web.
-
-For the Windows platform, using a virtual Linux Box for Docker containers,
-this is *NOT* possible. The virtual system is managed by Virtualbox and no
-direct relationship is in between the VBox and the host operating system
-Windows! No (direct) access to the host filesystem is possible. Bad luck so
-far.
-
-Generally spoken, there are 3 ways of sharing files between a Windows host
-and Linux guest boxes; keep files:
-
-* in the guest (Linux) and share them with host through Samba
-* on host (Windows) and use VirtualBox *Shared Folders*
-* on host (Windows) and mount Windows *Public Folders* via CIFS
-from within guest (Linux)
-
-For all people experienced on the Linux platform, the first option is
-probably the easiest. But it has it’s drawbacks. In most cases for testing,
-it's *NOT* wanted to keep files in a VM. In case of corruption of the VM,
-reinstallation needs, or whatever yor data is *lost* in most cases. Truly,
-not an option.
-
-Typically developers want them kept on native Windows *disks* as they are
-expected as more safely stored on physical devices and easier to backup.
-So first option is clearly out.
-
-*Shared Folders* are really a great idea. After installing the *VirtualBox
-Guest Additions* (which brings the mount.vboxsf binary and vboxsf kernel
-module) the guest can mount automatically a Windows OS folder inside the VM.
-Some klicks further the guest start's, mount the *shared folder* in guest and
-voila: you're done! Sounds really great.
-
-But there's a catch – performance. Shared Folders are really, really horrible
-slow. Which in turn kills the idea of programming and testing code without
-loosing hair because of the slowness. You can find tons of articles around
-slow shared folders on the Internet; both for the Big Dogs: VMware and
-VirtualBox. But no solution. Since decades.
-
-Analyzing the performance, it's obvious that kernel spends really large
-amount of time in IO mode – so the vboxsf CIFS emulation of VirtualBoxis
-behaving something like a slug. Birds love slugs but IT professionals don’t
-like that, do they?
-
-It seems that the only viable solution is sharing folders though Windows and
-mounting them via CIFS on the guest, the virtual Linux box. This way, a
-similiar flexible solution for sharing folders can be achived but at a much
-better performance.
-
-
-=== Performance tests
-
-Anyway, *shared folders* will be always slow as the are of type *NAS* - network
-attached storage. For a local network nowadays, typically at Gigabit level and
-quite low in latency, an acceptable performance cab be achived.
-
-I did some simple tests to show the performance differences. There are three
-directories I did for my tests:
-
-* /mnt/media/repo1, data on a physical (local) disk on the host
-* /mnt/media/repo2, data on a physical (local) disk in the guest
-* /mnt/media/repo3, data on a Windows share mounted via cifs in the guest
-
-I've been using simple (bash) script based on *dd* commands for testing.
-The *dd* commands used as a base are shown below. For sure not a quite
-sophisticated test scenario but it's giving a general impression what can
-achived in real world.
-
-NOTE: For multi-platform testing, on Windows the `dd` command is used as well.
-For *Docker Toolbox*, beside the GNU bash, a full set of *GNU CoreUtils* are
-available as well (accessible out of the *Docker Quickstart Terminal*). The
-used (bash) test script needs to be run out of *Docker Quickstart Terminal*.
-Download the tester script from here.
-
-The test script *docker_perf_test.sh* supports a test scenario for
-*General System Performance*. This is focussing on pure CPU|Memory power.
-On both systems (host and guest) these tests are using pure *kernel services*
-for creating input and output data. One is creating random input data as
-fast as possible, the other discards everything it gets as fast as it can.
-
-.General System Performance
-[source, sh]
-----
-dd if=/dev/urandom of=/dev/null bs=1M count=10000
-----
-
-Please see those tests for *General System Performance* for the background
-*What could be achived in therory*. These tests may helpful to compare your
-current setup for the host and the guest same way.
-
-As mentioned, all tests for *docker_perf_test.sh* are based on the `dd`
-command. For *real world* measures, standard *dd tests* are used. You'll
-find a lot of those on the Internet. All tests for *docker_perf_test.sh* are
-changed (from `/dev/zero`) to `/dev/urandom` for the input to put some
-*pressure* on the CPU while processing data for reading or writing from the
-filesystem to be checked. All the tests are *rules of thumb*, no technical
-measures.
-
-NOTE: Zum Messen der Schreibperformance liest man die zu Schreibenden
-Daten am besten aus /dev/zero und schreibt eine normale Datei im Filesystem
-(z.B. mit of=/root/testfile). Die folgenden Beispiele verwenden ein Testdatei,
-um irrtümlichen Datenverlust zu vermeiden. Die dabei erzielbare Performance
-Werte sind etwas geringer (da dadurch auch Metadaten im Filesystem geschrieben
-werden).
-
-Find the base `dd` commands for read an write performance tests below. The
-exported shared folder on Windows is *C:\Users\Public* mapped to the Unix
-(POSIX) folder scheme of */c/Users/Public* on the guest OS.
-
-.Write Performance - Windows host (local disk), Linux guest (shared disk)
-[source, sh]
-----
-dd if=/dev/urandom bs=1M count=1024 | split -b 1M - name.
-----
-.Write Performance (local disk), Linux guest
-[source, sh]
-----
-dd if=/dev/urandom of=/var/tmp/test/samplefile bs=1M count=1024
-----
-
-.Read Performance - Windows host (local disk), Linux guest (shared disk)
-[source, sh]
-----
-dd if=/c/Users/Public/test/samplefile of=/dev/null bs=1M count=1024 iflag=direct
-----
-.Read Performance (local disk), Linux guest
-[source, sh]
-----
-dd if=/var/tmp/test/samplefile of=/dev/null bs=1M count=1024 iflag=direct
-----
-
-Have a look at the table below for the measures found on a *Windows 10*
-desktop host (Intel Core Quad Q9550) using a *SATA-300* disk for the local
-physical disk and a Gigabit network interface (*Realtek PCIe GBE* familiy)
-running a *CentOS 7 Linux* (version 3.10.0-862) as a guest:
-
-.Data transfer rates for 1 GB of data
-[cols="2,2,4,3, options="header", role="table-responsive, full-width"]
-|===============================================================================
-|direction |mountpoint |source |througput [MB/s]
-
-|`read`
-|/mnt/media/repo1
-|physical (local) disk on the *host*
-|85.20
-
-|`read`
-|/mnt/media/repo2
-|physical (local) disk on the *guest*
-|147.00
-
-|`read`
-|/mnt/media/repo3
-|shared disk on the *guest*
-|30.3
-
-|`write`
-|/mnt/media/repo1
-|physical (local) disk on the *host*
-|234.00
-
-|`write`
-|/mnt/media/repo2
-|physical (local) disk on the *guest*
-|34.00
-
-|`write`
-|/mnt/media/repo3
-|shared disk on the *guest*
-|39.9
-
-|===============================================================================
-
-WARNING: Bei Verwendung von if=/dev/zero und bs=1G benötigt das Linuxsystem
-1GB freien Platz im RAM. Falls Ihr Testsystem nicht ausreichend RAM ...
-
-NOTE: Um praxisnahe Ergebnisse zu erhalten empfehlen wir die beschrieben Tests
-mehrmals (z.B. 3 bis 10x) durchzuführen. Damit können Sie Ausreißer rechtzeitig
-erkennen.
-
-
-lorem:sentences[5]
-
-== Publish a Shared Folder
-
-lorem:sentences[5]
-
-lorem:sentences[3]
-
-
-== Mount Shared Folders on Linux
-
-lorem:sentences[5]
-
-=== Installing CIFS
-
-For the Linux VM, a current Ubunt Server of version 18.06 is used. To mount
-CIFS shares, the package `cifs-utils` needs to be installed:
-
-[source, bash]
-----
-sudo apt-get -y install cifs-utils
-----
-
-Mounting filesystems in general, therefor the same to the CIFS share, are
-done as root. This ends up in the situation this folder cannot (accessed??)
-written as normal user.
-
-. Create the `cifs` group
-+
-[source, bash]
-----
-sudo groupadd cifs
-----
-
-[start=2]
-.  Add your user to the `cifs` group
-+
-[source, bash]
-----
-sudo usermod -aG cifs $USER
-----
-
-[start=3]
-.  Create the mountpoint (to be used by Docker) as root
-+
-[source, bash]
-----
-mkdir -p /c/Users/Public
-----
-
-[start=4]
-.  Change the ownership of the mountpoint
-+
-[source, bash]
-----
-chown -R root:cifs  /c/Users/Public
-----
-
-[start=5]
-.  Create a credentials file to place user|password data safe.
-+
-[source, bash]
-----
-touch ~/.smbcredentials
-----
-
-.smbcredentials
-----
-username=<your_windows_user>
-password=<windows_user_password>
-----
-
-=== Mount the share manually
-
-To enable non-authorized users to read and write the shared files, specify
-user and group ID that the mounted shares folders should use. This would
-allow particular users and group members to read|write to the share.
-
-To do so, the following options are used for a public mount:
-
-* username
-* password
-* uid
-* gid
-
-Add the Windows host IP address to the hosts file
-
-./etc/hosts
-<ip_v4_address>  <name_of_the windows_box>  <alias_name>
-
-
-=== Mount the share at boot-time
-
-lorem:sentences[3]
-
-./etc/fstab
-&#47;&#47;win10pc/Public /c/Users/Public cifs uid=1000,gid=5555,credentials=/home/jadams/.smbcredentials,iocharset=utf8,rw  0 0