Skip to content

Commit

Permalink
remove Test pages and make use of headless: true
Browse files Browse the repository at this point in the history
  • Loading branch information
SciLor committed Aug 14, 2024
1 parent b7018a3 commit a4645ef
Show file tree
Hide file tree
Showing 10 changed files with 67 additions and 78 deletions.
7 changes: 2 additions & 5 deletions content/docs/box-variants/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
title: "Box Variants"
description: "Start and read!"
type: page
---

Test
headless: true
---
7 changes: 2 additions & 5 deletions content/docs/box-variants/cc3200.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
title: "CC3200"
description: "Start and read!"
type: page
---

Test
headless: true
---
7 changes: 2 additions & 5 deletions content/docs/box-variants/cc3235.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
title: "CC3235"
description: "Start and read!"
type: page
---

Test
headless: true
---
7 changes: 2 additions & 5 deletions content/docs/custom-firmware/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
title: "Custom Firmware"
description: "Start and read!"
type: page
---

Test
headless: true
---
6 changes: 2 additions & 4 deletions content/docs/custom-firmware/cc3200/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: "CC3200"
description: "Start and read!"
bookCollapseSection: true
---

Test
headless: true
---
6 changes: 2 additions & 4 deletions content/docs/custom-firmware/esp32/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: "ESP32"
description: "Start and read!"
headless: true
bookCollapseSection: true
---

Test
---
4 changes: 1 addition & 3 deletions content/docs/tools/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,4 @@
title: "Tools"
description: "Start and read!"
weight: 20
---

Test
---
48 changes: 2 additions & 46 deletions content/docs/tools/teddyCloud/_index.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,5 @@
---
title: "teddyCloud"
description: "teddyCloud is an open source replacement server for the tonies cloud."
bookCollapseSection: true
---
# teddyCloud

## 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](setup/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```.

## 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.

An example [docker-compose.yaml can be found within the docker subdir.](https://github.com/toniebox-reverse-engineering/teddycloud/blob/master/docker/docker-compose.yaml)
Please beware that port 443 cannot be remapped and you cannot use a reverse proxy like nginx or traefik without passing through the TLS (complex, not recommended). The client certificate authentication needs to be done by teddyCloud. Also, there is no SNI. If you are using docker, you can use macvlan to give the teddyCloud container a dedicated IP address (recommended).

## Preparation
Please connect your Toniebox to your Wi-Fi and update its firmware. Many boxes are shipped with a production firmware that needs to be updated. Otherwise the box won't work as it should. It is not necessary to connect the box to the mytonies app/account. [Connect the box without the setup assistant.](https://support.tonies.com/hc/en-us/articles/4415294030482-How-do-I-set-up-a-Wi-Fi-connection-without-the-setup-assistant)

## Device specific preparation
Please check wether you got a Toniebox with a CC3200, CC3235 or ESP32 and continue with the following steps:
* [Dump CA and client certificates](setup/dump-certs)
* [Flash the replacement CA](setup/flash-ca)
* [DNS](setup/dns)

## Test & Troubleshooting
If you have problems with teddyCloud or just want to be sure everything works as it should, please check our [Test & Troubleshooting site](setup/test-troubleshooting).

## 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).

![teddyCloud Webinterface](/img/teddyCloudWebinterface.png)


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.



## Links
* [GitHub](https://github.com/toniebox-reverse-engineering/teddycloud)
* [Releases](https://github.com/toniebox-reverse-engineering/teddycloud/releases)
headless: true
---
48 changes: 47 additions & 1 deletion content/docs/tools/teddyCloud/setup/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,50 @@
---
title: "Setup"
description: "teddyCloud is an open source replacement server for the tonies cloud."
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```.

## 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.

An example [docker-compose.yaml can be found within the docker subdir.](https://github.com/toniebox-reverse-engineering/teddycloud/blob/master/docker/docker-compose.yaml)
Please beware that port 443 cannot be remapped and you cannot use a reverse proxy like nginx or traefik without passing through the TLS (complex, not recommended). The client certificate authentication needs to be done by teddyCloud. Also, there is no SNI. If you are using docker, you can use macvlan to give the teddyCloud container a dedicated IP address (recommended).

## Preparation
Please connect your Toniebox to your Wi-Fi and update its firmware. Many boxes are shipped with a production firmware that needs to be updated. Otherwise the box won't work as it should. It is not necessary to connect the box to the mytonies app/account. [Connect the box without the setup assistant.](https://support.tonies.com/hc/en-us/articles/4415294030482-How-do-I-set-up-a-Wi-Fi-connection-without-the-setup-assistant)

## Device specific preparation
Please check wether you got a Toniebox with a CC3200, CC3235 or ESP32 and continue with the following steps:
* [Dump CA and client certificates](dump-certs)
* [Flash the replacement CA](flash-ca)
* [DNS](dns)

## Test & Troubleshooting
If you have problems with teddyCloud or just want to be sure everything works as it should, please check our [Test & Troubleshooting site](test-troubleshooting).

## 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).

![teddyCloud Webinterface](/img/teddyCloudWebinterface.png)


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.



## Links
* [GitHub](https://github.com/toniebox-reverse-engineering/teddycloud)
* [Releases](https://github.com/toniebox-reverse-engineering/teddycloud/releases)
5 changes: 5 additions & 0 deletions content/docs/tools/teddyCloud/tecdoc/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Technical Docs"
bookCollapseSection: true
headless: true
---

0 comments on commit a4645ef

Please sign in to comment.