Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/josiahsiegel/triple-stack

A simple layout that combines LDAP authentication with Rails and a Microsoft SQL backend.
https://github.com/josiahsiegel/triple-stack

Last synced: 6 days ago
JSON representation

A simple layout that combines LDAP authentication with Rails and a Microsoft SQL backend.

Awesome Lists containing this project

README 

        
[RailsInstaller]:http://railsinstaller.org/en

[ODBC Driver]:http://www.microsoft.com/en-us/download/details.aspx?id=36434

[secrets_demo.yml]:https://github.com/josiah85/triple-stack/blob/master/config/secrets_demo.yml

[secrets]:https://github.com/josiah85/triple-stack#secrets

[Puma]:https://github.com/puma/puma

[rails-disco]:https://github.com/hicknhack-software/rails-disco/wiki/Installing-puma-on-windows



# **Triple-Stack**



## Build from scratch:



Install rails: [RailsInstaller]



Verify your installation by running `rails --version`



If you see the error `cannot load such file -- c:/RailsInstaller/Ruby2.1.0/lib/ruby/gems/2.1.0/gems/rails-4.2.0/bin/rails (LoadError)` 

or similar, do the following:



- Navigate to the rails file and set the correct rails path:



>  `C:/Users/xmr/Desktop/railsinstaller-windows/stage/Ruby2.1.0/bin/rails`

    

>  to

    

>  `C:/RailsInstaller/Ruby2.1.0/bin/rails`

 

Build a rails app: `rails new triple-stack`



If you receive the following error: `Gem::RemoteFetcher::FetchError: SSL_connect`, you will have to temporarily edit your Gemfile source to http instead of https, `cd` into `triple-stack`, and run `bundle install`.



To view your new application, run `rails server` and navigate to http://localhost:3000/.

You will see the error " **Could not load 'active_record/connection_adapters/sqlite3_adapter'** ".



`Ctrl-C` to shutdown server.



Open your Gemfile, remove `gem 'sqlite3'`, and add the following gems:

```ruby

gem 'tiny_tds'

gem 'activerecord-sqlserver-adapter'

gem 'devise'

gem 'devise_ldap_authenticatable'



gem 'bootstrap-sass', '~> 3.3.3'

gem 'font-awesome-rails'



gem 'puma'

```



- change the rails gem version to `'4.1.9'`.

- run `bundle update`

- comment out `config.active_record.raise_in_transactional_callbacks = true` in ***config/application.rb***

- Create a [secrets] file.

- replace the content in your ***app/config/database.yml*** file to the following:



```ruby

default: &default

  adapter: sqlserver

  dataserver: <%= Rails.application.secrets.DB_HOST %>

  database: <%= Rails.application.secrets.DB_NAME %>

  username: <%= Rails.application.secrets.DOMAIN_USER %>

  password: <%= Rails.application.secrets.DB_SECRET %>



development:

  adapter: sqlserver

  dataserver: <%= Rails.application.secrets.DB_HOST %>

  database: <%= Rails.application.secrets.DB_NAME %>

  username: <%= Rails.application.secrets.DOMAIN_USER %>

  password: <%= Rails.application.secrets.DB_SECRET %>



# Warning: The database defined as "test" will be erased and

# re-generated from your development database when you run "rake".

# Do not set this db to the same as development or production.

test:

  adapter: sqlserver

  dataserver: <%= Rails.application.secrets.DB_HOST %>

  database: <%= Rails.application.secrets.DB_NAME %>

  username: <%= Rails.application.secrets.DOMAIN_USER %>

  password: <%= Rails.application.secrets.DB_SECRET %>



production:

  dataserver: <%= Rails.application.secrets.DB_HOST %>

  database: <%= Rails.application.secrets.DB_NAME %>

  username: <%= Rails.application.secrets.DOMAIN_USER %>

  password: <%= Rails.application.secrets.DB_SECRET %>

```



*Optional*



>To create an odbc connection in Windows: 

>- Add gem `ruby-odbc` and run `bundle install`

