Web socket fails to connect through Apache

OS/Web Information

Web Browser: Chrome
Local OS: MacOS 12.2
Remote OS: Ubuntu 20.04 LTS
Remote Architecture: amd64
code-server --version: 4.0.1

Logs

code-server --log debug
[2022-01-11T03:38:43.612Z] info code-server 4.0.1 735c6da
[2022-01-11T03:38:43.613Z] info Using user-data-dir ~/.local/share/code-server
[2022-01-11T03:38:43.628Z] info Using config file ~/.config/code-server/config.yaml
[2022-01-11T03:38:43.628Z] info HTTP server listening on http://0.0.0.0:8080/
[2022-01-11T03:38:43.628Z] info - Authentication is enabled
[2022-01-11T03:38:43.628Z] info - Using password from ~/.config/code-server/config.yaml
[2022-01-11T03:38:43.628Z] info - Not serving HTTPS
[22:38:51] Extension host agent started.
[22:38:51] [Theme Service] Scanning for theme extension...
[22:38:51] [Theme Service] theme-abyss
[22:38:51] [Theme Service] theme-defaults
[22:38:51] [Theme Service] theme-kimbie-dark
[22:38:51] [Theme Service] theme-monokai
[22:38:51] [Theme Service] theme-monokai-dimmed
[22:38:51] [Theme Service] theme-quietlight
[22:38:51] [Theme Service] theme-red
[22:38:51] [Theme Service] theme-solarized-dark
[22:38:51] [Theme Service] theme-solarized-light
[22:38:51] [Theme Service] theme-tomorrow-night-blue
[22:38:51] [Theme Service] Attempting to find user's active theme: Default Dark+
[2022-01-11T03:38:54.949Z] debug got latest version {"latest":"4.0.1"}
[2022-01-11T03:38:54.949Z] debug comparing versions {"current":"4.0.1","latest":"4.0.1"}
[2022-01-11T03:39:51.007Z] debug 0 active connections

Screenshot

Notes

I currently only experience this error on code-server 4.0.1. code-server 3.12.0 works without issue.
I am currently using apache2 with a reverse proxy. The current config for the apache2 virtual host is below:

<Location "/">
ProxyPass http://127.0.0.1:8080/
ProxyPassReverse http://127.0.0.1:8080/
ProxyPassReverse /
RewriteEngine on
RewriteCond %{HTTP:Upgrade} websocket [NC]
RewriteCond %{HTTP:Connection} upgrade [NC]
RewriteRule ^/?(.*) "ws://127.0.0.1:8080/" [P,L]

I also made sure all the websockets modules are loaded in apache2 and working without problems. No errors occur on the Apache web server. Any suggestions on how to get this working with Apache2?

This issue can be reproduced in VS Code: No

Same issue here. Using apache2 with reverse proxy. Only occur with 4.0.1, code-server 3.12.0 works fine for me.

@code-asher

@code-asher any ideas?

If the exact same config works with 3.12 that does seem like it could be an issue with 4.0 but I have no idea how; so far all the 1006 errors I have seen have been caused by misconfiguration. I am not very familiar with Apache but maybe this comment has a clue: #2104 (comment)

Same issue here using apache2 with reverse proxy

Ditto.

3.12.0 works fine. 4.0.1 returns 1006.
apache2 reverse proxy.

Same issue.

Same issue, 3.12.0 works fine and 4.0.1 fails with this error. I'm using apache2 as a reverse proxy. Trying to access the service directly without the proxy seems to work

Sounds like we need to spin up Apache and try to reproduce.

I found a fix on nginx #4763 not sure if there’s an Apache analog for those settings

I'm guessing that line from release log "Web socket compression has been made the default (when supported). This means
the --enable flag will no longer take permessage-deflate as an option" is causing problem. I tried finding analog to "proxy_set_header Accept-Encoding gzip" nginx but I have not yet figured way to make it work.

