added openspeedtest #834

Svelte-Enthusiast · 2023-01-10T19:29:23Z

Added #808 , openspeedtest

☑️ Self Check before Merge

I have tested the template using the method described in README.md thoroughly
I have ensured that I put as much default values as possible (except passwords) to ensure minimum effort required for end users to get started.
I have ensured that I am not using the "latest" tag as this tag is dynamically changing and might break the one-click app. Use a fixed version.
I have made sure that instructions.start and instructions.end are clear and self-explanatory.
Icon is added as a png file to the logos directory.

public/v4/apps/openspeedtest.yml

openspeedtest · 2023-01-13T08:32:04Z

@Svelte-Enthusiast Thank you for the PR.

Default port for http : 3000

Default port for https : 3001

Written in Vanilla Javascript (Client-Side). No PHP, Node Js, or any other Server-Side programming languages are used.
This is a docker implementation using nginxinc/nginx-unprivileged:stable-alpine. uses significantly fewer resources.
Nginx Deliver our static SpeedTest application, That is how it works.

I don't know how caprover handles apps.
If you run behind a reverse proxy and reverse proxy is used for handling HTTPS.
I think it's better to run the app in HTTP mode, to save server resources.
3000 is the HTTP port.

If you run it behind a reverse proxy you should increase the post-body content length to 35 Megabytes or more.

githubsaturn · 2023-01-19T05:39:07Z

Thanks! Formatting seems to be not working. Suggest running npm run formatter-write to reformat your changes.

githubsaturn · 2023-01-21T03:39:37Z

public/v4/apps/openspeedtest.yml

@@ -2,23 +2,23 @@ captainVersion: 4

 services:
    '$$cap_appname':
-        image: index.docker.io/openspeedtest/latest:$$cap_openspeedtest_version
+        image: index.docker.io/test/latest:$$cap_test_version


lots of wrong replacement here. All "openspeedtest" instances in the definition are converted to test

githubsaturn · 2023-01-21T03:40:03Z

public/v4/apps/openspeedtest.yml

    instructions:
        start: |-
-            OpenSpeedTest is a self-hosted speedtest. You can read more about this on https://openspeedtest.com/selfhosted-speedtest.
+            Test is a self-hosted speedtest. You can read more about this on https://test.com/selfhosted-speedtest.


same here... Test is a self-hosted speedtest. You can read more about this on https://test.com/selfhosted-speedtest.

super weird. the only thing i did was run the formatter. i fixed it with the next push

githubsaturn · 2023-01-21T21:39:12Z

Thanks!

@openspeedtest - I assume you maintain this image. I suggest you change the image to a standard format.

openspeedtest/latest:openspeedtest is a non conventional format. Docker images should have their version as a tag. So for example: openspeedtest/openspeedtest:v1.2.3 or openspeedtest/openspeedtest:latest

openspeedtest · 2023-01-22T00:42:04Z

@githubsaturn When I started using docker, I was unaware of or fully understood this concept.
Now I don't want to break existing deployments by deleting them. Also, it will reset the pull count and star count.
No breaking changes will be introduced to this image, especially to the latest and speedtest tags. That is why I avoided versioning them. Still, if that is important from the next version (2.5.5), I will add a version number.
Thanks!

githubsaturn · 2023-01-22T00:48:13Z

Yea I definitely recommend using concrete version tags. Here is a snippet on why they are important.

* added openspeedtest * changed default version to speedtest * suggested fixes * add formatting * fixed replacement issues

nativeit · 2024-04-07T05:24:57Z

I was getting ready to open a PR for this app, I may link it here if I can confirm that I'm not breaking anything, or that I wasn't making a mistake in my initial setup. The problem as it currently exists is this:

When deployed as-is, the port is set to the https port 3001, but whether or not SSL is enabled under the app's HTTP settings, this results in the following Nginx error:

The plain HTTP request was sent to HTTPS port

It's my understanding that this is due to the way the reverse proxy is being handled. I'm not an expert with Nginx, so a second opinion would be good here, but I believe the app's port should be set to the http port 3000 instead, as Caprover will handle the secure connection, and the traffic to port 3000 will effectively be local proxy traffic.

I deployed v2.0.5 to my server, and with the HTTP port set to 3001 it produces the error with/without HTTPS enabled, but with 3000 set it works as expected with either HTTP/HTTPS enabled in the app's settings.

My PR was going to change the HTTP port to 3000, and the default version tag to v2.0.5. I'd welcome @openspeedtest to please advise, as well as anyone with better knowledge of the Nginx proxy to confirm that using 3000 with SSL enabled under the app settings achieves the same security as running OpenSpeedTest from a non-proxied web server on port 3001.

nativeit · 2024-04-07T05:54:51Z

While reading on the Content-Length header issue posted above, I also saw that there were issues with http2/http3, and under the repo's Nginx configuration (link) it includes a block disabling http2.

Caprover's default Nginx config uses listen 443 ssl http2;

