Add Windows installation procedures

bodastage · Jan 16, 2018 · e9f61b1 · e9f61b1
1 parent 1a8ecea
commit e9f61b1
Show file tree

Hide file tree

Showing 9 changed files with 143 additions and 8 deletions.
diff --git a/_build/doctrees/environment.pickle b/_build/doctrees/environment.pickle
diff --git a/_build/doctrees/installation.doctree b/_build/doctrees/installation.doctree
diff --git a/_build/html/_images/enable_windows_features.png b/_build/html/_images/enable_windows_features.png
diff --git a/_build/html/_sources/installation.rst.txt b/_build/html/_sources/installation.rst.txt
@@ -1,6 +1,52 @@
 Installation
-============================= 
-To simplify the installation and setup process, the application is distributed in Docker containers. Docker is a way to distribute self-contained applications easily. We provide Docker images for the Community Edition that you can very easily install and upgrade on your PC, Laptops, or server. The docker hub repositories are located at https://hub.docker.com/u/bodastage/
+************
+The BTS-CE application is distributed in Docker containers to simplify the installation. Docker is a way to distribute self-contained applications easily. We provide Docker images for the Community Edition that you can very easily install and upgrade on your PC, Laptops, or server. The docker hub repositories are located at https://hub.docker.com/u/bodastage/
+
+Although this is the recommended installation method, you can still download the individual components from the Bodastage Solutions github page and install them as your see fit.
+
+Requirements
+============
+To run BTS-CE Docker containers, you will need:
+
+* A 64 bit operating system. (Windows 10, Linux, MacOSX)
+
+* Atleast 10 GB disk space
+
+* Atleast 4 GB RAM
+
+
+Windows  
+=======
+
+1. Enable HyperV or Install Oracle VirtualBox 
+
+2. Download and install Docker Community Edition for your platform from https://www.docker.com/community-edition#/download. Optionally, install Docker Toolbox depending on your Windows OS version for Windows users.
+
+3. Download the latest release files for BTS-CE from https://github.com/bodastage/bts-ce/releases
+
+4. Unzip the BTS-CE realease files. Open **cmd** as an Administrator and run **manager.bat up -d**
+
+4. Access the web client at localhost or <docker-machine ip> for Windows users
+
+Enable HyperV or Install Oracle VirtualBox 
+------------------------------------------
+
+When installing Docker CE on Windows. You can either use HyperV or Oracle VirtualBox.  These are used to create virtual machines from which your containers will run. 
+
+HyperV is an optional feature available on Windows 10 Enterprise, Professional, or Education. If you are using Windows 10 Home or any other windows release, you will need to upgrade or use Oracle VirtualBox.
+
+To enabled HyperV, follow the steps at https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v
+
+Download Oracle VirtualBox from https://www.virtualbox.org/
+
+.. Add note on which windows build versions are supported 
+
+Download Docker Community Edition
+---------------------------------
+Docker community edition
+
+Lunix and MacOSX
+================
 
 Follow the steps below to install the application:
 

diff --git a/_build/html/index.html b/_build/html/index.html
@@ -57,7 +57,12 @@ <h1>Guide<a class="headerlink" href="#guide" title="Permalink to this headline">
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#windows">Windows</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#lunix-and-macosx">Lunix and MacOSX</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 <li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a></li>

diff --git a/_build/html/installation.html b/_build/html/installation.html
@@ -44,7 +44,42 @@
 
   <div class="section" id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
-<p>To simplify the installation and setup process, the application is distributed in Docker containers. Docker is a way to distribute self-contained applications easily. We provide Docker images for the Community Edition that you can very easily install and upgrade on your PC, Laptops, or server. The docker hub repositories are located at <a class="reference external" href="https://hub.docker.com/u/bodastage/">https://hub.docker.com/u/bodastage/</a></p>
+<p>The BTS-CE application is distributed in Docker containers to simplify the installation. Docker is a way to distribute self-contained applications easily. We provide Docker images for the Community Edition that you can very easily install and upgrade on your PC, Laptops, or server. The docker hub repositories are located at <a class="reference external" href="https://hub.docker.com/u/bodastage/">https://hub.docker.com/u/bodastage/</a></p>
+<p>Although this is the recommended installation method, you can still download the individual components from the Bodastage Solutions github page and install them as your see fit.</p>
+<div class="section" id="requirements">
+<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
+<p>To run BTS-CE Docker containers, you will need:</p>
+<ul class="simple">
+<li>A 64 bit operating system. (Windows 10, Linux, MacOSX)</li>
+<li>Atleast 10 GB disk space</li>
+<li>Atleast 4 GB RAM</li>
+</ul>
+</div>
+<div class="section" id="windows">
+<h2>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h2>
+<ol class="arabic simple">
+<li>Enable HyperV or Install Oracle VirtualBox</li>
+<li>Download and install Docker Community Edition for your platform from <a class="reference external" href="https://www.docker.com/community-edition#/download">https://www.docker.com/community-edition#/download</a>. Optionally, install Docker Toolbox depending on your Windows OS version for Windows users.</li>
+<li>Download the latest release files for BTS-CE from <a class="reference external" href="https://github.com/bodastage/bts-ce/releases">https://github.com/bodastage/bts-ce/releases</a></li>
+<li>Unzip the BTS-CE realease files. Open <strong>cmd</strong> as an Administrator and run <strong>manager.bat up -d</strong></li>
+</ol>
+<ol class="arabic simple" start="4">
+<li>Access the web client at localhost or &lt;docker-machine ip&gt; for Windows users</li>
+</ol>
+<div class="section" id="enable-hyperv-or-install-oracle-virtualbox">
+<h3>Enable HyperV or Install Oracle VirtualBox<a class="headerlink" href="#enable-hyperv-or-install-oracle-virtualbox" title="Permalink to this headline">¶</a></h3>
+<p>When installing Docker CE on Windows. You can either use HyperV or Oracle VirtualBox.  These are used to create virtual machines from which your containers will run.</p>
+<p>HyperV is an optional feature available on Windows 10 Enterprise, Professional, or Education. If you are using Windows 10 Home or any other windows release, you will need to upgrade or use Oracle VirtualBox.</p>
+<p>To enabled HyperV, follow the steps at <a class="reference external" href="https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v">https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v</a></p>
+<p>Download Oracle VirtualBox from <a class="reference external" href="https://www.virtualbox.org/">https://www.virtualbox.org/</a></p>
+</div>
+<div class="section" id="download-docker-community-edition">
+<h3>Download Docker Community Edition<a class="headerlink" href="#download-docker-community-edition" title="Permalink to this headline">¶</a></h3>
+<p>Docker community edition</p>
+</div>
+</div>
+<div class="section" id="lunix-and-macosx">
+<h2>Lunix and MacOSX<a class="headerlink" href="#lunix-and-macosx" title="Permalink to this headline">¶</a></h2>
 <p>Follow the steps below to install the application:</p>
 <ol class="arabic simple">
 <li>Download Docker Community Edition for your platform from <a class="reference external" href="https://www.docker.com/community-edition#/download">https://www.docker.com/community-edition#/download</a>. Optionally, install Docker Toolbox depending on your Windows OS version for Windows users.</li>
@@ -53,6 +88,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <li>Run manage.sh start</li>
 <li>Access the web client at localhost or &lt;docker-machine ip&gt; for Windows users</li>
 </ol>
+</div>
 </div>
 
 
@@ -82,7 +118,12 @@ <h3>Quick search</h3>
 <h3><a href="index.html">Table Of Contents</a></h3>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#windows">Windows</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#lunix-and-macosx">Lunix and MacOSX</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li>
 <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
 <li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a></li>