Feature monitor the resource over proxy #840

ugurerkan · 2021-10-30T18:45:17Z

Description

Added new proxy feature based on http and https proxy agents. Proxy feature works like notifications, there is many proxy could be related one proxy entry.

Supported features

Proxies can activate and disable in bulk
Proxies auto enabled by default for new monitors
Proxies could be applied in bulk to current monitors
Both authenticated and anonymous proxies supported
Export and import support for proxies
HTTP, HTTPS, SOCKS, SOCKS v5 SOCKS v4 protocols are supported

Reviews are welcome 🤩

Fixes #470

Type of change

User Interface
New feature (non-breaking change which adds functionality)

Checklist

My code follows the style guidelines of this project
I ran ESLint and other linters for modified files
I have performed a self-review of my own code and test it
I have commented my code, particularly in hard-to-understand areas
My changes generate no new warnings

Screenshots

server/model/monitor.js

src/components/ProxyDialog.vue

src/pages/Settings.vue

src/pages/EditMonitor.vue

src/languages/en.js

ugurerkan · 2021-10-30T19:09:27Z

@Saibamen Thank you for your quick reviews, I have updated them.

src/pages/EditMonitor.vue

deefdragon · 2021-11-01T03:42:07Z

Looking good. As a note, I think the switches should be "Enabled" and "Set As Default" instead of "Activated" and "Default Enabled".

louislam · 2021-11-03T04:34:12Z

Wondering why it looks like that it is allowed to select multiple proxies for a monitor.

If it is single selection, dropdown (select-option) would be better.

Saibamen · 2021-11-03T08:12:03Z

Or radio button

Radio button is also better for Edit URL and Default label

ugurerkan · 2021-11-03T08:44:19Z

Wondering why it looks like that it is allowed to select multiple proxies for a monitor.

If it is single selection, dropdown (select-option) would be better.

@louislam I have used them as radio buttons and multiple proxy can not selected. I prefer radios over dropdown because look more fancy but dropdown also considerable.

Screen.Recording.2021-11-03.at.12.08.28.mp4

Or radio button

Radio button is also better for Edit URL and Default label

@Saibamen I did not understand this, could you please clarify? 🤔
edit url triggers modal to edit proxy configuration and the default label is just indicator does not have interaction.

ugurerkan · 2021-11-03T09:04:09Z

Looking good. As a note, I think the switches should be "Enabled" and "Set As Default" instead of "Activated" and "Default Enabled".

@deefdragon Thank you for your advice, agree on this and updated accordingly. Now, it is more expressive.

Saibamen · 2021-11-03T11:45:55Z

@ugurerkan

I did not understand this, could you please clarify? 🤔

It is OK. I just wanted to say in my previous comment, that you can't implement working Edit or Default label in dropdown ;)

thomasleveil · 2021-11-03T18:31:35Z

@ugurerkan nice work, there are a few monitors I cannot yet create because I need to go through a proxy. Would this feature work with sock5 type proxies ?

ugurerkan · 2021-11-03T22:51:20Z

@thomasleveil thank you very much.

Currently, the feature supports only HTTP and HTTPS protocols. But, the base proxy agent library is supporting SOCKS and PAC proxy as well. So, this could be easily integrated. I will take a look and try to improve accordingly. SOCKS proxies have common usage, it looks like this feature should have it at least.

ugurerkan · 2021-11-04T11:37:35Z

SOCKS proxy agent library and protocol support added.

thomasleveil · 2021-11-05T10:14:25Z

@ugurerkan may I suggest using {{ proxy.host }}:{{ proxy.port }} ({{ proxy.protocol }}) to describe a proxy

ugurerkan · 2021-11-05T10:37:45Z

@thomasleveil good point, thank you.
Proxies was able to be mistaken by other protocols and ports with same host, updated accordingly.

ugurerkan · 2021-11-16T06:12:57Z

There are couple straightforward solutions like below;

Socks Proxy

HTTP/S Proxy

I suggest tinyproxy for HTTP proxy and dante or ssh for SOCKS proxies.

ugurerkan · 2021-11-30T07:19:29Z

I have sync the branch with new settings page.
BTW, functional and neat design, congrats @chakflying @louislam 🚀

louislam · 2021-11-30T07:25:26Z

I have sync the branch with new settings page. BTW, functional and neat design, congrats @chakflying @louislam 🚀

All credit goes to @chakflying!

ugurerkan · 2021-12-01T09:53:50Z

Hey @louislam, it is possible to relate and support proxy for notifications there is a couple of feature request for this #616 #915

I think it is better to implement this with an axios wrapper notification client. The notification client is going to provide support of proxy to HTTP/S requests of notification providers. The wrapper approach is will reduce copy code to implement the proxy option to each notification provider.

