Misconfigured WebSockets reverse-proxying with Apache HTTPD

Zaserr · 2023-02-19T06:06:13.675Z

When I try do do coder templates create I get this error: unexpected non-JSON response "text/html; charset=iso-8859-1".

Z

ZaserrOP•2/19/23, 6:33 AM

I did some testing with Ammar and if I logout with localhost via cli the install/upload error disappears so we are thinking it is something with apache.

P

Phorcys•2/19/23, 8:48 AM

it is likely some issue with apache yes

P

Phorcys•2/19/23, 8:48 AM

can you send your apache virtualhost block ?

M

matifali•2/19/23, 6:24 PM

you have to configure apache to foreard websockets also.

M

matifali•2/19/23, 6:24 PM

Please see here,
https://github.com/coder/coder/tree/main/examples/web-server/

GitHub

coder/examples/web-server at main · coder/coder

A tool that provisions remote development environments via Terraform - coder/examples/web-server at main · coder/coder

Z

ZaserrOP•2/19/23, 7:27 PM

# Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Websockets are required for workspace connectivity
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     RewriteCond %{HTTP:Upgrade} websocket [NC]
     RewriteRule /(.*) ws://127.0.0.1:3000/$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

# Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Websockets are required for workspace connectivity
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     RewriteCond %{HTTP:Upgrade} websocket [NC]
     RewriteRule /(.*) ws://127.0.0.1:3000/$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

# Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Websockets are required for workspace connectivity
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     RewriteCond %{HTTP:Upgrade} websocket [NC]
     RewriteRule /(.*) ws://127.0.0.1:3000/$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

# Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Websockets are required for workspace connectivity
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     RewriteCond %{HTTP:Upgrade} websocket [NC]
     RewriteRule /(.*) ws://127.0.0.1:3000/$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

Z

ZaserrOP•2/19/23, 7:27 PM

@Phorcys here you go thank you!

Z

ZaserrOP•2/19/23, 10:25 PM

@matifali As you see here I am forwarding the web sockets as well

P

Phorcys•2/20/23, 7:02 AM

I'll try setting up a temporary apache env with my current deployment to see if that works

P

Phorcys•2/20/23, 7:03 AM

I've already had quite a bit of trouble with apache websockets at work and I remember that RewriteEngine didn't work properly

M

matifali•2/20/23, 8:15 AM

I think there is an issue with Apache config that does not let VS Code Desktop and ssh connect but

coder_app

coder_app

s do connect.

M

matifali•2/20/23, 8:16 AM

@Phorcys if you can test we should correct the docs.

P

Phorcys•2/20/23, 8:17 AM

P

Phorcys•2/20/23, 8:17 AM

I have an issue with the SSO provider @ work, I'll fix that and then I'll take a look

M

matifali•2/20/23, 8:18 AM

I myself have no experience with apache.

P

Phorcys•2/20/23, 8:19 AM

well, I've never quite liked how httpd handles the virtualhosts

P

Phorcys•2/20/23, 8:19 AM

I'm not really a XML-style config guy

M

matifali•2/20/23, 10:13 AM

caddy the savior.

P

Phorcys•2/20/23, 12:22 PM

I'll take a look right now

P

Phorcys•2/20/23, 12:32 PM

here is a config that should work

<VirtualHost *:443>
     ProxyPreserveHost On
     ProxyRequests Off

     ProxyPass / http://172.23.0.2/
     ProxyPass / ws://172.23.0.2/

     ProxyPassReverse / http://172.23.0.2/
     ProxyPassReverse / ws://172.23.0.2/
</VirtualHost>

<VirtualHost *:443>
     ProxyPreserveHost On
     ProxyRequests Off

     ProxyPass / http://172.23.0.2/
     ProxyPass / ws://172.23.0.2/

     ProxyPassReverse / http://172.23.0.2/
     ProxyPassReverse / ws://172.23.0.2/
</VirtualHost>

<VirtualHost *:443>
     ProxyPreserveHost On
     ProxyRequests Off

     ProxyPass / http://172.23.0.2/
     ProxyPass / ws://172.23.0.2/

     ProxyPassReverse / http://172.23.0.2/
     ProxyPassReverse / ws://172.23.0.2/
</VirtualHost>

<VirtualHost *:443>
     ProxyPreserveHost On
     ProxyRequests Off

     ProxyPass / http://172.23.0.2/
     ProxyPass / ws://172.23.0.2/

     ProxyPassReverse / http://172.23.0.2/
     ProxyPassReverse / ws://172.23.0.2/
</VirtualHost>

where

172.23.0.2

172.23.0.2

172.23.0.2

172.23.0.2 is the ip of the coder deployment

P

Phorcys•2/20/23, 12:32 PM

@Zaserr

PPhorcys here is a config that should work ``` <VirtualHost *:443> ProxyPreserveHos...

M

matifali•2/20/23, 2:25 PM

Is this another method to forward websockets?

Mmatifali Is this another method to forward websockets?

P

Phorcys•2/20/23, 4:22 PM

it is, that's what I do at work and it works

PPhorcys here is a config that should work ``` <VirtualHost *:443> ProxyPreserveHos...

M

matifali•2/20/23, 6:01 PM

with this coder agent does not connect for me. RewriteEngine works

