Merge branch 'main' into code-scanning-faq-fix
2
.github/workflows/orphaned-assets-check.yml
vendored
@@ -11,7 +11,7 @@ permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
build:
|
||||
orphaned-assets-check:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
|
||||
64
.github/workflows/prod-build-deploy-azure.yml
vendored
@@ -26,9 +26,14 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 15
|
||||
env:
|
||||
IMAGE_TAG_BASE: ${{ secrets.PROD_REGISTRY_SERVER }}/${{ github.repository }}
|
||||
DOCKER_IMAGE: ${{ secrets.PROD_REGISTRY_SERVER }}/${{ github.repository }}:${{ github.sha }}
|
||||
|
||||
steps:
|
||||
- name: 'Az CLI login'
|
||||
uses: azure/login@66d2e78565ab7af265d2b627085bc34c73ce6abb
|
||||
with:
|
||||
creds: ${{ secrets.PROD_AZURE_CREDENTIALS }}
|
||||
|
||||
- name: 'Docker login'
|
||||
uses: azure/docker-login@81744f9799e7eaa418697cb168452a2882ae844a
|
||||
with:
|
||||
@@ -68,10 +73,65 @@ jobs:
|
||||
context: .
|
||||
push: true
|
||||
target: 'production_early_access'
|
||||
tags: ${{ env.IMAGE_TAG_BASE }}:${{ github.sha }}, ${{ env.IMAGE_TAG_BASE }}:production
|
||||
tags: ${{ env.DOCKER_IMAGE }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
|
||||
- name: 'Update docker-compose.prod.yaml template file'
|
||||
run: |
|
||||
sed 's|#{IMAGE}#|${{ env.DOCKER_IMAGE }}|g' docker-compose.prod.tmpl.yaml > docker-compose.prod.yaml
|
||||
|
||||
- name: 'Apply updated docker-compose.prod.yaml config to preview slot'
|
||||
run: |
|
||||
az webapp config container set --multicontainer-config-type COMPOSE --multicontainer-config-file docker-compose.prod.yaml --slot preview -n ghdocs-prod -g docs-prod
|
||||
|
||||
# Watch preview slot instances to see when all the instances are ready
|
||||
- name: Check that preview slot is ready
|
||||
uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
|
||||
env:
|
||||
CHECK_INTERVAL: 10000
|
||||
with:
|
||||
script: |
|
||||
const { execSync } = require('child_process')
|
||||
|
||||
const getStatesForSlot = (slot) => {
|
||||
return JSON.parse(
|
||||
execSync(
|
||||
`az webapp list-instances --slot ${slot} --query "[].state" -n ghdocs-prod -g docs-prod`,
|
||||
{ encoding: 'utf8' }
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
let hasStopped = false
|
||||
const waitDuration = parseInt(process.env.CHECK_INTERVAL, 10) || 10000
|
||||
async function doCheck() {
|
||||
const states = getStatesForSlot('preview')
|
||||
console.log(`Instance states:`, states)
|
||||
|
||||
// We must wait until at-least 1 instance has STOPPED to know we're looking at the "next" deployment and not the "previous" one
|
||||
// That way we don't immediately succeed just because all the previous instances were READY
|
||||
if (!hasStopped) {
|
||||
hasStopped = states.some((s) => s === 'STOPPED')
|
||||
}
|
||||
|
||||
const isAllReady = states.every((s) => s === 'READY')
|
||||
|
||||
if (hasStopped && isAllReady) {
|
||||
process.exit(0) // success
|
||||
}
|
||||
|
||||
console.log(`checking again in ${waitDuration}ms`)
|
||||
setTimeout(doCheck, waitDuration)
|
||||
}
|
||||
|
||||
doCheck()
|
||||
|
||||
# TODO - make a request to verify the preview app version aligns with *this* github action workflow commit sha
|
||||
- name: 'Swap preview slot to production'
|
||||
run: |
|
||||
az webapp deployment slot swap --slot preview --target-slot production -n ghdocs-prod -g docs-prod
|
||||
|
||||
# TODO - enable this when we disable the other production deploy
|
||||
# - name: Purge Fastly edge cache
|
||||
# env:
|
||||
|
||||
BIN
assets/images/azure/azure-resources-search.png
Normal file
|
After Width: | Height: | Size: 23 KiB |
BIN
assets/images/azure/azure-storage-containers.png
Normal file
|
After Width: | Height: | Size: 137 KiB |
BIN
assets/images/azure/azure-storage-permissions.png
Normal file
|
After Width: | Height: | Size: 182 KiB |
BIN
assets/images/azure/azure-storage-shared-access-tokens.png
Normal file
|
After Width: | Height: | Size: 128 KiB |
BIN
assets/images/enterprise/3.4/actions-access-settings.png
Normal file
|
After Width: | Height: | Size: 59 KiB |
BIN
assets/images/enterprise/site-admin-settings/site-admin-link.png
Normal file
|
After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 7.0 KiB |
|
Before Width: | Height: | Size: 2.1 KiB |
|
Before Width: | Height: | Size: 2.5 KiB |
|
Before Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 8.5 KiB |
|
Before Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 1.6 KiB |
BIN
assets/images/help/enterprises/audit-stream-add-azureblob.png
Normal file
|
After Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 105 KiB |
BIN
assets/images/help/enterprises/audit-stream-choice-azureblob.png
Normal file
|
After Width: | Height: | Size: 105 KiB |
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 104 KiB |
BIN
assets/images/help/enterprises/emu-login-submit.png
Normal file
|
After Width: | Height: | Size: 17 KiB |
BIN
assets/images/help/enterprises/emu-login-username.png
Normal file
|
After Width: | Height: | Size: 12 KiB |
BIN
assets/images/help/enterprises/idp-groups-team-switcher.png
Normal file
|
After Width: | Height: | Size: 14 KiB |
BIN
assets/images/help/enterprises/select-idp-group.png
Normal file
|
After Width: | Height: | Size: 17 KiB |
BIN
assets/images/help/enterprises/view-suspended-members.png
Normal file
|
After Width: | Height: | Size: 4.6 KiB |
|
After Width: | Height: | Size: 7.8 KiB |
BIN
assets/images/help/organizations/view-alert-subset.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 15 KiB |
BIN
assets/images/help/repository/actions-general-tab.png
Normal file
|
After Width: | Height: | Size: 25 KiB |
|
After Width: | Height: | Size: 7.4 KiB |
BIN
assets/images/help/repository/repo-security-side-panel.png
Normal file
|
After Width: | Height: | Size: 6.9 KiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 137 KiB |
BIN
assets/images/help/support/add-comment.png
Normal file
|
After Width: | Height: | Size: 28 KiB |
BIN
assets/images/help/support/close-ticket.png
Normal file
|
After Width: | Height: | Size: 29 KiB |
BIN
assets/images/help/support/installation-field.png
Normal file
|
After Width: | Height: | Size: 6.8 KiB |
BIN
assets/images/help/support/my-tickets-header.png
Normal file
|
After Width: | Height: | Size: 19 KiB |
BIN
assets/images/help/support/my-tickets-list.png
Normal file
|
After Width: | Height: | Size: 17 KiB |
BIN
assets/images/help/support/new-comment-field.png
Normal file
|
After Width: | Height: | Size: 29 KiB |
BIN
assets/images/help/support/product-field-ghec.png
Normal file
|
After Width: | Height: | Size: 6.6 KiB |
BIN
assets/images/help/support/support-recent-response.png
Normal file
|
After Width: | Height: | Size: 66 KiB |
BIN
assets/images/help/support/ticket-context.png
Normal file
|
After Width: | Height: | Size: 25 KiB |
@@ -2,7 +2,7 @@ import React, { useState, useEffect, useRef, ReactNode, RefObject } from 'react'
|
||||
import { useRouter } from 'next/router'
|
||||
import useSWR from 'swr'
|
||||
import cx from 'classnames'
|
||||
import { ActionList, DropdownMenu, Label, Overlay } from '@primer/components'
|
||||
import { ActionList, DropdownMenu, Flash, Label, Overlay } from '@primer/components'
|
||||
import { ItemInput } from '@primer/components/lib/ActionList/List'
|
||||
|
||||
import { useTranslation } from 'components/hooks/useTranslation'
|
||||
@@ -176,20 +176,28 @@ export function Search({
|
||||
'pt-9 color-bg-default color-shadow-medium position-absolute top-0 right-0',
|
||||
styles.resultsContainer,
|
||||
isHeaderSearch && styles.resultsContainerHeader,
|
||||
query ? 'd-block' : 'd-none',
|
||||
query && styles.resultsContainerOpen
|
||||
query || searchError ? 'd-block' : 'd-none',
|
||||
(query || searchError) && styles.resultsContainerOpen
|
||||
)}
|
||||
>
|
||||
<ShowSearchResults
|
||||
anchorRef={inputRef}
|
||||
isHeaderSearch={isHeaderSearch}
|
||||
isMobileSearch={isMobileSearch}
|
||||
isLoading={isLoading}
|
||||
results={previousResults}
|
||||
closeSearch={closeSearch}
|
||||
debug={debug}
|
||||
query={query}
|
||||
/>
|
||||
{searchError ? (
|
||||
<ShowSearchError
|
||||
error={searchError}
|
||||
isHeaderSearch={isHeaderSearch}
|
||||
isMobileSearch={isMobileSearch}
|
||||
/>
|
||||
) : (
|
||||
<ShowSearchResults
|
||||
anchorRef={inputRef}
|
||||
isHeaderSearch={isHeaderSearch}
|
||||
isMobileSearch={isMobileSearch}
|
||||
isLoading={isLoading}
|
||||
results={previousResults}
|
||||
closeSearch={closeSearch}
|
||||
debug={debug}
|
||||
query={query}
|
||||
/>
|
||||
)}
|
||||
</div>
|
||||
{/* eslint-disable-next-line jsx-a11y/click-events-have-key-events, jsx-a11y/no-static-element-interactions */}
|
||||
<div
|
||||
@@ -274,6 +282,33 @@ function useDebounce<T>(value: T, delay?: number): [T, (value: T) => void] {
|
||||
return [debouncedValue, setDebouncedValue]
|
||||
}
|
||||
|
||||
function ShowSearchError({
|
||||
error,
|
||||
isHeaderSearch,
|
||||
isMobileSearch,
|
||||
}: {
|
||||
error: Error
|
||||
isHeaderSearch: boolean
|
||||
isMobileSearch: boolean
|
||||
}) {
|
||||
const { t } = useTranslation('search')
|
||||
return (
|
||||
<Flash
|
||||
variant="danger"
|
||||
sx={{ margin: isMobileSearch || isHeaderSearch ? '2rem 2rem 0 2em' : '1rem' }}
|
||||
>
|
||||
<p>{t('search_error')}</p>
|
||||
{process.env.NODE_ENV === 'development' && (
|
||||
<p>
|
||||
<small>
|
||||
<code>{error.toString()}</code>
|
||||
</small>
|
||||
</p>
|
||||
)}
|
||||
</Flash>
|
||||
)
|
||||
}
|
||||
|
||||
function ShowSearchResults({
|
||||
anchorRef,
|
||||
isHeaderSearch,
|
||||
|
||||
@@ -2,7 +2,7 @@ import cx from 'classnames'
|
||||
import { useTranslation } from 'components/hooks/useTranslation'
|
||||
import { ArrowRightIcon } from '@primer/octicons-react'
|
||||
import { ActionList } from '@primer/components'
|
||||
import { useEffect, useRef, useState } from 'react'
|
||||
import { useState } from 'react'
|
||||
import { FeaturedTrack } from 'components/context/ProductGuidesContext'
|
||||
import { TruncateLines } from 'components/ui/TruncateLines'
|
||||
import slugger from 'github-slugger'
|
||||
@@ -17,15 +17,10 @@ export const LearningTrack = ({ track }: Props) => {
|
||||
const [numVisible, setNumVisible] = useState(DEFAULT_VISIBLE_GUIDES)
|
||||
const { t } = useTranslation('product_guides')
|
||||
const slug = track?.title ? slugger.slug(track?.title) : ''
|
||||
const listRef = useRef<HTMLLIElement>(null)
|
||||
const showAll = () => {
|
||||
setNumVisible(track?.guides?.length || 0)
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
if (listRef.current) listRef.current.focus()
|
||||
})
|
||||
|
||||
return (
|
||||
<div data-testid="learning-track" className="my-3 px-4 col-12 col-md-6">
|
||||
<div className="Box d-flex flex-column">
|
||||
@@ -62,7 +57,6 @@ export const LearningTrack = ({ track }: Props) => {
|
||||
return {
|
||||
renderItem: () => (
|
||||
<ActionList.Item
|
||||
ref={listRef}
|
||||
as="li"
|
||||
key={guide.href + track?.trackName}
|
||||
sx={{
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { useState } from 'react'
|
||||
import { useEffect, useState } from 'react'
|
||||
import { ArrowRightIcon, SearchIcon } from '@primer/octicons-react'
|
||||
import { Text } from '@primer/components'
|
||||
|
||||
@@ -13,11 +13,11 @@ export const CodeExamples = () => {
|
||||
const { t } = useTranslation('product_landing')
|
||||
const [numVisible, setNumVisible] = useState(PAGE_SIZE)
|
||||
const [search, setSearch] = useState('')
|
||||
const [typed, setTyped] = useState('')
|
||||
|
||||
const onSearchChange: React.ChangeEventHandler<HTMLInputElement> = (e) => {
|
||||
setSearch(e.target.value)
|
||||
useEffect(() => {
|
||||
setNumVisible(PAGE_SIZE) // reset the visible count (only matters after searching)
|
||||
}
|
||||
}, [search])
|
||||
|
||||
const isSearching = !!search
|
||||
let searchResults: typeof productCodeExamples = []
|
||||
@@ -31,7 +31,13 @@ export const CodeExamples = () => {
|
||||
|
||||
return (
|
||||
<div>
|
||||
<div className="pr-lg-3 mb-5 mt-3">
|
||||
<form
|
||||
className="pr-lg-3 mb-5 mt-3"
|
||||
onSubmit={(event) => {
|
||||
event.preventDefault()
|
||||
setSearch(typed.trim())
|
||||
}}
|
||||
>
|
||||
<Text
|
||||
className="ml-1 mr-2"
|
||||
fontWeight="bold"
|
||||
@@ -49,11 +55,25 @@ export const CodeExamples = () => {
|
||||
type="search"
|
||||
autoComplete="off"
|
||||
aria-label={t('search_code_examples')}
|
||||
onChange={onSearchChange}
|
||||
onChange={(event) => setTyped(event.target.value)}
|
||||
value={typed}
|
||||
/>
|
||||
</div>
|
||||
<button data-testid="code-examples-search-btn" className="btn ml-2 py-2" type="submit">
|
||||
Search
|
||||
</button>
|
||||
</form>
|
||||
|
||||
<div className="d-flex flex-wrap gutter">
|
||||
{isSearching && (
|
||||
<div role="status">
|
||||
<h3>
|
||||
{t('search_results_for')}: {search}
|
||||
</h3>
|
||||
<p className="mb-4">
|
||||
{t('matches_displayed')}: {searchResults.length}
|
||||
</p>
|
||||
</div>
|
||||
)}
|
||||
<ul className="d-flex flex-wrap gutter">
|
||||
{(isSearching ? searchResults : productCodeExamples.slice(0, numVisible)).map((example) => {
|
||||
return (
|
||||
<li key={example.href} className="col-12 col-xl-4 col-lg-6 mb-4 list-style-none">
|
||||
@@ -61,7 +81,7 @@ export const CodeExamples = () => {
|
||||
</li>
|
||||
)
|
||||
})}
|
||||
</div>
|
||||
</ul>
|
||||
|
||||
{numVisible < productCodeExamples.length && !isSearching && (
|
||||
<button
|
||||
@@ -74,7 +94,11 @@ export const CodeExamples = () => {
|
||||
)}
|
||||
|
||||
{isSearching && searchResults.length === 0 && (
|
||||
<div data-testid="code-examples-no-results" className="py-4 text-center color-fg-muted">
|
||||
<div
|
||||
role="status"
|
||||
data-testid="code-examples-no-results"
|
||||
className="py-4 text-center color-fg-muted"
|
||||
>
|
||||
<div className="mb-3">
|
||||
<SearchIcon size={24} />{' '}
|
||||
</div>
|
||||
@@ -84,7 +108,7 @@ export const CodeExamples = () => {
|
||||
<p className="my-3 f4">
|
||||
{t('no_example')} <br /> {t('try_another')}
|
||||
</p>
|
||||
<Link href="https://github.com/github/docs/blob/main/data/variables/actions_code_examples.yml">
|
||||
<Link href="https://github.com/github/docs/blob/main/data/product-examples/actions/code-examples.yml">
|
||||
{t('learn')} <ArrowRightIcon />
|
||||
</Link>
|
||||
</div>
|
||||
|
||||
@@ -20,10 +20,12 @@ export const GuideCards = () => {
|
||||
|
||||
return (
|
||||
<div>
|
||||
<div className="d-lg-flex gutter-lg flex-items-stretch">
|
||||
{(featuredLinks.guideCards || []).map((guide) => {
|
||||
return <GuideCard key={guide.href} guide={guide} />
|
||||
})}
|
||||
<div className="d-lg-flex flex-items-stretch">
|
||||
<ul className="d-flex flex-wrap gutter">
|
||||
{(featuredLinks.guideCards || []).map((guide) => {
|
||||
return <GuideCard key={guide.href} guide={guide} />
|
||||
})}
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
{!currentCategory && hasGuidesPage && (
|
||||
|
||||
@@ -2,6 +2,7 @@ import { useRouter } from 'next/router'
|
||||
import { Link } from 'components/Link'
|
||||
import { useLanguages } from 'components/context/LanguagesContext'
|
||||
import { Picker } from 'components/ui/Picker'
|
||||
import { useTranslation } from 'components/hooks/useTranslation'
|
||||
|
||||
type Props = {
|
||||
variant?: 'inline'
|
||||
@@ -13,6 +14,7 @@ export const LanguagePicker = ({ variant }: Props) => {
|
||||
const locale = router.locale || 'en'
|
||||
const langs = Object.values(languages)
|
||||
const selectedLang = languages[locale]
|
||||
const { t } = useTranslation('picker')
|
||||
|
||||
// The `router.asPath` will always be without a hash in SSR
|
||||
// So to avoid a hydraration failure on the client, we have to
|
||||
@@ -24,7 +26,7 @@ export const LanguagePicker = ({ variant }: Props) => {
|
||||
<Picker
|
||||
variant={variant}
|
||||
data-testid="language-picker"
|
||||
defaultText="Choose language"
|
||||
defaultText={t('language_picker_default_text')}
|
||||
options={langs
|
||||
.filter((lang) => !lang.wip)
|
||||
.map((lang) => ({
|
||||
|
||||
@@ -4,17 +4,19 @@ import { Link } from 'components/Link'
|
||||
import { useMainContext } from 'components/context/MainContext'
|
||||
import { LinkExternalIcon } from '@primer/octicons-react'
|
||||
import { Picker } from 'components/ui/Picker'
|
||||
import { useTranslation } from 'components/hooks/useTranslation'
|
||||
|
||||
export const ProductPicker = () => {
|
||||
const router = useRouter()
|
||||
const { activeProducts, currentProduct } = useMainContext()
|
||||
const { t } = useTranslation('picker')
|
||||
|
||||
return (
|
||||
<Picker
|
||||
variant="inline"
|
||||
data-testid="product-picker"
|
||||
data-current-product-path={currentProduct?.href}
|
||||
defaultText="All products"
|
||||
defaultText={t('product_picker_default_text')}
|
||||
options={activeProducts.map((product) => ({
|
||||
text: product.name,
|
||||
selected: product.name === currentProduct?.name,
|
||||
|
||||
@@ -15,7 +15,7 @@ export const VersionPicker = ({ variant }: Props) => {
|
||||
const router = useRouter()
|
||||
const { currentVersion } = useVersion()
|
||||
const { allVersions, page, enterpriseServerVersions } = useMainContext()
|
||||
const { t } = useTranslation('pages')
|
||||
const { t } = useTranslation(['pages', 'picker'])
|
||||
|
||||
if (page.permalinks && page.permalinks.length <= 1) {
|
||||
return null
|
||||
@@ -50,7 +50,7 @@ export const VersionPicker = ({ variant }: Props) => {
|
||||
<Picker
|
||||
variant={variant}
|
||||
data-testid="version-picker"
|
||||
defaultText="Choose version"
|
||||
defaultText={t('version_picker_default_text')}
|
||||
options={allLinks}
|
||||
/>
|
||||
)
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import { ReactNode } from 'react'
|
||||
import cx from 'classnames'
|
||||
import { useTranslation } from 'components/hooks/useTranslation'
|
||||
|
||||
import { Details, useDetails, Text, Dropdown, Box } from '@primer/components'
|
||||
import { ChevronDownIcon } from '@primer/octicons-react'
|
||||
@@ -41,7 +40,11 @@ function PickerSummaryWrapper({ variant, children }: PickerWrapperPropsT) {
|
||||
|
||||
function PickerOptionsWrapper({ variant, children }: PickerWrapperPropsT) {
|
||||
if (variant === 'inline') {
|
||||
return <Box py="2">{children}</Box>
|
||||
return (
|
||||
<Box py="2">
|
||||
<ul>{children}</ul>
|
||||
</Box>
|
||||
)
|
||||
}
|
||||
return (
|
||||
<Dropdown.Menu direction="sw" style={{ width: 'unset' }}>
|
||||
@@ -53,7 +56,6 @@ function PickerOptionsWrapper({ variant, children }: PickerWrapperPropsT) {
|
||||
export function Picker({ variant, defaultText, options, ...restProps }: PickerPropsT) {
|
||||
const { getDetailsProps, setOpen } = useDetails({ closeOnOutsideClick: true })
|
||||
const selectedOption = options.find((option) => option.selected)
|
||||
const { t } = useTranslation(['picker', 'toggle_picker_list'])
|
||||
|
||||
return (
|
||||
<Details
|
||||
@@ -67,7 +69,7 @@ export function Picker({ variant, defaultText, options, ...restProps }: PickerPr
|
||||
<summary
|
||||
className="d-block btn btn-invisible color-fg-default"
|
||||
aria-haspopup="true"
|
||||
aria-label={t('toggle_picker_list')}
|
||||
aria-label={selectedOption?.text || defaultText}
|
||||
>
|
||||
<PickerSummaryWrapper variant={variant}>
|
||||
<Text>{selectedOption?.text || defaultText}</Text>
|
||||
|
||||
@@ -25,11 +25,14 @@ Your profile picture helps identify you across {% data variables.product.product
|
||||
|
||||
When you sign up for an account, {% data variables.product.product_name %} provides you with a randomly generated "identicon". [Your identicon](https://github.com/blog/1586-identicons) generates from a hash of your user ID, so there's no way to control its color or pattern. You can replace your identicon with an image that represents you.
|
||||
|
||||
{% tip %}
|
||||
{% note %}
|
||||
|
||||
**Tip**: Your profile picture should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend keeping the image at about 500 by 500 pixels.
|
||||
**Note{% ifversion ghec %}s{% endif %}**: {% ifversion ghec %}
|
||||
|
||||
{% endtip %}
|
||||
* {% endif %}Your profile picture should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend keeping the image at about 500 by 500 pixels.
|
||||
{% ifversion ghec %}* Gravatar profile pictures are not supported with {% data variables.product.prodname_emus %}.{% endif %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### Setting a profile picture
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Managing your tab size rendering preference
|
||||
intro: You can manage the number of spaces a tab is equal to for your user account.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghae: ghae-issue-5083
|
||||
ghae: issue-5083
|
||||
ghes: '>=3.4'
|
||||
ghec: '*'
|
||||
topics:
|
||||
|
||||
@@ -16,8 +16,16 @@ shortTitle: Merge multiple user accounts
|
||||
---
|
||||
{% tip %}
|
||||
|
||||
{% ifversion ghec %}
|
||||
|
||||
**Tip:** {% data variables.product.prodname_emus %} allow an enterprise to provision unique user accounts for its members through an identity provider (IdP). For more information, see "[About Enterprise Managed Users](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users)." For other use cases, we recommend using only one user account to manage both personal and professional repositories.
|
||||
|
||||
{% else %}
|
||||
|
||||
**Tip:** We recommend using only one user account to manage both personal and professional repositories.
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% endtip %}
|
||||
|
||||
{% warning %}
|
||||
|
||||
@@ -124,19 +124,21 @@ jobs:
|
||||
tags: ghcr.io/{% raw %}${{ env.REPO }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %}
|
||||
file: ./Dockerfile
|
||||
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
environment:
|
||||
name: 'production'
|
||||
url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %}
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Lowercase the repo name
|
||||
run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
|
||||
needs: build
|
||||
|
||||
- name: Deploy to Azure Web App
|
||||
id: deploy-to-webapp
|
||||
environment:
|
||||
name: 'production'
|
||||
url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %}
|
||||
|
||||
steps:
|
||||
- name: Lowercase the repo name
|
||||
run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
|
||||
|
||||
- name: Deploy to Azure Web App
|
||||
id: deploy-to-webapp
|
||||
uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
|
||||
with:
|
||||
app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %}
|
||||
|
||||
@@ -36,13 +36,13 @@ shortTitle: Monitor & troubleshoot
|
||||
|
||||
## Reviewing the self-hosted runner application log files
|
||||
|
||||
You can monitor the status of the self-hosted runner application and its activities. Log files are kept in the `_diag` directory, and a new one is generated each time the application is started. The filename begins with *Runner_*, and is followed by a UTC timestamp of when the application was started.
|
||||
You can monitor the status of the self-hosted runner application and its activities. Log files are kept in the `_diag` directory where you installed the runner application, and a new log is generated each time the application is started. The filename begins with *Runner_*, and is followed by a UTC timestamp of when the application was started.
|
||||
|
||||
For detailed logs on workflow job executions, see the next section describing the *Worker_* files.
|
||||
|
||||
## Reviewing a job's log file
|
||||
|
||||
The self-hosted runner application creates a detailed log file for each job that it processes. These files are stored in the `_diag` directory, and the filename begins with *Worker_*.
|
||||
The self-hosted runner application creates a detailed log file for each job that it processes. These files are stored in the `_diag` directory where you installed the runner application, and the filename begins with *Worker_*.
|
||||
|
||||
{% linux %}
|
||||
|
||||
@@ -163,7 +163,7 @@ You can view the update activities in the *Runner_* log files. For example:
|
||||
[Feb 12 12:37:07 INFO SelfUpdater] An update is available.
|
||||
```
|
||||
|
||||
In addition, you can find more information in the _SelfUpdate_ log files located in the `_diag` directory.
|
||||
In addition, you can find more information in the _SelfUpdate_ log files located in the `_diag` directory where you installed the runner application.
|
||||
|
||||
{% linux %}
|
||||
|
||||
|
||||
@@ -24,9 +24,14 @@ featuredLinks:
|
||||
- /actions/learn-github-actions/expressions
|
||||
- /actions/learn-github-actions/environment-variables
|
||||
- /actions/security-guides/encrypted-secrets
|
||||
changelog:
|
||||
label: actions
|
||||
prefix: 'GitHub Actions: '
|
||||
videos:
|
||||
- title: "Inside GitHub: How we use GitHub Actions – Brian Douglas"
|
||||
href: 'https://www.youtube-nocookie.com/embed/MW0V5Q9WJu4'
|
||||
- title: "Advanced GitHub Actions – Jennifer Schelkopf"
|
||||
href: 'https://www.youtube-nocookie.com/embed/wWOH44Lscoc'
|
||||
- title: "GitHub Actions in action – Karan MV"
|
||||
href: 'https://www.youtube-nocookie.com/embed/4SWO0Pc76CU'
|
||||
videosHeading: GitHub Universe 2021 videos
|
||||
examples_source: data/product-examples/actions/code-examples.yml
|
||||
product_video: 'https://www.youtube-nocookie.com/embed/cP0I9w2coGU'
|
||||
redirect_from:
|
||||
|
||||
@@ -187,7 +187,7 @@ The `github` context contains information about the workflow run and the event t
|
||||
| `github.api_url` | `string` | The URL of the {% data variables.product.prodname_dotcom %} REST API. |
|
||||
| `github.base_ref` | `string` | The `base_ref` or target branch of the pull request in a workflow run. This property is only available when the event that triggers a workflow run is either `pull_request` or `pull_request_target`. |
|
||||
| `github.env` | `string` | Path on the runner to the file that sets environment variables from workflow commands. This file is unique to the current step and is a different file for each step in a job. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-commands-for-github-actions#setting-an-environment-variable)."
|
||||
| `github.event` | `object` | The full event webhook payload. You can access individual properties of the event using this context. This object is identical to the webhook payload of the event that triggered the workflow run, and is different for each event. The webhooks for each {% data variables.product.prodname_actions %} event is linked in "[Events that trigger workflows](/articles/events-that-trigger-workflows/)." For example, for a workflow run triggered by the [`push` event](http://localhost:4000/en/actions/learn-github-actions/events-that-trigger-workflows#push), this object contains the contents of the [push webhook payload](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#push). |
|
||||
| `github.event` | `object` | The full event webhook payload. You can access individual properties of the event using this context. This object is identical to the webhook payload of the event that triggered the workflow run, and is different for each event. The webhooks for each {% data variables.product.prodname_actions %} event is linked in "[Events that trigger workflows](/articles/events-that-trigger-workflows/)." For example, for a workflow run triggered by the [`push` event](/actions/using-workflows/events-that-trigger-workflows#push), this object contains the contents of the [push webhook payload](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#push). |
|
||||
| `github.event_name` | `string` | The name of the event that triggered the workflow run. |
|
||||
| `github.event_path` | `string` | The path to the file on the runner that contains the full event webhook payload. |
|
||||
| `github.graphql_url` | `string` | The URL of the {% data variables.product.prodname_dotcom %} GraphQL API. |
|
||||
|
||||
@@ -56,7 +56,7 @@ For guidance on a phased deployment of GitHub Advanced Security, see "[Deploying
|
||||
|
||||
- {% data variables.product.prodname_code_scanning_capc %}, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/admin/advanced-security/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)."
|
||||
- {% data variables.product.prodname_secret_scanning_caps %}, see "[Configuring {% data variables.product.prodname_secret_scanning %} for your appliance](/admin/advanced-security/configuring-secret-scanning-for-your-appliance#prerequisites-for-secret-scanning)."{% endif %}
|
||||
- {% data variables.product.prodname_dependabot %}, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)."
|
||||
- {% data variables.product.prodname_dependabot %}, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-the-dependency-graph-and-dependabot-alerts-for-your-enterprise)."
|
||||
|
||||
## Enabling and disabling {% data variables.product.prodname_GH_advanced_security %} features
|
||||
|
||||
|
||||
@@ -1,210 +0,0 @@
|
||||
---
|
||||
title: Using SAML
|
||||
redirect_from:
|
||||
- /enterprise/admin/articles/configuring-saml-authentication
|
||||
- /enterprise/admin/articles/about-saml-authentication
|
||||
- /enterprise/admin/user-management/using-saml
|
||||
- /enterprise/admin/authentication/using-saml
|
||||
- /admin/authentication/using-saml
|
||||
intro: 'SAML is an XML-based standard for authentication and authorization. {% data variables.product.prodname_ghe_server %} can act as a service provider (SP) with your internal SAML identity provider (IdP).'
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Accounts
|
||||
- Authentication
|
||||
- Enterprise
|
||||
- Identity
|
||||
- SSO
|
||||
---
|
||||
{% data reusables.enterprise_user_management.built-in-authentication %}
|
||||
|
||||
## Supported SAML services
|
||||
|
||||
{% data reusables.saml.saml-supported-idps %}
|
||||
|
||||
{% data reusables.saml.saml-single-logout-not-supported %}
|
||||
|
||||
## Username considerations with SAML
|
||||
|
||||
Each {% data variables.product.prodname_ghe_server %} username is determined by one of the following assertions in the SAML response, ordered by priority:
|
||||
|
||||
- The custom username attribute, if defined and present
|
||||
- An `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name` assertion, if present
|
||||
- An `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` assertion, if present
|
||||
- The `NameID` element
|
||||
|
||||
The `NameID` element is required even if other attributes are present.
|
||||
|
||||
A mapping is created between the `NameID` and the {% data variables.product.prodname_ghe_server %} username, so the `NameID` should be persistent, unique, and not subject to change for the lifecycle of the user.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: If the `NameID` for a user does change on the IdP, the user will see an error message when they try to sign in to your {% data variables.product.prodname_ghe_server %} instance. {% ifversion ghes %}To restore the user's access, you'll need to update the user account's `NameID` mapping. For more information, see "[Updating a user's SAML `NameID`](#updating-a-users-saml-nameid)."{% else %} For more information, see "[Error: 'Another user already owns the account'](#error-another-user-already-owns-the-account)."{% endif %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.enterprise_management_console.username_normalization %}
|
||||
|
||||
{% data reusables.enterprise_management_console.username_normalization_sample %}
|
||||
|
||||
{% data reusables.enterprise_user_management.two_factor_auth_header %}
|
||||
{% data reusables.enterprise_user_management.external_auth_disables_2fa %}
|
||||
|
||||
## SAML metadata
|
||||
|
||||
Your {% data variables.product.prodname_ghe_server %} instance's service provider metadata is available at `http(s)://[hostname]/saml/metadata`.
|
||||
|
||||
To configure your identity provider manually, the Assertion Consumer Service (ACS) URL is `http(s)://[hostname]/saml/consume`. It uses the `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST` binding.
|
||||
|
||||
## SAML attributes
|
||||
|
||||
These attributes are available. You can change the attribute names in the [management console](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-management-console/), with the exception of the `administrator` attribute.
|
||||
|
||||
| Default attribute name | Type | Description |
|
||||
|-----------------|----------|-------------|
|
||||
| `NameID` | Required | A persistent user identifier. Any persistent name identifier format may be used. The `NameID` element will be used for a {% data variables.product.prodname_ghe_server %} username unless one of the alternative assertions is provided. |
|
||||
| `administrator` | Optional | When the value is 'true', the user will automatically be promoted as an administrator. Any other value or a non-existent value will demote the user to a normal user account. |
|
||||
| `username` | Optional | The {% data variables.product.prodname_ghe_server %} username. |
|
||||
| `full_name` | Optional | The name of the user displayed on their profile page. Users may change their names after provisioning. |
|
||||
| `emails` | Optional | The email addresses for the user. More than one can be specified. |
|
||||
| `public_keys` | Optional | The public SSH keys for the user. More than one can be specified. |
|
||||
| `gpg_keys` | Optional | The GPG keys for the user. More than one can be specified. |
|
||||
|
||||
To specify more than one value for an attribute, use multiple `<saml2:AttributeValue>` elements.
|
||||
|
||||
```
|
||||
<saml2:Attribute FriendlyName="public_keys" Name="urn:oid:1.2.840.113549.1.1.1" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri">
|
||||
<saml2:AttributeValue>ssh-rsa LONG KEY</saml2:AttributeValue>
|
||||
<saml2:AttributeValue>ssh-rsa LONG KEY 2</saml2:AttributeValue>
|
||||
</saml2:Attribute>
|
||||
```
|
||||
|
||||
## Configuring SAML settings
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_management_console.authentication %}
|
||||
3. Select **SAML**.
|
||||

|
||||
4. {% data reusables.enterprise_user_management.built-in-authentication-option %} 
|
||||
5. Optionally, to enable unsolicited response SSO, select **IdP initiated SSO**. By default, {% data variables.product.prodname_ghe_server %} will reply to an unsolicited Identity Provider (IdP) initiated request with an `AuthnRequest` back to the IdP.
|
||||

|
||||
|
||||
{% tip %}
|
||||
|
||||
**Note**: We recommend keeping this value **unselected**. You should enable this feature **only** in the rare instance that your SAML implementation does not support service provider initiated SSO, and when advised by {% data variables.contact.enterprise_support %}.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
5. Select **Disable administrator demotion/promotion** if you **do not** want your SAML provider to determine administrator rights for users on {% data variables.product.product_location %}.
|
||||

|
||||
6. In the **Single sign-on URL** field, type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.product.product_location %} to use internal nameservers](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-dns-nameservers/).
|
||||

|
||||
7. Optionally, in the **Issuer** field, type your SAML issuer's name. This verifies the authenticity of messages sent to {% data variables.product.product_location %}.
|
||||

|
||||
8. In the **Signature Method** and **Digest Method** drop-down menus, choose the hashing algorithm used by your SAML issuer to verify the integrity of the requests from {% data variables.product.product_location %}. Specify the format with the **Name Identifier Format** drop-down menu.
|
||||

|
||||
9. Under **Verification certificate**, click **Choose File** and choose a certificate to validate SAML responses from the IdP.
|
||||

|
||||
10. Modify the SAML attribute names to match your IdP if needed, or accept the default names.
|
||||

|
||||
|
||||
{% ifversion ghes %}
|
||||
|
||||
## Updating a user's SAML `NameID`
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
2. In the left sidebar, click **All users**.
|
||||

|
||||
3. In the list of users, click the username you'd like to update the `NameID` mapping for.
|
||||

|
||||
{% data reusables.enterprise_site_admin_settings.security-tab %}
|
||||
5. To the right of "Update SAML NameID", click **Edit** .
|
||||

|
||||
6. In the "NameID" field, type the new `NameID` for the user.
|
||||

|
||||
7. Click **Update NameID**.
|
||||

|
||||
|
||||
{% endif %}
|
||||
|
||||
## Revoking access to {% data variables.product.product_location %}
|
||||
|
||||
If you remove a user from your identity provider, you must also manually suspend them. Otherwise, they'll continue to be able to authenticate using access tokens or SSH keys. For more information, see "[Suspending and unsuspending users](/enterprise/admin/guides/user-management/suspending-and-unsuspending-users)".
|
||||
|
||||
## Response message requirements
|
||||
|
||||
The response message must fulfill the following requirements:
|
||||
|
||||
- The `<Destination>` element must be provided on the root response document and match the ACS URL only when the root response document is signed. If the assertion is signed, it will be ignored.
|
||||
- The `<Audience>` element must always be provided as part of the `<AudienceRestriction>` element. It must match the `EntityId` for {% data variables.product.prodname_ghe_server %}. This is the URL to the {% data variables.product.prodname_ghe_server %} instance, such as `https://ghe.corp.example.com`.
|
||||
- Each assertion in the response **must** be protected by a digital signature. This can be accomplished by signing each individual `<Assertion>` element or by signing the `<Response>` element.
|
||||
- A `<NameID>` element must be provided as part of the `<Subject>` element. Any persistent name identifier format may be used.
|
||||
- The `Recipient` attribute must be present and set to the ACS URL. For example:
|
||||
|
||||
```xml
|
||||
<samlp:Response ...>
|
||||
<saml:Assertion ...>
|
||||
<saml:Subject>
|
||||
<saml:NameID ...>...</saml:NameID>
|
||||
<saml:SubjectConfirmation ...>
|
||||
<saml:SubjectConfirmationData Recipient="https://ghe.corp.example.com/saml/consume" .../>
|
||||
</saml:SubjectConfirmation>
|
||||
</saml:Subject>
|
||||
<saml:AttributeStatement>
|
||||
<saml:Attribute FriendlyName="USERNAME-ATTRIBUTE" ...>
|
||||
<saml:AttributeValue>monalisa</saml:AttributeValue>
|
||||
</saml:Attribute>
|
||||
</saml:AttributeStatement>
|
||||
</saml:Assertion>
|
||||
</samlp:Response>
|
||||
```
|
||||
|
||||
## Troubleshooting SAML authentication
|
||||
|
||||
{% data variables.product.prodname_ghe_server %} logs error messages for failed SAML authentication in the authentication log at _/var/log/github/auth.log_. For more information about SAML response requirements, see "[Response message requirements](#response-message-requirements)."
|
||||
|
||||
### Error: "Another user already owns the account"
|
||||
|
||||
When a user signs in to {% data variables.product.prodname_ghe_server %} for the first time with SAML authentication, {% data variables.product.prodname_ghe_server %} creates a user account on the instance and maps the SAML `NameID` to the account.
|
||||
|
||||
When the user signs in again, {% data variables.product.prodname_ghe_server %} compares the account's `NameID` mapping to the IdP's response. If the `NameID` in the IdP's response no longer matches the `NameID` that {% data variables.product.prodname_ghe_server %} expects for the user, the sign-in will fail. The user will see the following message.
|
||||
|
||||
> Another user already owns the account. Please have your administrator check the authentication log.
|
||||
|
||||
The message typically indicates that the person's username or email address has changed on the IdP. {% ifversion ghes %}Ensure that the `NameID` mapping for the user account on {% data variables.product.prodname_ghe_server %} matches the user's `NameID` on your IdP. For more information, see "[Updating a user's SAML `NameID`](#updating-a-users-saml-nameid)."{% else %}For help updating the `NameID` mapping, contact {% data variables.contact.contact_ent_support %}.{% endif %}
|
||||
|
||||
### Error: Recipient in SAML response was blank or not valid
|
||||
|
||||
If the `Recipient` does not match the ACS URL for your {% data variables.product.prodname_ghe_server %} instance, one of the following two error messages will appear in the authentication log when a user attempts to authenticate.
|
||||
|
||||
```
|
||||
Recipient in the SAML response must not be blank.
|
||||
```
|
||||
|
||||
```
|
||||
Recipient in the SAML response was not valid.
|
||||
```
|
||||
|
||||
Ensure that you set the value for `Recipient` on your IdP to the full ACS URL for your {% data variables.product.prodname_ghe_server %} instance. For example, `https://ghe.corp.example.com/saml/consume`.
|
||||
|
||||
### Error: "SAML Response is not signed or has been modified"
|
||||
|
||||
If your IdP does not sign the SAML response, or the signature does not match the contents, the following error message will appear in the authentication log.
|
||||
|
||||
```
|
||||
SAML Response is not signed or has been modified.
|
||||
```
|
||||
|
||||
Ensure that you configure signed assertions for the {% data variables.product.prodname_ghe_server %} application on your IdP.
|
||||
|
||||
### Error: "Audience is invalid" or "No assertion found"
|
||||
|
||||
If the IdP's response has a missing or incorrect value for `Audience`, the following error message will appear in the authentication log.
|
||||
|
||||
```shell
|
||||
Audience is invalid. Audience attribute does not match https://<em>YOUR-INSTANCE-URL</em>
|
||||
```
|
||||
|
||||
Ensure that you set the value for `Audience` on your IdP to the `EntityId` for your {% data variables.product.prodname_ghe_server %} instance, which is the full URL to your {% data variables.product.prodname_ghe_server %} instance. For example, `https://ghe.corp.example.com`.
|
||||
@@ -0,0 +1,71 @@
|
||||
---
|
||||
title: About GitHub Connect
|
||||
intro: "{% data variables.product.prodname_github_connect %} enhances {% data variables.product.product_name %} by giving you access to additional features and workflows that rely on the power of {% data variables.product.prodname_dotcom_the_website %}."
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- Enterprise
|
||||
- GitHub Connect
|
||||
---
|
||||
|
||||
## About {% data variables.product.prodname_github_connect %}
|
||||
|
||||
{% data variables.product.prodname_github_connect %} enhances {% data variables.product.product_name %} by allowing {% data variables.product.product_location %} to benefit from the power of {% data variables.product.prodname_dotcom_the_website %} in limited ways. After you enable {% data variables.product.prodname_github_connect %}, you can enable additional features and workflows that rely on {% data variables.product.prodname_dotcom_the_website %}, such as {% ifversion ghes or ghae-issue-4864 %}{% data variables.product.prodname_dependabot_alerts %} for security vulnerabilities that are tracked in the {% data variables.product.prodname_advisory_database %}{% else %}allowing users to use community-powered actions from {% data variables.product.prodname_dotcom_the_website %} in their workflow files{% endif %}.
|
||||
|
||||
{% data variables.product.prodname_github_connect %} does not open {% data variables.product.product_location %} to the public internet. None of your enterprise's private data is exposed to {% data variables.product.prodname_dotcom_the_website %} users. Instead, {% data variables.product.prodname_github_connect %} transmits only the limited data needed for the individual features you choose to enable. Unless you enable license sync, no personal data is transmitted by {% data variables.product.prodname_github_connect %}. For more information about what data is transmitted by {% data variables.product.prodname_github_connect %}, see "[Data transmission for {% data variables.product.prodname_github_connect %}](#data-transmission-for-github-connect)."
|
||||
|
||||
Enabling {% data variables.product.prodname_github_connect %} will not allow {% data variables.product.prodname_dotcom_the_website %} users to make changes to {% data variables.product.product_name %}.
|
||||
|
||||
To enable {% data variables.product.prodname_github_connect %}, you configure a connection between {% data variables.product.product_location %} and an organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %} that uses {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Managing {% data variables.product.prodname_github_connect %}](/admin/configuration/configuring-github-connect/managing-github-connect)."
|
||||
|
||||
After enabling {% data variables.product.prodname_github_connect %}, you will be able to enable features such as {% ifversion ghes %}automatic user license sync and {% endif %}{% data variables.product.prodname_dependabot_alerts %}. For more information about all of the features available, see "[{% data variables.product.prodname_github_connect %} features](#github-connect-features)."
|
||||
|
||||
## {% data variables.product.prodname_github_connect %} features
|
||||
|
||||
After you configure the connection between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}, you can enable individual features of {% data variables.product.prodname_github_connect %} for your enterprise.
|
||||
|
||||
Feature | Description | More information |
|
||||
------- | ----------- | ---------------- |{% ifversion ghes %}
|
||||
Automatic user license sync | Manage license usage across your {% data variables.product.prodname_enterprise %} deployments by automatically syncing user licenses from {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %}. | "[Enabling automatic user license sync for your enterprise](/admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise)"{% endif %}{% ifversion ghes or ghae-issue-4864 %}
|
||||
{% data variables.product.prodname_dependabot_alerts %} | Allow users to find and fix vulnerabilities in code dependencies. | "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-the-dependency-graph-and-dependabot-alerts-for-your-enterprise)"{% endif %}
|
||||
{% data variables.product.prodname_dotcom_the_website %} actions | Allow users to use actions from {% data variables.product.prodname_dotcom_the_website %} in workflow files. | "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)"
|
||||
Unified search | Allow users to include repositories on {% data variables.product.prodname_dotcom_the_website %} in their search results when searching from {% data variables.product.product_location %}. | "[Enabling {% data variables.product.prodname_unified_search %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-unified-search-for-your-enterprise)"
|
||||
Unified contributions | Allow users to include anonymized contribution counts for their work on {% data variables.product.product_location %} in their contribution graphs on {% data variables.product.prodname_dotcom_the_website %}. | "[Enabling {% data variables.product.prodname_unified_contributions %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-unified-contributions-for-your-enterprise)"
|
||||
|
||||
## Data transmission for {% data variables.product.prodname_github_connect %}
|
||||
|
||||
When you enable {% data variables.product.prodname_github_connect %} or specific {% data variables.product.prodname_github_connect %} features, a record on {% data variables.product.prodname_ghe_cloud %} stores the following information about the connection.
|
||||
{% ifversion ghes %}
|
||||
- The public key portion of your {% data variables.product.prodname_ghe_server %} license
|
||||
- A hash of your {% data variables.product.prodname_ghe_server %} license
|
||||
- The customer name on your {% data variables.product.prodname_ghe_server %} license
|
||||
- The version of {% data variables.product.product_location_enterprise %}{% endif %}
|
||||
- The hostname of {% data variables.product.product_location %}
|
||||
- The organization or enterprise account on {% data variables.product.prodname_ghe_cloud %} that's connected to {% data variables.product.product_location %}
|
||||
- The authentication token that's used by {% data variables.product.product_location %} to make requests to {% data variables.product.prodname_ghe_cloud %}
|
||||
- If Transport Layer Security (TLS) is enabled and configured on {% data variables.product.product_location %}{% ifversion ghes %}
|
||||
- The {% data variables.product.prodname_github_connect %} features that are enabled on {% data variables.product.product_location %}, and the date and time of enablement{% endif %}
|
||||
|
||||
{% data variables.product.prodname_github_connect %} syncs the above connection data between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %} weekly, from the day and approximate time that {% data variables.product.prodname_github_connect %} was enabled.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** No repositories, issues, or pull requests are ever transmitted by {% data variables.product.prodname_github_connect %}.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
Additional data is transmitted if you enable individual features of {% data variables.product.prodname_github_connect %}.
|
||||
|
||||
Feature | Data | Which way does the data flow? | Where is the data used? |
|
||||
------- | ---- | --------- | ------ |{% ifversion ghes %}
|
||||
Automatic user license sync | Each {% data variables.product.product_name %} user's user ID and email addresses | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |{% endif %}{% ifversion ghes or ghae-issue-4864 %}
|
||||
{% data variables.product.prodname_dependabot_alerts %} | Vulnerability alerts | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name%} |{% endif %}
|
||||
{% data variables.product.prodname_dotcom_the_website %} actions | Name of action, action (YAML file from {% data variables.product.prodname_marketplace %}) | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}<br><br>From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}
|
||||
Unified search | Search terms, search results | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}<br><br>From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} |
|
||||
Unified contributions | Contribution counts | From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} |
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)" in the GraphQL API documentation
|
||||
@@ -1,11 +1,12 @@
|
||||
---
|
||||
title: Enabling automatic user license sync between GitHub Enterprise Server and GitHub Enterprise Cloud
|
||||
intro: 'You can connect {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_ghe_cloud %} and allow {% data variables.product.prodname_ghe_server %} to upload user license information to your enterprise account on {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
title: Enabling automatic user license sync for your enterprise
|
||||
intro: 'You can manage license usage across your {% data variables.product.prodname_enterprise %} deployments by automatically syncing user licenses from {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/installation/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
- /enterprise/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
- /admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
- /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
- /admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable automatic user license synchronization.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
@@ -14,17 +15,17 @@ topics:
|
||||
- Enterprise
|
||||
- GitHub Connect
|
||||
- Licensing
|
||||
shortTitle: Enable user license sync
|
||||
shortTitle: Automatic user license sync
|
||||
---
|
||||
## About license synchronization
|
||||
|
||||
After you enable license synchronization, you'll be able to view license usage for your entire enterprise account, across {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}. {% data variables.product.prodname_github_connect %} syncs license between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} weekly. For more information, see "[Managing your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise)."
|
||||
After you enable license synchronization, you'll be able to view license usage for your entire enterprise across {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}. {% data variables.product.prodname_github_connect %} syncs license between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} weekly. For more information, see "[Managing your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise)."
|
||||
|
||||
You can also manually upload {% data variables.product.prodname_ghe_server %} user license information to {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)."
|
||||
You can also manually upload {% data variables.product.prodname_ghe_server %} user license information to {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Syncing license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)."
|
||||
|
||||
## Enabling license synchronization
|
||||
|
||||
Before enabling license synchronization on {% data variables.product.product_location_enterprise %}, you must connect {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)."
|
||||
Before enabling license synchronization on {% data variables.product.product_location %}, you must enable {% data variables.product.prodname_github_connect %}. For more information, see "[Managing {% data variables.product.prodname_github_connect %}](/admin/configuration/configuring-github-connect/managing-github-connect)."
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}
|
||||
1. Under "Server can sync user license count and usage", use the drop-down menu and select **Enabled**.
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
title: Enabling the dependency graph and Dependabot alerts on your enterprise account
|
||||
intro: 'You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %} and enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %} in repositories in your instance.'
|
||||
title: Enabling the dependency graph and Dependabot alerts for your enterprise
|
||||
intro: 'You can allow users on {% data variables.product.product_location %} to find and fix vulnerabilities in code dependencies by enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %}.'
|
||||
miniTocMaxHeadingLevel: 3
|
||||
shortTitle: Enable dependency analysis
|
||||
shortTitle: Dependabot
|
||||
redirect_from:
|
||||
- /enterprise/admin/installation/enabling-security-alerts-for-vulnerable-dependencies-on-github-enterprise-server
|
||||
- /enterprise/admin/configuration/enabling-security-alerts-for-vulnerable-dependencies-on-github-enterprise-server
|
||||
@@ -10,6 +10,7 @@ redirect_from:
|
||||
- /admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server
|
||||
- /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server
|
||||
- /admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server
|
||||
- /admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account
|
||||
permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on {% data variables.product.product_location %}.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
@@ -36,7 +37,7 @@ For more information about these features, see "[About the dependency graph](/gi
|
||||
|
||||
{% data reusables.repositories.tracks-vulnerabilities %}
|
||||
|
||||
You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_github_connect %}. Once connected, vulnerability data is synced from the {% data variables.product.prodname_advisory_database %} to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from {% data variables.product.product_location %} is uploaded to {% data variables.product.prodname_dotcom_the_website %}.
|
||||
You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_github_connect %}. Once connected, vulnerability data is synced from the {% data variables.product.prodname_advisory_database %} to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from {% data variables.product.product_location %} is uploaded to {% data variables.product.prodname_dotcom_the_website %}.
|
||||
|
||||
Only {% data variables.product.company_short %}-reviewed advisories are synchronized. {% data reusables.security-advisory.link-browsing-advisory-db %}
|
||||
|
||||
@@ -44,7 +45,6 @@ Only {% data variables.product.company_short %}-reviewed advisories are synchron
|
||||
|
||||
For repositories with {% data variables.product.prodname_dependabot_alerts %} enabled, scanning is triggered on any push to the default branch that contains a manifest file or lock file. Additionally, when a new vulnerability record is added to the instance, {% data variables.product.prodname_ghe_server %} scans all existing repositories in that instance and generates alerts for any repository that is vulnerable. For more information, see "[Detection of vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#detection-of-vulnerable-dependencies)."
|
||||
|
||||
|
||||
### About generation of {% data variables.product.prodname_dependabot_alerts %}
|
||||
|
||||
If you enable vulnerability detection, when {% data variables.product.product_location %} receives information about a vulnerability, it identifies repositories in your instance that use the affected version of the dependency and generates {% data variables.product.prodname_dependabot_alerts %}. You can choose whether or not to notify users automatically about new {% data variables.product.prodname_dependabot_alerts %}.
|
||||
@@ -54,7 +54,7 @@ If you enable vulnerability detection, when {% data variables.product.product_lo
|
||||
### Prerequisites
|
||||
|
||||
For {% data variables.product.product_location %} to detect vulnerable dependencies and generate {% data variables.product.prodname_dependabot_alerts %}:
|
||||
- You must connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}. {% ifversion ghae %}This also enables the dependency graph service. {% endif %}{% ifversion ghes or ghae %}For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)."{% endif %}
|
||||
- You must enable {% data variables.product.prodname_github_connect %}. {% ifversion ghae %}This also enables the dependency graph service.{% endif %}{% ifversion ghes or ghae %}For more information, see "[Managing {% data variables.product.prodname_github_connect %}](/admin/configuration/configuring-github-connect/managing-github-connect)."{% endif %}
|
||||
{% ifversion ghes %}- You must enable the dependency graph service.{% endif %}
|
||||
- You must enable vulnerability scanning.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Enabling unified contributions between your enterprise account and GitHub.com
|
||||
shortTitle: Enable unified contributions
|
||||
intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow {% data variables.product.prodname_ghe_cloud %} members to highlight their work on {% data variables.product.product_name %} by sending the contribution counts to their {% data variables.product.prodname_dotcom_the_website %} profiles.'
|
||||
title: Enabling unified contributions for your enterprise
|
||||
shortTitle: Unified contributions
|
||||
intro: 'You can allow users to include anonymized contribution counts for their work on {% data variables.product.product_location %} in their contribution graphs on {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-and-github-com
|
||||
- /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-server-and-github-com
|
||||
@@ -10,6 +10,7 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom
|
||||
- /admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom
|
||||
- /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-unified-contributions-between-github-enterprise-server-and-githubcom
|
||||
- /admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom
|
||||
permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified contributions between {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
@@ -22,15 +23,21 @@ topics:
|
||||
|
||||
{% data reusables.github-connect.beta %}
|
||||
|
||||
## About unified contributions
|
||||
|
||||
As an enterprise owner, you can allow end users to send anonymized contribution counts for their work from {% data variables.product.product_location %} to their {% data variables.product.prodname_dotcom_the_website %} contribution graph.
|
||||
|
||||
After you enable {% data variables.product.prodname_github_connect %} and enable {% data variables.product.prodname_unified_contributions %} in both environments, end users on your enterprise account can connect to their {% data variables.product.prodname_dotcom_the_website %} accounts and send contribution counts from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.github-connect.sync-frequency %} For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)."
|
||||
After you enable {% data variables.product.prodname_unified_contributions %}, before individual users can send contribution counts from {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}, each user must also connect their personal account on {% data variables.product.product_name %} with a personal account on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)."
|
||||
|
||||
If the enterprise owner disables the functionality or developers opt out of the connection, the {% data variables.product.product_name %} contribution counts will be deleted on {% data variables.product.prodname_dotcom_the_website %}. If the developer reconnects their profiles after disabling them, the contribution counts for the past 90 days are restored.
|
||||
{% data reusables.github-connect.sync-frequency %}
|
||||
|
||||
If the enterprise owner disables the functionality or individual users opt out of the connection, the contribution counts from {% data variables.product.product_name %} will be deleted on {% data variables.product.prodname_dotcom_the_website %}. If the user reconnects their profiles after disabling them, the contribution counts for the past 90 days are restored.
|
||||
|
||||
{% data variables.product.product_name %} **only** sends the contribution count and source ({% data variables.product.product_name %}) for connected users. It does not send any information about the contribution or how it was made.
|
||||
|
||||
Before enabling {% data variables.product.prodname_unified_contributions %} on {% data variables.product.product_location %}, you must connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting your enterprise account to {% data variables.product.prodname_dotcom_the_website %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)."
|
||||
## Enabling unified contributions
|
||||
|
||||
Before enabling {% data variables.product.prodname_unified_contributions %} on {% data variables.product.product_location %}, you must enable {% data variables.product.prodname_github_connect %}. For more information, see "[Managing {% data variables.product.prodname_github_connect %}](/admin/configuration/configuring-github-connect/managing-github-connect)."
|
||||
|
||||
{% ifversion ghes %}
|
||||
{% data reusables.github-connect.access-dotcom-and-enterprise %}
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Enabling unified search between your enterprise account and GitHub.com
|
||||
shortTitle: Enable unified search
|
||||
intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow search of {% data variables.product.prodname_dotcom_the_website %} for members of your enterprise on {% data variables.product.product_name %}.'
|
||||
title: Enabling unified search for your enterprise
|
||||
shortTitle: Unified search
|
||||
intro: 'You can allow users to include repositories on {% data variables.product.prodname_dotcom_the_website %} in their search results when searching from {% data variables.product.product_location %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-and-github-com
|
||||
- /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-server-and-github-com
|
||||
@@ -10,6 +10,7 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom
|
||||
- /admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom
|
||||
- /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-unified-search-between-github-enterprise-server-and-githubcom
|
||||
- /admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom
|
||||
permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified search between {% data variables.product.product_name %} and {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
@@ -21,29 +22,32 @@ topics:
|
||||
- GitHub search
|
||||
---
|
||||
|
||||
## About {% data variables.product.prodname_unified_search %}
|
||||
|
||||
{% data reusables.github-connect.beta %}
|
||||
|
||||
When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location %}{% ifversion ghae %} on {% data variables.product.prodname_ghe_managed %}{% endif %}.
|
||||
When you enable unified search, users can view search results from content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location %}{% ifversion ghae %} on {% data variables.product.prodname_ghe_managed %}{% endif %}.
|
||||
|
||||
After you enable unified search for {% data variables.product.product_location %}, individual users must also connect their user accounts on {% data variables.product.product_name %} with their user accounts on {% data variables.product.prodname_dotcom_the_website %} in order to see search results from {% data variables.product.prodname_dotcom_the_website %} on {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_dotcom_the_website %} repository search in your private enterprise account](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)."
|
||||
You can choose to allow search results for public repositories on {% data variables.product.prodname_dotcom_the_website %}, and you can separately choose to allow search results for private repositories on {% data variables.product.prodname_ghe_cloud %}. If you enable unified search for private repositories, users can only search private repositories that they have access to and that are owned by the connected organization or enterprise account. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)."
|
||||
|
||||
Users will not be able to search {% data variables.product.product_location %} from {% data variables.product.prodname_dotcom_the_website %}, even if they have access to both environments. Users can only search private repositories you've enabled {% data variables.product.prodname_unified_search %} for and that they have access to in the connected {% data variables.product.prodname_ghe_cloud %} organizations. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)."
|
||||
Users will never be able to search {% data variables.product.product_location %} from {% data variables.product.prodname_dotcom_the_website %}, even if they have access to both environments.
|
||||
|
||||
After you enable unified search for {% data variables.product.product_location %}, before individual users can see search results from {% data variables.product.prodname_dotcom_the_website %} on {% data variables.product.product_location %}, each user must also connect their personal account on {% data variables.product.product_name %} with a personal account on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Enabling {% data variables.product.prodname_dotcom_the_website %} repository search in your private enterprise account](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)."
|
||||
|
||||
Searching via the REST and GraphQL APIs does not include {% data variables.product.prodname_dotcom_the_website %} search results. Advanced search and searching for wikis in {% data variables.product.prodname_dotcom_the_website %} are not supported.
|
||||
|
||||
## Enabling {% data variables.product.prodname_unified_search %}
|
||||
|
||||
Before you can enable {% data variables.product.prodname_unified_search %}, you must enable {% data variables.product.prodname_github_connect %}. For more information, see "[Managing {% data variables.product.prodname_github_connect %}](/admin/configuration/configuring-github-connect/managing-github-connect)."
|
||||
|
||||
{% ifversion ghes %}
|
||||
{% data reusables.github-connect.access-dotcom-and-enterprise %}
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.business %}
|
||||
{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %}
|
||||
1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}.
|
||||
1. Sign into {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}.
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %}
|
||||
1. Under "Users can search {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**.
|
||||

|
||||
1. Optionally, under "Users can search private repositories on {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**.
|
||||

|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Managing connections between your enterprise accounts
|
||||
intro: 'With {% data variables.product.prodname_github_connect %}, you can share certain features and data between {% data variables.product.product_location %} and your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
title: Configuring GitHub Connect
|
||||
intro: 'With {% data variables.product.prodname_github_connect %}, you can access additional features and workflows by connecting {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/developer-workflow/connecting-github-enterprise-to-github-com
|
||||
- /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-and-github-com
|
||||
@@ -9,6 +9,7 @@ redirect_from:
|
||||
- /enterprise/admin/installation/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
- /enterprise/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
- /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
- /admin/configuration/managing-connections-between-your-enterprise-accounts
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
@@ -16,11 +17,12 @@ type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
children:
|
||||
- /connecting-your-enterprise-account-to-github-enterprise-cloud
|
||||
- /enabling-unified-search-between-your-enterprise-account-and-githubcom
|
||||
- /enabling-unified-contributions-between-your-enterprise-account-and-githubcom
|
||||
- /enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account
|
||||
- /enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
shortTitle: Connect enterprise accounts
|
||||
- /about-github-connect
|
||||
- /managing-github-connect
|
||||
- /enabling-automatic-user-license-sync-for-your-enterprise
|
||||
- /enabling-the-dependency-graph-and-dependabot-alerts-for-your-enterprise
|
||||
- /enabling-unified-search-for-your-enterprise
|
||||
- /enabling-unified-contributions-for-your-enterprise
|
||||
shortTitle: GitHub Connect
|
||||
---
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Connecting your enterprise account to GitHub Enterprise Cloud
|
||||
shortTitle: Connect enterprise accounts
|
||||
intro: 'After you enable {% data variables.product.prodname_github_connect %}, you can share specific features and workflows between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}.'
|
||||
title: Managing GitHub Connect
|
||||
shortTitle: Manage GitHub Connect
|
||||
intro: 'You can enable {% data variables.product.prodname_github_connect %} to access additional features and workflows for {% data variables.product.product_location %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-to-github-com
|
||||
- /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com
|
||||
@@ -10,6 +10,7 @@ redirect_from:
|
||||
- /enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud
|
||||
- /admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud
|
||||
- /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud
|
||||
- /admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
@@ -25,45 +26,31 @@ topics:
|
||||
|
||||
## About {% data variables.product.prodname_github_connect %}
|
||||
|
||||
To enable {% data variables.product.prodname_github_connect %}, you must configure the connection in both {% data variables.product.product_location %} and in your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account.
|
||||
You can access additional features and workflows on {% data variables.product.product_location %} by enabling {% data variables.product.prodname_github_connect %}. For more information, see "[About {% data variables.product.prodname_github_connect %}](/admin/configuration/configuring-github-connect/about-github-connect)."
|
||||
|
||||
When you enable {% data variables.product.prodname_github_connect %}, you configure a connection between {% data variables.product.product_location %} and an organization or enterprise account on {% data variables.product.prodname_ghe_cloud %}. Enabling {% data variables.product.prodname_github_connect %} creates a {% data variables.product.prodname_github_app %} owned by the organization or enterprise account on {% data variables.product.prodname_ghe_cloud %}. {% data variables.product.product_name %} uses the {% data variables.product.prodname_github_app %}'s credentials to make requests to {% data variables.product.prodname_ghe_cloud %}.
|
||||
|
||||
{% ifversion ghes %}
|
||||
To configure a connection, your proxy configuration must allow connectivity to `github.com` and `api.github.com`. For more information, see "[Configuring an outbound web proxy server](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-an-outbound-web-proxy-server)."
|
||||
{% endif %}
|
||||
|
||||
After enabling {% data variables.product.prodname_github_connect %}, you will be able to enable features such as unified search and unified contributions. For more information about all of the features available, see "[Managing connections between your enterprise accounts](/admin/configuration/managing-connections-between-your-enterprise-accounts)."
|
||||
|
||||
When you connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %}, or enable {% data variables.product.prodname_github_connect %} features, a record on {% data variables.product.prodname_dotcom_the_website %} stores information about the connection:
|
||||
{% ifversion ghes %}
|
||||
- The public key portion of your {% data variables.product.prodname_ghe_server %} license
|
||||
- A hash of your {% data variables.product.prodname_ghe_server %} license
|
||||
- The customer name on your {% data variables.product.prodname_ghe_server %} license
|
||||
- The version of {% data variables.product.product_location_enterprise %}{% endif %}
|
||||
- The hostname of {% data variables.product.product_location %}
|
||||
- The organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %} that's connected to {% data variables.product.product_location %}
|
||||
- The authentication token that's used by {% data variables.product.product_location %} to make requests to {% data variables.product.prodname_dotcom_the_website %}
|
||||
- If Transport Layer Security (TLS) is enabled and configured on {% data variables.product.product_location %}{% ifversion ghes %}
|
||||
- The {% data variables.product.prodname_github_connect %} features that are enabled on {% data variables.product.product_location %}, and the date and time of enablement{% endif %}
|
||||
|
||||
{% data variables.product.prodname_github_connect %} syncs the above connection data between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %} weekly, from the day and approximate time that {% data variables.product.prodname_github_connect %} was enabled.
|
||||
|
||||
Enabling {% data variables.product.prodname_github_connect %} also creates a {% data variables.product.prodname_github_app %} owned by your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account. {% data variables.product.product_name %} uses the {% data variables.product.prodname_github_app %}'s credentials to make requests to {% data variables.product.prodname_dotcom_the_website %}.
|
||||
{% ifversion ghes %}
|
||||
{% data variables.product.prodname_ghe_server %} stores credentials from the {% data variables.product.prodname_github_app %}. These credentials will be replicated to any high availability or clustering environments, and stored in any backups, including snapshots created by {% data variables.product.prodname_enterprise_backup_utilities %}.
|
||||
{% data variables.product.prodname_ghe_server %} stores credentials from the {% data variables.product.prodname_github_app %}. The following credentials will be replicated to all nodes in a high availability or cluster environment, and stored in any backups, including snapshots created by {% data variables.product.prodname_enterprise_backup_utilities %}.
|
||||
- An authentication token, which is valid for one hour
|
||||
- A private key, which is used to generate a new authentication token
|
||||
{% endif %}
|
||||
|
||||
Enabling {% data variables.product.prodname_github_connect %} will not allow {% data variables.product.prodname_dotcom_the_website %} users to make changes to {% data variables.product.product_name %}.
|
||||
## Prerequisites
|
||||
|
||||
To use {% data variables.product.prodname_github_connect %}, you must have an organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %} that uses {% data variables.product.prodname_ghe_cloud %}. You may already have {% data variables.product.prodname_ghe_cloud %} included in your plan. {% data reusables.enterprise.link-to-ghec-trial %}
|
||||
|
||||
{% ifversion ghes %}
|
||||
To configure a connection, your proxy configuration must allow connectivity to `github.com`, `api.github.com`, and `uploads.github.com`. For more information, see "[Configuring an outbound web proxy server](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-an-outbound-web-proxy-server)."
|
||||
{% endif %}
|
||||
|
||||
For more information about managing enterprise accounts using the GraphQL API, see "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)."
|
||||
## Enabling {% data variables.product.prodname_github_connect %}
|
||||
|
||||
Enterprise owners who are also owners of an organization or enterprise account that uses {% data variables.product.prodname_ghe_cloud %} can enable {% data variables.product.prodname_github_connect %}.
|
||||
|
||||
If you're connecting {% data variables.product.product_location %} to an organization on {% data variables.product.prodname_dotcom_the_website %} that is not owned by an enterprise account, you must enable {% data variables.product.prodname_github_connect %} with a personal account on {% data variables.product.prodname_dotcom_the_website %} that is an owner of the organization.
|
||||
If you're connecting {% data variables.product.product_location %} to an organization on {% data variables.product.prodname_ghe_cloud %} that is not owned by an enterprise account, you must sign into {% data variables.product.prodname_dotcom_the_website %} as an organization owner.
|
||||
|
||||
If you're connecting {% data variables.product.product_location %} to an organization on {% data variables.product.prodname_dotcom_the_website %} that is owned by an enterprise account or to an enterprise account itself, you must enable {% data variables.product.prodname_github_connect %} with a personal account on {% data variables.product.prodname_dotcom_the_website %} that is an owner of the enterprise account.
|
||||
If you're connecting {% data variables.product.product_location %} to an organization on {% data variables.product.prodname_ghe_cloud %} that is owned by an enterprise account or to an enterprise account itself, you must sign into {% data variables.product.prodname_dotcom_the_website %} as an enterprise owner.
|
||||
|
||||
{% ifversion ghes %}
|
||||
1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}.
|
||||
@@ -4,6 +4,7 @@ intro: 'You can give users easy access to enterprise-specific links by adding cu
|
||||
versions:
|
||||
ghec: '*'
|
||||
ghes: '>=3.4'
|
||||
ghae: 'issue-5487'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
@@ -14,7 +15,7 @@ Enterprise owners can configure {% data variables.product.product_name %} to sho
|
||||
|
||||

|
||||
|
||||
The custom footer is displayed above the {% data variables.product.prodname_dotcom %} footer {% ifversion ghes or ghae %}to all users, on all pages of {% data variables.product.product_name %}{% else %}to all enterprise members and collaborators, on all repository and organization pages for repositories and organizations that belong to the enterprise{% endif %}.
|
||||
The custom footer is displayed above the {% data variables.product.prodname_dotcom %} footer {% ifversion ghes or ghae %}to all users, on all pages of {% data variables.product.product_name %}{% elsif ghec %}to all enterprise members and collaborators, on all repository and organization pages for repositories and organizations that belong to the enterprise{% endif %}.
|
||||
|
||||
## Configuring custom footers for your enterprise
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ topics:
|
||||
children:
|
||||
- /configuring-your-enterprise
|
||||
- /configuring-network-settings
|
||||
- /managing-connections-between-your-enterprise-accounts
|
||||
- /configuring-github-connect
|
||||
---
|
||||
{% ifversion ghes %}
|
||||
{% note %}
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
title: Enabling unified search between your enterprise account and GitHub.com
|
||||
shortTitle: Enable unified search
|
||||
intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow search of {% data variables.product.prodname_dotcom_the_website %} for members of your enterprise on {% data variables.product.product_name %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-and-github-com
|
||||
- /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-server-and-github-com
|
||||
- /enterprise/admin/developer-workflow/enabling-unified-search-between-github-enterprise-server-and-githubcom
|
||||
- /enterprise/admin/installation/enabling-unified-search-between-github-enterprise-server-and-githubcom
|
||||
- /enterprise/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom
|
||||
- /admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom
|
||||
- /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-unified-search-between-github-enterprise-server-and-githubcom
|
||||
permissions: 'Enterprise owners who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified search between {% data variables.product.product_name %} and {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
- GitHub Connect
|
||||
- GitHub search
|
||||
---
|
||||
|
||||
{% data reusables.github-connect.beta %}
|
||||
|
||||
When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location %}{% ifversion ghae %} on {% data variables.product.prodname_ghe_managed %}{% endif %}.
|
||||
|
||||
After you enable unified search for {% data variables.product.product_location %}, individual users must also connect their user accounts on {% data variables.product.product_name %} with their user accounts on {% data variables.product.prodname_dotcom_the_website %} in order to see search results from {% data variables.product.prodname_dotcom_the_website %} on {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_dotcom_the_website %} repository search in your private enterprise account](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)."
|
||||
|
||||
Users will not be able to search {% data variables.product.product_location %} from {% data variables.product.prodname_dotcom_the_website %}, even if they have access to both environments. Users can only search private repositories you've enabled {% data variables.product.prodname_unified_search %} for and that they have access to in the connected {% data variables.product.prodname_ghe_cloud %} organizations. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)."
|
||||
|
||||
Searching via the REST and GraphQL APIs does not include {% data variables.product.prodname_dotcom_the_website %} search results. Advanced search and searching for wikis in {% data variables.product.prodname_dotcom_the_website %} are not supported.
|
||||
|
||||
{% ifversion ghes %}
|
||||
{% data reusables.github-connect.access-dotcom-and-enterprise %}
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.business %}
|
||||
{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %}
|
||||
1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}.
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %}
|
||||
1. Under "Users can search {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**.
|
||||

|
||||
1. Optionally, under "Users can search private repositories on {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**.
|
||||

|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)"
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
---
|
||||
title: Managing connections between your enterprise accounts
|
||||
intro: 'With {% data variables.product.prodname_github_connect %}, you can share certain features and data between {% data variables.product.product_location %} and your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account on {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/developer-workflow/connecting-github-enterprise-to-github-com
|
||||
- /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-and-github-com
|
||||
- /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-server-and-github-com
|
||||
- /enterprise/admin/developer-workflow/connecting-github-enterprise-server-and-githubcom
|
||||
- /enterprise/admin/installation/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
- /enterprise/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
- /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
children:
|
||||
- /connecting-your-enterprise-account-to-github-enterprise-cloud
|
||||
- /enabling-unified-search-between-your-enterprise-account-and-githubcom
|
||||
- /enabling-unified-contributions-between-your-enterprise-account-and-githubcom
|
||||
- /enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account
|
||||
- /enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
shortTitle: Connect enterprise accounts
|
||||
---
|
||||
|
||||
@@ -14,7 +14,7 @@ If you have teams and CI farms located around the world, you may experience redu
|
||||
|
||||
A repository cache eliminates the need for {% data variables.product.product_name %} to transmit the same Git data over a long-haul network link multiple times to serve multiple clients, by serving your repository data close to CI farms and distributed teams. For instance, if your primary instance is in North America and you also have a large presence in Asia, you will benefit from setting up the repository cache in Asia for use by CI runners there.
|
||||
|
||||
The repository cache listens to the primary instance, whether that's a single instance or a geo-replicated set of instances, for changes to Git data. CI farms and other read-heavy consumers clone and fetch from the repository cache instead of the primary instance. Changes are propagated across the network, at periodic intervals, once per cache instance rather than once per client. Git data will typically be visible on the repository cache within several minutes after the data is pushed to the primary instance.
|
||||
The repository cache listens to the primary instance, whether that's a single instance or a geo-replicated set of instances, for changes to Git data. CI farms and other read-heavy consumers clone and fetch from the repository cache instead of the primary instance. Changes are propagated across the network, at periodic intervals, once per cache instance rather than once per client. Git data will typically be visible on the repository cache within several minutes after the data is pushed to the primary instance. {% ifversion ghes > 3.3 %}The [`cache_sync` webhook](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#cache_sync) can be used by CI systems to react to data being available in the cache.{% endif %}
|
||||
|
||||
You have fine-grained control over which repositories are allowed to sync to the repository cache.
|
||||
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
---
|
||||
title: 'Working with {% data variables.contact.github_support %}'
|
||||
intro: 'Learn how to open a ticket and provide the {% data variables.contact.enterprise_support %} team with the information they need to resolve your issues.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/enterprise-support
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
topics:
|
||||
- Enterprise
|
||||
children:
|
||||
- /overview
|
||||
- /receiving-help-from-github-support
|
||||
shortTitle: Working with support
|
||||
---
|
||||
|
||||
@@ -1,110 +0,0 @@
|
||||
---
|
||||
title: About GitHub Enterprise Support
|
||||
intro: '{% data variables.contact.github_support %} can help you troubleshoot issues that arise on {% data variables.product.product_name %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/enterprise-support/about-github-enterprise-support
|
||||
- /admin/enterprise-support/about-github-enterprise-support
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- Enterprise
|
||||
- Support
|
||||
shortTitle: GitHub Enterprise Support
|
||||
---
|
||||
{% note %}
|
||||
|
||||
**Note**: {% data reusables.support.data-protection-and-privacy %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## About {% data variables.contact.enterprise_support %}
|
||||
|
||||
{% data variables.product.product_name %} includes {% data variables.contact.enterprise_support %} in English{% ifversion ghes %} and Japanese{% endif %}.
|
||||
|
||||
{% ifversion ghes %}
|
||||
You can contact {% data variables.contact.enterprise_support %} through {% data variables.contact.contact_enterprise_portal %} for help with:
|
||||
- Installing and using {% data variables.product.product_name %}
|
||||
- Identifying and verifying the causes of suspected errors
|
||||
|
||||
In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.contact.premium_support %} support for {% data variables.product.product_name %} offers:
|
||||
- Written support through our support portal 24 hours per day, 7 days per week
|
||||
- Phone support 24 hours per day, 7 days per week
|
||||
- A Service Level Agreement (SLA) with guaranteed initial response times
|
||||
- Customer Reliability Engineers
|
||||
- Access to premium content
|
||||
- Scheduled health checks
|
||||
- Managed Admin hours
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes %}
|
||||
For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.support.scope-of-support %}
|
||||
|
||||
## Contacting {% data variables.contact.enterprise_support %}
|
||||
|
||||
{% ifversion ghes %}
|
||||
{% data reusables.support.zendesk-old-tickets %}
|
||||
{% endif %}
|
||||
|
||||
|
||||
You can contact {% data variables.contact.enterprise_support %} through {% ifversion ghes %}{% data variables.contact.contact_enterprise_portal %}{% elsif ghae %} the {% data variables.contact.ae_azure_portal %}{% endif %} to report issues in writing. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)."
|
||||
|
||||
{% ifversion ghes %}
|
||||
## Hours of operation
|
||||
|
||||
### Support in English
|
||||
|
||||
For standard non-urgent issues, we offer support in English 24 hours per day, 5 days per week, excluding weekends and national U.S. holidays. The standard response time is 24 hours.
|
||||
|
||||
For urgent issues, we are available 24 hours per day, 7 days per week, even during national U.S. holidays.
|
||||
|
||||
### Support in Japanese
|
||||
|
||||
For non-urgent issues, support in Japanese is available Monday through Friday from 9:00 AM to 5:00 PM JST, excluding national holidays in Japan. For urgent issues, we offer support in English 24 hours per day, 7 days per week, even during national U.S. holidays.
|
||||
|
||||
For a complete list of U.S. and Japanese national holidays observed by {% data variables.contact.enterprise_support %}, see "[Holiday schedules](#holiday-schedules)."
|
||||
|
||||
## Holiday schedules
|
||||
|
||||
For urgent issues, we can help you in English 24 hours per day, 7 days per week, including on U.S. and Japanese holidays.
|
||||
|
||||
### Holidays in the United States
|
||||
|
||||
{% data variables.contact.enterprise_support %} observes these U.S. holidays, although our global support team is available to answer urgent tickets.
|
||||
|
||||
{% data reusables.enterprise_enterprise_support.support-holiday-availability %}
|
||||
|
||||
### Holidays in Japan
|
||||
|
||||
{% data variables.contact.enterprise_support %} does not provide Japanese-language support on December 28th through January 3rd as well as on the holidays listed in [国民の祝日について - 内閣府](https://www8.cao.go.jp/chosei/shukujitsu/gaiyou.html).
|
||||
|
||||
{% data reusables.enterprise_enterprise_support.installing-releases %}
|
||||
{% endif %}
|
||||
|
||||
## Assigning a priority to a support ticket
|
||||
|
||||
When you contact {% data variables.contact.enterprise_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}.
|
||||
|
||||
{% data reusables.support.github-can-modify-ticket-priority %}
|
||||
|
||||
{% ifversion ghes %}
|
||||
{% data reusables.support.ghes-priorities %}
|
||||
{% elsif ghae %}
|
||||
{% data reusables.support.ghae-priorities %}
|
||||
{% endif %}
|
||||
|
||||
## Resolving and closing support tickets
|
||||
|
||||
{% data reusables.support.enterprise-resolving-and-closing-tickets %}
|
||||
|
||||
## Further reading
|
||||
|
||||
{% ifversion ghes %}
|
||||
- Section 10 on Support in the "[{% data variables.product.prodname_ghe_server %} License Agreement](https://enterprise.github.com/license)"{% endif %}
|
||||
- "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)"{% ifversion ghes %}
|
||||
- "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)"{% endif %}
|
||||
- "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)"
|
||||
@@ -1,71 +0,0 @@
|
||||
---
|
||||
title: About GitHub Premium Support for GitHub Enterprise Server
|
||||
intro: '{% data variables.contact.premium_support %} is a paid, supplemental support offering for {% data variables.product.prodname_enterprise %} customers.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/enterprise-support/about-premium-support-for-github-enterprise
|
||||
- /enterprise/admin/guides/enterprise-support/about-premium-support
|
||||
- /enterprise/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server
|
||||
- /admin/enterprise-support/about-github-premium-support-for-github-enterprise-server
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- Enterprise
|
||||
- Support
|
||||
shortTitle: Premium Support for GHES
|
||||
---
|
||||
{% note %}
|
||||
|
||||
**Notes:**
|
||||
|
||||
- The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of September 2018. If you purchased {% data variables.contact.premium_support %} prior to September 17, 2018, your plan might be different. Contact {% data variables.contact.premium_support %} for more details.
|
||||
|
||||
- {% data reusables.support.data-protection-and-privacy %}
|
||||
|
||||
- This article contains the terms of {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %} customers. The terms may be different for customers of {% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_enterprise %} customers who purchase {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} together. For more information, see "<a href="/articles/about-github-premium-support-for-github-enterprise-cloud" class="dotcom-only">About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %}</a>" and "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_enterprise %}](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## About {% data variables.contact.premium_support %}
|
||||
|
||||
In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.contact.premium_support %} offers:
|
||||
- Written support, in English, through our support portal 24 hours per day, 7 days per week
|
||||
- Phone support, in English, 24 hours per day, 7 days per week
|
||||
- A Service Level Agreement (SLA) with guaranteed initial response times
|
||||
- Access to premium content
|
||||
- Scheduled health checks
|
||||
- Managed services
|
||||
|
||||
{% data reusables.support.about-premium-plans %}
|
||||
|
||||
{% data reusables.support.signing-up-for-premium-support %}
|
||||
|
||||
{% data reusables.support.scope-of-support %}
|
||||
|
||||
{% data reusables.support.contacting-premium-support %}
|
||||
|
||||
## Hours of operation
|
||||
|
||||
{% data variables.contact.premium_support %} is available 24 hours a day, 7 days per week. If you purchased {% data variables.contact.premium_support %} prior to September 17, 2018, support is limited during holidays. For more information on holidays {% data variables.contact.premium_support %} observes, see the holiday schedule at "[About {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)."
|
||||
|
||||
{% data reusables.support.service-level-agreement-response-times %}
|
||||
|
||||
{% data reusables.enterprise_enterprise_support.installing-releases %}
|
||||
|
||||
You must install the minimum supported version of {% data variables.product.prodname_ghe_server %} pursuant to the Supported Releases section of your applicable license agreement within 90 days of placing an order for {% data variables.contact.premium_support %}.
|
||||
|
||||
## Assigning a priority to a support ticket
|
||||
|
||||
When you contact {% data variables.contact.premium_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}.
|
||||
|
||||
{% data reusables.support.github-can-modify-ticket-priority %}
|
||||
|
||||
{% data reusables.support.ghes-priorities %}
|
||||
|
||||
## Resolving and closing support tickets
|
||||
|
||||
{% data reusables.support.premium-resolving-and-closing-tickets %}
|
||||
|
||||
{% data reusables.support.receiving-credits %}
|
||||
|
||||
{% data reusables.support.accessing-premium-content %}
|
||||
@@ -1,76 +0,0 @@
|
||||
---
|
||||
title: About GitHub Premium Support for GitHub Enterprise
|
||||
intro: '{% data variables.contact.premium_support %} is a paid, supplemental support offering for {% data variables.product.prodname_enterprise %} customers.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/enterprise-support/about-github-premium-support-for-github-enterprise
|
||||
- /admin/enterprise-support/about-github-premium-support-for-github-enterprise
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- Enterprise
|
||||
- Support
|
||||
shortTitle: Premium Support for Enterprise
|
||||
---
|
||||
{% note %}
|
||||
|
||||
**Notes:**
|
||||
|
||||
- The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of July 2019.
|
||||
|
||||
- {% data reusables.support.data-protection-and-privacy %}
|
||||
|
||||
- This article contains the terms of {% data variables.contact.premium_support %} for {% data variables.product.prodname_enterprise %} customers who purchase {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} together. The terms of {% data variables.contact.premium_support %} may be different for customers who purchase either product separately. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)" and "<a href="/articles/about-github-premium-support-for-github-enterprise-cloud" class="dotcom-only">About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_cloud %}</a>."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## About {% data variables.contact.premium_support %}
|
||||
|
||||
In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.contact.premium_support %} offers:
|
||||
- Written support, in English, through our support portal 24 hours per day, 7 days per week
|
||||
- Phone support, in English, 24 hours per day, 7 days per week
|
||||
- A Service Level Agreement (SLA) with guaranteed initial response times
|
||||
- Access to premium content
|
||||
- Scheduled health checks
|
||||
- Managed services
|
||||
|
||||
{% data reusables.support.about-premium-plans %}
|
||||
|
||||
{% data reusables.support.signing-up-for-premium-support %}
|
||||
|
||||
{% data reusables.support.scope-of-support %}
|
||||
|
||||
{% data reusables.support.contacting-premium-support %}
|
||||
|
||||
## Hours of operation
|
||||
|
||||
{% data variables.contact.premium_support %} is available 24 hours a day, 7 days per week.
|
||||
|
||||
{% data reusables.support.service-level-agreement-response-times %}
|
||||
|
||||
{% data reusables.enterprise_enterprise_support.installing-releases %}
|
||||
|
||||
You must install the minimum supported version of {% data variables.product.prodname_ghe_server %} pursuant to the Supported Releases section of your applicable license agreement within 90 days of placing an order for {% data variables.contact.premium_support %}.
|
||||
|
||||
## Assigning a priority to a support ticket
|
||||
|
||||
When you contact {% data variables.contact.premium_support %}, you can choose one of four priorities for the ticket: {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}.
|
||||
|
||||
- [Ticket priorities for {% data variables.product.prodname_ghe_cloud %}](#ticket-priorities-for-github-enterprise-cloud)
|
||||
- [Ticket priorities for {% data variables.product.prodname_ghe_server %}](#ticket-priorities-for-github-enterprise-server)
|
||||
|
||||
### Ticket priorities for {% data variables.product.prodname_ghe_cloud %}
|
||||
|
||||
{% data reusables.support.ghec-premium-priorities %}
|
||||
|
||||
### Ticket priorities for {% data variables.product.prodname_ghe_server %}
|
||||
|
||||
{% data reusables.support.ghes-priorities %}
|
||||
|
||||
## Resolving and closing support tickets
|
||||
|
||||
{% data reusables.support.premium-resolving-and-closing-tickets %}
|
||||
|
||||
{% data reusables.support.receiving-credits %}
|
||||
|
||||
{% data reusables.support.accessing-premium-content %}
|
||||
@@ -1,76 +0,0 @@
|
||||
---
|
||||
title: About support for Advanced Security
|
||||
intro: '{% data variables.contact.enterprise_support %} can help you troubleshoot issues you run into while using {% data variables.product.prodname_advanced_security %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/enterprise-support/about-support-for-advanced-security
|
||||
- /admin/enterprise-support/about-support-for-advanced-security
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- Enterprise
|
||||
- Support
|
||||
shortTitle: Support for Advanced Security
|
||||
---
|
||||
{% note %}
|
||||
|
||||
**Note**: {% data reusables.support.data-protection-and-privacy %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## About support for {% data variables.product.prodname_advanced_security %}
|
||||
|
||||
{% data variables.product.prodname_advanced_security %} includes {% data variables.contact.enterprise_support %} in English, by email.
|
||||
|
||||
## Scope of support
|
||||
|
||||
If your support request is outside of the scope of what our team can help you with, we may recommend next steps to resolve your issue outside of {% data variables.contact.enterprise_support %}. Your support request is possibly out of {% data variables.contact.enterprise_support %}'s scope if it's primarily about:
|
||||
- Third party integrations
|
||||
- Hardware setup
|
||||
- Configuration of external systems
|
||||
- Open source projects
|
||||
- Building projects or repositories
|
||||
- LGTM cluster design
|
||||
- Writing or debugging new queries for {% data variables.product.prodname_codeql %}
|
||||
|
||||
If you're uncertain if the issue is out of scope, open a ticket and we're happy to help you determine the best way to proceed.
|
||||
|
||||
## Contacting {% data variables.contact.enterprise_support %}
|
||||
|
||||
{% data reusables.support.zendesk-old-tickets %}
|
||||
|
||||
You can contact {% data variables.contact.enterprise_support %} through the {% data variables.contact.contact_enterprise_portal %} for help with:
|
||||
- Installing and using {% data variables.product.prodname_advanced_security %}
|
||||
- Identifying and verifying the causes of supported errors
|
||||
|
||||
## Hours of operation
|
||||
|
||||
We offer support for {% data variables.product.prodname_advanced_security %} in English 24 hours per day, 5 days per week, excluding weekends and national U.S. holidays. The standard response time is 1 business day.
|
||||
|
||||
## Holiday schedule
|
||||
|
||||
{% data variables.contact.enterprise_support %} observes these U.S. holidays.
|
||||
|
||||
|
||||
{% data reusables.enterprise_enterprise_support.support-holiday-availability %}
|
||||
|
||||
|
||||
## Installing {% data variables.product.prodname_advanced_security %} updates
|
||||
|
||||
To ensure that your {% data variables.product.prodname_advanced_security %} instance is stable, you must install and implement new releases when they are made available. This ensures that you have the latest features, modifications, and enhancements as well as any updates to features, code corrections, patches, or other general updates and fixes to {% data variables.product.prodname_advanced_security %}.
|
||||
|
||||
## Assigning a priority to a support ticket
|
||||
|
||||
When you contact {% data variables.contact.enterprise_support %} for help with {% data variables.product.prodname_advanced_security %}, you can choose one of three priorities for the ticket: {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}.
|
||||
|
||||
{% data reusables.support.github-can-modify-ticket-priority %}
|
||||
|
||||
| Priority | Description |
|
||||
| :---: | --- |
|
||||
| {% data variables.product.support_ticket_priority_high %} | {% data variables.product.prodname_advanced_security %} is not functioning or is stopped or severely impacted such that the end user cannot reasonably continue use of the software and no workaround is available. |
|
||||
| {% data variables.product.support_ticket_priority_normal %} | {% data variables.product.prodname_advanced_security %} is functioning inconsistently, causing impaired end user usage and productivity. |
|
||||
| {% data variables.product.support_ticket_priority_low %} | {% data variables.product.prodname_advanced_security %} is functioning consistently, but the end user requests minor changes in the software, such as documentation updates, cosmetic defects, or enhancements.|
|
||||
|
||||
## Resolving and closing support tickets
|
||||
|
||||
{% data reusables.support.enterprise-resolving-and-closing-tickets %}
|
||||
@@ -1,17 +0,0 @@
|
||||
---
|
||||
title: Overview
|
||||
intro: 'Learn about the support options available for {% data variables.product.product_name %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/enterprise-support/overview
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
topics:
|
||||
- Enterprise
|
||||
children:
|
||||
- /about-github-enterprise-support
|
||||
- /about-github-premium-support-for-github-enterprise-server
|
||||
- /about-github-premium-support-for-github-enterprise
|
||||
- /about-support-for-advanced-security
|
||||
---
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
---
|
||||
title: Receiving help from GitHub Support
|
||||
intro: 'You can contact {% data variables.contact.enterprise_support %} to report a range of issues for your enterprise.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/enterprise-support/receiving-help-from-github-enterprise-support
|
||||
- /enterprise/admin/enterprise-support/receiving-help-from-github-support
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
topics:
|
||||
- Enterprise
|
||||
children:
|
||||
- /reaching-github-support
|
||||
- /preparing-to-submit-a-ticket
|
||||
- /submitting-a-ticket
|
||||
- /providing-data-to-github-support
|
||||
shortTitle: Receive help from Support
|
||||
---
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
---
|
||||
title: Preparing to submit a ticket
|
||||
intro: 'You can expedite your issue with {% data variables.contact.enterprise_support %} by following these suggestions before you open a support ticket.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/enterprise-support/preparing-to-submit-a-ticket
|
||||
- /admin/enterprise-support/preparing-to-submit-a-ticket
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
- Support
|
||||
shortTitle: Prepare a ticket
|
||||
---
|
||||
Before submitting a ticket, you should:
|
||||
|
||||
- Obtain information that can help {% data variables.contact.github_support %} track, prioritize, reproduce, or investigate the issue.
|
||||
- Reproduce the issue if applicable and be prepared to share the steps.
|
||||
- Be prepared to provide a full description of the issue and expected results.
|
||||
- Copy exact wording of all error messages related to your issue.
|
||||
- Determine if there is an existing ticket number in any ongoing communications with {% data variables.contact.github_support %}.
|
||||
- Determine the best person to contact {% data variables.contact.github_support %}.
|
||||
|
||||
## Choosing a contact person
|
||||
|
||||
Especially for tickets with {% data variables.product.support_ticket_priority_urgent %} priority, the person contacting {% data variables.contact.github_support %} should:
|
||||
|
||||
- Be knowledgeable in your internal systems, tools, policies, and practices.
|
||||
- Be a proficient user of {% data variables.product.product_name %}.
|
||||
- Have full access and permissions to any services that are required to troubleshoot the issue.
|
||||
- Be authorized to make the recommended changes to your network and any applicable products.
|
||||
@@ -1,160 +0,0 @@
|
||||
---
|
||||
title: Providing data to GitHub Support
|
||||
intro: 'Since {% data variables.contact.github_support %} doesn''t have access to your environment, we require some additional information from you.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/installation/troubleshooting
|
||||
- /enterprise/admin/articles/support-bundles
|
||||
- /enterprise/admin/guides/enterprise-support/providing-data-to-github-enterprise-support
|
||||
- /enterprise/admin/enterprise-support/providing-data-to-github-support
|
||||
- /admin/enterprise-support/providing-data-to-github-support
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
- Support
|
||||
shortTitle: Provide data to Support
|
||||
---
|
||||
## Creating and sharing diagnostic files
|
||||
|
||||
Diagnostics are an overview of a {% data variables.product.prodname_ghe_server %} instance's settings and environment that contains:
|
||||
|
||||
- Client license information, including company name, expiration date, and number of user licenses
|
||||
- Version numbers and SHAs
|
||||
- VM architecture
|
||||
- Host name, private mode, SSL settings
|
||||
- Load and process listings
|
||||
- Network settings
|
||||
- Authentication method and details
|
||||
- Number of repositories, users, and other installation data
|
||||
|
||||
You can download the diagnostics for your instance from the {% data variables.enterprise.management_console %} or by running the `ghe-diagnostics` command-line utility.
|
||||
|
||||
### Creating a diagnostic file from the {% data variables.enterprise.management_console %}
|
||||
|
||||
You can use this method if you don't have your SSH key readily available.
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_management_console.type-management-console-password %}
|
||||
{% data reusables.enterprise_management_console.support-link %}
|
||||
5. Click **Download diagnostics info**.
|
||||
|
||||
### Creating a diagnostic file using SSH
|
||||
|
||||
You can use this method without signing into the {% data variables.enterprise.management_console %}.
|
||||
|
||||
Use the [ghe-diagnostics](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-diagnostics) command-line utility to retrieve the diagnostics for your instance.
|
||||
|
||||
```shell
|
||||
$ ssh -p122 admin@<em>hostname</em> -- 'ghe-diagnostics' > diagnostics.txt
|
||||
```
|
||||
|
||||
## Creating and sharing support bundles
|
||||
|
||||
After you submit your support request, we may ask you to share a support bundle with our team. The support bundle is a gzip-compressed tar archive that includes diagnostics and important logs from your instance, such as:
|
||||
|
||||
- Authentication-related logs that may be helpful when troubleshooting authentication errors, or configuring LDAP, CAS, or SAML
|
||||
- {% data variables.enterprise.management_console %} log
|
||||
- `github-logs/exceptions.log`: Information about 500 errors encountered on the site
|
||||
- `github-logs/audit.log`: {% data variables.product.prodname_ghe_server %} audit logs
|
||||
- `babeld-logs/babeld.log`: Git proxy logs
|
||||
- `system-logs/haproxy.log`: HAProxy logs
|
||||
- `elasticsearch-logs/github-enterprise.log`: Elasticsearch logs
|
||||
- `configuration-logs/ghe-config.log`: {% data variables.product.prodname_ghe_server %} configuration logs
|
||||
- `collectd/logs/collectd.log`: Collectd logs
|
||||
- `mail-logs/mail.log`: SMTP email delivery logs
|
||||
|
||||
For more information, see "[Audit logging](/enterprise/{{ currentVersion }}/admin/guides/installation/audit-logging)."
|
||||
|
||||
Support bundles include logs from the past two days. To get logs from the past seven days, you can download an extended support bundle. For more information, see "[Creating and sharing extended support bundles](#creating-and-sharing-extended-support-bundles)."
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** When you contact {% data variables.contact.github_support %}, you'll be sent a confirmation email that will contain a ticket reference link. If {% data variables.contact.github_support %} asks you to upload a support bundle, you can use the ticket reference link to upload the support bundle.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
### Creating a support bundle from the {% data variables.enterprise.management_console %}
|
||||
|
||||
You can use these steps to create and share a support bundle if you can access the web-based {% data variables.enterprise.management_console %} and have outbound internet access.
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_management_console.type-management-console-password %}
|
||||
{% data reusables.enterprise_management_console.support-link %}
|
||||
5. Click **Download support bundle**.
|
||||
{% data reusables.enterprise_enterprise_support.sign-in-to-support %}
|
||||
{% data reusables.enterprise_enterprise_support.upload-support-bundle %}
|
||||
|
||||
### Creating a support bundle using SSH
|
||||
|
||||
You can use these steps to create and share a support bundle if you have SSH access to {% data variables.product.product_location %} and have outbound internet access.
|
||||
|
||||
{% data reusables.enterprise_enterprise_support.use_ghe_cluster_support_bundle %}
|
||||
|
||||
1. Download the support bundle via SSH:
|
||||
```shell
|
||||
$ ssh -p 122 admin@<em>hostname</em> -- 'ghe-support-bundle -o' > support-bundle.tgz
|
||||
```
|
||||
For more information about the `ghe-support-bundle` command, see "[Command-line utilities](/enterprise/admin/guides/installation/command-line-utilities#ghe-support-bundle)".
|
||||
{% data reusables.enterprise_enterprise_support.sign-in-to-support %}
|
||||
{% data reusables.enterprise_enterprise_support.upload-support-bundle %}
|
||||
|
||||
### Uploading a support bundle using your enterprise account
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
3. In the left sidebar, click **Enterprise licensing**.
|
||||

|
||||
4. Under "{% data variables.product.prodname_enterprise %} Help", click **Upload a support bundle**.
|
||||

|
||||
5. Under "Select an enterprise account", select the support bundle's associated account from the drop-down menu.
|
||||

|
||||
6. Under "Upload a support bundle for {% data variables.contact.enterprise_support %}", to select your support bundle, click **Choose file**, or drag your support bundle file onto **Choose file**.
|
||||

|
||||
7. Click **Upload**.
|
||||
|
||||
### Uploading a support bundle directly using SSH
|
||||
|
||||
You can directly upload a support bundle to our server if:
|
||||
- You have SSH access to {% data variables.product.product_location %}.
|
||||
- Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.product.product_location %} to _enterprise-bundles.github.com_ and _esbtoolsproduction.blob.core.windows.net_.
|
||||
|
||||
1. Upload the bundle to our support bundle server:
|
||||
```shell
|
||||
$ ssh -p122 admin@<em>hostname</em> -- 'ghe-support-bundle -u'
|
||||
```
|
||||
|
||||
## Creating and sharing extended support bundles
|
||||
|
||||
Support bundles include logs from the past two days, while _extended_ support bundles include logs from the past seven days. If the events that {% data variables.contact.github_support %} is investigating occurred more than two days ago, we may ask you to share an extended support bundle. You will need SSH access to download an extended bundle - you cannot download an extended bundle from the {% data variables.enterprise.management_console %}.
|
||||
|
||||
To prevent bundles from becoming too large, bundles only contain logs that haven't been rotated and compressed. Log rotation on {% data variables.product.prodname_ghe_server %} happens at various frequencies (daily or weekly) for different log files, depending on how large we expect the logs to be.
|
||||
|
||||
### Creating an extended support bundle using SSH
|
||||
|
||||
You can use these steps to create and share an extended support bundle if you have SSH access to {% data variables.product.product_location %} and you have outbound internet access.
|
||||
|
||||
1. Download the extended support bundle via SSH by adding the `-x` flag to the `ghe-support-bundle` command:
|
||||
```shell
|
||||
$ ssh -p 122 admin@<em>hostname</em> -- 'ghe-support-bundle -o -x' > support-bundle.tgz
|
||||
```
|
||||
{% data reusables.enterprise_enterprise_support.sign-in-to-support %}
|
||||
{% data reusables.enterprise_enterprise_support.upload-support-bundle %}
|
||||
|
||||
### Uploading an extended support bundle directly using SSH
|
||||
|
||||
You can directly upload a support bundle to our server if:
|
||||
- You have SSH access to {% data variables.product.product_location %}.
|
||||
- Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.product.product_location %} to _enterprise-bundles.github.com_ and _esbtoolsproduction.blob.core.windows.net_.
|
||||
|
||||
1. Upload the bundle to our support bundle server:
|
||||
```shell
|
||||
$ ssh -p122 admin@<em>hostname</em> -- 'ghe-support-bundle -u -x'
|
||||
```
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)"
|
||||
- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."
|
||||
@@ -1,58 +0,0 @@
|
||||
---
|
||||
title: Reaching GitHub Support
|
||||
intro: 'Contact {% data variables.contact.enterprise_support %} using the {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or{% endif %} the support portal.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/enterprise-support/reaching-github-enterprise-support
|
||||
- /enterprise/admin/enterprise-support/reaching-github-support
|
||||
- /admin/enterprise-support/reaching-github-support
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
- Support
|
||||
---
|
||||
## Using automated ticketing systems
|
||||
|
||||
Though we'll do our best to respond to automated support requests, we typically need more information than an automated ticketing system can give us to solve your issue. Whenever possible, please initiate support requests from a person or machine that {% data variables.contact.enterprise_support %} can interact with. For more information, see "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)."
|
||||
|
||||
## Contacting {% data variables.contact.enterprise_support %}
|
||||
|
||||
{% data reusables.support.zendesk-old-tickets %}
|
||||
|
||||
{% data variables.contact.enterprise_support %} customers can open a support ticket using the {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the {% data variables.contact.contact_enterprise_portal %}{% elsif ghae %} the {% data variables.contact.contact_ae_portal %}{% endif %}. For more information, see "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)."
|
||||
|
||||
{% ifversion ghes %}
|
||||
|
||||
## Contacting {% data variables.contact.premium_support %}
|
||||
|
||||
{% data variables.contact.enterprise_support %} customers can open a support ticket using the {% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the {% data variables.contact.contact_enterprise_portal %}. Mark its priority as {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. For more information, see "[Assigning a priority to a support ticket](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server#assigning-a-priority-to-a-support-ticket)" and "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)."
|
||||
|
||||
### Viewing past support tickets
|
||||
|
||||
You can use the {% data variables.contact.enterprise_portal %} to view past support tickets.
|
||||
|
||||
1. Navigate to the {% data variables.contact.contact_enterprise_portal %}.
|
||||
2. Click **My tickets**.
|
||||
|
||||
{% endif %}
|
||||
## Contacting sales
|
||||
|
||||
For pricing, licensing, renewals, quotes, payments, and other related questions, contact {% data variables.contact.contact_enterprise_sales %} or call [+1 (877) 448-4820](tel:+1-877-448-4820).
|
||||
|
||||
{% ifversion ghes %}
|
||||
## Contacting training
|
||||
|
||||
To learn more about training options, including customized trainings, see [{% data variables.product.company_short %}'s training site](https://services.github.com/).
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Training is included in the {% data variables.product.premium_plus_support_plan %}. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)"
|
||||
- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."
|
||||
@@ -1,76 +0,0 @@
|
||||
---
|
||||
title: Submitting a ticket
|
||||
intro: 'You can submit a support ticket using {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the support portal{% elsif ghae %}{% data variables.contact.ae_azure_portal %}{% endif %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/enterprise-support/submitting-a-ticket
|
||||
- /admin/enterprise-support/submitting-a-ticket
|
||||
versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
- Support
|
||||
---
|
||||
## About submitting a ticket
|
||||
|
||||
{% ifversion ghae %}
|
||||
|
||||
You can submit a ticket for support with {% data variables.product.prodname_ghe_managed %} from the {% data variables.contact.ae_azure_portal %}.
|
||||
|
||||
{% endif %}
|
||||
|
||||
Before submitting a ticket, you should gather helpful information for {% data variables.contact.github_support %} and choose a contact person. For more information, see "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)."
|
||||
|
||||
{% ifversion ghes %}
|
||||
After submitting your support request and optional diagnostic information, {% data variables.contact.github_support %} may ask you to download and share a support bundle with us. For more information, see "[Providing data to {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support)."
|
||||
|
||||
## Submitting a ticket using the {% data variables.contact.enterprise_portal %}
|
||||
|
||||
{% data reusables.support.zendesk-old-tickets %}
|
||||
|
||||
To submit a ticket about {% data variables.product.product_location_enterprise %}, you must be an owner, billing manager, or member with support entitlement. For more information, see "[Managing support entitlements for your enterprise](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)."
|
||||
|
||||
If you cannot sign in to your account on {% data variables.product.prodname_dotcom_the_website %} or do not have support entitlement, you can still submit a ticket by providing your license or a diagnostics file from your server.
|
||||
|
||||
1. Navigate to the {% data variables.contact.contact_support_portal %}.
|
||||
{% data reusables.support.submit-a-ticket %}
|
||||
|
||||
## Submitting a ticket using the {% data variables.product.product_name %} {% data variables.enterprise.management_console %}
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_management_console.type-management-console-password %}
|
||||
{% data reusables.enterprise_management_console.support-link %}
|
||||
5. If you'd like to include diagnostics with your support ticket, Under "Diagnostics", click **Download diagnostic info** and save the file locally. You'll attach this file to your support ticket later.
|
||||

|
||||
6. To complete your ticket and display the {% data variables.contact.enterprise_portal %}, under "Open Support Request", click **New support request**.
|
||||

|
||||
{% data reusables.support.submit-a-ticket %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghae %}
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To submit a ticket for {% data variables.product.prodname_ghe_managed %} in the {% data variables.contact.ae_azure_portal %}, you must provide the ID for your {% data variables.product.prodname_ghe_managed %} subscription in Azure to your Customer Success Account Manager (CSAM) at Microsoft.
|
||||
|
||||
## Submitting a ticket using the {% data variables.contact.ae_azure_portal %}
|
||||
|
||||
Commercial customers can submit a support request in the {% data variables.contact.contact_ae_portal %}. Government customers should use the [Azure portal for government customers](https://portal.azure.us/#blade/Microsoft_Azure_Support/HelpAndSupportBlade). For more information, see [Create an Azure support request](https://docs.microsoft.com/azure/azure-portal/supportability/how-to-create-azure-support-request) in the Microsoft Docs.
|
||||
|
||||
## Troubleshooting problems in the {% data variables.contact.ae_azure_portal %}
|
||||
|
||||
{% data variables.product.company_short %} is unable to troubleshoot access and subscription issues in the Azure portal. For help with the Azure portal, contact your CSAM at Microsoft or review the following information.
|
||||
|
||||
- If you cannot sign into the Azure portal, see [Troubleshoot Azure subscription sign-in issues](https://docs.microsoft.com/en-US/azure/cost-management-billing/manage/troubleshoot-sign-in-issue) in the Microsoft Docs or [submit a request directly](https://support.microsoft.com/en-us/supportrequestform/84faec50-2cbc-9b8a-6dc1-9dc40bf69178).
|
||||
|
||||
- If you can sign into the Azure portal but you cannot submit a ticket for {% data variables.product.prodname_ghe_managed %}, review the prerequisites for submitting a ticket. For more information, see "[Prerequisites](#prerequisites)".
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)"{% ifversion ghes %}
|
||||
- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."{% endif %}
|
||||
@@ -37,7 +37,7 @@ Both types of {% data variables.product.prodname_dependabot %} update have the f
|
||||
- Configure {% data variables.product.product_location %} to use {% data variables.product.prodname_actions %}. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for GitHub Enterprise Server](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)."
|
||||
- Set up one or more {% data variables.product.prodname_actions %} self-hosted runners for {% data variables.product.prodname_dependabot %}. For more information, see "[Setting up self-hosted runners for {% data variables.product.prodname_dependabot %} updates](#setting-up-self-hosted-runners-for-dependabot-updates)" below.
|
||||
|
||||
Additionally, {% data variables.product.prodname_dependabot_security_updates %} rely on the dependency graph, vulnerability data from {% data variables.product.prodname_github_connect %}, and {% data variables.product.prodname_dependabot_alerts %}. These features must be enabled on {% data variables.product.product_location %}. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} on your enterprise account](/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account)."
|
||||
Additionally, {% data variables.product.prodname_dependabot_security_updates %} rely on the dependency graph, vulnerability data from {% data variables.product.prodname_github_connect %}, and {% data variables.product.prodname_dependabot_alerts %}. These features must be enabled on {% data variables.product.product_location %}. For more information, see "[Enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-the-dependency-graph-and-dependabot-alerts-for-your-enterprise)."
|
||||
|
||||
## Setting up self-hosted runners for {% data variables.product.prodname_dependabot %} updates
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ Then,{% else %}First,{% endif %} decide whether you'll allow third-party actions
|
||||
|
||||

|
||||
|
||||
{% ifversion ghec or ghae-issue-4757-and-5856 %}
|
||||
{% ifversion ghec or ghae-issue-4757 %}
|
||||
Consider combining OpenID Connect (OIDC) with reusable workflows to enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. For more information, see "[Using OpenID Connect with reusable workflows](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows)."
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -53,11 +53,11 @@ includeGuides:
|
||||
- /admin/configuration/configuring-your-enterprise/managing-github-mobile-for-your-enterprise
|
||||
- /admin/configuration/connecting-your-enterprise-account-to-github-enterprise-cloud
|
||||
- /admin/configuration/enabling-and-scheduling-maintenance-mode
|
||||
- /admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud
|
||||
- /admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise
|
||||
- /admin/configuration/enabling-private-mode
|
||||
- /admin/configuration/enabling-subdomain-isolation
|
||||
- /admin/configuration/enabling-unified-contributions-between-your-enterprise-account-and-githubcom
|
||||
- /admin/configuration/enabling-unified-search-between-your-enterprise-account-and-githubcom
|
||||
- /admin/configuration/configuring-github-connect/enabling-unified-contributions-for-your-enterprise
|
||||
- /admin/configuration/configuring-github-connect/enabling-unified-search-for-your-enterprise
|
||||
- /admin/configuration/initializing-github-ae
|
||||
- /admin/configuration/network-ports
|
||||
- /admin/configuration/restricting-network-traffic-to-your-enterprise
|
||||
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /enterprise/admin/user-management/allowing-built-in-authentication-for-users-outside-your-identity-provider
|
||||
- /enterprise/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider
|
||||
- /admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider
|
||||
- /enterprise/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /enterprise/admin/user-management/changing-authentication-methods
|
||||
- /enterprise/admin/authentication/changing-authentication-methods
|
||||
- /admin/authentication/changing-authentication-methods
|
||||
- /enterprise/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/changing-authentication-methods
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: overview
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /enterprise/admin/user-management/disabling-unauthenticated-sign-ups
|
||||
- /enterprise/admin/authentication/disabling-unauthenticated-sign-ups
|
||||
- /admin/authentication/disabling-unauthenticated-sign-ups
|
||||
- /enterprise/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/disabling-unauthenticated-sign-ups
|
||||
intro: 'If you''re using built-in authentication, you can block unauthenticated people from being able to create an account.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /enterprise/admin/user-management/using-built-in-authentication
|
||||
- /enterprise/admin/authentication/using-built-in-authentication
|
||||
- /admin/authentication/using-built-in-authentication
|
||||
- /enterprise/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-built-in-authentication
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /enterprise/admin/user-management/using-cas
|
||||
- /enterprise/admin/authentication/using-cas
|
||||
- /admin/authentication/using-cas
|
||||
- /enterprise/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-cas
|
||||
intro: 'CAS is a single sign-on (SSO) protocol for multiple web applications. A CAS user account does not take up a {% ifversion ghes %}user license{% else %}seat{% endif %} until the user signs in.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
@@ -9,6 +9,7 @@ redirect_from:
|
||||
- /enterprise/admin/user-management/using-ldap
|
||||
- /enterprise/admin/authentication/using-ldap
|
||||
- /admin/authentication/using-ldap
|
||||
- /enterprise/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-ldap
|
||||
intro: 'LDAP lets you authenticate {% data variables.product.prodname_ghe_server %} against your existing accounts and centrally manage repository access. LDAP is a popular application protocol for accessing and maintaining directory information services, and is one of the most common protocols used to integrate third-party software with large company user directories.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
@@ -123,6 +124,8 @@ After you enable LDAP sync, a synchronization job will run at the specified time
|
||||
- If there is an LDAP mapping and the corresponding LDAP entry in the directory is missing, suspend the user and move on to the next user.
|
||||
- If the corresponding LDAP entry has been marked as disabled and the user is not already suspended, suspend the user and move on to the next user.
|
||||
- If the corresponding LDAP entry is not marked as disabled, and the user is suspended, and _Reactivate suspended users_ is enabled in the Admin Center, unsuspend the user.
|
||||
- If one or more restricted user groups are configured on the instance and the corresponding LDAP entry is not in one of these groups, suspend the user.
|
||||
- If one or more restricted user groups are configured on the instance, the corresponding LDAP entry is in one of these groups, and _Reactivate suspended users_ is enabled in the Admin Center, unsuspend the user.
|
||||
- If the corresponding LDAP entry includes a `name` attribute, update the user's profile name.
|
||||
- If the corresponding LDAP entry is in the Administrators group, promote the user to site administrator.
|
||||
- If the corresponding LDAP entry is not in the Administrators group, demote the user to a normal account.
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /enterprise/admin/user-management/using-saml
|
||||
- /enterprise/admin/authentication/using-saml
|
||||
- /admin/authentication/using-saml
|
||||
- /enterprise/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml
|
||||
intro: 'SAML is an XML-based standard for authentication and authorization. {% data variables.product.prodname_ghe_server %} can act as a service provider (SP) with your internal SAML identity provider (IdP).'
|
||||
versions:
|
||||
ghes: '*'
|
||||
@@ -14,6 +14,7 @@ topics:
|
||||
- SSO
|
||||
redirect_from:
|
||||
- /admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad
|
||||
- /admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad
|
||||
---
|
||||
## About authentication and user provisioning with Azure AD
|
||||
|
||||
@@ -5,6 +5,8 @@ intro: 'You can use Okta as an identity provider (IdP) to centrally manage authe
|
||||
permissions: 'Enterprise owners can configure authentication and provisioning for {% data variables.product.prodname_ghe_managed %}.'
|
||||
versions:
|
||||
ghae: '*'
|
||||
redirect_from:
|
||||
- /admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-okta
|
||||
type: how_to
|
||||
topics:
|
||||
- Accounts
|
||||
@@ -3,6 +3,8 @@ title: Configuring authentication and provisioning with your identity provider
|
||||
intro: 'You can configure user authentication and provisioning by integrating with an identity provider (IdP) that supports SAML single sign-on (SSO) and SCIM.'
|
||||
versions:
|
||||
ghae: '*'
|
||||
redirect_from:
|
||||
- /admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider
|
||||
children:
|
||||
- /configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad
|
||||
- /configuring-authentication-and-provisioning-for-your-enterprise-using-okta
|
||||
@@ -4,6 +4,8 @@ intro: 'You can map your Okta groups to teams on {% data variables.product.prodn
|
||||
permissions: 'Enterprise owners can configure authentication and provisioning for {% data variables.product.prodname_ghe_managed %}.'
|
||||
versions:
|
||||
ghae: '*'
|
||||
redirect_from:
|
||||
- /admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/mapping-okta-groups-to-teams
|
||||
type: how_to
|
||||
topics:
|
||||
- Accounts
|
||||