Synology Install Code Server With Portainer

by

Synology Install Code Server With Portainer

MyĀ previous guide for Code ServerĀ involved the use of Task Scheduler. Today Iā€™m offering a recommended and excellent alternative for installing the latest Code Server version via Portainer. Code-server is VS Code running on a remote server, accessible through the browser. You can code on your Chromebook, tablet, and laptop with a consistent dev environment using Code Server. You can take advantage of large cloud servers to speed up tests, compilations, downloads, and more. Code Server helps you preserve battery life when you’re on the go. All intensive computation runs on your NAS server; you’re no longer running excess instances of Chrome. In this step by step guide I will show you how to install Code Server on your Synology NAS using Docker & Portainer.

šŸ’”Note: This guide works perfectly with the latest Code Server v4.93.1 release.

  • 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.

Code Server Synology NAS Portainer Set up 1

  • STEP 5

Now click the ā€œCreateā€ button. Follow the instructions in the image below.

Code Server Synology NAS Portainer Set up 2

  • 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 Code Server. After that, add the following instructions:

Source:
Protocol:Ā HTTPS
Hostname: codeserver.yourname.synology.me
Port:Ā 443

Check Enable HSTS

Destination:
Protocol:Ā HTTP
Hostname:Ā localhost
Port:Ā 8377

Code Server Synology NAS Portainer Set up 3

  • STEP 7

Go to Control Panel / Login Portal / select your Code Server Reverse Proxy then click the Custom Header tab. Click Create and then, from the drop-down menu, click on 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.

Synology Proxy WebSocket

  • STEP 8

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

Code Server Synology NAS Portainer Set up 4

  • STEP 9

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

Code Server Synology NAS Portainer Set up 5

  • STEP 10

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

Code Server Synology NAS Portainer Set up 6

  • 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.

1 Synology Portainer Add Stack

  • STEP 12

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

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

version: "3.9"
services:
  codeserver:
    container_name: Code-Server
    image: ghcr.io/linuxserver/code-server
    healthcheck:
     test: curl -f http://localhost:8443/ || exit 1
    mem_limit: 6g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:false
    restart: on-failure:5
    ports:
      - 8377:8443
    volumes:
      - /volume1/docker/codeserver:/config:rw
    environment:
      TZ: Europe/Bucharest
      PUID: 1026
      PGID: 100
      PROXY_DOMAIN: codeserver.yourname.synology.me
      PASSWORD: mariushosting
      SUDO_PASSWORD: mariushosting

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.)
Note: Before you paste the code above in the Web editor area, change the value for PROXY_DOMAIN and add your own synology.me DDNS that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area, change the value for PASSWORDĀ and add your own password. mariushosting is an example of a password. You have to insert your own password. You will need this password at STEP 12.
Note: Before you paste the code above in the Web editor area, change the value for SUDO_PASSWORDĀ and add your own password. mariushosting is an example for a sudo password. You have to insert your own sudo password.

Code Server Synology NAS Portainer Set up 7 new 2024

  • 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.

Code Server Synology NAS Portainer Set up 8 new 2024

  • STEP 14

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

Code Server Synology NAS Portainer Set up 9

  • 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://codeserver.yourname.synology.me In my case it’s https://codeserver.mariushosting.synology.me Type in your own Password that you have previously chosen at STEP 12. Click SUBMIT. Follow the instructions in the image below.

Code Server Synology NAS Portainer Set up 10

  • STEP 17

Check “Trust the authors of all files in the parent folder ‘config’“. Click Yes, I trust the authors. Follow the instructions in the image below.

Code Server Synology NAS Portainer Set up 11

  • STEP 18

Choose the settings that appeal to you the most, like Dark theme, then click on Next Section.

Code Server Synology NAS Portainer Set up 12

  • STEP 19

Your Code Server dashboard at a glance!

Code Server Synology NAS Portainer Set up 13

Enjoy Code Server!

šŸ†˜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 Code Server 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 Wednesday / September 25th, 2024 at 9:22 PM

šŸ§” I Need Your Help!