Tutorial

Настройка код-серверной облачной IDE-платформы в Ubuntu 20.04

DevelopmentUbuntu 20.04

Автор выбрал фонд Free and Open Source Fund для получения пожертвования в рамках программы Write for DOnations.

Введение

По мере перемещения инструментов для разработчиков в облако, появляется все большее количество облачных IDE (интегрированная среда разработки), и все большее количество разработчиков начинает их использовать. Облачные IDE позволяют реализовать взаимодействие между группами разработчиков в режиме реального времени, работающих в единой среде разработки, которая минимизирует количество несовместимостей и повышает продуктивность. Облачные IDE, доступ к которым осуществляется с помощью веб-браузеров, можно использовать на любых типах современных устройств.

Код-серверная IDE — это код Microsoft Visual Studio Code, запущенный на удаленном сервере и доступный напрямую из браузера. Visual Studio Code — это современный редактор кода с интегрированной поддержкой Git, отладчиком кода, умным автозаполнением и настраиваемыми и расширяемыми функциями. Это означает, что вы можете использовать различные устройства, работающие под управлением различных операционных систем, и всегда иметь под рукой согласованную среду разработки.

В этом обучающем модуле мы выполним настройку код-серверной облачной IDE-платформы в системе Ubuntu 20.04 и откроем ей доступ к вашему домену, защищенный бесплатными сертификатами TLS от Let’s Encrypt. В итоге мы запустим на сервере Ubuntu 20.04 среду разработки Microsoft Visual Studio Code, которая будет доступна на вашем домене и защищена паролем.

Предварительные требования

  • Сервер с Ubuntu 20.04 и не менее чем 2 ГБ оперативной памяти, root-доступ и учетная запись sudo без прав root. Вы можете выполнить настройку с помощью данного руководства по первоначальной настройке сервера.

  • Nginx, установленный на сервере. Выполните шаги 1–4 руководства по установке Nginx в Ubuntu 20.04.

  • Полное зарегистрированное доменное имя для размещения код-сервера, указывающее на ваш сервер. В этом обучающем модуле мы будем использовать имя code-server.your-domain. Вы можете купить доменное имя на Namecheap, получить его бесплатно на Freenom или воспользоваться услугами любого предпочитаемого регистратора доменных имен. Если вы используете DigitalOcean, информацию об их добавлении вы найдете в этом введении в DigitalOcean DNS.

Шаг 1 — Установка код-серверной IDE

В этом разделе мы настроим код-серверную IDE на вашем сервере. Вы должны загрузить последнюю версию и создать службу systemd, которая будет поддерживать постоянную работу код-серверной IDE в фоновом режиме. Также мы зададим политику перезапуска службы, чтобы код-серверная IDE оставалась доступной после возможных сбоев или перезагрузок.

Вы сохраните все данные, относящиеся к код-серверной IDE, в папке с именем ~/code-server. Создайте ее с помощью следующей команды:

  • mkdir ~/code-server

Перейдите в нее:

  • cd ~/code-server

Вам нужно перейти на страницу релиза на GitHub для код-серверной IDE и выбрать последнюю сборку для Linux (файл будет содержать linux в своем имени). На момент написания последняя версия 3.3.1>. Загрузите ее с помощью wget, запустив следующую команду:

  • wget https://github.com/cdr/code-server/releases/download/v3.3.1/code-server-3.3.1-linux-amd64.tar.gz

Затем распакуйте архив с помощью команды:

  • tar -xzvf code-server-3.3.1-linux-amd64.tar.gz

Вы получите папку с исходным кодом код-сервера, и имя этой папки будет точно соответствовать имени первоначально загруженного вами файла. Скопируйте ее в каталог /usr/lib/code-server, чтобы иметь к ней доступ из любой точки системы с помощью следующей команды:

  • sudo cp -r code-server-3.3.1-linux-amd64 /usr/lib/code-server

Затем создайте в каталоге /usr/bin/code-server символическую ссылку, указывающую на исполняемый файл код-сервера:

  • sudo ln -s /usr/lib/code-server/bin/code-server /usr/bin/code-server

Затем создайте папку для код-серверной IDE, где будут храниться данные пользователя:

  • sudo mkdir /var/lib/code-server

Теперь, когда вы загрузили код-серверную IDE и сделали ее доступной в рамках всей системы, мы создадим службу systemd для постоянного запуска IDE в фоновом режиме.

Вы сохраните конфигурацию службы в файле с именем code-server.service в директории /lib/systemd/system, где systemd хранит свои службы. Создайте его с помощью текстового редактора:

  • sudo nano /lib/systemd/system/code-server.service

Добавьте следующие строки:

/lib/systemd/system/code-server.service
[Unit]
Description=code-server
After=nginx.service

[Service]
Type=simple
Environment=PASSWORD=your_password
ExecStart=/usr/bin/code-server --bind-addr 127.0.0.1:8080 --user-data-dir /var/lib/code-server --auth password
Restart=always

[Install]
WantedBy=multi-user.target

Здесь вы сначала задаете описание службы. Затем вы указываете, что служба nginx должна быть запущена до этой службы. После раздела [Unit] мы определяем тип службы (simple означает, что процесс должен просто запускаться) и предоставляем команду, которая будет выполнена.

Здесь мы указываем, что глобальный исполняемый файл код-сервера следует запускать с определенными аргументами, зависящими от код-сервера --bind-addr 127.0.0.1:8080 выполняет привязку к localhost на порту 8080, и поэтому он доступен только с вашего сервера. --user-data-dir /var/lib/code-server позволяет задать собственный каталог пользовательских данных, а --auth password указывает на необходимость аутентификации посетителей с использованием пароля, заданного в переменной среды PASSWORD, которая декларируется в предыдущей строке.

Замените your_password на желаемый домен, а затем сохраните и закройте файл.

Следующая строка указывает systemd перезапускать код-серверную IDE в случае любых сбоев (например, при аварийном завершении работы или завершении процесса). Раздел [Install] указывает systemd запускать эту службу, когда будет доступен вход на сервер.

Запустите службу код-серверной IDE, запустив следующую команду:

  • sudo systemctl start code-server

Проверьте, что она запущена корректно, просмотрев ее статус:

  • sudo systemctl status code-server

Результат будет выглядеть примерно так:

Output
● code-server.service - code-server Loaded: loaded (/lib/systemd/system/code-server.service; disabled; vendor preset: enabled) Active: active (running) since Wed 2020-05-20 13:03:40 UTC; 12s ago Main PID: 14985 (node) Tasks: 18 (limit: 2345) Memory: 26.1M CGroup: /system.slice/code-server.service ├─14985 /usr/lib/code-server/bin/../lib/node /usr/lib/code-server/bin/.. --bind-addr 127.0.0.1:8080 --user-data-dir /var/lib/code-server --auth> └─15010 /usr/lib/code-server/lib/node /usr/lib/code-server --bind-addr 127.0.0.1:8080 --user-data-dir /var/lib/code-server --auth password May 20 13:03:40 code-server-update-2004 systemd[1]: Started code-server. May 20 13:03:40 code-server-update-2004 code-server[15010]: info Wrote default config file to ~/.config/code-server/config.yaml May 20 13:03:40 code-server-update-2004 code-server[15010]: info Using config file ~/.config/code-server/config.yaml May 20 13:03:40 code-server-update-2004 code-server[15010]: info Using user-data-dir /var/lib/code-server May 20 13:03:40 code-server-update-2004 code-server[15010]: info code-server 3.3.1 6f1309795e1cb930edba68cdc7c3dcaa01da0ab3 May 20 13:03:40 code-server-update-2004 code-server[15010]: info HTTP server listening on http://127.0.0.1:8080 May 20 13:03:40 code-server-update-2004 code-server[15010]: info - Using password from $PASSWORD May 20 13:03:40 code-server-update-2004 code-server[15010]: info - To disable use `--auth none` May 20 13:03:40 code-server-update-2004 code-server[15010]: info - Not serving HTTPS

Чтобы настроить автоматический запуск после перезагрузки сервера, активируйте службу с помощью следующей команды:

  • sudo systemctl enable code-server

На этом шаге мы загрузили код-серверную IDE и сделали ее доступной глобально. Затем вы создали службу systemd для IDE и активировали ее, поэтому код-серверная IDE будет запускаться при каждой загрузке сервера. Далее вы опубликуете ее на своем домене, настроив Nginx, который будет выступать в роли обратного прокси между посетителем и код-серверной IDE.

Шаг 2 — Публикация код-серверной IDE на вашем домене

В этом разделе мы настроим Nginx в качестве обратного прокси для код-серверной IDE.

Как вы узнали из предварительных условий для Nginx, файлы конфигурации сайта хранятся в /etc/nginx/sites-available и должны быть позднее связаны символьной ссылкой с /etc/nginx/sites-enabled, чтобы стать активными.

Вы сохраните конфигурацию для публикации код-серверной IDE на вашем домене в файле с именем code-server.conf в директории /etc/nginx/sites-available. Начнем с создания файла с помощью редактора:

  • sudo nano /etc/nginx/sites-available/code-server.conf

Добавьте следующие строки:

/etc/nginx/sites-available/code-server.conf
server {
    listen 80;
    listen [::]:80;

    server_name code-server.your-domain;

    location / {
      proxy_pass http://localhost:8080/;
      proxy_set_header Upgrade $http_upgrade;
      proxy_set_header Connection upgrade;
      proxy_set_header Accept-Encoding gzip;
    }
}

