Rails code running the Lobsters link aggregation site
Ruby HTML JavaScript CSS
Latest commit 108baed Aug 16, 2016 @case case committed with Typo fix: "has mention" -> "mentioned" (#322)


Lobsters Rails Project

This is the source code to the site operating at https://lobste.rs. It is a Rails 4 codebase and uses a SQL (MariaDB in production) backend for the database and Sphinx for the search engine.

While you are free to fork this code and modify it (according to the license) to run your own link aggregation website, this source code repository and bug tracker are only for the site operating at lobste.rs. Please do not use the bug tracker for support related to operating your own site unless you are contributing code that will also benefit lobste.rs.

Contributing bugfixes and new features

Please see the CONTRIBUTING file.

Initial setup

  • Install Ruby. This code has been tested with Ruby versions 1.9.3, 2.0.0, 2.1.0, and 2.3.0.

  • Checkout the lobsters git tree from Github

     $ git clone git://github.com/jcs/lobsters.git
     $ cd lobsters
  • Run Bundler to install/bundle gems needed by the project:

     lobsters$ bundle
  • Create a MySQL (other DBs supported by ActiveRecord may work, only MySQL and MariaDB have been tested) database, username, and password and put them in a config/database.yml file:

        adapter: mysql2
        encoding: utf8mb4
        reconnect: false
        database: lobsters_dev
        socket: /tmp/mysql.sock
        username: *username*
        password: *password*
        adapter: sqlite3
        database: db/test.sqlite3
        pool: 5
        timeout: 5000
  • Load the schema into the new database:

      lobsters$ rake db:schema:load
  • Create a config/initializers/secret_token.rb file, using a randomly generated key from the output of rake secret:

      Lobsters::Application.config.secret_key_base = 'your random secret here'
  • (Optional, only needed for the search engine) Install Sphinx. Build Sphinx config and start server:

      lobsters$ rake ts:rebuild
  • Define your site's name and default domain, which are used in various places, in a config/initializers/production.rb or similar file:

      class << Rails.application
        def domain
        def name
          "Example News"
      Rails.application.routes.default_url_options[:host] = Rails.application.domain
  • Put your site's custom CSS in app/assets/stylesheets/local.

  • Seed the database to create an initial administrator user and at least one tag:

      lobsters$ rake db:seed
      created user: test, password: test
      created tag: test
  • Run the Rails server in development mode. You should be able to login to http://localhost:3000 with your new test user:

      lobsters$ rails server
  • In production, set up crontab or another scheduler to run regular jobs:

      */20 * * * * cd /path/to/lobsters && env RAILS_ENV=production bundle exec rake ts:index > /dev/null
      */5 * * * *  cd /path/to/lobsters && env RAILS_ENV=production sh -c 'bundle exec ruby script/mail_new_activity; bundle exec ruby script/post_to_twitter'