docs - updated setup documentation

superstes · Jan 8, 2022 · addb9c4 · addb9c4
1 parent 8d62efa
commit addb9c4
Show file tree

Hide file tree

Showing 10 changed files with 125 additions and 41 deletions.
diff --git a/ReadMe.md b/ReadMe.md
@@ -71,11 +71,12 @@ Version: 1.0
 
 ### History
 
-- v1.0 _(2021-11 - 2021-12)_
+- v1.0 _(2021-11 - 2022-02)_
   - refactoring setup tasks => using roles provided by <a href="https://github.com/ansibleguy">AnsibleGuy</a>
   - creating image for easy installation
   - update via webUI (_to specific vcs version_)
   - stateful service reload
+  - user management from webUI
 
 
 - v0.9 _(2021-09 - 2021-10)_

diff --git a/docs/source/_static/img/setup/post-setup/users.png b/docs/source/_static/img/setup/post-setup/users.png
diff --git a/docs/source/setup/buy.rst → docs/source/setup/1-buy.rst b/docs/source/setup/buy.rst → docs/source/setup/1-buy.rst
@@ -2,9 +2,9 @@
 
 .. include:: ../includes/tip_links.rst
 
-===
-Buy
-===
+======
+1. Buy
+======
 
 Description
 ***********

diff --git a/docs/source/setup/raspberry.rst → docs/source/setup/2-raspberry.rst b/docs/source/setup/raspberry.rst → docs/source/setup/2-raspberry.rst
@@ -3,18 +3,14 @@
 .. include:: ../includes/tip_links.rst
 .. include:: ../includes/warn_in_progress.rst
 
-=========
-Raspberry
-=========
+============
+2. Raspberry
+============
 
 Description
 ***********
 
-Here you can find some basic setup infos.
-
-**This is NOT a full set** of instructions needed to setup the GrowAutomation software.
-
-There is a `setup script <https://github.com/superstes/growautomation/tree/dev/setup>`_ for exactly that purpose.
+Here you can find some information on how to set-up your raspberry.
 
 ----
 

diff --git a/docs/source/setup/find.rst → docs/source/setup/3-find.rst b/docs/source/setup/find.rst → docs/source/setup/3-find.rst
@@ -3,9 +3,9 @@
 .. include:: ../includes/tip_links.rst
 .. include:: ../includes/warn_in_progress.rst
 
-====
-Find
-====
+=======
+3. Find
+=======
 
 Description
 ***********

diff --git a/docs/source/setup/connect.rst → docs/source/setup/4-connect.rst b/docs/source/setup/connect.rst → docs/source/setup/4-connect.rst
@@ -2,32 +2,57 @@
 
 .. include:: ../includes/tip_links.rst
 
+==========
+4. Connect
+==========
+
+.. _setup-connect-ssh:
+
+SSH
+***
+
+How to connect to a raspberry via ssh.
+
+Windows
 =======
-Connect
-=======
+
+If you have Windows 10 or higher => you can use the native PowerShell SSH-Client to connect.
+
+For earlier versions you will need to download a tool like `Putty <https://the.earth.li/~sgtatham/putty/latest/w64/putty.exe>`_.
+
+
+
+Linux
+=====
+
+Every linux distribution I know has a SSH-Client pre-installed - therefore you just need to open a terminal to use it.
+
+
+----
+
+Physical
+********
 
 Description
-***********
+===========
 
 Options how to connect your GrowAutomation setup to power and a network (*for your access*).
 
-----
 
 DISCLAIMER
-**********
+==========
 
 All the links for mentioned products are from amazon.
 
 This is mainly because of convenience.
 
 You **WILL GET** those products for a **better price somewhere else**.
 
-----
 
 .. _setup-connect-power:
 
 Power
-*****
+=====
 
 **How to power it?**
 
@@ -58,15 +83,15 @@ This is a basic question and we came up with the following options for the answe
 .. _setup-connect-network:
 
 Network
-*******
+=======
 
 The future **server-agent setup** will make wireless connections for agents easier.
 
 Since the web user-interface will be run on the server and the agent just needs to communicate its data to the server.
 
 
 WLAN
