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

Commit e9732e2

Browse files
committed
add server installation notes
1 parent 5adbd04 commit e9732e2

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

server-installation-notes.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## GitHub Enterprise Server (GHES) installation notes
2+
3+
🚫 | This course needs features not yet supported by GHES.
4+
--- | ---
5+
6+
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.
7+
8+
You may still make significant modifications to the course to work with a third-party code analysis tools.
9+
10+
### Course dependencies
11+
12+
The following are dependencies of the course. The course may continue to work without these dependencies, but learners won't experience the course as designed.
13+
14+
| Dependency | Required? | Reason | Alternative |
15+
|---------------------------------------------------------------------------------------------------------------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
16+
| 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. |
17+
| 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. |
18+
| The [Release Drafter GitHub App](https://github.com/toolmantim/release-drafter) must be installed or approved for installation. | No | Used in a course step to teach learners how to create automatic releases. | If the app won't be installed or pre-approved, remove the Release Drafter step in `config.yml`, the step that follows it, and any references to the GitHub App in the `responses/` folder. |

0 commit comments

Comments
 (0)