Описание GitHub Pages

Описание GitHub Pages

GitHub Pages — это служба размещения статических сайтов, которая принимает файлы HTML, CSS и JavaScript прямо из репозитория в GitHub Enterprise Cloud, при необходимости выполняет файлы с помощью процесса сборки и публикует веб-сайт. Примеры сайтов GitHub Pages можно посмотреть в коллекции примеров GitHub Pages.

Вы можете разместить свой сайт в домене github.io GitHub или в своем личном домене. Дополнительные сведения см. в разделе Настройка личного домена для сайта GitHub Pages.

Если только ваша организация не использует Enterprise Managed Users, вы можете публиковать сайты проектов в общедоступном или закрытом режиме, управляя доступом к сайту. Дополнительные сведения см. в разделе Изменение видимости сайта GitHub Pages."

Чтобы приступить к работе, см. раздел Создание сайта GitHub Pages.

Владельцы организации могут отключить публикацию сайтов GitHub Pages из репозиториев организации. Дополнительные сведения см. в разделе Управление публикацией сайтов GitHub Pages для организации.

Типы сайтов GitHub Pages

Существует три типа сайтов GitHub Pages: сайт проекта, сайт пользователя и сайт организации. Сайты проектов подключаются к определенным проектам, размещенным в GitHub Enterprise Cloud, таким как библиотека JavaScript или коллекция рецептов. Сайты пользователей и организаций подключены к определенной учетной записи в GitHub.com.

Чтобы опубликовать сайт пользователя, необходимо создать репозиторий, принадлежащий вашей личной учетной записи с именем <username>.github.io. Чтобы опубликовать сайт организации, необходимо создать репозиторий, принадлежащий организации с именем <organization>.github.io. Если вы не используете личный домен, сайты пользователя и организации доступны по адресу http(s)://<username>.github.io или http(s)://<organization>.github.io.

Исходные файлы для сайта проекта хранятся в том же репозитории, что и проект. Если вы не используете личный домен, сайты проекта доступны по адресу http(s)://<username>.github.io/<repository> или http(s)://<organization>.github.io/<repository>.

Если вы публикуете сайт в частном порядке, URL-адрес сайта будет отличаться. Дополнительные сведения см. в разделе Изменение видимости сайта GitHub Pages.

Дополнительные сведения о том, как личные домены влияют на URL-адрес вашего сайта, см. в разделе Сведения о личных доменах и страницах GitHub.

Для каждой учетной записи в GitHub Enterprise Cloud можно создать только один сайт пользователя или организации. Сайты проектов, принадлежащие учетной записи организации или личной учетной записи, не ограничены.

Источники публикации для сайтов GitHub Pages

Сайт можно публиковать при отправке изменений в определенную ветвь, а также с помощью рабочего процесса GitHub Actions.

Если вам не нужно управлять сборкой сайта, рекомендуется публиковать сайт, когда изменения отправляются в определенную ветвь. Можно указать, какую ветвь и папку следует использовать в качестве источника публикации. Исходной ветвью может стать любая ветвь репозитория, а исходной папкой может быть либо корень репозитория (/), либо папка /docs в исходной ветви. После отправки изменений в исходную ветвь изменения в исходной папке будут опубликованы на вашем сайте GitHub Pages.

Если вы хотите использовать сборку, отличную от Jekyll, или не хотите хранить скомпилированные статические файлы в выделенной ветви, рекомендуется создать рабочий процесс GitHub Actions для публикации сайта. GitHub Enterprise Cloud предоставляет начальные рабочие процессы для распространенных сценариев публикации, чтобы помочь вам в создании рабочего процесса.

Дополнительные сведения см. в разделе Настройка источника публикации для сайта GitHub Pages.

Ограничения для Enterprise Managed Users

Если вы являетесь управляемая учетная запись пользователя, использование GitHub Pages ограничено.

• Сайты GitHub Pages могут публиковаться только из репозиториев, принадлежащих организациям.
• GitHub Pages сайты всегда публикуются в частном порядке, и вы не можете изменить эту видимость. Дополнительные сведения см. в разделе Изменение видимости сайта GitHub Pages.
• Невозможно создать сайт организации (сайт, опубликованный из репозитория с именем <organization>.github.io)

