Quickstart
Follow the steps in this guide to install Coder locally or on a cloud-hostingprovider, set up a workspace, and connect to it from VS Code.
By the end of this guide, you'll have a remote development environment that youcan connect to from any device anywhere, so you can work on the same files in apersistent environment from your main device, a tablet, or your phone.
Install and start Coder
Configure Coder with a new Workspace
Coder will attempt to open the setup page in your browser. If it doesn't openautomatically, go tohttp://localhost:3000.
- If you get a browser warning similar to
Secure Site Not Available
, youcan ignore the warning and continue to the setup page.
If your Coder server is on a network or cloud device, or you are havingtrouble viewing the page, locate the web UI URL in Coder logs in yourterminal. It looks like
https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app
.It's one of the first lines of output, so you might have to scroll up to findit.- If you get a browser warning similar to
On theWelcome to Coder page, to use your GitHub account to log in,selectContinue with GitHub.You can also enter an email and password to create a new admin account onthe Coder deployment:
Welcometo Coder - Create admin user
On theWorkspaces page, selectGo to templates to create a newtemplate.
For this guide, use a Docker container. LocateDocker Containers andselectUse template.
Give the template aName that you'll recognize both in the Coder UI andin command-line calls.
The rest of the template details are optional, but will be helpful when youhave more templates.
Createtemplate
SelectCreate template.
After the template is ready, selectCreate Workspace.
Give the workspace a name and selectCreate Workspace.
Coder starts your new workspace:
Workspaceis running
SelectVS Code Desktop to install the Coder extension and connect to yourCoder workspace.
Work on some code
After VS Code loads the remote environment, you can selectOpen Folder toexplore directories in the Docker container or work on something new.
To clone an existing repository:
SelectClone Repository and enter the repository URL.
For example, to clone the Coder repo, enter
https://github.com/coder/coder.git
.Learn more about how to find the repository URL in theGitHub documentation.
Choose the folder to which VS Code should clone the repo. It will be in itsown directory within this folder.
Note that you cannot create a new parent directory in this step.
After VS Code completes the clone, selectOpen to open the directory.
You are now using VS Code in your Coder environment!
What's next?
Now that you have your own workspace, use the same template to set one up for ateammate.
Go toTemplates and selectCreate Workspace and continue from Step 7 inConfigure Coder with a new workspace.
After that, you can try to:
Troubleshooting
Cannot connect to the Docker daemon
Error: Error pinging Docker server: Cannot connect to the Docker daemon atunix:///var/run/docker.sock. Is the docker daemon running?
Install Docker for your system:
curl -sSL https://get.docker.com | sh
Set up the Docker daemon in rootless mode for your user to run Docker as anon-privileged user:
dockerd-rootless-setuptool.sh install
Depending on your system's dependencies, you might need to run other commandsbefore you retry this step. Read the output of this command for furtherinstructions.
Assign your user to the Docker group:
sudo usermod -aG docker $USER
Confirm that the user has been added:
$ groupsdocker sudo users
Ubuntu users might not see the group membership update. In that case, runthe following command or reboot the machine:
newgrp docker
Can't start Coder server: Address already in use
Encountered an error running "coder server", see "coder server --help" for more informationerror: configure http(s): listen tcp 127.0.0.1:3000: bind: address already in use
Stop the process:
sudo systemctl stop coder
Start Coder:
coder server