Merge pull request #313 from Paraphraser/20210410-documentation

Documentation enhancements

Author: Slyke

README.md

@@ -1,82 +1,24 @@
-# IOT Stack
+# IOTstack
 
 IOTstack is a builder for docker-compose to easily make and maintain IoT stacks on the Raspberry Pi.
 
-## Getting started
+### getting started
 
-See [Getting Started](https://sensorsiot.github.io/IOTstack/Getting-Started) in the Wiki. It includes:
+See [Getting Started](https://sensorsiot.github.io/IOTstack/Getting-Started) in the [IOTstack Wiki](https://sensorsiot.github.io/IOTstack/). It includes:
 
-* A link to Andreas Spiess video #295 and #352.
+* A link to Andreas Spiess videos #295 and #352.
 * How to download the project (including constraints you need to observe).
+* How to migrate from the older gcgarner/IOTstack repository.
 * Running the menu to install Docker and set up your containers.
 * Useful Docker commands (start \& stop the stack, manage containers).
+* Stack maintenance.
 
-See also the [documentation home page](https://sensorsiot.github.io/IOTstack/).
-
-## New Installation
-### Automatic
-1. Run the following command:
-```
-curl -fsSL https://raw.githubusercontent.com/SensorsIot/IOTstack/master/install.sh | bash
-```
-
-### Manual
-1. Install git
-```
-$ cd ~/IOTstack
-$ git remote set-url origin https://github.com/SensorsIot/IOTstack.git
-$ git pull origin master
-$ git checkout master
-$ docker-compose down
-$ ./menu.sh
-$ docker-compose up -d
-```
-
-## Need the old menu back?
-```
-cd ~/IOTstack/
-git pull
-git checkout old-menu
-```
-
-## Experimental Features
-
-## Running
-1. To enter the directory and run menu for installation options:
-```
-cd ~/IOTstack
-bash ./menu.sh
-```
-
-2. Install docker with the menu, restart your system.
-
-3. Run menu again to select your build options, then start docker-compose with
-```
-$ cd ~/IOTstack
-$ git pull origin master
-$ git checkout master
-$ ./menu.sh
-```
-
-Want to have the latest and greatest features? Switch to the experimental branch:
-
-```
-$ cd ~/IOTstack
-$ git pull origin master
-$ git checkout experimental
-$ ./menu.sh
-```
-
-Do note that the experimental branch may be broken, or may break your setup, so ensure you have a good backup, and please report any issues. The way back is:
-
-
-## Contributions
+### contributions
 
 Please use the [issues](https://github.com/SensorsIot/IOTstack/issues) tab to report issues.
 
-## Need help? Have a feature suggestion? Discovered a bug?
-We have a Discord server setup for discussions: [IOTstack Discord channel](https://discord.gg/ZpKHnks) if you want to comment on features, suggest new container types, or ask the IOTstack community for help.
+### Need help? Have a feature suggestion? Discovered a bug?
 
-You can also report bugs or suggestions to our Github: https://github.com/SensorsIot/IOTstack/issues
+We have a Discord server setup for discussions: [IOTstack Discord channel](https://discord.gg/ZpKHnks) if you want to comment on features, suggest new container types, or ask the IOTstack community for help.
 
-If you use some of the tools in the project please consider donating or contributing on their projects. It doesn't have to be monetary. Reporting bugs and creating Pull Requests helps improve the projects for everyone.
+If you use some of the tools in the project please consider donating or contributing on their projects. It doesn't have to be monetary. Reporting bugs and [creating Pull Requests](https://gist.github.com/Paraphraser/818bf54faf5d3b3ed08d16281f32297d) helps improve the projects for everyone.

docs/BuildStack-RandomPassword.md

@@ -1,4 +1,4 @@
-# Build Stack Random Services Passowrd
+# Build Stack Random Services Password
 
 This page explains how to have a service generate a random password during build time. This will require that your service have a working options menu.
 

docs/BuildStack-Services.md

@@ -1,4 +1,4 @@
-# Buid Stack Services system
+# Build Stack Services system
 
 This page explains how the build stack system works for developers.
 

docs/Containers/Zigbee2mqttassistant.md

@@ -0,0 +1,24 @@
+# Zigbee2Mqtt Assistant
+
+## References
+
+- [Docker](https://hub.docker.com/r/carldebilly/zigbee2mqttassistant)
+- [Website](https://github.com/yllibed/Zigbee2MqttAssistant/blob/master/README.md)
+
+## About
+
+This service a web frontend which displays Zigbee2Mqtt service messages and able to control it over MQTT. For the 
+servie a working MQTT server is required and that have to be configured.
+
+## Environment Parameters
+
+* `Z2MA_SETTINGS__MQTTSERVER=mosquitto` - The MQTT service instance which is used by Zigbee2Mqtt instance. Here, "mosquitto" is the name of the container.
+* `Z2MA_SETTINGS__MQTTUSERNAME=name` - Used if your MQTT service has authentication enabled. Optional.
+* `Z2MA_SETTINGS__MQTTPASSWORD=password` - Used if your MQTT service has authentication enabled. Optional.
+* `TZ=Etc/UTC`- Set to your timezone. Optional but recommended.
+
+## Accessing the UI
+
+The Zigbee2Mqtt Assistant UI is available using port 8880. For example:
+
+* `http://your.local.ip.address:8880/`