-====
+----
 
 If you have an existing WIFI network you could just connect the raspberry to it.
 

diff --git a/docs/source/setup/5-setup.rst b/docs/source/setup/5-setup.rst
@@ -0,0 +1,23 @@
+.. _setup-setup:
+
+.. include:: ../includes/tip_links.rst
+.. include:: ../includes/warn_in_progress.rst
+
+========
+5. Setup
+========
+
+There are two options on how to install the GrowAutomation software:
+
+* Pre-Installed **Image**
+
+  * Easier and faster.
+
+* Setup **Script**
+
+  * Allows you to customize many settings that are pre-set in the image.
+
+  * Always have the newest release/version.
+
+
+The detailed HowTo can be found in the `repository <https://github.com/superstes/growautomation/tree/dev/setup>`_.
diff --git a/docs/source/setup/6-post-setup.rst b/docs/source/setup/6-post-setup.rst
@@ -0,0 +1,51 @@
+.. _setup-post-setup:
+
+.. |users| image:: ../_static/img/setup/post-setup/users.png
+   :width: 100%
+
+.. include:: ../includes/tip_links.rst
+
+=============
+6. Post-Setup
+=============
+
+Description
+***********
+
+Here we will go through the tasks you need to perform :ref:`after the installation <setup-setup>` per **script or image**.
+
+
+Basic tasks
+***********
+
+1. You will have to connect to the device using ssh!
+
+  Look into the :ref:`find <setup-find>` and :ref:`connect guide <setup-connect>` on how to do that.
+
+  If you have used the installation image the password to connect should be: **Gr0w21736!**
+
+2. If you have used the installation image - you should run the password randomization script:
+
+  .. code-block:: bash
+
+    sudo bash /var/lib/ga/setup/randomize_pwds.sh
+
+3. You need to retrieve your passwords:
+
+  .. code-block:: bash
+
+    sudo cat /etc/.ga_setup
+    # after that you should remove the password file
+    sudo rm /etc/.ga_setup
+
+4. Login into the web user-interface using the retrieved password:
+
+  Open the URL https://${IP} - in which '${IP}' is the address you found using the :ref:`find guide <setup-find>`
+
+5. You can now manage the users using the 'System - Users' site.
+
+  |users|
+
+6. Now you can configure your devices and start using the GrowAutomation software!
+
+  More information to the configuration can be found :ref:`here <config-device-input>`.
diff --git a/docs/source/setup/wiring.rst → docs/source/setup/7-wiring.rst b/docs/source/setup/wiring.rst → docs/source/setup/7-wiring.rst
@@ -3,9 +3,9 @@
 .. include:: ../includes/tip_links.rst
 .. include:: ../includes/warn_in_progress.rst
 
-======
-Wiring
-======
+=========
+7. Wiring
+=========
 
 Description
 ***********

diff --git a/setup/ReadMe.md b/setup/ReadMe.md
@@ -32,8 +32,7 @@ To install the pre-configured raspberry image you need to:
     ```
     The '**user**' password is for the web-ui login!
   * **You should delete this file** after you saved your passwords safely!
-* Now you can access the web-interface and configure your devices. More information to the configuration can be found <a href="https://docs.growautomation.eu/en/latest/index.html">here</a>.
-
+* Look into the <a href="https://docs.growautomation.eu/en/latest/setup/raspberry.html#ssd">post-setup guide</a> for further ToDos.
 
 
 ----
@@ -92,15 +91,4 @@ After that it will ask you for a 'BECOME password' => you need to **provide the
 
 ##### Post install
 
-If you haven't set custom passwords -> you can find the randomly generated one's like this:
-
-```bash
-sudo cat /etc/.ga_setup
-# sudo rm /etc/.ga_setup  # to delete the file
-```
-
-**You should delete this file** after you saved your passwords safely!
-
-Now you can access the web-interface and configure your devices.
-
-More information to the configuration can be found <a href="https://docs.growautomation.eu/en/latest/index.html">here</a>.
+* Look into the <a href="https://docs.growautomation.eu/en/latest/setup/raspberry.html#ssd">post-setup guide</a> for further ToDos.