P

Phorcys•2/20/23, 8:12 PM

hmm

P

Phorcys•2/20/23, 8:13 PM

i was wrong, this isn't what I use

P

Phorcys•2/20/23, 8:13 PM

I picked the wrong config

P

Phorcys•2/20/23, 8:14 PM

I use this

RewriteEngine On
 
# Rewrite rule to proxy websockets

RewriteCond %{HTTP:Upgrade} =websocket [NC]

RewriteRule (.*) ws://domain.tld$1 [P,L]

RewriteEngine On
 
# Rewrite rule to proxy websockets

RewriteCond %{HTTP:Upgrade} =websocket [NC]

RewriteRule (.*) ws://domain.tld$1 [P,L]

RewriteEngine On
 
# Rewrite rule to proxy websockets

RewriteCond %{HTTP:Upgrade} =websocket [NC]

RewriteRule (.*) ws://domain.tld$1 [P,L]

RewriteEngine On
 
# Rewrite rule to proxy websockets

RewriteCond %{HTTP:Upgrade} =websocket [NC]

RewriteRule (.*) ws://domain.tld$1 [P,L]

P

Phorcys•2/20/23, 8:14 PM

in the end i got too lazy to set up another apache container

P

Phorcys•2/20/23, 8:14 PM

maybe i will do it tomorrow

Z

ZaserrOP•2/22/23, 9:28 PM

@Phorcys @matifali I am using this for my apache and it is not working

Z

ZaserrOP•2/22/23, 9:28 PM

# Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Websockets are required for workspace connectivity
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     # Rewrite rule to proxy websockets
     RewriteCond %{HTTP:Upgrade} =websocket [NC]
     RewriteRule (.*) ws://coder.zwserver.xyz$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

# Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Websockets are required for workspace connectivity
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     # Rewrite rule to proxy websockets
     RewriteCond %{HTTP:Upgrade} =websocket [NC]
     RewriteRule (.*) ws://coder.zwserver.xyz$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

# Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Websockets are required for workspace connectivity
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     # Rewrite rule to proxy websockets
     RewriteCond %{HTTP:Upgrade} =websocket [NC]
     RewriteRule (.*) ws://coder.zwserver.xyz$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

# Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Websockets are required for workspace connectivity
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     # Rewrite rule to proxy websockets
     RewriteCond %{HTTP:Upgrade} =websocket [NC]
     RewriteRule (.*) ws://coder.zwserver.xyz$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

P

Phorcys•2/22/23, 10:03 PM

replace ws://zwserver.xyz with ws://127.0.0.1:300 and add

upgrade=any

upgrade=any

upgrade=any

upgrade=any to the ProxyPass line

Z

ZaserrOP•2/22/23, 10:51 PM

Still getting unable to connect to linux

Z

ZaserrOP•2/22/23, 10:52 PM

 # Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/ upgrade=any
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Rewrite rule to proxy websockets
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     RewriteCond %{HTTP:Upgrade} =websocket [NC]
     RewriteRule (.*) ws://127.0.0.1:3000$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

 # Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/ upgrade=any
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Rewrite rule to proxy websockets
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     RewriteCond %{HTTP:Upgrade} =websocket [NC]
     RewriteRule (.*) ws://127.0.0.1:3000$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

 # Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/ upgrade=any
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Rewrite rule to proxy websockets
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     RewriteCond %{HTTP:Upgrade} =websocket [NC]
     RewriteRule (.*) ws://127.0.0.1:3000$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

 # Redirect HTTP to HTTPS
 <VirtualHost *:80>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     Redirect permanent / https://coder.zwserver.xyz/
 </VirtualHost>

 <VirtualHost *:443>
     ServerName coder.zwserver.xyz
     ServerAlias *.coder.zwserver.xyz
     ErrorLog ${APACHE_LOG_DIR}/error.log
     CustomLog ${APACHE_LOG_DIR}/access.log combined

     ProxyPass / http://127.0.0.1:3000/ upgrade=any
     ProxyPassReverse / http://127.0.0.1:3000/
     ProxyRequests Off
     ProxyPreserveHost On

     RewriteEngine On
     # Rewrite rule to proxy websockets
     RewriteCond %{HTTP:Connection} Upgrade [NC]
     RewriteCond %{HTTP:Upgrade} =websocket [NC]
     RewriteRule (.*) ws://127.0.0.1:3000$1 [P,L]

     SSLCertificateFile /etc/letsencrypt/live/coder.zwserver.xyz/fullchain.pem
     SSLCertificateKeyFile /etc/letsencrypt/live/coder.zwserver.xyz/privkey.pem
 </VirtualHost>

Z

ZaserrOP•2/22/23, 11:01 PM

@Phorcys

ZZaserr ``` # Redirect HTTP to HTTPS <VirtualHost *:80> ServerName coder.zwserver....

M

matifali•2/23/23, 5:41 AM

Is Coder running on:3000?
also, make sure

curl

curl

curl

curl or

wget

wget

wget

wget is installed in the docker image you are using to create the workspace.

Z

ZaserrOP•2/24/23, 10:05 AM

Yes and docker is right

Misconfigured WebSockets reverse-proxying with Apache HTTPD

Similar Threads

Similar Threads

Similar Threads