Skip to content
This repository has been archived by the owner on Sep 1, 2022. It is now read-only.

Commit

Permalink
Merge pull request #138 from githubtraining/server-installation-update
Browse files Browse the repository at this point in the history 
Update server installation docs for security course
  • Loading branch information
@brianamarie
brianamarie authored Jan 28, 2020
2 parents cf11492 + 4bd336a commit 88384ce
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions server-installation-notes.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
## GitHub Enterprise Server (GHES) installation notes

🚫 | This course needs features not yet supported by GHES.
✅ | This course is fully compatible with any versions 2.17 and above of GHES.
--- | ---

This course makes use of [security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies), a feature that is currently available for GitHub.com but not available on GHES.

You may still make significant modifications to the course to work with a third-party code analysis tools.
This course makes use of [security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies), a feature that needs to be configured by GHES administrators.

### Course dependencies

Expand All @@ -14,5 +12,6 @@ The following are dependencies of the course. The course may continue to work wi
| Dependency | Required? | Reason | Alternative |
|---------------------------------------------------------------------------------------------------------------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| GHES must be able to reach githubusercontent.com | Yes | Images used throughout the course are served from this domain. Learners will find broken images required to take the course without this access. | Manually download the images referenced in the `responses/` folder, upload them to an accessible domain, and replace the images in the `responses/` folder. |
| Security alerts for vulnerable dependencies must be enabled on GHES | Yes | This course prompts users to interact with alerts triggered by intentionally vulnerable dependencies. | None |
| Learner must be able to reach github.com and outside web | No | Links are provided to resources that live on the outside web. | Without access to resources on the outside web, learners will reach blocked resources. You can change the links to these resources in the `responses/` folder, and in the template repository. |
| [GitHub Pages](https://help.github.com/en/enterprise/admin/installation/configuring-github-pages-on-your-appliance) | No | Used to let the learner work on a realistic, published web page. | Remove the first step in `config.yml`, and adjust responses in the `responses/` folder to remove any mentions of GitHub Pages. |

0 comments on commit 88384ce

Please sign in to comment.