>- Open up the **Control Panel** 

>- Click on **Administrative Tools** 

>- Open **Data Sources (ODBC)**

>- Select the tab **User DSN** 

>- Click **Add**

>- Select **ODBC Driver 11 for SQL Server**

>

>If this driver is not available, you will have to download it here: [ODBC Driver].

>Once your ODBC connection is configured and you are able to successfully test the connection, you will then be able to add the name of the connection to `dsn` in your ***config/database.yml*** file.

>

>In ***config/database.yml***, change your datasource to look like the following:

>```ruby

>  adapter: sqlserver

>  dsn: local_sqlserver

>  mode: odbc

>  database: XXXX

>  username: XXXX

>  password: XXXX

>```



Run `rails server` and navigate to http://localhost:3000/. 



`Ctrl-C` to shutdown server.



## LDAP authentication:

- Run `rails g controller Welcome index`

- Set `root` in ***config/routes.rb*** to `'welcome#index'`

- Run `rails generate devise:install`

- Add the following between `` tags in ***app/views/layouts/application.html.erb***:

    - `
<%= notice %>
`

    - `
<%= alert %>
`

- Declaring a devise model other than 'User' may be necessary if your db already contains a 'users' table.

  - Run `rails generate devise LdapUser`

  - Run `rails generate devise_ldap_authenticatable:install --user-model=ldap_user`

- Run `rails g devise:views`

- Run `bin/rake db:migrate` to update the database

- Run `rails server` and navigate to http://localhost:3000/ldap_users/sign_in to view the sign in page.

- `Ctrl-C` to shutdown server.

- Open ***config/ldap.yml*** and configure with appropriate credentials.

    - You may need to contact your IT department for this information.

    - Example:

```ruby

development:

  host: name.company.local

  port: 389

  attribute: sAMAccountName

  base: "DC=company,DC=local"

  admin_user: domain\user

  admin_password: XXXX

  ssl: false

  # <<: *AUTHORIZATIONS

```



### Modify LDAP authentication to accept username:

- Open ***app/views/devise/sessions/new.html.erb*** and change

```html

<%= f.label :email %>


<%= f.email_field :email, autofocus: true %>

```

to

```html

<%= f.label :username %>


<%= f.text_field :username, autofocus: true %>

```

- Note email_field became text_field to disable email authentication.

- Modify the ldap_user model to populate the user's email and to no longer require it for validation:



  ```ruby

  before_validation:get_ldap_email

  

  def get_ldap_email

    array =  Devise::LDAP::Adapter.get_ldap_param(self.username, 'mail')

    self.email = array.first

  end

  

  def email_required?

    false

  end

  

  def email_changed?

    false

  end

  ```

- Open ***config/initializers/devise.rb***

    - Change `config.authentication_keys` to equal `[ :username ]`

    - Change `config.ldap_create_user` to equal `true` so all valid LDAP users will be allowed to login and an appropriate user record will be created.

    - Change `config.ldap_use_admin_to_bind` to equal `true` so the admin user will be used to bind to the LDAP server during authentication.

- Run `rails generate migration add_username_to_ldap_users username:string:uniq` to create a migration to add a username column to the ldap_users table.

- Run `rake db:migrate` to update the database with the migration.



## Sign In/Out links:

