From 3aa32200b6ef650a9bc22370472593d1b862038c Mon Sep 17 00:00:00 2001 From: Melissa Smith Date: Thu, 17 Dec 2015 14:00:34 -0800 Subject: [PATCH 1/7] Add -k flag and https to 2 examples --- content/v3/enterprise/management_console.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/v3/enterprise/management_console.md b/content/v3/enterprise/management_console.md index 53950f25a3..3c5cfa3812 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -18,7 +18,7 @@ If you don't want to provide a port number, you'll need to configure your tool t ## Authentication -You need to pass your [Management Console password](https://help.github.com/enterprise/2.0/admin/articles/accessing-the-management-console/) as an authentication token to every Management Console API endpoint except [`/setup/api/start`](#upload-a-license-for-the-first-time). +You need to pass your [Management Console password](https://help.github.com/enterprise/admin/articles/accessing-the-management-console/) as an authentication token to every Management Console API endpoint except [`/setup/api/start`](#upload-a-license-for-the-first-time). Use the `api_key` parameter to send this token with each request. For example: @@ -69,7 +69,7 @@ For a list of the available settings, see [the `/setup/api/settings` endpoint](# ### Example ``` command-line -$ curl -L -X POST 'http://hostname:admin_port/setup/api/start' -F license=@/path/to/github-enterprise.ghl -F "password=your-amazing-password" -F settings=</path/to/settings.json +$ curl -L -X -k POST 'https://hostname:admin_port/setup/api/start' -F license=@/path/to/github-enterprise.ghl -F "password=your-amazing-password" -F settings=</path/to/settings.json ``` ## Upgrade a license @@ -259,7 +259,7 @@ Name | Type | Description ### Example ``` command-line -$ curl -L -X POST 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub +$ curl -L -X -k POST 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub ``` ## Remove an authorized SSH key From 1bfd074395279830098d9c7edd2a3475286e5ccb Mon Sep 17 00:00:00 2001 From: Melissa Smith Date: Thu, 17 Dec 2015 14:33:58 -0800 Subject: [PATCH 2/7] reorder -k for new key and uploading a license --- content/v3/enterprise/management_console.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/v3/enterprise/management_console.md b/content/v3/enterprise/management_console.md index 3c5cfa3812..ec0419ef1b 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -69,7 +69,7 @@ For a list of the available settings, see [the `/setup/api/settings` endpoint](# ### Example ``` command-line -$ curl -L -X -k POST 'https://hostname:admin_port/setup/api/start' -F license=@/path/to/github-enterprise.ghl -F "password=your-amazing-password" -F settings=</path/to/settings.json +$ curl -L -X POST -k 'https://hostname:admin_port/setup/api/start' -F license=@/path/to/github-enterprise.ghl -F "password=your-amazing-password" -F settings=</path/to/settings.json ``` ## Upgrade a license @@ -259,7 +259,7 @@ Name | Type | Description ### Example ``` command-line -$ curl -L -X -k POST 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub +$ curl -L -X POST -k 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub ``` ## Remove an authorized SSH key From b9318270bba2d796227257ceabd92cbac6b9d76c Mon Sep 17 00:00:00 2001 From: Melissa Smith Date: Fri, 18 Dec 2015 15:26:02 -0800 Subject: [PATCH 3/7] add note about -k flag, remove from examples --- content/v3/enterprise/management_console.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/v3/enterprise/management_console.md b/content/v3/enterprise/management_console.md index ec0419ef1b..e20de85d5f 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -47,6 +47,8 @@ When using this endpoint, your Enterprise instance must have a password set. Thi 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. +You may also need to use the `-k` flag, as GitHub Enterprise uses a self-signed certificate before you [enable your own SSL certificate](https://help.github.com/enterprise/admin/guides/installation/dns-hostname-subdomain-isolation-and-ssl/#ssl). + {{/warning}} ### Parameters @@ -69,7 +71,7 @@ For a list of the available settings, see [the `/setup/api/settings` endpoint](# ### Example ``` command-line -$ curl -L -X POST -k 'https://hostname:admin_port/setup/api/start' -F license=@/path/to/github-enterprise.ghl -F "password=your-amazing-password" -F settings=</path/to/settings.json +$ curl -L -X POST 'https://hostname:admin_port/setup/api/start' -F license=@/path/to/github-enterprise.ghl -F "password=your-amazing-password" -F settings=</path/to/settings.json ``` ## Upgrade a license @@ -259,7 +261,7 @@ Name | Type | Description ### Example ``` command-line -$ curl -L -X POST -k 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub +$ curl -L -X POST 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub ``` ## Remove an authorized SSH key From 4a91f27ec3539c2f705bcf2df05ffa19367ce9c6 Mon Sep 17 00:00:00 2001 From: Melissa Smith Date: Tue, 22 Dec 2015 14:00:13 -0800 Subject: [PATCH 4/7] add curl caveat and update language --- content/v3/enterprise/management_console.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/v3/enterprise/management_console.md b/content/v3/enterprise/management_console.md index e20de85d5f..0697c92107 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -47,7 +47,7 @@ When using this endpoint, your Enterprise instance must have a password set. Thi 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. -You may also need to use the `-k` flag, as GitHub Enterprise uses a self-signed certificate before you [enable your own SSL certificate](https://help.github.com/enterprise/admin/guides/installation/dns-hostname-subdomain-isolation-and-ssl/#ssl). +You may also need to add the `-k` flag when using `curl`, sicne GitHub Enterprise uses a self-signed certificate before you [add your own SSL certificate](https://help.github.com/enterprise/admin/guides/installation/dns-hostname-subdomain-isolation-and-ssl/#ssl). {{/warning}} From b5a405ccdcd8ba7441a3735798b58aa973155981 Mon Sep 17 00:00:00 2001 From: Melissa Smith Date: Tue, 22 Dec 2015 14:13:11 -0800 Subject: [PATCH 5/7] update all examples to https --- content/v3/enterprise/management_console.md | 22 ++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/content/v3/enterprise/management_console.md b/content/v3/enterprise/management_console.md index 0697c92107..09d19d652c 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -23,13 +23,13 @@ You need to pass your [Management Console password](https://help.github.com/ente Use the `api_key` parameter to send this token with each request. For example: ``` command-line -$ curl -L 'http://hostname:admin_port/setup/api?api_key=your-amazing-password' +$ curl -L 'https://hostname:admin_port/setup/api?api_key=your-amazing-password' ``` You can also use standard HTTP authentication to send this token. For example: ``` command-line -$ curl -L 'http://api_key:your-amazing-password@hostname:admin_port/setup/api' +$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api' ``` ## Upload a license for the first time @@ -96,7 +96,7 @@ Name | Type | Description ### Example ``` command-line -$ curl -L -X POST 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/upgrade' +$ curl -L -X POST 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/upgrade' ``` ## Check configuration status @@ -125,7 +125,7 @@ Status | Description ### Example ``` command-line -$ curl -L 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/configcheck' +$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/configcheck' ``` ## Start a configuration process @@ -144,7 +144,7 @@ This endpoint allows you to start a configuration process at any time for your u ### Example ``` command-line -$ curl -L -X POST 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/configure' +$ curl -L -X POST 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/configure' ``` ## Retrieve settings @@ -159,7 +159,7 @@ $ curl -L -X POST 'http://api_key:your-amazing-password@hostnameyour-amazing-password@hostname:admin_port/setup/api/settings' +$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings' ``` ## Modify settings @@ -181,7 +181,7 @@ Name | Type | Description ### Example ``` command-line -$ curl -L -X PUT 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/settings' --data-urlencode "settings=`cat /path/to/settings.json`" +$ curl -L -X PUT 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings' --data-urlencode "settings=`cat /path/to/settings.json`" ``` ## Check maintenance status @@ -198,7 +198,7 @@ Check your installation's maintenance status: ### Example ``` command-line -$ curl -L 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/maintenance' +$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/maintenance' ``` ## Enable or disable maintenance mode @@ -225,7 +225,7 @@ The possible values for `when` are `now` or any date parseable by ### Example ``` command-line -$ curl -L -X POST 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/maintenance' -d 'maintenance={"enabled":true, "when":"now"}' +$ curl -L -X POST 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/maintenance' -d 'maintenance={"enabled":true, "when":"now"}' ``` ## Retrieve authorized SSH keys @@ -240,7 +240,7 @@ $ curl -L -X POST 'http://api_key:your-amazing-password@hostnameyour-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' +$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' ``` ## Add a new authorized SSH key @@ -282,5 +282,5 @@ Name | Type | Description ### Example ``` command-line -$ curl -L -X DELETE 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub +$ curl -L -X DELETE 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub ``` From 7055fe3993d7cde8e0ef23b6e4252bec8411d9de Mon Sep 17 00:00:00 2001 From: David Ginsburg Date: Wed, 23 Dec 2015 14:41:05 -0800 Subject: [PATCH 6/7] fix typo s/sicne/since/ --- content/v3/enterprise/management_console.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/v3/enterprise/management_console.md b/content/v3/enterprise/management_console.md index 09d19d652c..1722391636 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -47,7 +47,7 @@ When using this endpoint, your Enterprise instance must have a password set. Thi 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. -You may also need to add the `-k` flag when using `curl`, sicne GitHub Enterprise uses a self-signed certificate before you [add your own SSL certificate](https://help.github.com/enterprise/admin/guides/installation/dns-hostname-subdomain-isolation-and-ssl/#ssl). +You may also need to add the `-k` flag when using `curl`, since GitHub Enterprise uses a self-signed certificate before you [add your own SSL certificate](https://help.github.com/enterprise/admin/guides/installation/dns-hostname-subdomain-isolation-and-ssl/#ssl). {{/warning}} From 08af3aebf48b295e91bde59123f6640598369b37 Mon Sep 17 00:00:00 2001 From: Melissa Smith Date: Mon, 28 Dec 2015 11:41:54 -0800 Subject: [PATCH 7/7] add link re: -k flag and move note to tip section --- content/v3/enterprise/management_console.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/v3/enterprise/management_console.md b/content/v3/enterprise/management_console.md index 1722391636..e2915032a7 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -14,6 +14,8 @@ You must explicitly set the port number when making API calls to the Management If you don't want to provide a port number, you'll need to configure your tool to automatically follow redirects. +You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since GitHub Enterprise uses a self-signed certificate before you [add your own SSL certificate](https://help.github.com/enterprise/admin/guides/installation/dns-hostname-subdomain-isolation-and-ssl/#ssl). + {{/tip}} ## Authentication @@ -47,8 +49,6 @@ When using this endpoint, your Enterprise instance must have a password set. Thi 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. -You may also need to add the `-k` flag when using `curl`, since GitHub Enterprise uses a self-signed certificate before you [add your own SSL certificate](https://help.github.com/enterprise/admin/guides/installation/dns-hostname-subdomain-isolation-and-ssl/#ssl). - {{/warning}} ### Parameters pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy