Merge pull request #32 from OSC/add-sftp

Add sftp host env variable

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 
 ## [Unreleased]
+### Added
+- added SFTP links to support [#3](https://github.com/OSC/frame-renderer/issues/3)
 
 ## [0.1.1] - 2019-09-26
 ### Fixed

README.md

@@ -192,7 +192,18 @@ execute the yum install command.
 
 `sudo yum install ondemand-frame-renderer`
 
-## Custom Initializers
+### Customizing the install
+
+### Env file
+
+Create the file `/etc/ood/config/apps/frame-renderer/env` and add these entries.
+
+```bash
+# the sftp host your users can connect to to upload and download their project files.
+SFTP_HOST=my-host.net
+```
+
+### Initializers
 
 Create the file `/etc/ood/config/apps/frame-renderer/config/initializers/site_cluster_overrides.rb`
 and populate it with the ruby class definition below. Notes are given as to why you're overriding

app/views/projects/new.html.erb

@@ -6,6 +6,13 @@
   Before making a new project here, be sure to upload the project to the servers if the files are not already there. <br>
   You can follow the directions on the <a href="https://github.com/OSC/frame-renderer/#upload-your-project">README</a> on how to do so.
   <br><br>
+
+  <% if Configuration.sftp_host %>
+  If you already have an SFTP client installed, you can click
+  <a href="sftp://<%= ENV["USER"] %>@<%= Configuration.sftp_host %><%= @project.directory %>/">here</a> to open it.
+  <br><br>
+  <% end %>
+
 </div>
 
 <%= render 'form' %>

config/configuration_singleton.rb

@@ -83,6 +83,10 @@ def locales_root
     Pathname.new(ENV['OOD_LOCALES_ROOT'] || "/etc/ood/config/locales")
   end
 
+  def sftp_host
+    ENV['SFTP_HOST']
+  end
+
   private 
 
   # The environment