From a30534f5641fbfccf1d58a37beba6428df202058 Mon Sep 17 00:00:00 2001 From: "Michael C. Harris" Date: Thu, 11 Dec 2014 19:08:31 +1100 Subject: [PATCH 1/4] Providing a password to /setup/api/start. --- content/v3/enterprise/management_console.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/v3/enterprise/management_console.md b/content/v3/enterprise/management_console.md index cae936b7c1..36c806d234 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -33,6 +33,8 @@ When you boot a virtual machine for the first time, you can use the following en Note that you need to POST to [`/setup/api/configure`](#start-a-configuration-process) to start the actual configuration process. +You *must* provide a password when uploading your license for the first time. If you haven't previously set a password through the web interface, we'll set it to the password you provide. + ### Parameters Name | Type | Description From c686979f39b4ddf149cad7ea0e69dc387c4b7177 Mon Sep 17 00:00:00 2001 From: Garen Torikian Date: Fri, 16 Jan 2015 12:08:57 -0800 Subject: [PATCH 2/4] Bring "must" copy down to Parameters table --- content/v3/enterprise/management_console.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/v3/enterprise/management_console.md b/content/v3/enterprise/management_console.md index 36c806d234..dd48e4a442 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -33,13 +33,12 @@ When you boot a virtual machine for the first time, you can use the following en Note that you need to POST to [`/setup/api/configure`](#start-a-configuration-process) to start the actual configuration process. -You *must* provide a password when uploading your license for the first time. If you haven't previously set a password through the web interface, we'll set it to the password you provide. - ### Parameters Name | Type | Description -----|------|-------------- `license`|`string` | **Required**. The content of your *.ghl* license file. +`password`|`string` | You **must** provide a password when uploading your license for the first time. If you haven't previously set a password through the web interface, we'll set it to the password you provide. `settings`| `string`| Optional path to a JSON file containing your installation settings. For a list of the available settings, see [the `/setup/api/settings` endpoint](#retrieve-settings). From dd8956a984e76fb9ef2476eff2ead46bb6f84b06 Mon Sep 17 00:00:00 2001 From: Garen Torikian Date: Fri, 16 Jan 2015 12:09:02 -0800 Subject: [PATCH 3/4] Update terminal command --- 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 dd48e4a442..5b0e86c757 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -53,7 +53,7 @@ Location: http://hostname/setup/api/configcheck ### Example 
-curl -X POST 'http://api_key:your-amazing-password@hostname/setup/api/start' -F license=@/path/to/github-enterprise.ghl -F settings=</path/to/settings.json
+curl -X POST 'http://hostname/setup/api/start' -F license=@/path/to/github-enterprise.ghl -F "password=your-amazing-password" -F settings=</path/to/settings.json
## Upgrade a license From 133d7099bbae0b18863a7a93a60b6ba8b3f2d6b6 Mon Sep 17 00:00:00 2001 From: Garen Torikian Date: Fri, 16 Jan 2015 14:40:09 -0800 Subject: [PATCH 4/4] Be much more explicit about what needs to be done here. --- content/v3/enterprise/management_console.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/content/v3/enterprise/management_console.md b/content/v3/enterprise/management_console.md index 5b0e86c757..8e2779bb70 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -33,12 +33,21 @@ When you boot a virtual machine for the first time, you can use the following en Note that you need to POST to [`/setup/api/configure`](#start-a-configuration-process) to start the actual configuration process. +{{#warning}} + +When using this endpoint, your Enterprise instance must have a password set. This can be accomplished two ways: + +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. + +{{/warning}} + ### Parameters Name | Type | Description -----|------|-------------- `license`|`string` | **Required**. The content of your *.ghl* license file. -`password`|`string` | You **must** provide a password when uploading your license for the first time. If you haven't previously set a password through the web interface, we'll set it to the password you provide. +`password`|`string` | You **must** provide a password *only if* you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter. `settings`| `string`| Optional path to a JSON file containing your installation settings. For a list of the available settings, see [the `/setup/api/settings` endpoint](#retrieve-settings).