Замените code-server.your-domain на желаемый домен, а затем сохраните и закройте файл.

В этом файле мы определяем, что Nginx должен прослушивать HTTP-порт 80. Затем укажите server_name, чтобы сообщить Nginx, для какого домена необходимо принимать запросы и применять эту конкретную конфигурацию. В следующем блоке для расположения корня (/) вы указываете, что запросы следует передавать в сторону код-серверной IDE, запущенной на localhost:8080, и обратно. Следующие три строки (начиная с proxy_set_header) указывают Nginx передавать несколько заголовков HTTP-запросов, необходимых для корректной работы веб-сокетов, которые активно использует код-серверная IDE.

Чтобы сделать конфигурацию сайта активной, вам потребуется создать символьную ссылку на нее в папке /etc/nginx/sites-enabled, выполнив следующую команду:

  • sudo ln -s /etc/nginx/sites-available/code-server.conf /etc/nginx/sites-enabled/code-server.conf

Чтобы протестировать валидность конфигурации, запустите следующую команду:

  • sudo nginx -t

Вывод должен выглядеть так:

Output
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok nginx: configuration file /etc/nginx/nginx.conf test is successful

Чтобы изменения в конфигурацию вступили в силу, необходимо перезапустить Nginx:

  • sudo systemctl restart nginx

Теперь у вас есть установка код-серверной IDE, доступная на вашем домене. На следующем шаге вы обеспечите безопасность установки с помощью бесплатного TLS-сертификата Let’s Encrypt.

Шаг 3 — Защита вашего домена

В этом разделе мы обеспечим безопасность вашего домена с помощью TLS-сертификата Let’s Encrypt, который вы будете получать с помощью Certbot.

Чтобы установить последнюю версию Certbot и его плагин Nginx, запустите следующую команду:

  • sudo apt install certbot python3-certbot-nginx

В качестве предварительных условий мы активировали ufw (Uncomplicated Firewall) и настроили его для приема незашифрованного HTTP-трафика. Чтобы получить доступ к защищенному сайту, вам нужно настроить его для приема шифрованного трафика, запустив следующую команду:

  • sudo ufw allow https

Результат будет выглядеть следующим образом:

Output
Rule added Rule added (v6)

Как и в случае с Nginx, вам потребуется выполнить перезагрузку, чтобы конфигурация вступила в силу:

  • sudo ufw reload

Результат будет выглядеть так:

Output
Firewall reloaded

Затем в браузере перейдите в домен, используемый для код-серверной IDE. Вы увидите запрос для входа в систему код-серверной IDE.

запрос данных для входа в код-серверную IDE

Код-серверная IDE запрашивает ваш пароль. Введите пароль, который вы задали на предыдущем шаге и нажмите Enter IDE. Вы выполните вход в код-серверную IDE и немедленно увидите графический интерфейс редактора.

графический интерфейс код-серверной IDE

Теперь, когда мы проверили, что код-серверная IDE надлежащим образом опубликована на домене, нужно установить TLS-сертификаты Let’s Encrypt, чтобы обеспечить ее безопасность, используя Certbot.

Чтобы запросить сертификаты вашего домена, запустите следующую команду:

  • sudo certbot --nginx -d code-server.your-domain

В этой команде вы запустите certbot, чтобы запрашивать сертификаты для вашего домена, вы передаете доменное имя с параметром -d. Флаг --nginx указывает Nginx автоматически изменять конфигурацию сайта для поддержки HTTPS. Обязательно замените code-server.your-domain​​ на ваше доменное имя.

Если это первый запуск Certbot, вам нужно будет указать адрес электронной почты для срочных уведомлений и принять Правила и условия EFF. Затем Certbot запрашивает сертификаты для вашего домена в Let’s Encrypt. Далее будет отображен запрос о необходимости перенаправления всего трафика HTTP на HTTPS:

Output
Please choose whether or not to redirect HTTP traffic to HTTPS, removing HTTP access. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1: No redirect - Make no further changes to the webserver configuration. 2: Redirect - Make all requests redirect to secure HTTPS access. Choose this for new sites, or if you're confident your site works on HTTPS. You can undo this change by editing your web server's configuration. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Select the appropriate number [1-2] then [enter] (press 'c' to cancel):

Рекомендуется выбрать второй вариант, чтобы обеспечить максимальную безопасность. После выбора нажмите ENTER.

Результат будет выглядеть примерно следующим образом:

