Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor README updates #22

Merged
merged 1 commit into from Mar 29, 2018
Merged

Minor README updates #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Expand Up @@ -65,7 +65,7 @@ For the configuration below, you will also need to know following *fully qualifi
For more information, please refer to the
[GitHub Developer Documentation](https://developer.github.com/apps/building-oauth-apps/authorization-options-for-oauth-apps/) or the [BitBucket Developer Documentation](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html).

Further information on the OAuth endpoints can also be found [here](https://tools.ietf.org/html/rfc6749#page-21)
Further information on the OAuth endpoints can also be found [here](https://tools.ietf.org/html/rfc6749#page-21).

## Setup

Expand All @@ -92,7 +92,7 @@ If things don't work as expected, please see the Troubleshooting section below.

Once the services are running successfully, the Builder UI will become available at the configured hostname or IP address.

Nagigate to http://${APP_HOSTNAME_OR_IP}/#/sign-in to access the Builder UI
Navigate to `http://${APP_HOSTNAME_OR_IP}/#/sign-in` to access the Builder UI.

At that point you should be able to log in using your configured OAuth provider.

Expand Down Expand Up @@ -133,7 +133,7 @@ Once the services are uninstalled, you may re-install them by running `./install

## Support

Please work with your Chef success engineers for support. You may also file issues directly at the [Github repo](https://github.com/habitat-sh/on-prem-builder/issues)
Please work with your Chef success engineers for support. You may also file issues directly at the [Github repo](https://github.com/habitat-sh/on-prem-builder/issues).

## Troubleshooting

Expand All @@ -147,7 +147,7 @@ If you have outgoing access via a proxy, please ensure that HTTPS_PROXY is set c

### Authentication failure when logging in

If you are not able to log in, please double check the settings that you have configured your OAuth application with, as well as the URLs that you have specified in your bldr.env file.
If you are not able to log in, please double check the settings that you have configured your OAuth application with, as well as the URLs that you have specified in your `bldr.env` file.

You can also turn on debug logging (section below) and check to see that the authenticate endpoint is getting called at the Builder API backend, and whether there is any additional information in the logs that may be helpful.

Expand Down