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.**