Merge pull request #2 from jerryhgladinet/BryanGuoInstallationDoc

Update CentreStack Installation Documentation
jerryhgladinet · Jun 23, 2021 · 1fa0f0d · 1fa0f0d
1 parent ff16936
commit 1fa0f0d
Show file tree

Hide file tree

Showing 63 changed files with 1,087 additions and 56 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,9 @@
 [Bb]uild/
 _[Bb]uild/
+
+### vs ###
 .vscode/
+.vs/
+
+### macOS ###
+.DS_Store
diff --git a/.vs/ProjectSettings.json b/.vs/ProjectSettings.json
@@ -0,0 +1,3 @@
+{
+  "CurrentProjectSetting": null
+}
diff --git a/.vs/VSWorkspaceState.json b/.vs/VSWorkspaceState.json
@@ -0,0 +1,6 @@
+{
+  "ExpandedNodes": [
+    ""
+  ],
+  "PreviewInSolutionExplorer": false
+}
diff --git a/.vs/docs/v16/.suo b/.vs/docs/v16/.suo
diff --git a/.vs/slnx.sqlite b/.vs/slnx.sqlite
diff --git a/deploy/source/_static/image008.png b/deploy/source/_static/image008.png
diff --git a/deploy/source/_static/image009(1).png b/deploy/source/_static/image009(1).png
diff --git a/deploy/source/_static/image010(1).png b/deploy/source/_static/image010(1).png
diff --git a/deploy/source/_static/image011(2).png b/deploy/source/_static/image011(2).png
diff --git a/install/.vscode_defaults/settings.json b/install/.vscode_defaults/settings.json
diff --git a/install/source/_static/image_s10_1_1.png b/install/source/_static/image_s10_1_1.png
diff --git a/install/source/_static/image_s10_1_1_v2.png b/install/source/_static/image_s10_1_1_v2.png
diff --git a/install/source/_static/image_s11_1_1.png b/install/source/_static/image_s11_1_1.png
diff --git a/install/source/_static/image_s11_1_1_v2.png b/install/source/_static/image_s11_1_1_v2.png
diff --git a/install/source/_static/image_s11_1_2_v2.png b/install/source/_static/image_s11_1_2_v2.png
diff --git a/install/source/_static/image_s2_5_1.png b/install/source/_static/image_s2_5_1.png
diff --git a/install/source/_static/image_s2_5_1_v3.png b/install/source/_static/image_s2_5_1_v3.png
diff --git a/install/source/_static/image_s2_5_2.png b/install/source/_static/image_s2_5_2.png
diff --git a/install/source/_static/image_s2_5_2_v3.png b/install/source/_static/image_s2_5_2_v3.png
diff --git a/install/source/_static/image_s2_5_3.png b/install/source/_static/image_s2_5_3.png
diff --git a/install/source/_static/image_s2_5_3_v3.png b/install/source/_static/image_s2_5_3_v3.png
diff --git a/install/source/_static/image_s2_5_4.png b/install/source/_static/image_s2_5_4.png
diff --git a/install/source/_static/image_s2_5_4_v2.png b/install/source/_static/image_s2_5_4_v2.png
diff --git a/install/source/_static/image_s2_5_5.png b/install/source/_static/image_s2_5_5.png
diff --git a/install/source/_static/image_s2_5_5_v2.png b/install/source/_static/image_s2_5_5_v2.png
diff --git a/install/source/_static/image_s2_5_5_v3.png b/install/source/_static/image_s2_5_5_v3.png
diff --git a/install/source/_static/image_s2_5_6_v2.png b/install/source/_static/image_s2_5_6_v2.png
diff --git a/install/source/_static/image_s2_5_7_v2.png b/install/source/_static/image_s2_5_7_v2.png
diff --git a/install/source/_static/image_s2_5_8_v4.png b/install/source/_static/image_s2_5_8_v4.png
diff --git a/install/source/_static/image_s3_1_1.png b/install/source/_static/image_s3_1_1.png
diff --git a/install/source/_static/image_s3_1_1_v4.png b/install/source/_static/image_s3_1_1_v4.png
diff --git a/install/source/_static/image_s4_1_1.png b/install/source/_static/image_s4_1_1.png
diff --git a/install/source/_static/image_s4_1_1_v2.png b/install/source/_static/image_s4_1_1_v2.png
diff --git a/install/source/_static/image_s4_1_2.png b/install/source/_static/image_s4_1_2.png
diff --git a/install/source/_static/image_s4_1_2_v2.png b/install/source/_static/image_s4_1_2_v2.png
diff --git a/install/source/_static/image_s7_1_1.png b/install/source/_static/image_s7_1_1.png
diff --git a/install/source/_static/image_s7_1_1_V2.png b/install/source/_static/image_s7_1_1_V2.png
diff --git a/install/source/_static/image_s7_1_2.png b/install/source/_static/image_s7_1_2.png
diff --git a/install/source/_static/image_s7_1_2_v2.png b/install/source/_static/image_s7_1_2_v2.png
diff --git a/install/source/_static/image_s7_1_3.png b/install/source/_static/image_s7_1_3.png
diff --git a/install/source/_static/image_s7_1_3_v3.png b/install/source/_static/image_s7_1_3_v3.png
diff --git a/install/source/_static/image_s7_1_4.png b/install/source/_static/image_s7_1_4.png
diff --git a/install/source/_static/image_s7_1_4_v2.png b/install/source/_static/image_s7_1_4_v2.png
diff --git a/install/source/_static/image_s7_1_5.png b/install/source/_static/image_s7_1_5.png
diff --git a/install/source/_static/image_s7_1_5_v2.png b/install/source/_static/image_s7_1_5_v2.png
diff --git a/install/source/_static/image_s7_1_6_v2.png b/install/source/_static/image_s7_1_6_v2.png
diff --git a/install/source/_static/image_s7_1_7_v3.png b/install/source/_static/image_s7_1_7_v3.png
diff --git a/install/source/_static/image_s7_1_8_v2.png b/install/source/_static/image_s7_1_8_v2.png
diff --git a/install/source/_static/image_s8_1_1_v2.png b/install/source/_static/image_s8_1_1_v2.png
diff --git a/install/source/_static/image_s8_1_2.png b/install/source/_static/image_s8_1_2.png
diff --git a/install/source/_static/image_s8_1_2_v2.png b/install/source/_static/image_s8_1_2_v2.png
diff --git a/install/source/chapter02.rst b/install/source/chapter02.rst
@@ -110,21 +110,21 @@ We recommend Windows server 2019 2012 R2 or Windows server 2016 as a preferred s
 Step 5: Start Installation
 ============================
 
