Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/refinery/refinerycms-inquiries

Inquiries extension for Refinery CMS
https://github.com/refinery/refinerycms-inquiries

Last synced: 3 months ago
JSON representation

Inquiries extension for Refinery CMS

Awesome Lists containing this project

README

        

# Inquiries

![Refinery Inquiries](http://refinerycms.com/system/images/BAhbBlsHOgZmSSIqMjAxMS8wNS8wMS8wNF81MF8wMV81MDlfaW5xdWlyaWVzLnBuZwY6BkVU/inquiries.png)

## About

__Add a simple contact form to Refinery that notifies you and the customer when an inquiry is made.__

In summary you can:

* Collect and manage inquiries
* Specify who is notified when a new inquiry comes in
* Customise an auto responder email that is sent to the person making the inquiry

When inquiries come in, you and the customer are generally notified. As we implemented spam filtering through the [filters_spam plugin](https://github.com/resolve/filters_spam#readme) you will not get notified if an inquiry is marked as 'spam'. This feature is optional, and can be disabled in `config/initializers/refinery/inquiries.rb` by setting `config.filter_spam = false`.

### Gem Installation using Bundler (The very best way)

Include the latest [gem](http://rubygems.org/gems/refinerycms-inquiries) into your Refinery CMS application's Gemfile:

```ruby
gem 'refinerycms-inquiries', '~> 3.0.0'
```

Then type the following at command line inside your Refinery CMS application's root directory:

bundle install

#### Installation on Refinery 2.0.0 or above.

To install the migrations, run:

rails generate refinery:inquiries
rake db:migrate

Add pages to the database and you're done:

rake db:seed

#### Optionally include the stylesheet.

Next, you can include the stylesheet that improves the form's display a bit,
and also adds an asterisk to each `required` label: `Name *` instead of `Name`.

To do this, include it in your `application.css` manifest file and insert:

```css
//= require refinery/inquiries/inquiries
```

## How do I enable reCAPTCHA support?

Note: enabling this feature disables the built in spam filtering.

Just add your reCAPTCHA "Site key" in `config/initializers/refinery/inquiries.rb`:

```ruby
config.recaptcha_site_key = "do NOT put your secret key here"
```

Inside `config/secrets.yml`, the file for application secrets in Rails applications,
place the secret key:

```yml
development:
recaptcha_secret_key: "This IS your secret key"

production:
recaptcha_secret_key: <%= ENV["RECAPTCHA_SECRET_KEY"] %>
```

Note: This expects you to set your secret key via `ENV` in your production environment.

## How do I set up email to be sent from GMail, SendGrid or other service?

Inquiries uses `actionmailer` under the hood so you can refer to [Rails Action Mailer guide](http://guides.rubyonrails.org/action_mailer_basics.html). For example to use GMail see [Action Mailer Configuration for GMail](http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration-for-gmail) guide.

## How do I get Notified?

Go into your 'Inquiries' tab in the Refinery admin area and click on "Update who gets notified"

## How do I Edit the Automatic Confirmation Email

Go into your 'Inquiries' tab in the Refinery admin area and click on "Edit confirmation email"

## Help! How do I send emails from [email protected] instead of [email protected]?

Simply set the following in `config/application.rb`:

```ruby
config.action_dispatch.tld_length = 2
```