1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Ruby on Rails
Find a file
schneems 5563c329ee Add Default Puma Config
When the `puma` command is run without any configuration options it will detect presence of a `config/puma.rb` file and use that. Currently there is discrepancy between `puma` command and `rails server` but Evan said it would be reasonable to add in reading in config from the default location. I am working on that right now as a feature in puma/puma.

Why do we need this? By default Puma uses 16 threads, and by default ActiveRecord only has 5 threads. Due to the architecture of AR it is guaranteed that if you're running with fewer DB connections than your server has threads you will hit `ActiveRecord::ConnectionTimeoutError ` eventually if your app gets modest amounts of traffic. Since we are providing a default webserver, we should provide reasonable configuration for that webserver.

This PR does a few things, first it sets the default Puma thread count to 5 to mach ActiveRecord's default. It sets the default environment to `"development"` and the default port to 300 so that booting the server with `$ puma` will give you the same default port as `rails server`. It is worth mentioning that by reading in from `PORT` environment variable this config can work with containerized deployments, such as on Heroku. 

We are not using worker processes by default, that way JRuby and windows devs can use this configuration without modification. I went ahead and included a default `on_worker_boot`. It won't be used unless a worker count is specified, that means this config will not use it. Even though it's not being used now It will make someone who wants to try modifying their config to run extra workers easier.

cc/ @pixeltrix
2016-01-29 15:58:37 -06:00
actioncable Small doc update per RF [ci skip] 2016-01-20 17:13:43 -05:00
actionmailer Update copyright notice for 2016 2016-01-01 12:31:53 -05:00
actionpack rm changelog for unreleased changes fixes 2016-01-22 12:43:03 +05:30
actionview html_safe is not supposed to be public API for AV. This change removes usage of html_safe in favour of raw() in AV helpers. 2016-01-20 12:38:59 +05:30
activejob Merge pull request #22487 from joshsoftware/issue_22413 2016-01-01 18:58:42 -03:00
activemodel Refactor tz aware types, add support for PG ranges 2016-01-08 14:11:45 -07:00
activerecord [ci skip] Add note about tsrange and timezone awareness to docs 2016-01-22 14:35:52 +03:00
activesupport Merge pull request #22278 from poporul/master 2016-01-15 10:32:30 -08:00
ci Use an appropriate rebuild task on Travis 2015-12-22 00:55:13 +09:00
guides [ci skip] fix #23157 2016-01-22 02:25:55 +06:00
railties Add Default Puma Config 2016-01-29 15:58:37 -06:00
tasks Add task to test the release preparation 2015-12-18 14:56:26 -02:00
tools make it possible to customize the executable inside rereun snippets. 2015-06-13 11:58:43 +02:00
.gitignore Test against Rails edge by default. CI against 4.2 also. 2015-10-16 00:58:06 -07:00
.travis.yml Update postgresql version to 9.4 for travis. 2016-01-10 04:31:22 +05:30
.yardopts
CODE_OF_CONDUCT.md Move the CoC text to the Rails website 2015-08-21 12:32:59 -07:00
CONTRIBUTING.md Typo in Contributing.md documentation 2016-01-06 23:34:41 +00:00
Gemfile Ensure sucker_punch < v2 is installed due to the change in public API 2016-01-02 14:54:15 -05:00
Gemfile.lock Fix code review comments 2016-01-18 19:37:25 -05:00
load_paths.rb require "rubygems" is obsolete in Ruby 1.9.3 2012-05-13 14:47:25 +02:00
rails.gemspec Initial stab at adding Action Cable to rails/master 2015-12-14 16:38:37 +01:00
RAILS_VERSION Change alpha to beta1 to prep for release of Rails 5 2015-12-18 12:14:09 -05:00
Rakefile Add task to test the release preparation 2015-12-18 14:56:26 -02:00
README.md Add Action Cable to README.md of Rails 2015-12-15 09:36:06 -08:00
RELEASING_RAILS.md Convert Releasing Rails guide to Markdown 2015-08-15 09:21:46 -04:00
version.rb Change alpha to beta1 to prep for release of Rails 5 2015-12-18 12:14:09 -05:00

Welcome to Rails

Rails is a web-application framework that includes everything needed to create database-backed web applications according to the Model-View-Controller (MVC) pattern.

Understanding the MVC pattern is key to understanding Rails. MVC divides your application into three layers, each with a specific responsibility.

The Model layer represents your domain model (such as Account, Product, Person, Post, etc.) and encapsulates the business logic that is specific to your application. In Rails, database-backed model classes are derived from ActiveRecord::Base. Active Record allows you to present the data from database rows as objects and embellish these data objects with business logic methods. You can read more about Active Record in its README. Although most Rails models are backed by a database, models can also be ordinary Ruby classes, or Ruby classes that implement a set of interfaces as provided by the Active Model module. You can read more about Active Model in its README.

The Controller layer is responsible for handling incoming HTTP requests and providing a suitable response. Usually this means returning HTML, but Rails controllers can also generate XML, JSON, PDFs, mobile-specific views, and more. Controllers load and manipulate models, and render view templates in order to generate the appropriate HTTP response. In Rails, incoming requests are routed by Action Dispatch to an appropriate controller, and controller classes are derived from ActionController::Base. Action Dispatch and Action Controller are bundled together in Action Pack. You can read more about Action Pack in its README.

The View layer is composed of "templates" that are responsible for providing appropriate representations of your application's resources. Templates can come in a variety of formats, but most view templates are HTML with embedded Ruby code (ERB files). Views are typically rendered to generate a controller response, or to generate the body of an email. In Rails, View generation is handled by Action View. You can read more about Action View in its README.

Active Record, Active Model, Action Pack, and Action View can each be used independently outside Rails. In addition to them, Rails also comes with Action Mailer (README), a library to generate and send emails; Active Job (README), a framework for declaring jobs and making them run on a variety of queueing backends; Action Cable (README), a framework to integrate WebSockets with a Rails application; and Active Support (README), a collection of utility classes and standard library extensions that are useful for Rails, and may also be used independently outside Rails.

Getting Started

  1. Install Rails at the command prompt if you haven't yet:

     $ gem install rails
    
  2. At the command prompt, create a new Rails application:

     $ rails new myapp
    

    where "myapp" is the application name.

  3. Change directory to myapp and start the web server:

     $ cd myapp
     $ rails server
    

    Run with --help or -h for options.

  4. Using a browser, go to http://localhost:3000 and you'll see: "Welcome aboard: You're riding Ruby on Rails!"

  5. Follow the guidelines to start developing your application. You may find the following resources handy:

Contributing

We encourage you to contribute to Ruby on Rails! Please check out the Contributing to Ruby on Rails guide for guidelines about how to proceed. Join us!

Everyone interacting in Rails and its sub-projects' codebases, issue trackers, chat rooms, and mailing lists is expected to follow the Rails code of conduct.

Code Status

Build Status

License

Ruby on Rails is released under the MIT License.