Переадресация портов в вашем codespace

Когда приложение, выполняющееся в кодовом пространстве, выводит выходные данные в терминал, содержащий URL-адрес localhost, например, http://localhost:PORT или http://127.0.0.1:PORT, выполняется автоматическая переадресация порта. Если GitHub Codespaces используется в браузере или в Visual Studio Code, строка URL-адреса в терминале преобразуется в ссылку, по которой можно перейти, чтобы просмотреть веб-страницу на локальном компьютере. По умолчанию GitHub Codespaces перенаправит порты с помощью ПРОТОКОЛА HTTP.

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

Переадресация порта

Можно вручную выполнить переадресацию порта, который не был переадресован автоматически.

1. Откройте терминал в пространстве кода.

2. Перейдите на вкладку "ПОРТЫ ".

3. В списке портов нажмите кнопку Добавить порт.

   

4. Введите номер порта или адрес, а затем нажмите клавишу ВВОД.

   

Использование переадресации HTTPS

По умолчанию GitHub Codespaces перенаправит порты с помощью HTTP, но при необходимости можно обновить любой порт для использования HTTPS. Если вы обновляете порт с общедоступной видимостью для использования HTTPS, видимость порта автоматически изменится на частный.

1. Откройте терминал в пространстве кода.

2. Перейдите на вкладку "ПОРТЫ ".

3. Щелкните правой кнопкой мыши порт, который требуется обновить, а затем наведите указатель мыши на протокол изменения порта.

   

4. Выберите протокол, необходимый для этого порта. Выбранный протокол будет запоминаться для этого порта на время существования кодового пространства.

Общий доступ к порту

Если требуется предоставить доступ к переадресованному порту другим пользователям, можно сделать порт частным для организации или общедоступным. После того как вы сделаете порт частным для организации, любой пользователь в организации с URL-адресом порта сможет просмотреть выполняющееся приложение. После того как вы сделаете порт общедоступным, любой пользователь, который знает URL-адрес и номер порта, сможет просмотреть выполняющееся приложение без необходимости проходить проверку подлинности.

1. Откройте терминал в пространстве кода.

2. Перейдите на вкладку "ПОРТЫ ".

3. Щелкните правой кнопкой мыши порт, к которому нужно предоставить общий доступ, щелкните "Видимость портов", а затем выберите "Приватный" в организацию или "Общедоступную".

   

4. Справа от локального адреса порта щелкните значок копирования.

   

5. Отправьте скопированный URL-адрес пользователю, которому требуется предоставить доступ к порту.

Использование средств командной строки и клиентов REST для доступа к портам

При пересылке порта приложение становится доступным по URL-адресу https://CODESPACENAME-PORT.app.github.dev. Например, https://monalisa-hot-potato-vrpqrxxrx7x2rxx-4000.app.github.dev. Если вы пересылаете частный порт из классического приложения VS Code, ваше приложение также будет доступно на порту localhost, например 127.0.0.1:4000.

Чтобы получить доступ к приложению с помощью клиента REST, например Postman, или средства командной строки, например curl, вам не нужно проходить проверку подлинности, если вы используете порт localhost, или если вы обращаетесь к общедоступному порту в удаленном домене. Однако для подключения к частному порту в удаленном домене необходимо пройти проверку подлинности с помощью GITHUB_TOKEN маркера доступа в запросе.

Поиск адреса для подключения

1. Откройте терминал в пространстве кода.

2. Перейдите на вкладку "ПОРТЫ ". В этом списке перечислены все порты, которые вы перенаправили.

3. Щелкните правой кнопкой мыши порт, к которому нужно подключиться, и нажмите кнопку "Копировать локальный адрес".

   

4. Вставьте скопированный адрес где-то для последующего использования.

Поиск GITHUB_TOKEN

1. В терминале в пространстве кода введите echo $GITHUB_TOKEN.

   Маркер — это строковое начало ghu_.

2. Скопируйте маркер.

   Important

   Не делитесь этим маркером доступа с кем-либо.

Использование curl для доступа к переадресованным порту

В терминале на локальном компьютере введите следующее:

curl ADDRESS -H "X-Github-Token: TOKEN"

Замените ADDRESS и TOKEN на значения, скопированные ранее.

Использование Postman для доступа к переадресованным порту

1. Откройте Postman.

2. Создайте новый запрос GET.

3. Вставьте адрес, скопированный ранее в качестве URL-адреса запроса.

   

4. На вкладке "Заголовки " создайте новую запись, в которой ключ — X-Github-Token, а значение GITHUB_TOKEN — скопированное ранее.

   

5. Нажмите Отправить.

Автоматическая пересылка порта

Вы можете добавить переадресованный порт в конфигурацию GitHub Codespaces для репозитория, чтобы порт автоматически перенаправился для всех пространств кода, созданных из репозитория. После обновления конфигурации все ранее созданные кодовые пространства необходимо перестроить, чтобы применить изменение. Дополнительные сведения о файле конфигурации контейнера разработки см. в разделе Основные сведения о контейнерах разработки.

1. В пространстве кода откройте файл конфигурации контейнера разработки, который требуется обновить. Обычно этот файл имеет значение .devcontainer/devcontainer.json.

2. Добавление свойства forwardPorts

   "forwardPorts": [NUMBER],
   

   Замените NUMBER номер порта, который требуется перенаправить. Это может быть разделенный запятыми список номеров портов.

3. Сохраните файл.

Маркировка порта

При открытии пространства кода в браузере или в классическом приложении VS Code можно пометить переадресованный порт, чтобы упростить идентификацию в списке.

1. Откройте терминал в пространстве кода.

2. Перейдите на вкладку "ПОРТЫ ".

3. Щелкните правой кнопкой мыши порт, который нужно наметить, а затем выберите пункт "Задать метку порта".

   

4. Введите метку для порта, а затем нажмите клавишу ВВОД.

   

Автоматическая маркировка переадресованного порта

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

1. Откройте терминал в пространстве кода.

2. Перейдите на вкладку "ПОРТЫ ".

3. Щелкните правой кнопкой мыши порт, атрибут метки которого нужно добавить в конфигурацию пространства кода, а затем щелкните "Задать метку" и "Обновить devcontainer.json".

   

4. Введите метку для порта, а затем нажмите клавишу ВВОД.

   

5. Если в репозитории есть несколько файлов конфигурации контейнера разработки, вам будет предложено выбрать файл, который требуется обновить.

   Файл конфигурации контейнера разработки обновляется, чтобы включить новую метку в portsAttributes свойство. Например:

   // Use 'forwardPorts' to make a list of ports inside the container available locally.
   "forwardPorts": [3333, 4444],
   
   "portsAttributes": {
     "3333": {
       "label": "app-standard-preview"
     },
     "4444": {
       "label": "app-pro-preview"
     }
   }