- Create partial `_login_items.html.erb` in directory ***app/views/devise/shared/*** with the following:

```r

<% if ldap_user_signed_in? %>

  
  • 

      <%= link_to('Sign Out', destroy_ldap_user_session_path, :method => :delete) %>        

      
    • 

    <% else %>

      
  • 

      <%= link_to('Sign In', new_ldap_user_session_path)  %>  

      
    • 

    <% end %>

    ```

    - In ***app/views/layouts/application.html.erb***, add `<%= render 'devise/shared/login_items' %>` above `<%= yield %>` to display the sign in/out links.
    


    ## Bootstrap styling & Font Awesome icons:

    - In directory ***app/assets/stylesheets/***, rename file ***application.css*** to ***application.css.scss***.

    - Add the following to ***application.css.scss***:

    ```css

    @import 'bootstrap';

    @import 'font-awesome';

    ```

    - In file ***app/assets/javascripts/application.js***, add `//= require bootstrap`

    - Add the following to ***config/initializers/assets.rb***:

    ```ruby

    Rails.application.config.assets.precompile += %w( fontawesome-webfont.eot )

    Rails.application.config.assets.precompile += %w( fontawesome-webfont.woff )

    Rails.application.config.assets.precompile += %w( fontawesome-webfont.ttf )

    Rails.application.config.assets.precompile += %w( fontawesome-webfont.svg )

    ```

    - Modify `_login_items.html.erb` in ***app/views/devise/shared/*** to:

    ```r
    


      <%= link_to image_tag('stacker.png', size: '25x20'), '#', class: 'navbar-brand' %>

        <%= link_to 'Triple Stack', root_path, class: 'navbar-brand' %>

      
      

          <% if ldap_user_signed_in? %>

            
    • 

            <%= link_to('Sign Out', destroy_ldap_user_session_path, :method => :delete) %>        

            
      • 

          <% else %>

            
    • 

            <%= link_to('Sign In', new_ldap_user_session_path)  %>  

            
      • 

          <% end %>

          
    


    ```

    - Place your brand image under ***app/assets/images/***.
    


    ## Build on a preexisting database:

    - Open your Gemfile and add `gem 'schema_to_scaffold'`

    - Run `bundle install`

    - Run `scaffold`

    - When prompted, enter the path of your schema that was populated after running `rake db:migrate`:

      - `app/db/schema.rb`

    - When prompted, designate the tables that you want scaffolding generated for.

    - Scripts will be generated that you can copy and run to build the necessary scaffolding.
    


    ## SQL 2014 support:

    - Modify the activerecord-sqlserver-adapter gem in the Gemfile to the following:

       ```

        gem 'activerecord-sqlserver-adapter', :git => "git://github.com/rails-sqlserver/activerecord-sqlserver-adapter.git", :branch => "4-1-stable"

        ```

        

    ## Secrets:

    The .gitignore file should contain `config/secrets.yml`, to prevent sensitive information from being stored in the repository.
    


    See file [secrets_demo.yml]
    


    To reference a value, use `<%= Rails.application.secrets.DOMAIN_USER %>` in a view or .yml file, or 

    `Rails.application.secrets.DOMAIN_USER` in an .rb file.
    


    ##Deployment Setup ([Puma]):
    


    #####Steps for windows installation:
    


    1. Install Ruby DevKit, e.g. in `c:\devkit`

    2. Unpack an OpenSSL Package in `c:\openssl`

    3. You need to copy the ddls from the bin directory (`libeay32.dll` and `ssleay32.dll`) to your `ruby/bin` directory.

    4. Open a windows console

    5. Initialize the DevKit build environment

      `c:\devkit\devkitvars.bat`

    6. `git clone` repo

    7. `cd triple-stack`

    8. Now it's possible to install the puma gem with the OpenSSL packages

      `gem install puma -v '2.11.0' --source http://www.rubygems.org -- --with-opt-dir="c:\openssl"`

    9. `bundle install`

    10. `puma -v` to verify installation

    11. Add `config/secrets.yml`

    12. `bundle exec rails s Puma`
    


    reference: [rails-disco]
    


    #####Steps for Linux installation:
    


    1. `git clone` repo

    2. `sudo chown -R $(whoami):$(whoami) triple-stack` to claim ownership of repo

    3. `sudo apt-get install freetds-dev` or `sudo yum install freetds-devel` to install dependencies for gem tiny_tds

    4. `cd triple-stack`

    5. `bundle install`

    6. Add `config/secrets.yml`

    7. `bundle exec rails s Puma`
    


    #####VirtualBox installation:
    


    1. Settings>Network>"NAT" to "Bridged Adapter"

    2. Follow Linux installation