diff --git a/INSTALL.md b/INSTALL.md index 7bc85350..2a851ba4 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,8 +1,22 @@ # Install Open Source Event Manager -All the information that you need to install OSEM. If you have any problems with installing don't hesitate to [contact us](https://github.com/openSUSE/osem#contact) +This file contains all the information you need to install OSEM. If you run into any problems, do not hesitate to [contact us](https://github.com/openSUSE/osem#contact). + +If you encounter +``` +An error occurred while installing yajl-ruby (1.2.0), and Bundler cannot continue. +Make sure that `gem install yajl-ruby -v '1.2.0'` succeeds before bundling. +``` +or + +``` +An error occurred while installing json (1.8.3), and Bundler cannot continue. +Make sure that `gem install json -v '1.8.3'` succeeds before bundling. +``` + +check that your Ruby version is not greater than `ruby-2.3.3`. ## Versions -OSEM is an [semantic versioned](http://semver.org/) app. That means given a version number MAJOR.MINOR.PATCH we increment the: +OSEM is a [semantic versioned](http://semver.org/) app. That means given a version number MAJOR.MINOR.PATCH we increment the: 1. MAJOR version when we make incompatible changes, 2. MINOR version when we add functionality in a backwards-compatible manner @@ -12,13 +26,13 @@ OSEM is an [semantic versioned](http://semver.org/) app. That means given a vers You can find the latest OSEM releases on our [release page](https://github.com/openSUSE/osem/releases/latest) ([older release here](https://github.com/openSUSE/osem/releases)) ## Deploy -OSEM is a *Ruby on Rails* application. We recommend to run OSEM in production with [mod_passenger](https://www.phusionpassenger.com/download/#open_source) +OSEM is a *Ruby on Rails* application. We recommend you run OSEM in production with [mod_passenger](https://www.phusionpassenger.com/download/#open_source) and the [apache web-server](https://www.apache.org/). There are tons of guides on how to deploy rails apps on various base operating systems. [Check Google](https://encrypted.google.com/search?hl=en&q=ruby%20on%20rails%20apache%20passenger) ;-) -For more information about rails and what it can do, see the [rails guides.](http://guides.rubyonrails.org/getting_started.html) +For more information about Fails and what it can do, see the [Fails Guides.](http://guides.rubyonrails.org/getting_started.html) -If you have an heroku account you can also +If you have a Heroku account you can also Deploy @@ -55,8 +69,8 @@ There are a couple of environment variables you can set to configure OSEM. | STRIPE_SECRET_KEY | *string* | Secret Key for Stripe Gateway ### Online Ticket Payments -We use [Stripe](https://stripe.com) for accepting your ticket payments securely over the web. -Our application uses iFrame for accepting your user's payment details without storing them, making the application PCI SAQ-A Compliant. +We use [Stripe](https://stripe.com) for accepting ticket payments securely over the web. +Our application uses iFrame for accepting your users' payment details without storing them, making the application PCI SAQ-A Compliant. Please refer to [PAYMENTS](PAYMENTS.md) documentation file for setting up your stripe account and start accepting payments from your users. ## Dependencies @@ -74,7 +88,7 @@ In order to use [openID](http://openid.net/) logins for your OSEM installation y ## Recurring Jobs ======= -Open a separate terminal and go into the directory where the rails app is present, and type the following to start the delayed_jobs worker for sending email notifications. +Open a separate terminal and go into the directory where the Rails app is present, and type the following to start the delayed_jobs worker for sending email notifications. ``` bundle exec rake jobs:work ``` diff --git a/PAYMENTS.md b/PAYMENTS.md index ea1d515b..d835e1c0 100644 --- a/PAYMENTS.md +++ b/PAYMENTS.md @@ -1,5 +1,5 @@ # Integrate your Stripe account to accept your user's payments -Here you will find all the information that you need to setup your Stripe account into OSEM. +Here you will find all the information you need to setup your Stripe account into OSEM. If you have any problems with installing don't hesitate to [contact us](https://github.com/openSUSE/osem#contact) ## Configure Stripe into the application @@ -25,9 +25,9 @@ You can test the payment feature in development mode with some test cards. Check out the list of test cards [here](https://stripe.com/docs/testing#cards). ### PCI Self Assessment Questionnaire(SAQ) -> As long as you serve your payment pages over TLS, and use either Checkout or Stripe.js -> as the only way of handling card information, Stripe automatically creates a prefilled SAQ A questionnaire for you, -> and you won’t need to undergo a PCI audit. If card data is stored or transferred through your servers, +> As long as you serve your payment pages over TLS, and use either Checkout or Stripe.js +> as the only way of handling card information, Stripe automatically creates a prefilled SAQ A questionnaire for you, +> and you won’t need to undergo a PCI audit. If card data is stored or transferred through your servers, > you are responsible for following PCI DSS guidelines for handling card data, and periodic audits by a PCI-certified auditor. As we are using Stripe Checkout for accepting payments, Stripe will help you for filling SAQ for your application.