not sure if there’s an Apache analog for those settings

Me neither.

the --enable flag will no longer take permessage-deflate

I cannot find any documentation on said flag, how does it work ?
Would there be a --disable flag too, which would allow apache users to upgrade to 4.x ?

There is no way to disable compression support. It is only used if the browser tells the server that it supports compression. I am not sure issues with compression could cause a 1006 but you could could try stripping `permessage-deflate` from the `Sec-WebSocket-Extensions` header to see if that does anything (this header is how the browser informs the server it supports compression)

Confirming I was able to reproduce:

$ sudo apt install apache2
$ sudo a2enmod rewrite proxy proxy_http proxy_wstunnel
$ sudo vim /etc/apache2/sites-available/000-default.conf # See below
$ sudo apache2
$ code-server --version
4.0.1 735c6da829535969ff7193c79379299e4a1cb9bc
$ code-server --port 8080

<VirtualHost *:80>
  ProxyPass / http://localhost:8080/
  RewriteEngine on
  RewriteCond %{HTTP:Upgrade} websocket [NC]
  RewriteCond %{HTTP:Connection} upgrade [NC]
  RewriteRule ^/?(.*) "ws://localhost:8080/$1" [P,L]
</VirtualHost>

Open localhost in browser
Get 1006 errors

Then to confirm it is a 4.0.1 issue I killed code-server with C-c and installed 3.12.0 with yarn:

$ yarn global add code-server@3.12.0
$ ~/.yarn/bin/code-server --version # .yarn/bin is not in my path
3.12.0 4cd55f94c0a72f05c18cea070e10b969996614d2
$ ~/.yarn/bin/code-server --port 8080

Open localhost in browser (Apache is still running from earlier)
Everything works

@leuit

I am using Apache2 version 2.4.53 and cannot use the workaround from @leuit , as disabling mod_proxy_http breaks other services I run on my server. Is there another fix?

You don't need to disable that. Once upgraded, it just works.

@KaKi87

@KaKi87 Well, it isn't working for me, and neither is v3.12. I am however, running code-server on a separate machine than the apache server and just trying to forward the site. This is the current config I'm using:

<VirtualHost *:80>
	     ServerName vscode.mydomain.com
	     UseCanonicalName on
	     Redirect / https://vscode.mydomain.com
</VirtualHost>

<VirtualHost *:443>
	     ServerName vscode.mydomain.com
	     
	     # setup the proxy
	     ProxyRequests off
	     <Proxy *>
	     	    Order deny,allow
		    Allow from all
	     </Proxy>

	     ProxyErrorOverride On

	     Header set Connection "Upgrade"
	     RequestHeader setifempty Connection "Upgrade"
	     Header set Upgrade "websocket"
	     RequestHeader setifempty Upgrade "websocket"

	     ProxyPass / http://192.168.50.60:8081/
	     ProxyPassReverse / http://192.168.50.60:8081/

	     <Location />
	     	       Order allow,deny
		       Allow from all
	     </Location>

	     SSLEngine on
	     Include /etc/letsencrypt/options-ssl-apache.conf
	     ErrorLog "/var/log/apache2/error.vscode.mydomain.dev.log"
	     SSLCertificateFile /etc/letsencrypt/live/mydomain/fullchain.pem
     	     SSLCertificateKeyFile /etc/letsencrypt/live/mydomain/privkey.pem
</VirtualHost>

And on the other machine I'm using code-server --bind-addr 0.0.0.0:8081 to start it. Any ideas?

@ihowell

@ihowell

Are you receiving the same error as OP? Is it not upgrading the websocket connection properly?

You say you're running code-server on a separate machine from apache; can you directly access code-server via the port it's listening on? Depending on the error you're receiving, I think it may just be a communication issue.

If you are indeed receiving the error on the websocket upgrade and can access the frontend webpage of code-server; you'll simply just need to upgrade apache2 as the version does not handle websocket upgrades according to RFC 7230