Дополнительные сведения о Enterprise Managed Users см. в разделе Сведения о Enterprise Managed Users.

Генераторы статических сайтов

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

Если используется пользовательский процесс сборки или генератор статических сайтов, отличный от Jekyll, можно создать действие GitHub Actions, чтобы создать и опубликовать сайт. GitHub Enterprise Cloud предоставляет начальные рабочие процессы для различных генераторов статических сайтов. Дополнительные сведения см. в разделе Настройка источника публикации для сайта GitHub Pages.

При публикации сайта из исходной ветви GitHub Pages будет по умолчанию использовать Jekyll, чтобы создать сайт. Если вы хотите использовать другой генератор статических сайтов, отличный от Jekyll, рекомендуется создать действие GitHub Actions, чтобы создать и опубликовать сайт. В противном случае отключите процесс сборки Jekyll, для этого необходимо создать в корне источника публикации пустой файл под названием .nojekyll, а затем следовать инструкциям используемого генератора статических сайтов, чтобы создать сайт локально.

GitHub Pages не поддерживает серверные языки, такие как PHP, Ruby или Python.

Ограничения на использование GitHub Pages

Сайты GitHub Pages, созданные после 15 июня 2016 г. и использующие домены github.io, обслуживаются по протоколу HTTPS. Если вы создали сайт до 15 июня 2016 г., то можете включить поддержку HTTPS для трафика на сайт. Дополнительные сведения см. в разделе Защита сайта GitHub Pages с помощью HTTPS.

Запрещенные виды использования

Не предусмотрено и не разрешается использование GitHub Pages в качестве бесплатной службы веб-размещения для запуска бизнеса в Интернете, сайта электронной коммерции и любого другого веб-сайта, в первую очередь направленного либо на коммерческие транзакции, либо на предоставление коммерческого программного обеспечения как услуги (SaaS). Сайты GitHub Pages не должны использоваться для конфиденциальных транзакций, таких как отправка паролей или номеров кредитных карт.

Кроме того, использование GitHub Pages регулируется условиями предоставления услуг GitHub, включающими ограничения на схемы быстрого обогащения, материалы непристойного сексуального характера, а также материалы или действия, содержащие насилие или угрозы.

Ограничения использования

На сайты GitHub Pages распространяются следующие ограничения использования.

• Для исходных репозиториев GitHub Pages рекомендуется использовать ограничение в 1 ГБ. Дополнительные сведения см. в разделе Сведения о больших файлах на GitHub

• Размер опубликованного сайта GitHub Pages не может превышать 1 ГБ.

• Время ожидания развертывания GitHub Pages истекает, если оно занимает больше 10 минут.

• Сайты GitHub Pages имеют мягкое ограничение пропускной способности в 100 ГБ в месяц.

• Для сайтов GitHub Pages установлено мягкое ограничение в 10 сборок в час. Это ограничение не применяется, если вы создаете и публикуете сайт с помощью пользовательского рабочего процесса GitHub Actions.

• Чтобы обеспечить согласованное качество обслуживания для всех сайтов GitHub Pages, могут применяться ограничения скорости. Эти ограничения скорости не предназначены для того, чтобы препятствовать законному использованию GitHub Pages. Если ваш запрос активирует ограничение скорости, вы получите соответствующий ответ с кодом состояния HTTP 429, а также информативным сообщением HTML.

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

Типы MIME в GitHub Pages

Тип MIME — это заголовок, который сервер отправляет в браузер, предоставляя сведения о характере и формате файлов, запрошенных браузером. GitHub Pages поддерживает более 750 типов MIME в тысячах расширений файлов. Список поддерживаемых типов MIME создается из проекта mime-db.

Хотя вы не можете указывать специальные типы MIME на уровне файла или репозитория, вы можете добавлять или изменять типы MIME для использования в GitHub Pages. Дополнительные сведения см. в правилах по предложению улучшений в mime-db.

Дополнительные материалы

• GitHub Pages в GitHub Skills
• "Репозитории"