Merge pull request #41 from henryk86/master

Adapt to current version

Author: SciLor

content/docs/tools/teddyBench/_index.md

@@ -1,6 +1,6 @@
 ---
 title: "teddyBench"
-description: "Start and read!"
+description: "Start and read to setup teddyBench!"
 ---
 # teddyBench
 With this tool you can dump existing files of the famous audio box or create custom ones.

content/docs/tools/teddyCloud/_index.md

@@ -1,5 +1,15 @@
 ---
 title: "teddyCloud"
+description: "teddyCloud is an open source replacement server for the tonies cloud."
 bookCollapseSection: true
 headless: true
----
+---
+
+## Features
+teddyCloud is an alternative server for your Toniebox, allowing you to host the cloud services locally.
+This gives you the control about which data is sent to the original manufacturer's cloud and allows you
+to host your own figurine audio files on e.g. your [NAS or any other server](supported-server-hardware). It provides an easy to use WebGui.
+
+![teddyCloud Webinterface](/img/teddyCloudWebinterface.png)
+
+You can also use teddyCloud on the command line to manipulate esp32 firmware dumps or encode Tonie Audio Files (TAFs). See ```toniecloud --help```.

content/docs/tools/teddyCloud/setup/_index.md

@@ -1,16 +1,12 @@
 ---
 title: "Setup"
-description: "teddyCloud is an open source replacement server for the tonies cloud."
+description: "Start and read to setup teddyCloud!"
 bookCollapseSection: true
 headless: true
 ---
 # teddyCloud Setup
 
-## Features
-teddyCloud is an alternative server for your Toniebox, allowing you to host the cloud services locally.
-This gives you the control about which data is sent to the original manufacturer's cloud and allows you
-to host your own figurine audio files on e.g. your [NAS or any other server](supported-server-hardware). 
-You can also use teddyCloud on the command line to manipulate esp32 firmware dumps or encode Tonie Audio Files (TAFs). See ```toniecloud --help```.
+Minimal teddyCloud version for this docu is release v0.6.0! Please ensure you are using that or a newer release.
 
 ## Docker hints
 The docker container automatically generates the server certificates on first run. You can extract the ```certs/server/ca.der``` for your box after that. 
@@ -32,18 +28,15 @@ If you have problems with teddyCloud or just want to be sure everything works as
 
 ## Additional
 
-### Content
-Please put your content into the ```/data/content/default/``` in the same structure as on your toniebox. You can edit ```500304E0.json``` file beside the content files to mark them as live or you can prevent the usage of the Boxine cloud for that tag with the nocloud parameter. By setting a source teddyCloud can stream any content that ffmpeg can decode (urls and files). Please check that the file and folders in upper case. If not rename them, otherwise teddyCloud won't serve them to the box!
-
-### Webinterface
-Currently the teddyCloud webinterface is reachable through the IP of the docker container at port 80 (depending on your ```docker-compose.yaml```). The 443 port is usally exclusive for the toniebox connection. Changes affecting the toniebox (volume, LED) which are made through this interface will only be reflected onto the toniebox after pressing the big ear for a few seconds until a beep occurs (freshnessCheck).
+### WebGui
+Currently the teddyCloud webinterface is reachable through the IP of the docker container at port 80 (depending on your ```docker-compose.yaml```). To reach the Webinterface with https the port 8443 (depending on your ```docker-compose.yaml```) is used (for example if you want to flash your box). The default https port 443 is usally exclusive for the toniebox connection. 
 
 ![teddyCloud Webinterface](/img/teddyCloudWebinterface.png)
 
+Changes affecting the toniebox (volume, LED) which are made through this interface will only be reflected onto the toniebox after pressing the big ear for a few seconds until a beep occurs (freshnessCheck).
 
