8014: Install guide uses new Rails postinst scripts for configuration.
authorBrett Smith <brett@curoverse.com>
Tue, 5 Jan 2016 22:33:11 +0000 (17:33 -0500)
committerBrett Smith <brett@curoverse.com>
Tue, 12 Jan 2016 01:22:59 +0000 (20:22 -0500)
doc/_includes/_install_rails_reconfigure.liquid [new file with mode: 0644]
doc/install/install-api-server.html.textile.liquid
doc/install/install-sso.html.textile.liquid
doc/install/install-workbench-app.html.textile.liquid

diff --git a/doc/_includes/_install_rails_reconfigure.liquid b/doc/_includes/_install_rails_reconfigure.liquid
new file mode 100644 (file)
index 0000000..b2f2965
--- /dev/null
@@ -0,0 +1,11 @@
+Now that all your configuration is in place, rerun the {{railspkg}} package configuration to install necessary Ruby Gems and other server dependencies.  On Debian-based systems:
+
+<notextile><pre><code>~$ <span class="userinput">sudo dpkg-reconfigure {{railspkg}}</span>
+</code></pre></notextile>
+
+On Red Hat-based systems:
+
+<notextile><pre><code>~$ <span class="userinput">sudo yum reinstall {{railspkg}}</span>
+</code></pre></notextile>
+
+You only need to do this manual step once, after initial configuration.  When you make configuration changes in the future, you just need to restart Nginx for them to take effect.
\ No newline at end of file
index 20a8a97af1b617f135c2000774144a08159ea1ca..fae06decb8ae14403e3afe92aa7e64057e0c2744 100644 (file)
@@ -340,14 +340,12 @@ server {
 
 h2. Prepare the API server deployment
 
-Now that all your configuration is in place, run @/usr/local/bin/arvados-api-server-upgrade.sh@.  This will install and check your configuration, install necessary gems, and run any necessary database setup.
+{% assign railspkg = "arvados-api-server" %}
+{% include 'install_rails_reconfigure' %}
 
 {% include 'notebox_begin' %}
-You can safely ignore the following messages if they appear while this script runs:
+You can safely ignore the following messages if they appear while this command runs:
 <pre>Don't run Bundler as root. Bundler can ask for sudo if it is needed, and installing your bundle as root will
 break this application for all non-root users on this machine.</pre>
 <pre>fatal: Not a git repository (or any of the parent directories): .git</pre>
 {% include 'notebox_end' %}
-
-This command aborts when it encounters an error.  It's safe to rerun multiple times, so if there's a problem with your configuration, you can fix that and try again.
-
index 1a3e4b380aefbbd21ed52d5a3e54e41e6add2e53..a3064038e85134f77697c8fb1c0cd43a7f370f64 100644 (file)
@@ -128,7 +128,7 @@ Enter password for new role: <span class="userinput">paste-database-password-you
 Enter it again: <span class="userinput">paste-database-password-you-generated</span>
 </code></pre></notextile>
 
-Rails will take care of creating the database, based on the information from @/etc/arvados/sso/database.yml@. 
+Rails will take care of creating the database, based on the information from @/etc/arvados/sso/database.yml@.
 
 Alternatively, if the database user you intend to use for the SSO server should not be allowed to create new databases, the user and the database can be created like this:
 
@@ -141,21 +141,8 @@ Enter it again: <span class="userinput">paste-database-password-you-generated</s
 
 h2(#reconfigure_package). Reconfigure the package
 
-Now that the @/etc/arvados/sso/application.yml@ and @/etc/arvados/sso/database.yml@ files have been updated, we need to reconfigure our installed package. Doing so will create and/or initialize the database and precompile the assets.
-
-On a Debian-based system:
-
-<notextile>
-<pre><code>~$ <span class="userinput">sudo dpkg-reconfigure arvados-sso-server</span>
-</code></pre>
-</notextile>
-
-On a Red Hat-based system, we need to reinstall the package instead:
-
-<notextile>
-<pre><code>~$ <span class="userinput">sudo yum reinstall arvados-sso-server</span>
-</code></pre>
-</notextile>
+{% assign railspkg = "arvados-sso-server" %}
+{% include 'install_rails_reconfigure' %}
 
 h2(#client). Create arvados-server client
 
@@ -309,5 +296,3 @@ In order to use Google+ authentication, you must use the <a href="https://consol
 <pre><code>  # Google API tokens required for OAuth2 login.
   google_oauth2_client_id: <span class="userinput">"---YOUR---CLIENT---ID---HERE--"-</span>
   google_oauth2_client_secret: <span class="userinput">"---YOUR---CLIENT---SECRET---HERE--"-</span></code></pre></notextile>
-
-
index 7f504a919d55dec472fee62f895ae8ba492fd520..1fd525d404c348fda648d57898c8c4877fd0bbb1 100644 (file)
@@ -162,10 +162,11 @@ server {
 
 h2. Prepare the Workbench deployment
 
-Now that all your configuration is in place, run @/usr/local/bin/arvados-workbench-upgrade.sh@.  This will install and check your configuration, and install necessary gems.
+{% assign railspkg = "arvados-workbench" %}
+{% include 'install_rails_reconfigure' %}
 
 {% include 'notebox_begin' %}
-You can safely ignore the following error message you may see when installing gems:
+You can safely ignore the following error message you may see when Ruby Gems are installed:
 <notextile>
 <pre><code>themes_for_rails at /usr/local/rvm/gems/ruby-2.1.1/bundler/gems/themes_for_rails-1fd2d7897d75 did not have a valid gemspec.
 This prevents bundler from installing bins or native extensions, but that may not affect its functionality.
@@ -177,8 +178,6 @@ Using themes_for_rails (0.5.1) from https://github.com/holtkampw/themes_for_rail
 </notextile>
 {% include 'notebox_end' %}
 
-This command aborts when it encounters an error.  It's safe to rerun multiple times, so if there's a problem with your configuration, you can fix that and try again.
-
 h2. Trusted client setting
 
 Log in to Workbench once to ensure that the Arvados API server has a record of the Workbench client. (It's OK if Workbench says your account hasn't been activated yet. We'll deal with that next.)