-You can get the CentreStack installation package from the CentreStack partner portal (by login to http://www.centrestack.com) and get to the Private CentreStack section.
+You can get the CentreStack installation package from the CentreStack partner portal (by logging in to http://www.centrestack.com) and get to the Private CentreStack section.
 
-.. image:: _static/image_s2_5_1.png
+.. image:: _static/image_s2_5_1_v3.png
 
 Sign into the CentreStack server console (RDP or physical console are fine) with administrator rights. Once you click the **"Download"** button on the Partner Portal, the installer will appear either in downloads or as a link at the bottom of your browser. Click the executable file to begin the installation.
 
 You will see the welcome screen.
 
-.. image:: _static/image_s2_5_2.png
+.. image:: _static/image_s2_5_2_v3.png
 
 Click 'Next'
 
 And accept the EULA
 
-.. image:: _static/image_s2_5_3.png
+.. image:: _static/image_s2_5_3_v3.png
 
 CentreStack will install and then you will need to restart your system to complete the installation. 
 
@@ -134,18 +134,18 @@ CentreStack will install and then you will need to restart your system to comple
 
 For the next screen, if you have an existing database use the pull-down menu to select a different option otherwise use the default which will also install the MySQL Community Edition database.
 
-.. image:: _static/image_s2_5_4.png
+.. image:: _static/image_s2_5_7_v2.png
 
 In the next screen, enter your Partner Account login credentials to complete the installation.
 
-.. image:: _static/image_s2_5_5.png
+.. image:: _static/image_s2_5_8_v4.png
 
 Click ‘Next’
 
-.. image:: _static/image014.png
+.. image:: _static/image_s2_5_5_v3.png
 
 And Click Install.
 
-.. image:: _static/image015.png
+.. image:: _static/image_s2_5_6_v2.png
 
-Once installation is complete, a reboot is required. Click 'Yes' on the reboot window.
+After the installation has been completed successfully, a reboot is required. Click 'Restart'.
diff --git a/install/source/chapter03.rst b/install/source/chapter03.rst
@@ -4,10 +4,10 @@
 
 After the machine reboots, the Default administration configuration page will be displayed.
 
-.. image:: _static/image_s3_1_1.png
-
 First, setup the cluster administrator account.
 
+.. image:: _static/image_s3_1_1_v4.png
+
 After setting up the cluster administrator account, the cluster administrator's dashboard will appear by default.
 
 .. image:: _static/image_s3_1_2.png

diff --git a/install/source/chapter04.rst b/install/source/chapter04.rst
@@ -4,10 +4,10 @@
 
 Click the Portal – “My Files” Link for the default master admin to view his files/folders over the web portal:
 
-.. image:: _static/image_s4_1_1.png
+.. image:: _static/image_s4_1_1_v2.png
 
 See below image for the files and folder view:
 
-.. image:: _static/image_s4_1_2.png
+.. image:: _static/image_s4_1_2_v2.png
 
 From here you can test the installation by creating files, migrating, editing, sharing and deleting files to verify the storage setup is working as expected.
diff --git a/install/source/chapter06.rst b/install/source/chapter06.rst
@@ -4,10 +4,7 @@
 
 .. note::
 
-    Assuming that you have already setup your DNS to point to a DNS name connected to the CentreStack server and SSL certificate already
-   purchased for the DNS name. 
-    If not, you can acquire a
-    SSL certificate from your SSL vendor.
+    Assuming that you have already setup your DNS to point to a DNS name connected to the CentreStack server and an SSL certificate already purchased for the DNS name. If not, you can acquire an SSL certificate from your SSL vendor.
 
     We recommend using https://www.ssllabs.com/ to test your SSL setup because 
     the SSL Labs site will produce a report on whether the SSL is compatible with all 

diff --git a/install/source/chapter07.rst b/install/source/chapter07.rst
@@ -2,46 +2,38 @@
 7 Setup Worker Node for SSL
 #############################
 
-Login to the Web Portal as the master administrator and go to the "Cluster Manager" page. 
+Login to the Web Portal as the master administrator, then, under the menu next to dashboard, go to "Cluster Control Panel".
 
-.. image:: _static/image_s7_1_1.png
+.. image:: _static/image_s7_1_1_v2.png
 
-Click on the "Cluster Server Farm" page to see the "Cluster Worker Nodes".
+After this, go to "Worker Nodes".
 
-.. image:: _static/image_s7_1_2.png
+.. image:: _static/image_s7_1_2_v2.png
 
 There is an "Advanced Setting" icon on the page.
 
-.. image:: _static/image_s7_1_3.png
+.. image:: _static/image_s7_1_3_v3.png
 
 Now, check **"Always force SSL on Login"** and **"Always force SSL for Native Clients"** boxes.
 
 .. warning::
 
   If you use the self-signed SSL certificate, the web portal is the only client that allows you to login after some SSL certificate warning. All other native clients such as Windows, mobile, and Mac clients will reject the connection.
 
-.. image:: _static/image_s7_1_4.png
+.. image:: _static/image_s7_1_4_v2.png
 
-You will also modify the node property for the node.
+You can also modify the node property for the node.
 
-The External URL will need to match the node's DNS name and the HTTP or HTTPS protocol.
-
-.. image:: _static/image_s7_1_5.png
+.. image:: _static/image_s7_1_5_v2.png
 
 The Node Name needs to match the hostname of the node.
 
-.. image:: _static/image036.jpg
-
-The external URL shall match the external URL for HTTPS. (If you do not have SSL certificate installed yet, this can be HTTP for now).
+.. image:: _static/image_s7_1_6_v2.png
 
+The External URL shall match the external URL for HTTPS. (If you do not have SSL certificate installed yet, this can be HTTP for now).
 
+.. image:: _static/image_s7_1_7_v3.png
 
-.. warning::
-
-    In the current version, the Internal URL is hidden and it will be automatically set to a correct value so no need to manage the Internal URL any more.
-
-    In previous version, this was where the Internal URL was set.
-
-    The internal URL will be the internal IP address or private DNS name.
+The Internal URL will need to match the internal IP address or node's private DNS name and the HTTP or HTTPS protocol.
 
-    .. image:: _static/image037.jpg
+.. image:: _static/image_s7_1_8_v2.png
diff --git a/install/source/chapter08.rst b/install/source/chapter08.rst
@@ -16,14 +16,14 @@ You can also verify the External URL by doing a file share to your own email add
 Verify Internal URL
 =====================
 
-For the verification of Internal URL, you can use the Node Performance page to make sure the node performance information shows up. (Cluster Info -> Node Performance).
+For the verification of Internal URL, you can use the Node Performance page to make sure the node performance information shows up. (Reports -> Node Performance).
 
-.. image:: _static/image038.jpg
+.. image:: _static/image_s8_1_1_v2.png
 
 Verify Node Name
 ==================
 
 To verify that the node name is correct, you can right click on a folder and use the **"Share"** option to verify that the email has been received and is correctly pointing to an external URL. 
 
-.. image:: _static/image_s8_1_2.png
+.. image:: _static/image_s8_1_2_v2.png
 
diff --git a/install/source/chapter10.rst b/install/source/chapter10.rst
@@ -2,7 +2,7 @@
 10 Branding
 #############
 
-You can brand web portal, Windows client, Mac client, iOS client and Android client.
+You can brand the web portal, Windows and Mac clients, iOS and Android Applications.
 
 Self-Service Branding
 =======================
@@ -12,9 +12,9 @@ the web portal as the Master Administrator.
 
 After you login to the web portal, click to the "Cluster Branding" Pages.
 
-.. image:: _static/image_s10_1_1.png
+.. image:: _static/image_s10_1_1_v2.png
 
 Please reference the "Branding" section in the `Admin Guide`__ for the self-hosted CentreStack server.
 
-.. _Admin_Guide: https://centrestack.com/Library/AdminGuide/ 
+.. _Admin_Guide: https://centrestack.com/Library/AdminGuide/chapter03.html#cluster-branding 
 __ Admin_Guide_
diff --git a/install/source/chapter11.rst b/install/source/chapter11.rst
@@ -2,16 +2,16 @@
 11 Upgrade CentreStack
 ########################
 
-We publish updated notes to our public blog forum called, `CentreStack Blog'. It is recommended that you perform an update if your self-hosted CentreStack and clients are three months or older.
+We publish updated notes to our public blog forum called `CentreStack Blog`__. It is recommended that you perform an update if your self-hosted CentreStack and clients are three months or older.
 
 .. _CentreStack_Blog: http://blog.centrestack.com/ 
 __ CentreStack_Blog_
 
 Using the GUI Installer to Upgrade
 ---------------------------------------
 
-.. image:: _static/image_s11_1_0.png
+.. image:: _static/image_s11_1_1_v2.png
 
 To install an update go to your Partner Portal at https://www.centrestack.com/management/partnerloginpage.aspx and download the GUI installer. When you run the GUI installer, it will detect the existing installation and perform an upgrade.
 
-.. image:: _static/image_s11_1_1.png
+.. image:: _static/image_s11_1_2_v2.png
diff --git a/install/source/conf.py b/install/source/conf.py
@@ -58,9 +58,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '9.7.5645'
+version = '12.5.9520'
 # The full version, including alpha/beta/rc tags.
-release = '9.7.5645.41666'
+release = '12.5.9520.51622'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.