This repository was archived by the owner on Nov 1, 2017. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork1.1k
every curl needs optional s, and admin port#859
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
5 commits Select commitHold shift + click to select a range
f0868f0
every curl needs optional s, and admin port
brntbeer74071af
remove (s) from curl commands
brntbeer277d62f
response location should be <em>'d and have admin_port
brntbeer8630086
forgot to remove the last (s)
brntbeer83f0f99
remove duplicate admin_port
brntbeerFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
32 changes: 16 additions & 16 deletionscontent/v3/enterprise/management_console.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -24,13 +24,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: | ||
<pre class="terminal"> | ||
$ curl -L 'http://<em>hostname</em>:<em>admin_port</em>/setup/api?api_key=<em>your-amazing-password</em>' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Maybe | ||
</pre> | ||
You can also use standard HTTP authentication to send this token. For example: | ||
<pre class="terminal"> | ||
$ curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api' | ||
</pre> | ||
## Upload a license for the first time | ||
@@ -64,13 +64,13 @@ For a list of the available settings, see [the `/setup/api/settings` endpoint](# | ||
<pre class="terminal"> | ||
HTTP/1.1 202 Created | ||
Location: http://<em>hostname</em>:<em>admin_port</em>/setup/api/configcheck | ||
</pre> | ||
### Example | ||
<pre class="terminal"> | ||
curl -L -X POST 'http://<em>hostname</em>:<em>admin_port</em>/setup/api/start' -F license=@<em>/path/to/github-enterprise.ghl</em> -F "password=<em>your-amazing-password</em>" -F settings=<<em>/path/to/settings.json</em> | ||
</pre> | ||
## Upgrade a license | ||
@@ -89,13 +89,13 @@ Name | Type | Description | ||
<pre class="terminal"> | ||
HTTP/1.1 202 Accepted | ||
Location: http://<em>hostname</em>:<em>admin_port</em>/setup/api/configcheck | ||
</pre> | ||
### Example | ||
<pre class="terminal"> | ||
curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/upgrade' | ||
</pre> | ||
## Check configuration status | ||
@@ -124,7 +124,7 @@ Status | Description | ||
### Example | ||
<pre class="terminal"> | ||
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/configcheck' | ||
</pre> | ||
## Start a configuration process | ||
@@ -137,13 +137,13 @@ This endpoint allows you to start a configuration process at any time: | ||
<pre class="terminal"> | ||
HTTP/1.1 202 Accepted | ||
Location: http://<em>hostname</em>:<em>admin_port</em>/setup/api/configcheck | ||
</pre> | ||
### Example | ||
<pre class="terminal"> | ||
curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/configure' | ||
</pre> | ||
## Retrieve settings | ||
@@ -158,7 +158,7 @@ curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em> | ||
### Example | ||
<pre class="terminal"> | ||
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/settings' | ||
</pre> | ||
## Modify settings | ||
@@ -180,7 +180,7 @@ HTTP/1.1 204 No Content | ||
### Example | ||
<pre class="terminal"> | ||
curl -L -X PUT 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/settings' --data-urlencode "settings=`cat /path/to/settings.json`" | ||
</pre> | ||
## Check maintenance status | ||
@@ -197,7 +197,7 @@ Check your installation's maintenance status: | ||
### Example | ||
<pre class="terminal"> | ||
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/maintenance' | ||
</pre> | ||
## Enable or disable maintenance mode | ||
@@ -224,7 +224,7 @@ The possible values for `when` are `now` or any date parseable by | ||
### Example | ||
<pre class="terminal"> | ||
curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/maintenance' -d 'maintenance=<em>{"enabled":true, "when":"now"}</em>' | ||
</pre> | ||
## Retrieve authorized SSH keys | ||
@@ -239,7 +239,7 @@ curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em> | ||
### Example | ||
<pre class="terminal"> | ||
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/settings/authorized-keys' | ||
</pre> | ||
## Add a new authorized SSH key | ||
@@ -260,7 +260,7 @@ Name | Type | Description | ||
### Example | ||
<pre class="terminal"> | ||
curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/settings/authorized-keys' -F authorized_key=@<em>/path/to/key.pub</em> | ||
</pre> | ||
## Remove an authorized SSH key | ||
@@ -281,5 +281,5 @@ Name | Type | Description | ||
### Example | ||
<pre class="terminal"> | ||
curl -L -X DELETE 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/settings/authorized-keys' -F authorized_key=@<em>/path/to/key.pub</em> | ||
</pre> |
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.