Implement VS Code remote extensions #1315

nhooyr · 2020-01-29T00:43:01Z

Container
SSH
Tunnels

Related #1032

LukasMasuch · 2020-01-29T11:04:55Z

In case this issue is about fixing the remote extensions to work with code-server, this related issue can be closed: #892. I would really like to see the SSH extension to work within code-server and would be happy to test it once there is any fix.

sr229 · 2020-01-29T13:19:34Z

@nhyoor if this interests you, there's a remote subfolder in the main vscode folder, wanna ~~abuse~~ reuse that?

frank-dspeed · 2020-02-01T12:25:31Z

The remote extension does some checks as far as i know i decompiled it some times.

There is a validation shema i think we should first automate the decompile process and check that.

nhooyr · 2020-02-02T20:49:02Z

We cannot and will not decompile the extension, that is not valid per the license terms.

Just-Insane · 2020-02-23T23:14:35Z

Is there any further plan to implement these extensions?

kirscheGIT · 2020-05-29T09:57:26Z

Is there any further plan to implement these extensions?

Would also like to know, if you have still have plans to implement this. Thanks!

code-asher · 2020-05-29T16:26:10Z

Nothing concrete at the moment.

gyzerok · 2020-06-05T01:04:30Z

I currently have a need for Remote - SSH extension and unfortunately the official one doesn't work for me (which is unlikely to be solved upstream in the near future). So I am considering implementing it myself.

At least initially I would like to have it as simple as possible. Without any fancy terminal forwarding or something like that. Just make it so that the work with the filesystem and all the language servers are running on the vm and UI is running in the vscode. Similar two what we now have with code-server in the browser, but without browser version problems (such as cmd+w for example).

Would you have some pointers as to where to start investigating from inside vscode source?

code-asher · 2020-06-08T19:58:23Z

At the moment I don't have a good idea of the full scope of what'll be required to make this work but it'll probably have to do with using and/or implementing the remote authority stuff.

There's a workspace.registerRemoteAuthorityResolver in the proposed API which might be a good starting point.

JayDoubleu · 2020-08-17T23:43:42Z

building from vscode-1.48.0 branch + adding 9fb33dc , as well as adding ms-vscode-remote.remote-containers to extensionAllowedProposedApi.

This gets the remote extensions installed however it is still complaining with the error:

[ms-vscode-remote.remote-containers]: View container 'remote' requires 'enableProposedApi' turned on to be added to 'Remote'.

Tried executing via below.

code-server --enable-proposed-api ms-vscode-remote.remote-containers
code-server --enable-proposed-api=ms-vscode-remote.remote-containers

Is there any more direct way to add arguments to the vscode to execute ?
I'm not sure if the enable-proposed-api switch simply does nothing or there is something else to be enabled.

code-asher · 2020-08-18T16:32:11Z

@JayDoubleu could you open a separate issue for the enable proposed API flag? It's possible we have a bug there.

I'm not confident the remote extensions will work in code-server even if we resolve that though. Unfortunately I won't be able to test since it's against the terms of service to use them in anything other than VS Code. 😢

nhooyr · 2020-08-20T19:46:06Z

See #1779

JayDoubleu · 2020-08-26T16:40:53Z

Just tested this with ms-vscode-remote.remote-containers-0.132.0.vsix
When clicking open in container it just disconnects and reloads.
[server] disconnected from client {"proxies":3}

I'm assuming there is no way to get ANY remote or codespaces working with code-server ?
I can see that it's already connecting to localhost as a remote

code-asher · 2020-08-27T16:59:41Z

I haven't investigated (I don't think I can since legally we can't run the extension with code-server) so I can't be sure but yeah, I think it's possible that code-server technically being a remote already might be what's causing the incompatibility.

code-asher · 2020-08-27T17:03:44Z

I'd be curious to know whether the remote extensions work in VS Code's own online offering, if anyone has given that a try. If they don't work then maybe they'll do some work to make it possible. If they do work then I think it's unlikely we'll be able to do anything about it.

JayDoubleu · 2020-08-27T17:24:30Z

The VSCode online AKA codespaces returns
Cannot install 'Remote - Containers' because this extension has defined that it cannot run on the remote server
when trying to install extension.

The codespace when opened already acts as a remote, and Microsoft allows for multiple of those.

The VS Code Remote - Containers extension allows you to clone a repository or open any folder mounted into (or already inside) a dev container and take advantage of VS Code's full development feature set. Visual Studio Codespaces and Codespaces in GitHub both use this same concept to quickly create customized, cloud-based development environments accessible from VS Code or the web.

It looks like it detects the devcontainer.json and automatically bootstraps into the environment as one would through remote container extension.

code-asher · 2020-08-27T17:39:38Z

