From c780f24ae4f5f447156641da162010bcfe95bec0 Mon Sep 17 00:00:00 2001 From: n-marton Date: Wed, 20 Jun 2018 16:35:17 +0200 Subject: [PATCH 1/3] Update README.md Enterprise github hostname in documentation. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 9397f7a77..683dd07b3 100644 --- a/README.md +++ b/README.md @@ -382,6 +382,12 @@ $ atlantis server --atlantis-url $URL --gh-user $USERNAME --gh-token $TOKEN --gh 2049/10/6 00:00:00 [WARN] server: Atlantis started - listening on port 4141 ``` +If you're using GitHub Enterprise, run: +``` +$ atlantis server --atlantis-url $URL --gh-user $USERNAME --gh-token $TOKEN --gh-webhook-secret $SECRET --gh-hostname $GITHUBHOSTNAME +2049/10/6 00:00:00 [WARN] server: Atlantis started - listening on port 4141 +``` + If you're using GitLab, run: ``` $ atlantis server --atlantis-url $URL --gitlab-user $USERNAME --gitlab-token $TOKEN --gitlab-webhook-secret $SECRET @@ -392,6 +398,7 @@ $ atlantis server --atlantis-url $URL --gitlab-user $USERNAME --gitlab-token $TO - `$USERNAME` is the GitHub/GitLab username you generated the token for - `$TOKEN` is the access token you created. If you don't want this to be passed in as an argument for security reasons you can specify it in a config file (see [Configuration](#configuration)) or as an environment variable: `ATLANTIS_GH_TOKEN` or `ATLANTIS_GITLAB_TOKEN` - `$SECRET` is the random key you used for the webhook secret. If you left the secret blank then don't specify this flag. If you don't want this to be passed in as an argument for security reasons you can specify it in a config file (see [Configuration](#configuration)) or as an environment variable: `ATLANTIS_GH_WEBHOOK_SECRET` or `ATLANTIS_GITLAB_WEBHOOK_SECRET` +- `$GITHUBHOSTNAME` is the URL of your enterprise Github Atlantis is now running! **We recommend running it under something like Systemd or Supervisord.** From 2676b1b9aca38d1640f79819cbf387fc3749fc94 Mon Sep 17 00:00:00 2001 From: n-marton Date: Sat, 23 Jun 2018 09:47:52 +0200 Subject: [PATCH 2/3] Update README.md example update for gh-hostname parameter --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 683dd07b3..723c2e25c 100644 --- a/README.md +++ b/README.md @@ -398,7 +398,7 @@ $ atlantis server --atlantis-url $URL --gitlab-user $USERNAME --gitlab-token $TO - `$USERNAME` is the GitHub/GitLab username you generated the token for - `$TOKEN` is the access token you created. If you don't want this to be passed in as an argument for security reasons you can specify it in a config file (see [Configuration](#configuration)) or as an environment variable: `ATLANTIS_GH_TOKEN` or `ATLANTIS_GITLAB_TOKEN` - `$SECRET` is the random key you used for the webhook secret. If you left the secret blank then don't specify this flag. If you don't want this to be passed in as an argument for security reasons you can specify it in a config file (see [Configuration](#configuration)) or as an environment variable: `ATLANTIS_GH_WEBHOOK_SECRET` or `ATLANTIS_GITLAB_WEBHOOK_SECRET` -- `$GITHUBHOSTNAME` is the URL of your enterprise Github +- `$GITHUBHOSTNAME` is the FQDN of your enterprise Github, for example `github.mycompany.com` (adding protocol before the FQDN is unnecessary, it will always use https). If you want to set it as an environment variable than use `ATLANTIS_GH_HOSTNAME`. Atlantis is now running! **We recommend running it under something like Systemd or Supervisord.** From eeac67814030d4261e04fe30d1c0cf4d982536ae Mon Sep 17 00:00:00 2001 From: Luke Kysow Date: Tue, 26 Jun 2018 09:00:53 +0200 Subject: [PATCH 3/3] Fix mispelling. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 723c2e25c..23af0cd4c 100644 --- a/README.md +++ b/README.md @@ -398,7 +398,7 @@ $ atlantis server --atlantis-url $URL --gitlab-user $USERNAME --gitlab-token $TO - `$USERNAME` is the GitHub/GitLab username you generated the token for - `$TOKEN` is the access token you created. If you don't want this to be passed in as an argument for security reasons you can specify it in a config file (see [Configuration](#configuration)) or as an environment variable: `ATLANTIS_GH_TOKEN` or `ATLANTIS_GITLAB_TOKEN` - `$SECRET` is the random key you used for the webhook secret. If you left the secret blank then don't specify this flag. If you don't want this to be passed in as an argument for security reasons you can specify it in a config file (see [Configuration](#configuration)) or as an environment variable: `ATLANTIS_GH_WEBHOOK_SECRET` or `ATLANTIS_GITLAB_WEBHOOK_SECRET` -- `$GITHUBHOSTNAME` is the FQDN of your enterprise Github, for example `github.mycompany.com` (adding protocol before the FQDN is unnecessary, it will always use https). If you want to set it as an environment variable than use `ATLANTIS_GH_HOSTNAME`. +- `$GITHUBHOSTNAME` is the FQDN of your enterprise Github, for example `github.mycompany.com` (adding protocol before the FQDN is unnecessary, it will always use https). If you want to set it as an environment variable then use `ATLANTIS_GH_HOSTNAME`. Atlantis is now running! **We recommend running it under something like Systemd or Supervisord.**