gronod/ha-3dprinter-addons
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Fredrik Baberg 2024-01-15 23:48:12 +01:00
parent aa8dae2bf8
commit bbb2263092
4 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,10 @@
{
"spellright.language": [
"en"
],
"spellright.documentTypes": [
"markdown",
"latex",
"plaintext"
]
}

6
3dprinter-octoprint/CHANGELOG.md
View File

@ -1,3 +1,9 @@
## 2024.01.0
* Maintenance release:
* Upgrade base image to Bookworm.
* Upgrade default OctoPrint version to 1.9.3.
## 2023.03.1
* Add check that OctoPrint can install at buildtime.
* Add missing dependency for armhf (libffi-dev)

20
3dprinter-octoprint/DOCS.md
View File

@ -6,7 +6,7 @@ Set a network port in addon settings to be able to access the WebUI.
## Trusted proxies
By setting trusted proxies you should be able to use HTTPS *if you have placed a reverse proxy in front of Home Assistant*. For more information, see [Caddy documentation](https://caddyserver.com/docs/caddyfile/directives/reverse_proxy).
*If you have placed a reverse proxy in front of Home Assistant*, by setting trusted proxies you should be able to use HTTPS. For more information, see [Caddy documentation](https://caddyserver.com/docs/caddyfile/directives/reverse_proxy).
# OctoPrint integration
@ -19,22 +19,10 @@ Go to OctoPrint WebUI, you should see a request for authentication.
# Camera
There is no camera server in the addon, it has to be setup separately.
This addon does not include a camera server, it has to be setup separately.
You could, for instance, use the addon [camera-mjpg-streamer](https://github.com/fredrikbaberg/3dprinter-addons/tree/main/camera-mjpg-streamer) available in the same repository. If so, you can set the snapshot URL to:
> `http://cce6f2d5-camera-mjpg-streamer/?action=snapshot`.
You could, for instance, use the addon [camera-mjpg-streamer](https://github.com/fredrikbaberg/ha-3dprinter-addons/tree/main/camera-mjpg-streamer) available in the same repository. Note that this method **only allows for snapshot**, it does **NOT** work for camera stream as this requires the browser/app used to directly access the stream.
Note that this method **only allows for snapshot**, it does **NOT** work for camera stream as this requires the browser/app used to directly access the stream.
# Ingress?
This add-on drops support for Ingress. The main reason for this is issues with finding a working configuration.
* An update to OctoPrint increased the security (which is good!). Unfortunately it also broke the configuration used in this addon, most likely due to this addon not behaving properly.
* There has been issues with accessing camera stream by Ingress since I added support for it, which I have not been able to solve.
I have tried to find a solution to this, without success. Therefore I decided to disable the option, as it just leads to frustration.
If someone is able to find a working configuration, please let me know.
# Remote access
If you need remote access, have a look at [remote access plugins for OctoPrint](https://plugins.octoprint.org/topics/remote_access/). Remember to **NEVER** directly portforward your OctoPrint instance to the internet!

2
3dprinter-octoprint/README.md
View File

@ -2,8 +2,6 @@
Provides OctoPrint as an addon to Home Assistant.
Note: Ingress is **NOT** supported.
## Instructions
Set a network port in addon settings.