I don't think it's generally ideal for apps to require editing the default config (although it isn't unheard of). That said, I noticed if "Websocket Support" has been enabled, then this line is added to the default config: proxy_http_version 1.1;

@githubsaturn - Would the "Websocket Support" flag do anything to help with this, or is it only triggered when the $http_upgrade header is included with the client's request (otherwise all requests get passed to 443 ssl http2 as usual)?

It seems like running OpenSpeedTest behind a reverse proxy may just have some inherent issues. I am running it under port 3000 in a Caprover instance (Proxmox KVM) that's hosted on a bare metal server at OVH's Virginia datacenter (my nearest region) and it seems to be working normally, and providing realistic measurements for my current location.

I'll be glad to continue testing, if the http2 vs http1.1 topic is ultimately not relevant to the Caprover deployment, I'll move this particular issue to the OpenSpeedTest repo.

nativeit · 2024-04-07T16:29:55Z

I attempted to work with both the http/1.1 vs http/2 and request_max_body_size issues, but in the end could not determine whether any of my changes to the Nginx configuration made an impact at all (assuming they didn't break something outright, which also happened in a few cases). No matter what I did, when I used my browser's Network Inspection it was always http/2, but I'm also fairly sure the Docker networking layer facilitates those connections. Correct me if I'm wrong, but in order to see the relevant stats I would need to inspect the traffic between the upstream server and reverse proxy.

Tldr; I don't have any suggestions with regard to the reverse proxy problems. But I believe I have fixed the port issue, and I added details in the deployment instructions regarding the limits for this implementation of OpenSpeedTest. I put my local branch up at https://github.com/nativeit/one-click-apps/tree/openspeedtest-dev - if you'd like me to open a PR, I certainly will.

See changes at: master...nativeit:one-click-apps:openspeedtest-dev

githubsaturn · 2024-04-09T02:42:11Z

but I believe the app's port should be set to the http port 3000 instead, as Caprover will handle the secure connection

100% correct!

RE: the rest of your questions, I can't say much since it's really dependent of how this app was built.
Looks like they have some guide here for reverse proxy:
https://github.com/openspeedtest/Docker-Image?tab=readme-ov-file#or-use-docker-composeyml

But looks like they require a lot of custom settings for nginx to work properly
https://github.com/openspeedtest/Nginx-Configuration/blob/main/OpenSpeedTest-Server.conf

Svelte-Enthusiast added 2 commits January 10, 2023 19:22

added openspeedtest

97c48a8

changed default version to speedtest

8d6a900

githubsaturn reviewed Jan 11, 2023

View reviewed changes

public/v4/apps/openspeedtest.yml Outdated Show resolved Hide resolved

public/v4/apps/openspeedtest.yml Outdated Show resolved Hide resolved

suggested fixes

1908c2d

add formatting

f992276

githubsaturn reviewed Jan 21, 2023

View reviewed changes

fixed replacement issues

9756446

githubsaturn merged commit 54c04f8 into caprover:master Jan 21, 2023

Tivin-i pushed a commit to SelfHosted-Club/caprover-one-click-apps that referenced this pull request May 19, 2023

added openspeedtest (caprover#834)

66fb82f

* added openspeedtest * changed default version to speedtest * suggested fixes * add formatting * fixed replacement issues

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added openspeedtest #834

added openspeedtest #834

Svelte-Enthusiast commented Jan 10, 2023 •

edited

Loading

openspeedtest commented Jan 13, 2023

githubsaturn commented Jan 19, 2023

githubsaturn Jan 21, 2023

githubsaturn Jan 21, 2023

Svelte-Enthusiast Jan 21, 2023

githubsaturn commented Jan 21, 2023

openspeedtest commented Jan 22, 2023

githubsaturn commented Jan 22, 2023

nativeit commented Apr 7, 2024

nativeit commented Apr 7, 2024

nativeit commented Apr 7, 2024 •

edited

Loading

githubsaturn commented Apr 9, 2024

added openspeedtest #834

added openspeedtest #834

Conversation

Svelte-Enthusiast commented Jan 10, 2023 • edited Loading

☑️ Self Check before Merge

openspeedtest commented Jan 13, 2023

Default port for http : 3000

Default port for https : 3001

githubsaturn commented Jan 19, 2023

githubsaturn Jan 21, 2023

Choose a reason for hiding this comment

githubsaturn Jan 21, 2023

Choose a reason for hiding this comment

Svelte-Enthusiast Jan 21, 2023

Choose a reason for hiding this comment

githubsaturn commented Jan 21, 2023

openspeedtest commented Jan 22, 2023

githubsaturn commented Jan 22, 2023

nativeit commented Apr 7, 2024

nativeit commented Apr 7, 2024

nativeit commented Apr 7, 2024 • edited Loading

githubsaturn commented Apr 9, 2024

Svelte-Enthusiast commented Jan 10, 2023 •

edited

Loading

nativeit commented Apr 7, 2024 •

edited

Loading