Ah, we disable the remote extension check and just let every extension attempt to run which explains why code-server doesn't display that error (otherwise extensions like vscode-icons won't run even though they work).

I suppose that means the extension is not meant to work by design, at least as it currently stands, and that probably won't change if they've already coded the functionality separately in codespaces. So in the end we're basically stuck just having to re-implement these extensions.

JayDoubleu · 2020-09-02T16:35:40Z

I see,
The ability to spin up multiple code-server codespaces* while using devcontainer.json as provisioner would be a very appreciated feature.
In theory one could create some sort of wrapper with just docker build + bind mounts however its all about the experience.

bryanculver · 2021-05-26T13:26:42Z

✋ I would love to know who/how I can help. I've worked with TypeScript, Docker, and other tangentially related bits. Green behind the ears when it comes to contributing to this repo but I'm using code-server almost daily now from an iPad. Would love to leverage an almost inverse of most people's setups of remote extensions, where I have powerful machines running at home and would like to leverage them instead of massively scaling up my droplets.

jsjoeio · 2021-05-26T14:43:32Z

@bryanculver love the enthusiasm and the willingness to help ❤️

I have not looked into this myself, but maybe @code-asher can give a pointer on to where to start?

code-asher · 2021-05-26T17:21:47Z

I'm actually not sure how the remote extensions are implemented but they will need to do something like this:

Connect to the remote (SSH, Docker, etc)
Download code-server into the remote if necessary
Start code-server in the remote if not already started
Connect to code-server (not completely sure what this entails, might need to make modifications to code-server to support non-web connections)
At this point things are quite fuzzy for me. Somehow the extensions provide file access (maybe through registerFileSystemProvider?) and extensions (no idea how this is done). It's possible the extensions use APIs that aren't documented.

bryanculver · 2021-05-27T02:12:37Z

The comments above are a goldmine. My old mentor's comedic relief quip "should be simple" is ringing in my head. Since they haven't published the extension with a permissive license nor the source code, a non-trivial complexity is necessary to implement this.

However seeing code-server is already being run as a server process, 🤞 this isn't that hard.

Would it be fair to say/assume that this will have to be it's own plugin (with maybe some enhanced APIs on the client side)? Trying to determine if I should fork this repo and start a new plugin project somewhere or start a new repo to build this out.

sr229 · 2021-05-27T03:44:16Z

The comments above are a goldmine. My old mentor's comedic relief quip "should be simple" is ringing in my head. Since they haven't published the extension with a permissive license nor the source code, a non-trivial complexity is necessary to implement this.

However seeing code-server is already being run as a server process, 🤞 this isn't that hard.

Would it be fair to say/assume that this will have to be it's own plugin (with maybe some enhanced APIs on the client side)? Trying to determine if I should fork this repo and start a new plugin project somewhere or start a new repo to build this out.

I was working on this under the calliope repo. I haven't gone around it for a while but I may when I have enough time. We can probably pool together and make this possible!

bryanculver · 2021-05-27T12:12:21Z

@sr229 Awesome! Please tell me how I can jump in to help. I've been trying to verify if the existing plugins leverage undocumented APIs to deliver some of the client side features at the moment.

code-asher · 2021-05-27T18:18:55Z

Would it be fair to say/assume that this will have to be it's own plugin (with maybe some enhanced APIs on the client side)?

Yup, this would need to be a separate plugin. I think a separate repo will make the most sense for that.

There may be changes we have to make to code-server itself as well; in that case you'll need to fork this repo.

sr229 · 2021-05-28T11:42:11Z

@sr229 Awesome! Please tell me how I can jump in to help. I've been trying to verify if the existing plugins leverage undocumented APIs to deliver some of the client side features at the moment.

As far as I'm aware, they use the undocumented proposed APIs for remote. Apparently they are documented but no formal documentation exists outside the vscode.proposed.d.ts file.

Lestt · 2021-06-21T23:36:35Z

@sr229 I just noticed your message... as you tagged me in the edition mode, i got no notification. I ll show up asap on the Coder Slack and see if I can be useful.
Sorry again for the late reply.

vegardhw · 2021-06-29T22:51:24Z

So the idea here is to have code-server serve as the lightweight "local os", and from there ssh-remote to other systems? As in the overview image at the top here: https://code.visualstudio.com/docs/remote/remote-overview (local os -> remote os).

code-asher · 2021-06-30T16:22:12Z

Yup you'd be able to use code-server from the local OS as indicated in that diagram. But you could also use VS Code if you were so inclined (so both code-server to code-server and VS Code to code-server).

vegardhw · 2021-07-09T07:43:17Z

This sounds awesome! :) What is the expected timeline for a release...? :)

code-asher · 2021-07-12T20:17:09Z

There's no timeline unfortunately, this is just a candidate for possibly being worked on in the future.