I am receiving the same 1006 error as op, however I don't know how to tell if the websocket is being upgraded properly. I can access code-server from http://192.168.50.60:8081 in my browser and everything works fine. I just followed instructions and upgraded my server to Apache2 version 2.4.53, but it still isn't working.

Edit: When I run code-server with --log debug, I don't see any errors in the logs.

Edit 2: I now have it working by using the rewriting rules above instead of using my configuration for proxy passing and reverse proxy passing.

@ihowell

@ihowell Wonderful! I was going to suggest changing the apache config next; glad you got it resolved!

@ihowell

Here's my working config using apache2 v2.4.52 & code-server v4.3.0, using ProxyPass (and RewriteEngine only for WebSocket).

<VirtualHost *:80>
    ServerName code.kaki87.net
    RewriteEngine On
    RewriteCond %{HTTPS} off
    RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI}
</VirtualHost>

<VirtualHost *:443>
    ServerName code.kaki87.net
    ProxyRequests Off
    ProxyPass / http://localhost:3090/
    ProxyPassReverse / http://localhost:3090/
    RewriteEngine On
    RewriteCond %{HTTP:Upgrade} =websocket [NC]
    RewriteRule /(.*) ws://localhost:3090/$1 [P,L]
    SSLCertificateFile /home/kaki/.acme.sh/kaki87.net/fullchain.cer
    SSLCertificateKeyFile /home/kaki/.acme.sh/kaki87.net/kaki87.net.key
</VirtualHost>

I always try to make those as light as possible.
I don't think proxying to the local host or to another host on the local network changes anything.
Also, @ihowell, when making future reports about something that isn't working, please document the unexpected behavior as much as you can, because it is as important as documenting your configuration. :)

Upgrade Apache2 to 2.4.52 also solved the issue for me without change anythingelse in apache configuration.

@ihowell

Hi @ihowell can you please share your solution? I have your same issue running last Apache version (2.4.6)

Upgrading apache2 worked for me.

This issue has not been resolved in version 4.

try nginx config as follows:

location ~ ${your frontend url pattern} {
    # add it if your url is dynamic
    resolver {your DNS server}
    
    # trick here, consult here for Nginx official doc
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection upgrade;
    # trick here, if absent, the server will block the websocket request if the origin is NOT equal to the host
    proxy_set_header Origin http://${your backend host}/;
    proxy_set_header X-Forwarded-Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    
    proxy_set_header Accept-Encoding gzip;
    proxy_cookie_domain ${your backend host} ${your frontend host};
    
    proxy_pass ${your backend url pattern};
}

config above working for me. my scene：

code-server: 4.18.0, running in an container of Kubernetes
nginx:1.9.7, running in an container of another Kubernetes.

As of Apache 2.4.58 I'm still having this issue. 😒

lilithe@lilithebowman:~$ apache2 -v
Server version: Apache/2.4.58 (Ubuntu)
Server built:   2025-04-03T14:36:49

Status
404
Not Found
VersionHTTP/1.1
Transferred215 B (0 B size)
DNS ResolutionSystem

	
Connection
	Upgrade
Content-Encoding
	br
Content-Type
	text/plain
Date
	Thu, 24 Apr 2025 16:22:10 GMT
Server
	Apache/2.4.58 (Ubuntu)
Transfer-Encoding
	chunked
Vary
	Accept-Encoding
	