-As an additional frontend is still being developed, you can reach a second frontend at ```xxx.xxx.xxx/web```. Changes made here are instantly live on the box.
-
-
+### Content (Legacy)
+Please put your content into the ```/data/content/default/``` in the same structure as on your toniebox. You can edit ```500304E0.json``` file beside the content files to mark them as live or you can prevent the usage of the Boxine cloud for that tag with the nocloud parameter. By setting a source teddyCloud can stream any content that ffmpeg can decode (urls and files). Please check that the file and folders in upper case. If not rename them, otherwise teddyCloud won't serve them to the box!
 
 ## Links
 * [GitHub](https://github.com/toniebox-reverse-engineering/teddycloud)

content/docs/tools/teddyCloud/setup/dns/cc3200.md

@@ -10,7 +10,7 @@ With a CC3200 box it is recommened to a altUrl patch. As a standard the fritzbox
 If you have a fritzbox you can use the [altUrl.tc.fritz.box](https://github.com/toniebox-reverse-engineering/hackiebox_cfw_ng/blob/master/sd-bootloader-ng/bootmanager/sd/revvox/boot/patch/altUrl.tc.fritz.box.json) patch. You'll just have to set the name of your server in your fritzbox to ```tc``` (Heimnetz -> Netzwerk -> Netzwerkverbindungen -> bearbeiten).
 
 ## Other (custom dns)
-The [altUrl.305](https://github.com/toniebox-reverse-engineering/hackiebox_cfw_ng/blob/master/sd-bootloader-ng/bootmanager/sd/revvox/boot/patch/altUrl.305.json) patch replaces the cloud urls with custom ones. Set the DNS entries for ```prod.revvox``` and ```rtnl.revvox``` to the TeddyCloud servers ip-address.
+The [altUrl.305](https://github.com/toniebox-reverse-engineering/hackiebox_cfw_ng/blob/master/sd-bootloader-ng/bootmanager/sd/revvox/boot/patch/altUrl.305.json) patch replaces the cloud urls with custom ones. Set the DNS entries for ```prod.revvox``` and ```rtnl.revvox``` to the teddyCloud servers ip-address.
 You may also edit the patch yourself to set the ip-address directly. Please beware, it should not be longer than the original url, which is 12 characters.
 
 [Please continue with on the teddyCloud tool page from the beginning](../../#additional)

content/docs/tools/teddyCloud/setup/dns/cc3235.md

@@ -4,7 +4,7 @@ description: ""
 ---
 
 # CC3235
-Set the DNS entries for ```prod.de.tbs.toys``` and ```rtnl.bxcl.de``` to the TeddyCloud servers ip-address. Beware, this will cut off the connection of all tonieboxes within your network, which arn't patched with your replacement CA!
+Set the DNS entries for ```prod.de.tbs.toys``` and ```rtnl.bxcl.de``` to the teddyCloud servers ip-address. Beware, this will cut off the connection of all tonieboxes within your network, which arn't patched with your replacement CA!
 As an alternative you can set the gateway for the tonieboxes to the ip of teddyCloud. With OpenWRT it works this way:
 ```
 uci set dhcp.teddycloud="tag"

content/docs/tools/teddyCloud/setup/dump-certs/esp32.md

@@ -12,7 +12,18 @@ If connected with the Boot jumper, the box just start in "DOWNLOAD (USB/UART0)"
 
 ## Browser based
 You can use the build in ESP32 box flashing tool in the webinterface of teddyCloud to backup your box with "Read ESP32".
-After that you can manually extract them into the ```/certs/client/``` directory. You can either do that with the teddycloud executable on your computer or you may do it via the docker shell `docker exec -it <container-name> bash`.
+
+![Initial Screen ESP32 flash](/img/esp32_newgui_flashing_00_initial.png)
+
+Click on [Read Flash]
+
+![Read flash](/img/esp32_newgui_flashing_01_readflash.png)
+
+If the flash is read sucessfully, you can download the unpatched firmware.
+
+![Flash successfully read](/img/esp32_newgui_flashing_02_patchflash.png)
+
+After that you can manually extract the certificates into the ```/certs/client/``` directory. You can either do that with the teddycloud executable on your computer or you may do it via the docker shell `docker exec -it <container-name> bash`.
 ```
 # Please check the filename of your backup
 # Be sure you are in the teddycloud directory
@@ -28,11 +39,7 @@ mv certs/client/CA.DER certs/client/ca.der
 
 Be sure, that the dump is okay and you are able to extract the certificates. 
 
-![Read flash](/img/esp32_read_flash_webui.png)
-
-![Finished reading the flash/hostname](/img/esp32_read_flash_finished_webui.png)
-
-
+[Please continue with flash CA step for the ESP32](../../flash-ca/esp32)
 
 ## Legacy
 ```

content/docs/tools/teddyCloud/setup/flash-ca/esp32.md

@@ -10,9 +10,24 @@ If you have a Fritzbox you can set it to tc.fritz.box (see CC3200 how to configu
 
 Check, that your backup of your flash is okay and you were able to extract the certificates. 
 
-![Finished reading the flash/hostname](/img/esp32_read_flash_finished_webui.png)
+If you successfully read or load the flash of your Toniebox, the patching step is shown. Enter the hostname/ip of your teddyCloud instance. You can now also enter the WiFi credentials. To proceed click [Patch].
+
+![Patching the flash/hostname/wifi](/img/esp32_newgui_flashing_02_patchflash.png)
+
+After the flash is patched, you can proceed with the actuall flashing. Till this step nothing happens to your Toniebox. 
+
+![Flash you Toniebox](/img/esp32_newgui_flashing_03_initialflash.png)
+
+To flash the patched firmware on your Toniebox, disconnect your Toniebox first from your powersource, click [Flash ESP32], confirm the dialog and immediatly connect to powersource again.
+
+![Confirm flashing](/img/esp32_newgui_flashing_04_confirmflash.png)
+
+![Flashing in progress](/img/esp32_newgui_flashing_05_flashing.png)
+
+If the flashing was successful, you can download the unpatched and patched Firmware for your backup.
+
+![Flashing done](/img/esp32_newgui_flashing_06_flashingdone.png)
 
-![Patchimage](/img/esp32_patch_image_webui.png)
 
 ## Legacy
 Replace the original CA within your flash dump with esptool.
@@ -33,4 +48,6 @@ esptool.py -b 921600 write_flash 0x0 tb.esp32.fakeca.bin
 ![Flash ESP32 Image](/img/esp32_write_patched_image_with_esptools.png)
 
 
-[Please continue with DNS step for the ESP32](../../dns/esp32)
+Reassamble your Toniebox again. If you already set the teddyCloud hostname, you can skip the [DNS step for the ESP32](../../dns/esp32), if not [continue with DNS step for the ESP32](../../dns/esp32). 
+
+Your Toniebox should now be able to connect to your teddyCloud. Do a freshnesscheck and check if the box appears in the Toniebox management.

content/docs/tools/teddyCloud/setup/supported-server-hardware.md

@@ -6,7 +6,7 @@ bookCollapseSection: true
 # Supported NAS/Server hardware
 
 Teddycloud is supported on nearly all servers utilizing the x86_64, arm64, and armhf (linux/arm/v7) architectures, as Docker containers are available for these platforms.
-Below is a compilation of NAS/server hardware that has been successfully utilized to host TeddyCloud:
+Below is a compilation of NAS/server hardware that has been successfully utilized to host teddyCloud:
 
 | NAS / Server hardware           | Limitations                                                                                                                                                                                        |
 |---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -22,11 +22,11 @@ Consider using Alpine container instead of Ubuntu / Debian container if your ser
 
 If you're utilizing alternative NAS/server hardware configurations, your contribution is welcome. Feel free to share your experience and insights with the community.
 
-## Tested Hardware, but not supporting TeddyCloud
+## Tested Hardware, but not supporting teddyCloud
 
 
 | NAS / Server hardware | Comment/Discussion/Links |
 |-----------------------|--------------------------|
 | ...                   |                          |
 
-If you've attempted to deploy TeddyCloud on specialized hardware without success, we encourage you to share your experience for community contribution. Conversely, if you've successfully implemented TeddyCloud on any of the mentioned hardware platforms, we invite you to document your process on our forum. Additionally, you're welcome to transition your system to one of the officially supported configurations.
+If you've attempted to deploy teddyCloud on specialized hardware without success, we encourage you to share your experience for community contribution. Conversely, if you've successfully implemented teddyCloud on any of the mentioned hardware platforms, we invite you to document your process on our forum. Additionally, you're welcome to transition your system to one of the officially supported configurations.

content/docs/tools/teddyCloud/tecdoc/playlist-tap-json.md

@@ -5,7 +5,7 @@ bookCollapseSection: true
 ---
 # Playlist Feature (TAP files)
 
-TeddyCloud supports basic playlist handling. A playlist file (TAP) can be linked to multiple sources, as long as it is supported by ffmpeg. 
+teddyCloud supports basic playlist handling. A playlist file (TAP) can be linked to multiple sources, as long as it is supported by ffmpeg. Please be aware: If you are adding TAF files, the chapters of them will get lost in the TAP!
 
 TAP files can be placed into library folder. The Tonies (from content folder) can then get assigned to any TAP file, just like it would be a normal TAF.
 

content/docs/tools/teddyCloud/tecdoc/tonies-custom-json.md

@@ -4,44 +4,31 @@ description: "Info about the tonies-custom-json file"
 bookCollapseSection: true
 ---
 # tonies.custom.json
-TeddyCloud uses the tonies-custom-json file to read the metadata of custom tags in the same manner it's done for the official boxine tonies in the tonies-json file. The structure is the same, but it's not overwritten as the tonies-json file through regularly updates. So you can use the tonies-custom-json to save metadata of your own custom tags.
+teddyCloud uses the tonies-custom-json file to read the metadata of custom tags in the same manner it's done for the official boxine tonies in the tonies-json file. The structure is the same, but it's not overwritten as the tonies-json file through regularly updates. So you can use the tonies-custom-json to save metadata of your own custom tags.
 
 Initially the tonies-custom-json file looks like the following:
 
 ```
 []
 ```
 
-In the gui, a custom tag looks initially like:
+In the GUI, a custom tag looks initially like:
 
-_old gui_
-
-![Old GUI](/img/tonies-custom-json_empty_oldgui.png)
-
-
-_new /web gui_
-
-![New GUI](/img/tonies-custom-json_empty_newgui.png)
+![GUI](/img/tonies-custom-json_empty.png)
 
 Enriched with metadata for the above shown custom tag the tonies-custom-json file looks like this (more details see below in section [Specification](#specification)):
 
 ```json
 [{"no": "0", "model": "123456", "audio_id": ["369519776"], "hash": ["af9e61a9c1b12138fb060908d595742334b04515"], "title": "Custom Tonie Example Title", "series": "Custom Tonies", "episodes": "This is my custom tonie", "tracks": ["Title 1", "Title 2", "Title 3", "Title 4", "Title 5", "Title 6", "Title 7", "Title 8", "Title 9", "Title 10"], "release": "0", "language": "de-de", "category": "custom", "pic": "https://upload.wikimedia.org/wikipedia/en/6/6b/Hello_Web_Series_%28Wordmark%29_Logo.png"}]
 ```
 
-This results after restart of TeddyCloud in the following changed appearance in the GUIs:
+This results after restart of teddyCloud in the following changed appearance in the GUI:
 
-_old gui_
 
-![Old GUI](/img/tonies-custom-json_filled_oldgui.png)
+![Tonie Cards](/img/tonies-custom-json_filled1.png)
 
 
-_new /web gui_
-
-![New GUI Tonie Cards](/img/tonies-custom-json_filled1_newgui.png)
-
-
-![New GUI with track display](/img/tonies-custom-json_filled2_newgui.png)
+![with track display](/img/tonies-custom-json_filled2.png)
 
 
 ## Specification
@@ -54,17 +41,20 @@ Each element consists of a JSON object with the following keys:
 | Option         | Example value                                                                               | Description |
 |----------------|---------------------------------------------------------------------------------------------|-------------|
 | no             | `"0"`                                                                                       | Number of custom tag |
-| model          | `""`                                                                                        | A model number of the custom tag, can be left empty |
-| audio_id       | `["369519776"]`                                                                             | Enter the custom audio ID of the custom tag. Can be found in the old GUI as shown below |
-| hash           | `["af9e61a9c1b12138fb060908d595742334b04515"]`                                              | Enter the hash of the custom tag. Can be found in the old GUI as shown below |
+| model          | `"123456"`                                                                                        | A model number of the custom tag |
+| audio_id       | `["369519776"]`                                                                             | Enter the custom audio ID of the custom tag. Can be found in GUI as shown below |
+| hash           | `["af9e6..b04515"]`                                              | Enter the hash of the custom tag. Can be found in the GUI as shown below |
 | title          | `"Custom Tonie Example Title"`                                                              | Enter the title of the custom tag, it's currently not displayed, use the series and episode tag to give your custom tag a title which is shown in the GUI |
 | series         | `"Custom Tonie"`                                                                            | Enter the Series of the custom tag, will be shown in the GUI |
 | episodes       | `"This is my custom tonie"`                                                                 | Enter the Episode of the custom tag, will be shown in the GUI |
-| tracks         | `["Title 1", "Title 2"]`                                                               | Enter the tracks of the custom tag, will be shown in the new GUI only |
+| tracks         | `["Title 1", "Title 2"]`                                                               | Enter the tracks of the custom tag, will be shown in the GUI |
 | release        | `"0"`                                                                                       | currently unused |
-| language       | `"de-de"`                                                                                   | language code, currently unused |
+| language       | `"de-de"`                                                                                   | language code, will be shown in the gui if it's another language than the dominant one |
 | category       | `"custom"`                                                                                  | category of the custom tag, currently unused |
-| pic            | `"https://upload.wikimedia.org/wikipedia/en/6/6b/Hello_Web_Series_%28Wordmark%29_Logo.png"` | url of the picture which shall be shown as custom tag image in the GUI |
+| pic            | `"https://.../Logo.png"` | url of the picture which shall be shown as custom tag image in the GUI |
+
+### How to get the Audio ID and the Hash value of a TAF
 
+Navigate to the taf file in the library (or content if library is not enabled) and double click on the row. A modal will be shown which contains the information:
 
-![Getting the Audio ID and Hash value](/img/tonies-custom-json_sources_audioId_Hash_oldgui.png)
+![Getting the Audio ID and Hash value](/img/tonies-custom-json_getaudioid_hash.png)