VSCodium is a community-driven, freely-licensed binary distribution of Microsoft’s editor VS Code. This project’s sole aim is to provide you with ready to use binaries without Microsoft’s telemetry code. This solves the problem where you want to use VS Code without the proprietary code from Microsoft, but you are not comfortable with building it from the source. In this step by step guide I will show you how to install VSCodium on your Synology NAS with Docker & Portainer.

💡Note: This guide works perfectly with the latest version of VSCodium v1.96.2

• STEP 1

Please Support My work by Making a Donation.

• STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

• STEP 3

Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.

• STEP 4

Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.

• STEP 5

Now click the “Create” button. Follow the instructions in the image below.

• STEP 6

After you click the Create button, the window below will open. Follow the instructions in the image below.

On the General area, set the Reverse Proxy Name description: type in VSCodium. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: vscodium.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3400

• STEP 7

On the Reverse Proxy Rules click the Custom Header tab. Click Create and then, from the drop-down menu, click WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.

• STEP 8

Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

• STEP 9

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.

• STEP 10

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it vscodium. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 11

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

• STEP 12

In the Name field type in vscodium. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

version: "3.9"
services:
  vscodium:
    image: ghcr.io/linuxserver/vscodium:latest
    container_name: VSCodium
    hostname: vscodium
    mem_limit: 3g
    shm_size: 1g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
      - seccomp:unconfined
    ports:
      - 3400:3000
      - 3401:3001
    volumes:
      - /volume1/docker/vscodium:/config:rw
    environment:
      TZ: Europe/Bucharest
      PUID: 1026
      PGID: 100
      CUSTOM_USER: marius
      PASSWORD: mariushosting
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)
Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.) 1026 is my personal PUID value and 100 is my personal PGID value. You have to type in your own values.
Note: Before you paste the code above in the Web editor area below, change the value for CUSTOM_USER. Type in your own username. marius is an example for a username.
Note: Before you paste the code above in the Web editor area below, change the value for PASSWORD. Type in your own password. mariushosting is an example for a password.

• STEP 13

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

• STEP 14

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

• STEP 15

Go back to STEP 1 or you will deal with karma 🙂

• STEP 16

Now open your browser and type in your HTTPS/SSL certificate like this https://vscodium.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://vscodium.mariushosting.synology.me If everything goes right, you will see the VSCodium Login page. Type in your own CUSTOM_USER and PASSWORD that you have previously created at STEP 12 then click Sign In. Follow the instructions in the image below.

• STEP 17

Your VSCodium page at a glance!

Enjoy VSCodium!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the VSCodium container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Tuesday / December 24th, 2024 at 3:09 AM