Accept
	*/*
Accept-Encoding
	gzip, deflate, br, zstd
Accept-Language
	en-US,en;q=0.5
Cache-Control
	no-cache
Connection
	keep-alive, Upgrade
Cookie
	code-server-session=%24argon2id%24v%3D19%24m%3D65536%2Ct%3D3%2Cp%3D4%24mBGJVPPISLtELQT8KxmJcQ%24aZdISVoXpjpHH89DwmOOTlcTQ%2Bq257Nnfb2iiXvlPP0
Host
	<my site HOST>
Origin
	<my site URL>
Pragma
	no-cache
Sec-Fetch-Dest
	empty
Sec-Fetch-Mode
	websocket
Sec-Fetch-Site
	same-origin
Sec-WebSocket-Extensions
	permessage-deflate
Sec-WebSocket-Key
	CPDPULLXB/3igjyaVRePmw==
Sec-WebSocket-Version
	13
Upgrade
	websocket
User-Agent
	Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:137.0) Gecko/20100101 Firefox/137.0

As of Apache 2.4.58 I'm still having this issue. 😒

Share your config.

As of Apache 2.4.58 I'm still having this issue. 😒

Share your config.

Sure thing! Sorry I was just cleaning up my /etc/apache2/sites-available/ because it's been there for years with a few unnecessary site configs and things LetsEncrypt made that don't need to be there. Now that it's cleanly whittled down to the configs I need for my sites, I can begin to debug this.

Okay false alarm. Here is my fixed config!

cat /etc/apache2/sites-available/code-server.conf

<VirtualHost *:443>
        ServerName code.mysite.com

        <Proxy *>
                Allow from all
                Allow from localhost
        </Proxy>

        Header add Connection "Upgrade"
        RequestHeader set Connection "Upgrade"


        RewriteEngine On RewriteCond %{HTTP:Upgrade} =websocket [NC]
        RewriteRule /(.*) ws://127.0.0.1:1024/$1 [P,L]
        RewriteCond %{HTTP:Upgrade} !=websocket [NC]
        RewriteRule /(.*) http://127.0.0.1:1024/$1 [P,L]
        ProxyRequests off ProxyPass / http://127.0.0.1:1024/ nocanon retry=10 
        ProxyPassReverse / http://127.0.0.1:1024/ retry=10

        ProxyPass /api/websocket ws://127.0.0.1:8123/api/websocket
        ProxyPassReverse /api/websocket ws://127.0.0.1:8123/api/websocket
        #Header add Connection "Upgrade"
        #RequestHeader set Connection "Upgrade"

        Include /etc/letsencrypt/options-ssl-apache.conf
        SSLCertificateFile /etc/letsencrypt/live/mysite.com/fullchain.pem
        SSLCertificateKeyFile /etc/letsencrypt/live/mysite.com/privkey.pem
</VirtualHost>

Navigation Menu

Repository navigation

Web socket fails to connect through Apache #4723

OS/Web Information

Logs

Screenshot

Notes

31 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Web socket fails to connect through Apache #4723

Description

OS/Web Information

Logs

Screenshot

Notes

Activity

JimmyNi commented on Jan 12, 2022

jsjoeio commented on Jan 13, 2022

code-asher commented on Jan 13, 2022

konni commented on Jan 17, 2022

jamieshaw commented on Jan 17, 2022

sobakaio commented on Jan 19, 2022

gmiscione commented on Jan 19, 2022

code-asher commented on Jan 19, 2022

dokastho commented on Jan 19, 2022

siklosi commented on Jan 24, 2022

KaKi87 commented on Jan 24, 2022

code-asher commented on Jan 26, 2022

code-asher commented on Jan 26, 2022

31 remaining items

ihowell commented on May 5, 2022

KaKi87 commented on May 5, 2022

ihowell commented on May 5, 2022

leuit commented on May 5, 2022

ihowell commented on May 5, 2022

leuit commented on May 6, 2022

KaKi87 commented on May 6, 2022

Drealine commented on May 21, 2022

maverjk commented on May 30, 2022

lachlansimpson commented on Sep 16, 2022

qjaden commented on Sep 3, 2023

mashroomxl commented on Nov 12, 2023

lilithebowman commented on Apr 24, 2025

KaKi87 commented on Apr 24, 2025

lilithebowman commented on Apr 24, 2025

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions