devise.rb 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  1. # Use this hook to configure devise mailer, warden hooks and so forth.
  2. # Many of these configuration options can be set straight in your model.
  3. Devise.setup do |config|
  4. # ==> Mailer Configuration
  5. # Configure the e-mail address which will be shown in Devise::Mailer,
  6. # note that it will be overwritten if you use your own mailer class
  7. # with default "from" parameter.
  8. config.mailer_sender = ENV['EMAIL_FROM_ADDRESS'].presence || 'you@example.com'
  9. # Configure the class responsible to send e-mails.
  10. # config.mailer = 'Devise::Mailer'
  11. # ==> ORM configuration
  12. # Load and configure the ORM. Supports :active_record (default) and
  13. # :mongoid (bson_ext recommended) by default. Other ORMs may be
  14. # available as additional gems.
  15. require 'devise/orm/active_record'
  16. # ==> Configuration for any authentication mechanism
  17. # Configure which keys are used when authenticating a user. The default is
  18. # just :email. You can configure it to use [:username, :subdomain], so for
  19. # authenticating a user, both parameters are required. Remember that those
  20. # parameters are used only when authenticating and not when retrieving from
  21. # session. If you need permissions, you should implement that in a before filter.
  22. # You can also supply a hash where the value is a boolean determining whether
  23. # or not authentication should be aborted when the value is not present.
  24. config.authentication_keys = [ :login ]
  25. # Configure parameters from the request object used for authentication. Each entry
  26. # given should be a request method and it will automatically be passed to the
  27. # find_for_authentication method and considered in your model lookup. For instance,
  28. # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
  29. # The same considerations mentioned for authentication_keys also apply to request_keys.
  30. # config.request_keys = []
  31. # Configure which authentication keys should be case-insensitive.
  32. # These keys will be downcased upon creating or modifying a user and when used
  33. # to authenticate or find a user. Default is :email.
  34. config.case_insensitive_keys = [ :email ]
  35. # Configure which authentication keys should have whitespace stripped.
  36. # These keys will have whitespace before and after removed upon creating or
  37. # modifying a user and when used to authenticate or find a user. Default is :email.
  38. config.strip_whitespace_keys = [ :email ]
  39. # Tell if authentication through request.params is enabled. True by default.
  40. # It can be set to an array that will enable params authentication only for the
  41. # given strategies, for example, `config.params_authenticatable = [:database]` will
  42. # enable it only for database (email + password) authentication.
  43. # config.params_authenticatable = true
  44. # Tell if authentication through HTTP Auth is enabled. False by default.
  45. # It can be set to an array that will enable http authentication only for the
  46. # given strategies, for example, `config.http_authenticatable = [:database]` will
  47. # enable it only for database authentication. The supported strategies are:
  48. # :database = Support basic authentication with authentication key + password
  49. # config.http_authenticatable = false
  50. # If 401 status code should be returned for AJAX requests. True by default.
  51. # config.http_authenticatable_on_xhr = true
  52. # The realm used in Http Basic Authentication. 'Application' by default.
  53. # config.http_authentication_realm = 'Application'
  54. # It will change confirmation, password recovery and other workflows
  55. # to behave the same regardless if the e-mail provided was right or wrong.
  56. # Does not affect registerable.
  57. # config.paranoid = true
  58. # By default Devise will store the user in session. You can skip storage for
  59. # particular strategies by setting this option.
  60. # Notice that if you are skipping storage for all authentication paths, you
  61. # may want to disable generating routes to Devise's sessions controller by
  62. # passing skip: :sessions to `devise_for` in your config/routes.rb
  63. config.skip_session_storage = [:http_auth]
  64. # By default, Devise cleans up the CSRF token on authentication to
  65. # avoid CSRF token fixation attacks. This means that, when using AJAX
  66. # requests for sign in and sign up, you need to get a new CSRF token
  67. # from the server. You can disable this option at your own risk.
  68. # config.clean_up_csrf_token_on_authentication = true
  69. # ==> Configuration for :database_authenticatable
  70. # For bcrypt, this is the cost for hashing the password and defaults to 10. If
  71. # using other encryptors, it sets how many times you want the password re-encrypted.
  72. #
  73. # Limiting the stretches to just one in testing will increase the performance of
  74. # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
  75. # a value less than 10 in other environments. Note that, for bcrypt (the default
  76. # encryptor), the cost increases exponentially with the number of stretches (e.g.
  77. # a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
  78. config.stretches = Rails.env.test? ? 1 : 10
  79. # Setup a pepper to generate the encrypted password.
  80. # config.pepper = "SOME LONG HASH GENERATED WITH rake secret"
  81. # Send a notification email when the user's password is changed
  82. # config.send_password_change_notification = false
  83. # ==> Configuration for :confirmable
  84. # A period that the user is allowed to access the website even without
  85. # confirming their account. For instance, if set to 2.days, the user will be
  86. # able to access the website for two days without confirming their account,
  87. # access will be blocked just in the third day. Default is 0.days, meaning
  88. # the user cannot access the website without confirming their account.
  89. config.allow_unconfirmed_access_for = Utils.parse_duration(ENV['ALLOW_UNCONFIRMED_ACCESS_FOR']).presence || 2.days
  90. # A period that the user is allowed to confirm their account before their
  91. # token becomes invalid. For example, if set to 3.days, the user can confirm
  92. # their account within 3 days after the mail was sent, but on the fourth day
  93. # their account can't be confirmed with the token any more.
  94. # Default is nil, meaning there is no restriction on how long a user can take
  95. # before confirming their account.
  96. config.confirm_within = Utils.parse_duration(ENV['CONFIRM_WITHIN']).presence || 3.days
  97. # If true, requires any email changes to be confirmed (exactly the same way as
  98. # initial account confirmation) to be applied. Requires additional unconfirmed_email
  99. # db field (see migrations). Until confirmed, new email is stored in
  100. # unconfirmed_email column, and copied to email column on successful confirmation.
  101. config.reconfirmable = true
  102. # Defines which key will be used when confirming an account
  103. config.confirmation_keys = [ :login ]
  104. # ==> Configuration for :rememberable
  105. # The time the user will be remembered without asking for credentials again.
  106. config.remember_for = Utils.parse_duration(ENV['REMEMBER_FOR']).presence || 4.weeks
  107. # Invalidates all the remember me tokens when the user signs out.
  108. config.expire_all_remember_me_on_sign_out = true
  109. # If true, extends the user's remember period when remembered via cookie.
  110. # config.extend_remember_period = false
  111. # Options to be passed to the created cookie. For instance, you can set
  112. # secure: true in order to force SSL only cookies.
  113. if Rails.env.production?
  114. config.rememberable_options = { secure: true }
  115. else
  116. config.rememberable_options = { }
  117. end
  118. # ==> Configuration for :validatable
  119. # Range for password length.
  120. config.password_length = (Utils.if_present(ENV['MIN_PASSWORD_LENGTH'], :to_i) || 8)..128
  121. # Email regex used to validate email formats. It simply asserts that
  122. # one (and only one) @ exists in the given string. This is mainly
  123. # to give user feedback and not to assert the e-mail validity.
  124. # config.email_regexp = /\A[^@]+@[^@]+\z/
  125. # ==> Configuration for :timeoutable
  126. # The time you want to timeout the user session without activity. After this
  127. # time the user will be asked for credentials again. Default is 30 minutes.
  128. # config.timeout_in = 30.minutes
  129. # ==> Configuration for :lockable
  130. # Defines which strategy will be used to lock an account.
  131. # :failed_attempts = Locks an account after a number of failed attempts to sign in.
  132. # :none = No lock strategy. You should handle locking by yourself.
  133. config.lock_strategy = Utils.if_present(ENV['LOCK_STRATEGY'], :to_sym) || :failed_attempts
  134. # Defines which key will be used when locking and unlocking an account
  135. config.unlock_keys = [ :login ]
  136. # Defines which strategy will be used to unlock an account.
  137. # :email = Sends an unlock link to the user email
  138. # :time = Re-enables login after a certain amount of time (see :unlock_in below)
  139. # :both = Enables both strategies
  140. # :none = No unlock strategy. You should handle unlocking by yourself.
  141. config.unlock_strategy = Utils.if_present(ENV['UNLOCK_STRATEGY'], :to_sym) || :both
  142. # Number of authentication tries before locking an account if lock_strategy
  143. # is failed attempts.
  144. config.maximum_attempts = Utils.if_present(ENV['MAX_FAILED_LOGIN_ATTEMPTS'], :to_i) || 10
  145. # Time interval to unlock the account if :time is enabled as unlock_strategy.
  146. config.unlock_in = Utils.parse_duration(ENV['UNLOCK_AFTER']).presence || 1.hour
  147. # Warn on the last attempt before the account is locked.
  148. # config.last_attempt_warning = true
  149. # ==> Configuration for :recoverable
  150. #
  151. # Defines which key will be used when recovering the password for an account
  152. config.reset_password_keys = [ :login ]
  153. # Time interval you can reset your password with a reset password key.
  154. # Don't put a too small interval or your users won't have the time to
  155. # change their passwords.
  156. config.reset_password_within = Utils.parse_duration(ENV['RESET_PASSWORD_WITHIN']).presence || 6.hours
  157. # ==> Configuration for :encryptable
  158. # Allow you to use another encryption algorithm besides bcrypt (default). You can use
  159. # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
  160. # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
  161. # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
  162. # REST_AUTH_SITE_KEY to pepper).
  163. #
  164. # Require the `devise-encryptable` gem when using anything other than bcrypt
  165. # config.encryptor = :sha512
  166. # ==> Scopes configuration
  167. # Turn scoped views on. Before rendering "sessions/new", it will first check for
  168. # "users/sessions/new". It's turned off by default because it's slower if you
  169. # are using only default views.
  170. # config.scoped_views = false
  171. # Configure the default scope given to Warden. By default it's the first
  172. # devise role declared in your routes (usually :user).
  173. # config.default_scope = :user
  174. # Set this configuration to false if you want /users/sign_out to sign out
  175. # only the current scope. By default, Devise signs out all scopes.
  176. # config.sign_out_all_scopes = true
  177. # ==> Navigation configuration
  178. # Lists the formats that should be treated as navigational. Formats like
  179. # :html, should redirect to the sign in page when the user does not have
  180. # access, but formats like :xml or :json, should return 401.
  181. #
  182. # If you have any extra navigational formats, like :iphone or :mobile, you
  183. # should add them to the navigational formats lists.
  184. #
  185. # The "*/*" below is required to match Internet Explorer requests.
  186. # config.navigational_formats = ['*/*', :html]
  187. # The default HTTP method used to sign out a resource. Default is :delete.
  188. config.sign_out_via = :get
  189. # ==> OmniAuth
  190. # Add a new OmniAuth provider. Check the wiki for more information on setting
  191. # up on your models and hooks.
  192. # config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
  193. if defined?(OmniAuth::Strategies::Twitter) &&
  194. (key = ENV["TWITTER_OAUTH_KEY"]).present? &&
  195. (secret = ENV["TWITTER_OAUTH_SECRET"]).present?
  196. config.omniauth :twitter, key, secret, authorize_params: {force_login: 'true', use_authorize: 'true'}
  197. end
  198. if defined?(OmniAuth::Strategies::Tumblr) &&
  199. (key = ENV["TUMBLR_OAUTH_KEY"]).present? &&
  200. (secret = ENV["TUMBLR_OAUTH_SECRET"]).present?
  201. config.omniauth :'tumblr', key, secret
  202. end
  203. if defined?(OmniAuth::Strategies::ThirtySevenSignals) &&
  204. (key = ENV["THIRTY_SEVEN_SIGNALS_OAUTH_KEY"]).present? &&
  205. (secret = ENV["THIRTY_SEVEN_SIGNALS_OAUTH_SECRET"]).present?
  206. config.omniauth :'37signals', key, secret
  207. end
  208. if defined?(OmniAuth::Strategies::DropboxOauth2) &&
  209. (key = ENV["DROPBOX_OAUTH_KEY"]).present? &&
  210. (secret = ENV["DROPBOX_OAUTH_SECRET"]).present?
  211. config.omniauth :dropbox, key, secret, strategy_class: OmniAuth::Strategies::DropboxOauth2, request_path: '/auth/dropbox', callback_path: '/auth/dropbox/callback'
  212. end
  213. if defined?(OmniAuth::Strategies::Wunderlist) &&
  214. (key = ENV["WUNDERLIST_OAUTH_KEY"]).present? &&
  215. (secret = ENV["WUNDERLIST_OAUTH_SECRET"]).present?
  216. config.omniauth :wunderlist, key, secret
  217. end
  218. if defined?(OmniAuth::Strategies::Evernote) &&
  219. (key = ENV["EVERNOTE_OAUTH_KEY"]).present? &&
  220. (secret = ENV["EVERNOTE_OAUTH_SECRET"]).present?
  221. if ENV["USE_EVERNOTE_SANDBOX"] == "true"
  222. config.omniauth :evernote, key, secret, client_options: { :site => 'https://sandbox.evernote.com' }
  223. else
  224. config.omniauth :evernote, key, secret
  225. end
  226. end
  227. # ==> Warden configuration
  228. # If you want to use other strategies, that are not supported by Devise, or
  229. # change the failure app, you can configure them inside the config.warden block.
  230. #
  231. # config.warden do |manager|
  232. # manager.intercept_401 = false
  233. # manager.default_strategies(scope: :user).unshift :some_external_strategy
  234. # end
  235. # ==> Mountable engine configurations
  236. # When using Devise inside an engine, let's call it `MyEngine`, and this engine
  237. # is mountable, there are some extra configurations to be taken into account.
  238. # The following options are available, assuming the engine is mounted as:
  239. #
  240. # mount MyEngine, at: '/my_engine'
  241. #
  242. # The router that invoked `devise_for`, in the example above, would be:
  243. # config.router_name = :my_engine
  244. #
  245. # When using omniauth, Devise cannot automatically set Omniauth path,
  246. # so you need to do it manually. For the users scope, it would be:
  247. # config.omniauth_path_prefix = '/my_engine/users/auth'
  248. config.omniauth_path_prefix = "/auth"
  249. end