bpmct/code-server-azure

Running code-server on Azure

code-server-azure

Deploying code-server on Azure App Service. Can use --link or an Azure domain. This uses the codercom/code-server base image, so it will always use the latest version of code-server.

This setup includes

• OpenSSH (connect via Azure's portal)
• Domain+TLS (Provided by --link or Azure)
• Authentication (Provided by --link or password)
• A mini redirect web server (if running --link)

How to run

1. Create a new web app from Azure's portal
2. Deploy this container from the Docker Hub: bencdr/code-server-azure
3. Track the status of your deployment via the "Deployment Center"
4. Hit "Browse" on the app overview page to visit your code-server workspace

Configuration

After deploying, you can configure with the following settings (Settings > Configuration > Application Settings)

• LINK_NAME: A custom name used for code-server --link (ex. [linkname]-githubusername.cdr.co)
• PASSWORD: Password to log into code-server. Adding this will disable the use of --link
• GIT_REPO: A public git repo to clone (see #3)
• START_DIR: The directory code-server opens (default: /home/coder/project)
• DISABLE_SSH: Disable SSH access via the Azure portal, saves resources

⚠️ If you are using the Free (F1) app service plan: do not set a password. code-server --link will handle your access. See #2 for details

Troubleshooting

The web server may not redirect to the --link URL correctly off the bat. Restarting the app or waiting for the deployment to complete may fix the issue. After authenticating with GitHub, a single refresh may be necessary to connect to code-server.

You can connect to your code server instance via SSH under Development Tools -> SSH. Logs for code-server and the mini web server are stored in /home/coder/.

By default, Azure does not have logging enabled. To enable logs, go to "Monitoring -> App Service Logs" and turn on. Retention period can be set to 1 day. Then, you can preview logs under "Monitoring > Log Stream" or via the Azure CLI:

$ az webapp log tail --name [app] --resource-group [resource group]

code-server-azure's Issues

after deployment link leads to troubleshoot section

https://github.com/bpmct/code-server-azure#troubleshooting

consolidate with code-server-heroku

Many repeated code is used. Use a single base image and apply the provider-specific config on top.

https://github.com/bpmct/code-server-heroku

document attaching storage

https://docs.microsoft.com/en-us/azure/app-service/configure-connect-to-azure-storage?pivots=container-linux

Default Password

I’ve deployed this on VM, there’s no application setting in configuration. What is the default password?

persistent storage

Just wondering if there's already a configuration for having persistent storage. Like using a storage account or something?

Enquiry : editing dockerfile for azure web app container.

Hello, just a query on the guide for deploying the container on Azure Web App. I see that we have to use ben's public docker image to deploy. So when we edit the Dockerfile on our own GitHub repo, the change wouldn't reflect in Azure web app like on railway. Is that the current limitation of deploying on azure?

Reference link : https://github.com/bpmct/code-server-azure#readme

After deployment and Browse blank screen

Error connecting to your code-server instance

Ensure code-server is running and was properly started with the --link command line flag.

websockets don't work on Free F1 plan

$PASSWORD must be left blank to use code-server --link instead of directly using Azure's domain+TLS. I believe this is due to the web socket limit on the free tier: https://docs.microsoft.com/en-us/azure/app-service/faq-app-service-linux#web-sockets

Doesn't use latest code-server

It deploys v3.9.0 and not the latest(as of writing the latest version is 4.0.1)

add support for adding SSH keys

Allow private repos to be auto-cloned by supplying a SSH key