Site search for the City of Malmo
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config
db
lib
log
public
puppet
spec
vendor/malmo_shared_assets
.bowerrc
.gitignore
.rspec
.ruby-version
COPYING
Capfile
Gemfile
Gemfile.lock
Guardfile
README.md
Rakefile
Vagrantfile
config.ru

README.md

Site Search

A Ruby on Rails app for the external site search on the City of Malmo and the intranet. Search recommendations are managed in the application. The siteseeker_normalizer Ruby Gem is used for the Siteseeker integration part.

Dependencies

  • A Siteseeker account
  • Nginx (for production)
  • Ruby 2.x
  • MySQL
  • ElasticSearch 5.x
  • Memcached
  • Imagemagick
  • Global Assets.

We use Puppet in standalone mode to setup development and server environments, see puppet-mcommons for in-depth details.

Development Setup

Development dependencies:

  • Vagrant
  • A Vagrant compatible virtual machine such as VirtualBox or VMWare

To get the project files and create a Vagrant box with a ready-to-use development environment on your own machine, run the following commands:

$ git clone git@github.com:malmostad/sitesearch.git
$ cd sitesearch
$ vagrant up

Check the generated install_info.txt file in the project root for database details when the provisioning has finished.

Log in to the Vagrant box as the vagrant user and start the application in the Vagrant box:

$ vagrant ssh
$ cd /vagrant
$ rails s -b 0.0.0.0

Point a browser on your host system to http://127.0.0.1:3030. Editing of the project files on your host system will be reflected when you hit reload in your browser.

When you run the vagrant up command for the first time it creates an Ubuntu 16.04 based Vagrant box with a ready-to-use development environment for the application. This will take some time. Vagrant will launch fast after the first run.

If you get port conflicts in your host system, change forwarded_port in the Vagrantfile You might also want to edit the value for vm.hostname and puppet.facter in the same file or do a mapping localhost mapping in your hosts host file to reflect that value.

Server Provisioning

The project contains resources for a standalone Puppet (no master) one-time provisioning setup. Do not run or re-run the provisioning on an existing server if you have made manual changes to config files generated by Puppet. It will overwrite.

On a fresh server running a base install of Ubuntu 16.04:

  1. Add app_runner as a sudo user.

  2. Log on to the server as app_runner and download the two provisioning files needed:

     $ wget https://raw.githubusercontent.com/malmostad/puppet-mcommons/master/bootstrap.sh
     $ wget https://raw.githubusercontent.com/malmostad/sitesearch/master/puppet/server.pp
    
  3. Run the provisioning:

     $ sudo bash ./bootstrap.sh
    

When finished, read the generated install_info.txt file in app_runner's home directory for database details.

So, what happened?

  • Nginx, MySQL, Elasticsearch and memcached are configured and installed as services
  • A database ready for Rails migration is created (see deployment below)
  • Logrotating and database backup are configured
  • Snakeoil SSL certs are generated as placeholders
  • Ruby is compiled and managed using rbenv for the app_runner user.

The environment should now be ready for application deployment as described below.

The user app_runner must be used for all deployment task and for command executions related to the Rails application on the server. Rbenv is configured for that specific user only. The Rack application server, Unicorn, is run by app_runner.

Build and Deployment

Build and deployment is made with Capistrano 3.

In the project root, run one of the following commands including the appropriate environment name:

$ bundle exec cap staging_external deploy
$ bundle exec cap staging_internal deploy
$ bundle exec cap production_external deploy
$ bundle exec cap production_internal deploy

Testing

Run tests before pushing code to the Git repository and before performing deployments. The application contains unit tests and high level integration/feature tests using RSpec, Capybara and PhantomJS. Run the test cases in the projects root directory in your Vagrant box:

$ bundle exec rspec

License

Released under AGPL version 3.