gunghogeoduck/osem-fcy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add documentation for Stripe configuration

Browse source
This commit is contained in:
Rishabh Saxena 2016-07-31 23:58:25 +05:30
parent 2b4bf2fff7
commit c8b3b95d74
2 changed files with 34 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
INSTALL.md
View file

@ -46,7 +46,13 @@ There are a couple of environment variables you can set to configure OSEM.
| OSEM_SMTP_PASSWORD | *string* | The password for the smtp server | OSEM_SMTP_PASSWORD | *string* | The password for the smtp server
| OSEM_SMTP_AUTHENTICATION | plain, login or cram_md5 | The auth method for the smtp server | OSEM_SMTP_AUTHENTICATION | plain, login or cram_md5 | The auth method for the smtp server
| OSEM_SMTP_DOMAIN | opensuse.org | The HELO domain for the smtp server | OSEM_SMTP_DOMAIN | opensuse.org | The HELO domain for the smtp server
| CLOUDINARY_URL | *sting* | Configure your cloudinary.com cloud name and api key/secret | CLOUDINARY_URL | *string* | Configure your cloudinary.com cloud name and api key/secret
| STRIPE_PUBLISHABLE_KEY/STRIPE_SECRET_KEY | *string* | Publishable/Secret Keys 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.
Please refer to [PAYMENTS](PAYMENTS.md) documentation file for setting up your stripe account and start accepting payments from your users.
## Dependencies ## Dependencies

27
PAYMENTS.md Normal file
View file

@ -0,0 +1,27 @@
# Integrate your Stripe account to accept your user's payments
All the information that 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
To configure Stripe into your application all you need to do is add the private and publishable keys into the Rails environment.
You can add the your keys in `dotenv.example` and in `config/secrets.yml` into these variables:
If you are using the application in development mode your config should look like this:
`STRIPE_PUBLISHABLE_KEY = 'pk_test_random123example456'`
`STRIPE_SECRET_KEY = 'sk_test_random123example456'`
Otherwise, while in production mode, it should look like:
`STRIPE_PUBLISHABLE_KEY = 'pk_live_random123example456'`
`STRIPE_SECRET_KEY = 'sk_live_random123example456'`
## Configure image for your iFrame payment form
The stripe payment form uses an image of your organisation to display a personalised iFrame form for your application.
by default, the application comes with a SUSE icon, but, you can display the image of your organisation in place of that
by replacing the image of your organisation at `app/assets/images/OSEM_ICON.jpg` to an image of your organisation.
## Configure Stripe to send custom emails for your organisation
Stripe sends email reciepts for every successful payment done through its gateway.
You can also customise your payment reciepts by adding your personalisation like organisation name, logo etc.
You can see the options for personalisation [here](https://dashboard.stripe.com/account/public).