If it is suited well to uptime kuma goals, I can contribute to the implementation of this feature after the proxy feature is merged. 🤔

ufo56 · 2022-03-01T09:36:54Z

Any plan to merge this feature ?

Added new proxy feature based on http and https proxy agents. Proxy feature works like notifications, there is many proxy could be related one proxy entry. Supported features - Proxies can activate and disable in bulk - Proxies auto enabled by default for new monitors - Proxies could be applied in bulk to current monitors - Both authenticated and anonymous proxies supported - Export and import support for proxies

@thomasleveil

- Socks proxy support implemented. - Monitor proxy agent create flow refactored and moved under proxy class. Thanks for suggestion @thomasleveil

gaby · 2022-03-20T21:44:57Z

@ugurerkan Does this support Proxies using self-signed certificates ? It would be ideal if there was a field to paste a custom CA.

louislam · 2022-04-02T03:24:28Z

src/components/ProxyDialog.vue

+
+                        <div v-if="proxy.auth" class="mb-3">
+                            <label for="proxy-password" class="form-label">{{ $t("Password") }}</label>
+                            <input id="proxy-password" v-model="proxy.password" type="text" class="form-control" required>


Just finished testing, it is a solid update and feature!

Just found this should be type="password". I will update it my branch, because I don't have a write permission of this pr.

Thank you so much for the big feature.

Thank you very much for your test and review. It is good to help and contribute.

ugurerkan · 2022-04-02T08:43:34Z

@ugurerkan Does this support Proxies using self-signed certificates ? It would be ideal if there was a field to paste a custom CA.

@gaby Tested with Squid Proxy, there is couple solution for this;

Users could export a self-signed certificate for Node and the certificate will be trusted

# to enable environment wide or runtime
export NODE_EXTRA_CA_CERTS=[CA certificate file path]
  
# also enabling over npm is supported
npm config set cafile [CA certificate file path]

Users could execute node with use of the system certificate store and system trusted certificates are became trusted

 # to enable runtime
 node --use-openssl-ca
   
 # to enable environment wide
 export NODE_OPTIONS=--use-openssl-ca

Users could create a trusted self-signed certificate with mkcert tool. It will help to produce trusted self-signed certificates.
https://github.com/FiloSottile/mkcert
We could add systemwide-cas package and allow adding certificates like your advice
https://github.com/fujifish/syswide-cas

I think, solving this above uptime kuma level would be better and more flexible for users and we can keep our interface simple.

References;

gaby · 2022-04-02T14:09:04Z

@ugurerkan Does this support Proxies using self-signed certificates ? It would be ideal if there was a field to paste a custom CA.

@gaby Tested with Squid Proxy, there is couple solution for this;
Users could export a self-signed certificate for Node and the certificate will be trusted
# to enable environment wide or runtime
export NODE_EXTRA_CA_CERTS=[CA certificate file path]
  
# also enabling over npm is supported
npm config set cafile [CA certificate file path]
Users could execute node with use of the system certificate store and system trusted certificates are became trusted
 # to enable runtime
 node --use-openssl-ca
   
 # to enable environment wide
 export NODE_OPTIONS=--use-openssl-ca
Users could create a trusted self-signed certificate with mkcert tool. It will help to produce trusted self-signed certificates.
https://github.com/FiloSottile/mkcert

We could add systemwide-cas package and allow adding certificates like your advice
https://github.com/fujifish/syswide-cas
I think, solving this above uptime kuma level would be better and more flexible for users and we can keep our interface simple.

References;

https://stackoverflow.com/a/47160447/627456

https://github.com/stefpe/squid_proxy

https://stefan-poeltl.medium.com/setup-a-web-proxy-server-with-docker-d5c6942b5575

Something like syswide-cas is what I was thinking. Use case would be if multiple monitors use different CA's which could be a case in corporate/mixed environments.

Excellent work, i'm looking forward to using this recently merged feature!

louislam · 2022-04-04T07:00:18Z

server/server.js

