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

improve documentation

Browse source
This commit is contained in:
Rishabh Saxena 2016-08-03 00:25:56 +05:30
parent c8b3b95d74
commit f40caa8b24
3 changed files with 11 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

1
INSTALL.md
View file

@ -48,6 +48,7 @@ There are a couple of environment variables you can set to configure OSEM.
| 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 | *string* | 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 | STRIPE_PUBLISHABLE_KEY/STRIPE_SECRET_KEY | *string* | Publishable/Secret Keys for Stripe Gateway
| OSEM_ICON | *string* | Sharable link for your organisation's icon
### Online Ticket Payments ### Online Ticket Payments
We use [Stripe](https://stripe.com) for accepting your ticket payments securely over the web. We use [Stripe](https://stripe.com) for accepting your ticket payments securely over the web.

13
PAYMENTS.md
View file

@ -5,20 +5,21 @@ If you have any problems with installing don't hesitate to [contact us](https://
## Configure Stripe into the application ## 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. 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: Add your Stripe API keys in `config/secrets.yml` into these variables:
If you are using the application in development mode your config should look like this: If you are using the application in development mode your config should look like this:
`STRIPE_PUBLISHABLE_KEY = 'pk_test_random123example456'` `STRIPE_PUBLISHABLE_KEY = 'pk_**test**_random123example456'`
`STRIPE_SECRET_KEY = 'sk_test_random123example456'` `STRIPE_SECRET_KEY = 'sk_**test**_random123example456'`
Otherwise, while in production mode, it should look like: Otherwise, while in production mode, it should look like:
`STRIPE_PUBLISHABLE_KEY = 'pk_live_random123example456'` `STRIPE_PUBLISHABLE_KEY = 'pk_**live**_random123example456'`
`STRIPE_SECRET_KEY = 'sk_live_random123example456'` `STRIPE_SECRET_KEY = 'sk_**live**_random123example456'`
## Configure image for your iFrame payment form ## 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. 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 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. by putting the link of your organisation's image in your corresponding `.env` file as follows:
`OSEM_ICON = 'your organisation's sharable image link'`
## Configure Stripe to send custom emails for your organisation ## Configure Stripe to send custom emails for your organisation
Stripe sends email reciepts for every successful payment done through its gateway. Stripe sends email reciepts for every successful payment done through its gateway.

3
dotenv.example
View file

@ -9,6 +9,9 @@
# The name of your page # The name of your page
OSEM_NAME="OSEM" OSEM_NAME="OSEM"
# The shareable link of your organisation's icon image
OSEM_ICON=''
# The host this OSEM instance runs on. Used for # The host this OSEM instance runs on. Used for
# generating urls in emails sent # generating urls in emails sent
OSEM_HOSTNAME="localhost:3000" OSEM_HOSTNAME="localhost:3000"