Skip to content

Commit

Permalink
Fix initial errors identified when trying Vale (github#17608)
Browse files Browse the repository at this point in the history
* Fix errors in education product

* Fix errors in admin configuration docs

* Fix a few stray errors

* This works as is

* Sundry fixes picked up by Vale

* Another batch

* Today's batch of content fixes

* Sundry fixes

* More small updates

* Don't introduce a typo when we're trying to fix them

* Update content/admin/authentication/using-ldap.md

Co-authored-by: Laura Coursen <lecoursen@github.com>

Co-authored-by: Laura Coursen <lecoursen@github.com>
  • Loading branch information
emilyistoofunky and lecoursen authored Feb 9, 2021
1 parent e32567f commit d2d8f0b
Show file tree
Hide file tree
Showing 34 changed files with 52 additions and 53 deletions.
2 changes: 1 addition & 1 deletion content/admin/authentication/using-ldap.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Use these attributes to finish configuring LDAP for {% data variables.product.pr
| `Host` | Required | The LDAP host, e.g. `ldap.example.com` or `10.0.0.30`. If the hostname is only available from your internal network, you may need to configure {% data variables.product.product_location %}'s DNS first so it can resolve the hostname using your internal nameservers. |
| `Port` | Required | The port the host's LDAP services are listening on. Examples include: 389 and 636 (for LDAPS). |
| `Encryption` | Required | The encryption method used to secure communications to the LDAP server. Examples include plain (no encryption), SSL/LDAPS (encrypted from the start), and StartTLS (upgrade to encrypted communication once connected). |
| `Domain search user` | Optional | The LDAP user that performs user lookups to authenticate other users when they sign in. This is typically a service account created specifically for third-party integrations. Use a fully qualified name, such as `cn=Administrator,cn=Users,dc=Example,dc=com`. With Active Directory, you can also use the `[DOMAIN]\[USERNAME]` syntax (e.g. `WINDOWS\Administrator`) for the domain search user with Active Directory. |
| `Domain search user` | Optional | The LDAP user that looks up other users that sign in, to allow authentication. This is typically a service account created specifically for third-party integrations. Use a fully qualified name, such as `cn=Administrator,cn=Users,dc=Example,dc=com`. With Active Directory, you can also use the `[DOMAIN]\[USERNAME]` syntax (e.g. `WINDOWS\Administrator`) for the domain search user with Active Directory. |
| `Domain search password` | Optional | The password for the domain search user. |
| `Administrators group` | Optional | Users in this group are promoted to site administrators when signing into your appliance. If you don't configure an LDAP Administrators group, the first LDAP user account that signs into your appliance will be automatically promoted to a site administrator. |
| `Domain base` | Required | The fully qualified `Distinguished Name` (DN) of an LDAP subtree you want to search for users and groups. You can add as many as you like; however, each group must be defined in the same domain base as the users that belong to it. If you specify restricted user groups, only users that belong to those groups will be in scope. We recommend that you specify the top level of your LDAP directory tree as your domain base and use restricted user groups to control access. |
Expand Down
2 changes: 1 addition & 1 deletion content/admin/authentication/using-saml.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ These attributes are available. You can change the attribute names in the [manag
{% 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 %}.
![SAML disable admin config](/assets/images/enterprise/management-console/disable-admin-demotion-promotion.png)
![SAML disable admin configuration](/assets/images/enterprise/management-console/disable-admin-demotion-promotion.png)
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/).
![SAML authentication](/assets/images/enterprise/management-console/saml-single-sign-url.png)
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 %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ To specify a private SSH key using the command line, run `ssh` with the `-i` arg
ssh -i /path/to/ghe_private_key -p 122 admin@<em>hostname</em>
```

You can also specify a private SSH key using the SSH config file (`~/.ssh/config`).
You can also specify a private SSH key using the SSH configuration file (`~/.ssh/config`).

```shell
Host <em>hostname</em>
Expand Down
2 changes: 1 addition & 1 deletion content/admin/configuration/command-line-utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ $ ghe-config <em>core.github-hostname</em> <em>'example.com'</em>
$ ghe-config -l
# Lists all the configuration values
```
Allows you to find the uuid of your node in `cluster.conf`.
Allows you to find the universally unique identifier (UUID) of your node in `cluster.conf`.

```shell
$ ghe-config <em>HOSTNAME</em>.uuid
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ In the event of prolonged outage or catastrophic event at the primary site, you
{%if currentVersion ver_gt "enterprise-server@2.22"%}
{% note %}

**Note:** If {% data variables.product.product_location %} has {% data variables.product.prodname_actions %} enabled, you must first configure the {% data variables.product.prodname_actions %} external storage provider on the replacement appliance before running the the `ghe-restore` command. For more information, see "[Backing up and restoring {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_actions %} enabled](/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)."
**Note:** If {% data variables.product.product_location %} has {% data variables.product.prodname_actions %} enabled, you must first configure the {% data variables.product.prodname_actions %} external storage provider on the replacement appliance before running the `ghe-restore` command. For more information, see "[Backing up and restoring {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_actions %} enabled](/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)."

{% endnote %}
{% endif %}
Expand Down Expand Up @@ -116,4 +116,3 @@ $ ghe-restore -c 169.154.1.1
You can use these additional options with `ghe-restore` command:
- The `-c` flag overwrites the settings, certificate, and license data on the target host even if it is already configured. Omit this flag if you are setting up a staging instance for testing purposes and you wish to retain the existing configuration on the target. For more information, see the "Using using backup and restore commands" section of the [{% data variables.product.prodname_enterprise_backup_utilities %} README](https://github.com/github/backup-utils#using-the-backup-and-restore-commands).
- The `-s` flag allows you to select a different backup snapshot.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ versions:

After you install {% data variables.product.prodname_ghe_server %}, all required network ports are automatically opened to accept connections. Every non-required port is automatically configured as `deny`, and the default outgoing policy is configured as `allow`. Stateful tracking is enabled for any new connections; these are typically network packets with the `SYN` bit set. For more information, see "[Network ports](/enterprise/admin/guides/installation/network-ports)."

The UFW firewall also opens several other ports that are required for {% data variables.product.prodname_ghe_server %} to operate properly. For more information on the UFW ruleset, see [the UFW README](https://bazaar.launchpad.net/~jdstrand/ufw/0.30-oneiric/view/head:/README#L213).
The UFW firewall also opens several other ports that are required for {% data variables.product.prodname_ghe_server %} to operate properly. For more information on the UFW rule set, see [the UFW README](https://bazaar.launchpad.net/~jdstrand/ufw/0.30-oneiric/view/head:/README#L213).

### Viewing the default firewall rules

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ This log shows that the appliance:

#### Check {% data variables.product.product_location %} logs

If you need to verify that your inbound email is functioning, there are two logfiles that you can examine on your instance: To verify that */var/log/mail.log* and */var/log/mail-replies/metroplex.log*.
If you need to verify that your inbound email is functioning, there are two log files that you can examine on your instance: To verify that */var/log/mail.log* and */var/log/mail-replies/metroplex.log*.

*/var/log/mail.log* verifies that messages are reaching your server. Here's an example of a successful email reply:

Expand Down
2 changes: 1 addition & 1 deletion content/admin/configuration/site-admin-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ versions:
---

To access the dashboard, in the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}.
![Rocketship icon for accessing site admin settings](/assets/images/enterprise/site-admin-settings/access-new-settings.png)
![Rocket ship icon for accessing site admin settings](/assets/images/enterprise/site-admin-settings/access-new-settings.png)

{% if currentVersion ver_gt "enterprise-server@2.21" %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Multiple active replicas can provide a shorter distance to the nearest replica.

The active replica proxies requests that it can't process itself to the primary instance. The replicas function as a point of presence terminating all SSL connections. Traffic between hosts is sent through an encrypted VPN connection, similar to a two-node high availability configuration without geo-replication.

Git requests and specific fileserver requests, such as LFS and file uploads, can be served directly from the replica without loading any data from the primary. Web requests are always routed to the primary, but if the replica is closer to the user the requests are faster due to the closer SSL termination.
Git requests and specific file server requests, such as LFS and file uploads, can be served directly from the replica without loading any data from the primary. Web requests are always routed to the primary, but if the replica is closer to the user the requests are faster due to the closer SSL termination.

Geo DNS, such as [Amazon's Route 53 service](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-geo), is required for geo-replication to work seamlessly. The hostname for the instance should resolve to the replica that is closest to the user's location.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ versions:

### Network considerations

The simplest network design for clustering is to place the nodes on a single LAN. If a cluster must span subnets, we do not recommend configuring any firewall rules between the networks. The latency between nodes should be less than 1 millisecond.
The simplest network design for clustering is to place the nodes on a single LAN. If a cluster must span subnetworks, we do not recommend configuring any firewall rules between the networks. The latency between nodes should be less than 1 millisecond.

{% if currentVersion ver_gt "enterprise-server@2.21" %}For high availability, the latency between the network with the active nodes and the network with the passive nodes must be less than 70 milliseconds. We don't recommend configuring a firewall between the two networks.{% endif %}

Expand Down Expand Up @@ -54,12 +54,12 @@ If a network level firewall is in place between nodes, these ports will need to
| 6379/TCP | Redis |
| 8001/TCP | Grafana |
| 8090/TCP | Internal GPG access |
| 8149/TCP | GitRPC fileserver access |
| 8149/TCP | GitRPC file server access |
| 8300/TCP | Consul |
| 8301/TCP | Consul |
| 8302/TCP | Consul |
| 9000/TCP | Git Daemon |
| 9102/TCP | Pages fileserver |
| 9102/TCP | Pages file server |
| 9105/TCP | LFS server |
| 9200/TCP | Elasticsearch |
| 9203/TCP | Semantic code service |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ versions:
- If you’re several versions behind, upgrade {% data variables.product.product_location %} as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from {% data variables.product.prodname_enterprise %} 2.7 to 2.8 to 2.10, but upgrading from {% data variables.product.prodname_enterprise %} 2.7 to 2.9 to 2.10 uses a later version in the second step.
- Use the latest patch release when upgrading. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %}
- Use a staging instance to test the upgrade steps. For more information, see "[Setting up a staging instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-staging-instance/)."
- When running multiple upgrades, wait at least 24 hours between feature upgrades to allow data migrations and backgrounded upgrade tasks to fully complete.
- When running multiple upgrades, wait at least 24 hours between feature upgrades to allow data migrations and upgrade tasks running in the background to fully complete.

### Requirements

Expand Down
2 changes: 1 addition & 1 deletion content/admin/overview/system-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ For more information about {% data variables.product.prodname_ghe_server %}'s us

#### Audit and access logging

{% data variables.product.prodname_ghe_server %} stores both traditional operating system and application logs. The application also writes detailed auditing and security logs, which {% data variables.product.prodname_ghe_server %} stores permanently. You can forward both types of logs in realtime to multiple destinations via the `syslog-ng` protocol. For more information, see "[Log forwarding](/admin/user-management/log-forwarding)."
{% data variables.product.prodname_ghe_server %} stores both traditional operating system and application logs. The application also writes detailed auditing and security logs, which {% data variables.product.prodname_ghe_server %} stores permanently. You can forward both types of logs in real time to multiple destinations via the `syslog-ng` protocol. For more information, see "[Log forwarding](/admin/user-management/log-forwarding)."

Access and audit logs include information like the following.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ To use {% data variables.product.prodname_registry %} with Docker, you must have
{% data reusables.enterprise_management_console.save-settings %}

{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %}
### Connecting to the official NPM registry
### Connecting to the official npm registry

If you've enabled npm packages on your enterprise and want to allow access to the official NPM registry as well as the {% data variables.product.prodname_registry %} npm registry, then you must perform some additional configuration.
If you've enabled npm packages on your enterprise and want to allow access to the official npm registry as well as the {% data variables.product.prodname_registry %} npm registry, then you must perform some additional configuration.

{% data variables.product.prodname_registry %} uses a transparent proxy for network traffic that connects to the official NPM registry at `registry.npmjs.com`. The proxy is enabled by default and cannot be disabled.
{% data variables.product.prodname_registry %} uses a transparent proxy for network traffic that connects to the official npm registry at `registry.npmjs.com`. The proxy is enabled by default and cannot be disabled.

To allow network connections to the NPM registry, you will need to configure network ACLs that allow {% data variables.product.prodname_ghe_server %} to send HTTPS traffic to `registry.npmjs.com` over port 443:
To allow network connections to the npm registry, you will need to configure network ACLs that allow {% data variables.product.prodname_ghe_server %} to send HTTPS traffic to `registry.npmjs.com` over port 443:

| Source | Destination | Port | Type |
|---|---|---|---|
Expand Down
2 changes: 1 addition & 1 deletion content/admin/policies/about-pre-receive-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Examples of how you can use pre-receive hooks:

- Require commit messages to follow a specific pattern or format, such as including a valid ticket number or being over a certain length.
- Lock a branch or repository by rejecting all pushes.
- Prevent sensitive data from being added to the repository by blocking keywords, patterns or filetypes.
- Prevent sensitive data from being added to the repository by blocking keywords, patterns or file types.
- Prevent a PR author from merging their own changes.

### Impact on performance and workflows
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ You can test a pre-receive hook script locally before you create or update it on
$ docker cp data:/home/git/.ssh/id_ed25519 .
```

10. Modify the remote of a test repository and push to the `test.git` repo within the Docker container. This example uses `git@github.com:octocat/Hello-World.git` but you can use any repo you want. This example assumes your local machine (127.0.0.1) is binding port 52311, but you can use a different IP address if docker is running on a remote machine.
10. Modify the remote of a test repository and push to the `test.git` repo within the Docker container. This example uses `git@github.com:octocat/Hello-World.git` but you can use any repository you want. This example assumes your local machine (127.0.0.1) is binding port 52311, but you can use a different IP address if docker is running on a remote machine.

```shell
$ git clone git@github.com:octocat/Hello-World.git
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ A repository owner can only configure a hook if the site administrator selected
4. In the left sidebar, click **Hooks & Services**.
![Hooks and services](/assets/images/enterprise/repos/hooks-services.png)
5. Next to the pre-receive hook that you want to configure, click the **Hook permissions** drop-down menu. Select whether to enable or disable the pre-receive hook.
![Repo hook permissions](/assets/images/enterprise/repos/repo-hook-permissions.png)
![Repository hook permissions](/assets/images/enterprise/repos/repo-hook-permissions.png)
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The Migrations API is currently in a preview period, which means that the endpoi

1. Notify members of your organization that you'll be performing a migration. The export can take several minutes, depending on the number of repositories being exported. The full migration including import may take several hours so we recommend doing a trial run in order to determine how long the full process will take. For more information, see "[About Migrations](/enterprise/admin/migrations/about-migrations#types-of-migrations)."

2. Start a migration by `POST`ing to <a href="/rest/reference/migrations#start-an-organization-migration" class="dotcom-only">the migration endpoint</a>. You'll need:
2. Start a migration by sending a `POST` request to <a href="/rest/reference/migrations#start-an-organization-migration" class="dotcom-only">the migration endpoint</a>. You'll need:
* Your access token for authentication.
* A [list of the repositories](/rest/reference/repos#list-organization-repositories) you want to migrate:
```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,13 +128,13 @@ The same process can be used to create mappings for each record that supports cu

#### Applying modified migration data

1. After making changes, use the [`scp`](https://linuxacademy.com/blog/linux/ssh-and-scp-howto-tips-tricks#scp) command to apply your modified *conflicts.csv* (or any other mapping csv in the correct format) to the target instance:
1. After making changes, use the [`scp`](https://linuxacademy.com/blog/linux/ssh-and-scp-howto-tips-tricks#scp) command to apply your modified *conflicts.csv* (or any other mapping *.csv* file in the correct format) to the target instance:

```shell
$ scp -P 122 ~/Desktop/conflicts.csv admin@<em>hostname</em>:/home/admin/
```

2. Re-map the migration data using the `ghe-migrator map` command, passing in the path to your modified csv file and the Migration GUID:
2. Re-map the migration data using the `ghe-migrator map` command, passing in the path to your modified *.csv* file and the Migration GUID:

```shell
$ ghe-migrator map -i conflicts.csv -g <em>MIGRATION_GUID</em>
Expand Down
Loading

0 comments on commit d2d8f0b

Please sign in to comment.