geiseri · 2021-09-19T11:57:38Z

Given the "legal issues" surrounding this I think it would be best to just implement something "compatible" with dev containers. Currently, I run code-server in a docker, so IMHO it would be easier to just have something that will build a docker env from that dev container and run code-server from there. Then the current proxy code used for exposing web development can just forward to that instance. Thus far I have found the remote container development "clunky" at best and running code-server inside of a docker has proven a more usable experience. There is also the issue that code-server should have its own value beyond being a drop-in for MS technology that is easily replaceable. So far code-server can be instigated via ssh, it can run perfectly inside of docker. Just my 2c as someone who uses both remote VS code and code-server.

jsjoeio · 2021-09-20T17:00:54Z

^cc @bpmct @kylecarbs

jarodium · 2022-02-25T17:06:02Z

Maybe I am misintepreting the intent of the original issue, but is this issue about to use extensions on a remote location? If so, why not mount a ssh folder on the local/host machine and then run code-server to use that particular folder?

like this:
" --extensions-dir="DRIVELETTER:\VSCODE\extensions""
" --user-data-dir="DRIVELETTER:\VSCODE\settings""

I have a use case in which I will need this kind of setup. I want to run code-server inside several containers, in which I want a workspace to be available, but I would like to pre-install extensions when I bootup a container.

I understand that this setup will raise a great number of issues, but for me and my team would be great, since we always use the same extensions to work and has the bonus of adding another person to the team and start him/her up without going through environment setups.

jsjoeio · 2022-02-25T20:52:52Z

I have a use case in which I will need this kind of setup. I want to run code-server inside several containers, in which I want a workspace to be available, but I would like to pre-install extensions when I bootup a container.

This basically sounds like your own version of Coder! We have many teams who do this. The most common way I've seen is installing the extension as part of the Dockerfile so that it's available when your teammates create a workspace (i.e. access code-server):

https://coder.com/docs/coder/latest/workspaces/vs-code-extensions#adding-extensions-to-custom-images

spwoodcock · 2022-03-25T18:15:29Z

Though it would be nice to have the official remote extensions working, I can't see it happening anytime soon.

I have been using code-server for a few years now deployed inside a container (Docker & Kubernetes) & recently got remote debugging working inside Docker containers for a FastAPI app. (sidenote: Docker in Docker is messy. I currently bind mount docker.sock for local development, but I'm sure using a remote TCP host via DOCKER_HOST would work too.)

For anyone looking at remote debugging, this approach should work for any language that supports a remote debug package (e.g. Python, Node...). I currently use the debugpy package in Python.

In the root of your repo, add launch.json and tasks.json into the .vscode directory.

launch.json:

{
  "configurations": [
    {
      "name": "Python - Remote Attach",
      "type": "python",
      "preLaunchTask": "docker-compose: cycle",
      "request": "attach",
      "host": "NAME_OF_YOUR_DOCKER_CONTAINER",
      "port": 5678,
      "pathMappings": [
        {
          "localRoot": "${workspaceFolder}",
          "remoteRoot": "/opt/app"
        }
      ],
      "justMyCode": false,
    }
  ]
}

tasks.json (note: you could use a dockerCompose type task, but this doesn't support V2):

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "docker-compose: cycle",
      "type": "shell",
      "command": "docker compose down && docker compose up -d api --no-build",
    }
  ],
}

Relevant part of Dockerfile to make this work:

...
...
ENTRYPOINT ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]
USER appuser


FROM runtime as dev
RUN pip install debugpy
ENTRYPOINT ["python", "-m", "debugpy", "--wait-for-client", "--listen", \
            "0.0.0.0:5678", "-m", "uvicorn", "main:app", "--host", \
            "0.0.0.0", "--port", "8000"]
CMD ["--reload", "--log-level", "error", "--no-access-log"]


FROM runtime as prod
CMD ["--workers", "1", "--log-level", "error", "--no-access-log"]

archef2000 · 2023-08-29T14:23:32Z

Hello sorry if i ask, but is there currently a way to use the projects of code-server with the desktop app?

Enissay · 2024-06-30T09:07:28Z

Any update on this please ?

Or at least if someone could share a workaround to access remote files from ssh through code-server on docker ?

code-asher · 2024-07-01T20:56:58Z

We have no plans on working on this, but there is an open source version here: https://github.com/jeanp413/open-remote-ssh

I have not tried it, but maybe it can be made to work with code-server.

code-asher · 2024-07-01T20:59:54Z

Or this extension might work: https://open-vsx.org/extension/Kelvin/vscode-sshfs

Enissay · 2024-07-01T21:57:13Z

Or this extension might work: https://open-vsx.org/extension/Kelvin/vscode-sshfs

It doesnt sadly, I tried 2 more from the extension list and none worked, they just show empty pages...

