Web Site Manual: (2.3.0) Out of date instructions on obtaining 'oauth_consumer_key' and 'oauth_consumer_secret'

illumino · December 8, 2020, 11:13am

Problem: The instructions in the manual for obtaining the ‘oauth_consumer_key’ and ‘oauth_consumer_secret’ are out-of -date, in section 3.2.3 Installation Scenarios

Expected outcome: Up-to-date Instructions

Foreman and Proxy versions: 2.3.0

Foreman and Proxy plugin versions: 2.3.0

Distribution and version: Web-Site Issue

Other relevant data:

Raised: Bug #31472: Manual: (2.3.0) Instructions for obtaining the 'oauth_consumer_key' and 'oauth_consumer_secret' are out-of-date - Website - Foreman , but I was not sure if I placed the issue in the correct category (Website) as I didn’t see another relevant category, so I’m raising the issue here in the community Support website, so it does not go unnoticed. After appropriate developer consultation, its should be a very simple fix.

ekohl · December 8, 2020, 11:36am

Thanks for pointing this out. It’d be a great place to make a contribution now that you already know what needs to change. Here is the nightly page of that manual:

github.com

theforeman/theforeman.org/blob/gh-pages/_includes/manuals/nightly/3.2.3_installation_scenarios.md


The Foreman installer can accommodate more complex, multi-host setups when supplied with appropriate parameters.

#### Using an external database server

Per default foreman-installer will install a PostgreSQL database server onto the Foreman host and create its database. An external database server with an already created database can be used with the following arguments:

{% highlight bash %}
foreman-installer \
  --foreman-db-manage=false \
  --foreman-db-host=dbserver.example.com \
  --foreman-db-database=dbname \
  --foreman-db-username=dbuser \
  --foreman-db-password=dbpassword
{% endhighlight %}

As a post-installation step, to populate the database correctly, run:

{% highlight bash %}
foreman-rake db:migrate

This file has been truncated. show original

We typically update the nightly page in a PR. When it gets approved, we update the PR to update all other affected versions. This makes it easier when changes are requested because it saves you from making those changes in all files.

illumino · December 8, 2020, 11:53am

Question: The changes need to occur in a two spots (repeated text), should that be factored out with the new change? I’m thinking “Keep it simple” and repeat the text, a second time.

Existing Text:

Fill in the OAuth consumer key and secret values from your Foreman instance, retrieve them from Administer > Settings > Authentication, and set the Foreman URLs appropriately.

First Draft Replacement Text:

Fill in the OAuth consumer key and secret values from your Foreman instance, retrieve them from your Foreman server, using: grep oauth_consumer /etc/foreman/settings.yaml, and set the Foreman URLs appropriately.

illumino · December 8, 2020, 12:08pm

Changes made as suggested. Pull requested Created.
https://github.com/theforeman/theforeman.org/pull/1743