+                await sendProxyList(socket);
+
+                if (proxy.applyExisting) {
+                    await restartMonitors(socket.userID);


Just checking source code, may found some potential issues.

Should only restart monitors which belong to this proxy.
Even better, the proxy config of monitors should be updated without restarting.

louislam · 2022-04-04T07:08:32Z

src/pages/EditMonitor.vue

@@ -222,6 +222,32 @@
                                {{ $t("Setup Notification") }}
                            </button>

+                            <!-- Proxies -->
+                            <h2 class="mt-5 mb-2">{{ $t("Proxies") }}</h2>


Proxies section should be available for http(s) monitor type only?

Correct, it is better to show only v-if="monitor.type === 'http' || monitor.type === 'keyword'"

louislam · 2022-04-04T07:08:41Z

server/server.js

@@ -1490,6 +1562,19 @@ async function restartMonitor(userID, monitorID) {
    return await startMonitor(userID, monitorID);
 }

+async function restartMonitors(userID) {


This function creates another set of monitors unexpectedly, because it does not stop current monitors.

But as the proxy config of monitors should be updated without restarting, this function is not needed anyway in my opinion.

louislam · 2022-04-04T07:08:45Z

server/server.js

+
+                await Proxy.delete(proxyID, socket.userID);
+                await sendProxyList(socket);
+                await restartMonitors(socket.userID);


Should only restart monitors which belong to this proxy.
Even better, the proxy config of monitors should be updated without restarting.

ugurerkan · 2022-04-04T07:17:26Z

@louislam thank you in detail evaluation, I'll check update proxy configuration without restart monitor and create fix. It is going work better without restart all monitors and side effect you are detected.

louislam · 2022-04-07T06:40:30Z

@louislam thank you in detail evaluation, I'll check update proxy configuration without restart monitor and create fix. It is going work better without restart all monitors and side effect you are detected.

Thanks, I just created a pr for related issues

ugurerkan force-pushed the feature/request-with-http-proxy branch from 8471ce9 to f13bf6b Compare October 30, 2021 18:57

Saibamen reviewed Oct 30, 2021

View reviewed changes

server/model/monitor.js Outdated Show resolved Hide resolved

server/model/monitor.js Outdated Show resolved Hide resolved

server/model/monitor.js Outdated Show resolved Hide resolved

src/components/ProxyDialog.vue Outdated Show resolved Hide resolved

Saibamen reviewed Oct 30, 2021

View reviewed changes

src/pages/Settings.vue Outdated Show resolved Hide resolved

src/pages/EditMonitor.vue Outdated Show resolved Hide resolved

src/languages/en.js Show resolved Hide resolved

ugurerkan force-pushed the feature/request-with-http-proxy branch 2 times, most recently from b5a6114 to 3b99517 Compare October 30, 2021 19:08

ugurerkan force-pushed the feature/request-with-http-proxy branch 2 times, most recently from d21faa1 to 5515d64 Compare October 30, 2021 19:38

louislam added this to the 1.11.0 milestone Oct 31, 2021

ugurerkan force-pushed the feature/request-with-http-proxy branch from 5515d64 to 39804d1 Compare October 31, 2021 11:27

Saibamen suggested changes Oct 31, 2021

View reviewed changes

src/pages/EditMonitor.vue Outdated Show resolved Hide resolved

ugurerkan force-pushed the feature/request-with-http-proxy branch from 39804d1 to 2b061ce Compare November 3, 2021 09:02

ugurerkan force-pushed the feature/request-with-http-proxy branch from 57bc880 to d36373e Compare November 4, 2021 11:36

ugurerkan force-pushed the feature/request-with-http-proxy branch from d36373e to 6e2963f Compare November 4, 2021 11:39

ugurerkan changed the title ~~Feature monitor the resource over HTTP(s) proxy~~ Feature monitor the resource over proxy Nov 4, 2021

ugurerkan force-pushed the feature/request-with-http-proxy branch from 6e2963f to 461105d Compare November 5, 2021 10:35

ugurerkan force-pushed the feature/request-with-http-proxy branch 3 times, most recently from e4c5b0b to 1a7da29 Compare November 10, 2021 16:03

deefdragon mentioned this pull request Nov 20, 2021

Support telegram proxy configuration items #915

Closed

2 tasks

ugurerkan force-pushed the feature/request-with-http-proxy branch from 1a7da29 to 6160665 Compare November 30, 2021 07:17

ibehren1 mentioned this pull request Jan 5, 2022

Ability to set proxy per monitor for HTTP(S) monitors. #1097

Open

1 task

ugurerkan force-pushed the feature/request-with-http-proxy branch from 6160665 to 97acf08 Compare March 1, 2022 09:47

BioSs54 approved these changes Mar 2, 2022

View reviewed changes

ugurerkan force-pushed the feature/request-with-http-proxy branch from 97acf08 to 8527f6c Compare March 3, 2022 16:59

ugurerkan added 4 commits March 6, 2022 19:29

Add http and https agents

2cc7a99

Add socks proxy agent

9e27acb

Add socks proxy support to proxy feature

8078d06

- Socks proxy support implemented. - Monitor proxy agent create flow refactored and moved under proxy class. Thanks for suggestion @thomasleveil

ugurerkan force-pushed the feature/request-with-http-proxy branch from 8527f6c to 8078d06 Compare March 6, 2022 16:34

chakflying mentioned this pull request Mar 13, 2022

Outbout proxy configuration #1336

Closed

1 task

louislam modified the milestones: 1.11.0, Pending Mar 16, 2022

louislam modified the milestones: Pending, 1.14.0 Mar 22, 2022

louislam reviewed Apr 2, 2022

View reviewed changes

louislam merged commit 04e3394 into louislam:master Apr 2, 2022

louislam reviewed Apr 4, 2022

View reviewed changes

louislam mentioned this pull request Apr 7, 2022

Proxy Improvements #1461

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature monitor the resource over proxy #840

Feature monitor the resource over proxy #840

ugurerkan commented Oct 30, 2021 •

edited

Loading

ugurerkan commented Oct 30, 2021

deefdragon commented Nov 1, 2021

louislam commented Nov 3, 2021

Saibamen commented Nov 3, 2021 •

edited

Loading

ugurerkan commented Nov 3, 2021 •

edited

Loading

ugurerkan commented Nov 3, 2021 •

edited

Loading

Saibamen commented Nov 3, 2021

thomasleveil commented Nov 3, 2021

ugurerkan commented Nov 3, 2021 •

edited

Loading

ugurerkan commented Nov 4, 2021

thomasleveil commented Nov 5, 2021 •

edited

Loading

ugurerkan commented Nov 5, 2021

ugurerkan commented Nov 16, 2021 •

edited

Loading

ugurerkan commented Nov 30, 2021 •

edited

Loading

louislam commented Nov 30, 2021

ugurerkan commented Dec 1, 2021

ufo56 commented Mar 1, 2022

gaby commented Mar 20, 2022

louislam Apr 2, 2022

ugurerkan Apr 2, 2022 •

edited

Loading

ugurerkan commented Apr 2, 2022

gaby commented Apr 2, 2022

louislam Apr 4, 2022

louislam Apr 4, 2022

ugurerkan Apr 4, 2022 •

edited

Loading

louislam Apr 4, 2022 •

edited

Loading

louislam Apr 4, 2022

ugurerkan commented Apr 4, 2022

louislam commented Apr 7, 2022

Feature monitor the resource over proxy #840

Feature monitor the resource over proxy #840

Conversation

ugurerkan commented Oct 30, 2021 • edited Loading

Description

Type of change

Checklist

Screenshots

ugurerkan commented Oct 30, 2021

deefdragon commented Nov 1, 2021

louislam commented Nov 3, 2021

Saibamen commented Nov 3, 2021 • edited Loading

ugurerkan commented Nov 3, 2021 • edited Loading

ugurerkan commented Nov 3, 2021 • edited Loading

Saibamen commented Nov 3, 2021

thomasleveil commented Nov 3, 2021

ugurerkan commented Nov 3, 2021 • edited Loading

ugurerkan commented Nov 4, 2021

thomasleveil commented Nov 5, 2021 • edited Loading

ugurerkan commented Nov 5, 2021

ugurerkan commented Nov 16, 2021 • edited Loading

ugurerkan commented Nov 30, 2021 • edited Loading

louislam commented Nov 30, 2021

ugurerkan commented Dec 1, 2021

ufo56 commented Mar 1, 2022

gaby commented Mar 20, 2022

louislam Apr 2, 2022

Choose a reason for hiding this comment

ugurerkan Apr 2, 2022 • edited Loading

Choose a reason for hiding this comment

ugurerkan commented Apr 2, 2022

gaby commented Apr 2, 2022

louislam Apr 4, 2022

Choose a reason for hiding this comment

louislam Apr 4, 2022

Choose a reason for hiding this comment

ugurerkan Apr 4, 2022 • edited Loading

Choose a reason for hiding this comment

louislam Apr 4, 2022 • edited Loading

Choose a reason for hiding this comment

louislam Apr 4, 2022

Choose a reason for hiding this comment

ugurerkan commented Apr 4, 2022

louislam commented Apr 7, 2022

ugurerkan commented Oct 30, 2021 •

edited

Loading

Saibamen commented Nov 3, 2021 •

edited

Loading

ugurerkan commented Nov 3, 2021 •

edited

Loading

ugurerkan commented Nov 3, 2021 •

edited

Loading

ugurerkan commented Nov 3, 2021 •

edited

Loading

thomasleveil commented Nov 5, 2021 •

edited

Loading

ugurerkan commented Nov 16, 2021 •

edited

Loading

ugurerkan commented Nov 30, 2021 •

edited

Loading

ugurerkan Apr 2, 2022 •

edited

Loading

ugurerkan Apr 4, 2022 •

edited

Loading

louislam Apr 4, 2022 •

edited

Loading