We have no plans on working on this, but there is an open source version here: https://github.com/jeanp413/open-remote-ssh

I have not tried it, but maybe it can be made to work with code-server.

Thank you, I will try to figure out how to install it and revert back

nhooyr mentioned this issue Jan 29, 2020

[v2] Remote - Containers extension v0.74.0 does not work #1032

Closed

nhooyr added the enhancement Some improvement that isn't a feature label Jan 29, 2020

nhooyr mentioned this issue Jan 29, 2020

[v2] Remote Extension - fails to connect to host #892

Closed

code-asher mentioned this issue Aug 17, 2020

Extensions missing #1976

Closed

JayDoubleu mentioned this issue Aug 18, 2020

vscode remote containers extension #1977

Closed

2 tasks

code-asher mentioned this issue Aug 28, 2020

Microsoft Remote Development Extension Pack #2017

Closed

2 tasks

code-asher mentioned this issue Nov 16, 2020

How to install Remote Development extension? #1256

Closed

code-asher mentioned this issue Dec 2, 2020

Headless Remote Support #2105

Closed

nhooyr added extension Extension related but not a request feature New user visible feature and removed enhancement Some improvement that isn't a feature labels Dec 7, 2020

nhooyr added this to To do in code-server via automation Dec 7, 2020

jsjoeio modified the milestones: On Deck, Backlog Candidates May 13, 2021

lars18th mentioned this issue Jul 7, 2021

Failed to connect to the remote extension host server due to unsupported, out of date libraries like glibc (e.g. older CentOS version) microsoft/vscode-remote-release#103

Closed

benz0li mentioned this issue Jul 22, 2022

fix: invoking code-server in integrated terminal #5360

Merged

1 task

jsjoeio mentioned this issue Sep 29, 2022

[Feat]: Adding remote-ssh support #5603

Closed

Creling mentioned this issue Oct 1, 2022

[Bug]: desktop-only extensions are forced to disable in code-server #5609

Closed

code-asher mentioned this issue May 30, 2023

[Feat]: How to support remote ssh, or is there any alternative #6236

Closed

Implement VS Code remote extensions #1315

Implement VS Code remote extensions #1315

Comments

nhooyr commented Jan 29, 2020 • edited by code-asher Loading

LukasMasuch commented Jan 29, 2020

sr229 commented Jan 29, 2020

frank-dspeed commented Feb 1, 2020 • edited Loading

nhooyr commented Feb 2, 2020

Just-Insane commented Feb 23, 2020

kirscheGIT commented May 29, 2020

code-asher commented May 29, 2020

gyzerok commented Jun 5, 2020 • edited Loading

code-asher commented Jun 8, 2020

JayDoubleu commented Aug 17, 2020 • edited Loading

code-asher commented Aug 18, 2020

nhooyr commented Aug 20, 2020

JayDoubleu commented Aug 26, 2020 • edited Loading

code-asher commented Aug 27, 2020

code-asher commented Aug 27, 2020

JayDoubleu commented Aug 27, 2020

code-asher commented Aug 27, 2020 • edited Loading

JayDoubleu commented Sep 2, 2020

bryanculver commented May 26, 2021

jsjoeio commented May 26, 2021

code-asher commented May 26, 2021 • edited Loading

bryanculver commented May 27, 2021

sr229 commented May 27, 2021

bryanculver commented May 27, 2021

code-asher commented May 27, 2021

sr229 commented May 28, 2021

Lestt commented Jun 21, 2021

vegardhw commented Jun 29, 2021

code-asher commented Jun 30, 2021 via email • edited Loading

vegardhw commented Jul 9, 2021

code-asher commented Jul 12, 2021 via email

geiseri commented Sep 19, 2021

jsjoeio commented Sep 20, 2021

jarodium commented Feb 25, 2022

jsjoeio commented Feb 25, 2022

spwoodcock commented Mar 25, 2022 • edited Loading

archef2000 commented Aug 29, 2023

Enissay commented Jun 30, 2024

code-asher commented Jul 1, 2024

code-asher commented Jul 1, 2024 • edited Loading

Enissay commented Jul 1, 2024

nhooyr commented Jan 29, 2020 •

edited by code-asher

Loading

frank-dspeed commented Feb 1, 2020 •

edited

Loading

gyzerok commented Jun 5, 2020 •

edited

Loading

JayDoubleu commented Aug 17, 2020 •

edited

Loading

JayDoubleu commented Aug 26, 2020 •

edited

Loading

code-asher commented Aug 27, 2020 •

edited

Loading

code-asher commented May 26, 2021 •

edited

Loading

code-asher commented Jun 30, 2021 via email •

edited

Loading

spwoodcock commented Mar 25, 2022 •

edited

Loading

code-asher commented Jul 1, 2024 •

edited

Loading