Output
IMPORTANT NOTES: - Congratulations! Your certificate and chain have been saved at: /etc/letsencrypt/live/code-server.your-domain/fullchain.pem Your key file has been saved at: /etc/letsencrypt/live/code-server.your-domain/privkey.pem Your cert will expire on ... To obtain a new or tweaked version of this certificate in the future, simply run certbot again with the "certonly" option. To non-interactively renew *all* of your certificates, run "certbot renew" - Your account credentials have been saved in your Certbot configuration directory at /etc/letsencrypt. You should make a secure backup of this folder now. This configuration directory will also contain certificates and private keys obtained by Certbot so making regular backups of this folder is ideal. - If you like Certbot, please consider supporting our work by: Donating to ISRG / Let's Encrypt: https://letsencrypt.org/donate Donating to EFF: https://eff.org/donate-le

Это означает, что Certbot успешно сгенерировал TLS-сертификаты и применил их к конфигурации Nginx для вашего домена. Теперь вы можете перезагрузить домен код-серверной IDE в браузере и убедиться, что слева от адреса сайта есть замок, означающий, что подключение защищено надлежащим образом.

Теперь, когда вы можете получать доступ к вашей код-серверной IDE через домен и защищенный обратный прокси-сервер Nginx, можно познакомиться с пользовательским интерфейсом код-серверной IDE.

Шаг 4 — Использование интерфейса код-серверной IDE

В этом разделе вы изучите некоторые функции интерфейса код-серверной IDE. Поскольку наша код-серверная IDE — это Visual Studio Code, запущенный в облаке, она имеет тот же интерфейс, что и отдельная настольная версия.

С левой стороны IDE имеется вертикальный ряд из 6 кнопок с самыми популярными функциями на боковой панели, которая называется панелью активности.

Графический интерфейс код-серверной IDE — боковая панель

Эта панель настраивается, поэтому вы можете перемещать эти представления в различном порядке или удалять их из панели. По умолчанию первая кнопка открывает общее выпадающее меню, вторая кнопка открывает панель обозревателя, которая открывает древовидную навигацию по структуре проекта. Здесь вы можете управлять папками и файлами — создавать, удалять, перемещать их при необходимости. Следующее представление предоставляет доступ к поиску и замене.

Далее при использовании порядка по умолчанию идет представление систем контроля версий, например Git. Visual Studio Code также поддерживает другие системы контроля версий, вы можете найти дополнительные данные о системах контроля версий в этой документации.

Панель Git с открытым контекстным меню

Функция отладчика на панели действий предоставляет все стандартные возможности для отладки на панели. Visual Studio Code оснащен встроенной поддержкой встроенного отладчика во время выполнения для Node.js​​​ и любого языка, который компилируется в Javascript. Для других языков вы можете установить расширения для требуемого отладчика. Вы можете сохранить конфигрурации отладчика в файле launch.json.

Представление отладчика с открытым файлом launch.json

Последнее представление панели активности предоставляет меню для доступа к доступным расширениям в Marketplace.

Графический интерфейс код-серверной IDE — вкладки

Центральную часть графического интерфейса занимает редактор, который вы можете разделить вкладками для редактирования кода. Вы можете изменить представление редактирования на сетку или расположенные параллельно файлы.

Вид редактора в сетку

После создания нового файла с помощью меню File, в новой вкладке открывается пустой файл, а после сохранения имя файла будет отображаться в боковой панели обозревателя. Папки можно создать, нажав правой кнопкой мыши на боковой панели обозревателя и затем New Folder. Вы можете развернуть папку, нажав на ее имя, а также перетаскивать файлы и папки в верхнюю часть иерархии, чтобы переместить их в новое место.

Графический интерфейс код-серверной IDE — новая папка

Вы можете получить доступ к терминалу, введя CTRL+SHIFT+` или выбрав пункт Terminal в верхнем меню и выбрав New Terminal. Терминал откроется в нижней панели, а в качестве его рабочей директории будет указано рабочее пространство проекта, которое содержит файлы и папки, отображаемые в боковой панели обозревателя.

Вы изучили базовые элементы интерфейса код-серверной IDE и познакомились с некоторыми самыми популярными функциями.

Заключение

Мы установили на сервер Ubuntu 20.04 код-сервер или универсальную облачную среду разработки, открыли доступ к ней в вашем домене и защитили ее сертификатами Let’s Encrypt. Теперь мы можем работать над отдельными проектами, а также организовать командную работу. Использование облачной IDE позволяет высвободить ресурсы на локальном компьютере и масштабировать ресурсы при необходимости. Дополнительную информацию о других функциях и подробные инструкции по работе с прочими компонентами код-серверной IDE см. в документации для Visual Studio Code.

Если вы хотите запустить код-серверную IDE на своем кластере DigitalOcean Kubernetes, изучите наше руководство по настройке код-серверной облачной IDE-платформы на кластере DigitalOcean Kubernetes.

Creative Commons License