gunghogeoduck/osem-fcy
1
0
Fork 0
mirror of https://github.com/openSUSE/osem.git synced 2026-08-13 19:54:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Move stripe docu to the wiki

Browse source 
This doesn't need to live in the code base...
This commit is contained in:
Henne Vogelsang 2019-01-30 01:45:20 +01:00
parent 2a7acf7369
commit 6745f61c83
3 changed files with 13 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

46
PAYMENTS.md
View file

@ -1,46 +0,0 @@
# Payments through Stripe
Here you will find all the information that you need to setup your Stripe account and integrate it into OSEM.
If you experience any problems, don't hesitate to [contact us](https://github.com/openSUSE/osem#contact)
**To enable payments, you need to add the API keys, provided by Stripe, in OSEM.**
## Add Stripe credentials
To integrate Stripe into OSEM, all you need to do is add the *publishable* and *secret* keys into the Rails environment.
1. Register with Stripe [here](https://dashboard.stripe.com/register) and get your API keys for free
2. Add your Stripe API keys in the following variables of your `.env` file:
* For **development**
* `STRIPE_PUBLISHABLE_KEY = 'pk_**test**_random123example456'`
* `STRIPE_SECRET_KEY = 'sk_**test**_random123example456'`
In development mode, the Stripe integration is useful for feature testing purposes. However, if you wish to enable payments for users, you need to use the live API keys.
* For **production**
* `STRIPE_PUBLISHABLE_KEY = 'pk_**live**_random123example456'`
* `STRIPE_SECRET_KEY = 'sk_**live**_random123example456'`
3. You are ready to start accepting payments from users
## Feature tests in development mode
You can test the payment feature in development mode using test credit cards; check out the list [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,
> 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.
You can read the full security documentation [here](https://stripe.com/docs/security).
## Configure Stripe to send emails for successful transactions
Stripe can send email reciepts for every successful payment done through its gateway.
Please refer [here](https://dashboard.stripe.com/account/emails) to enable invoice emails for your users.
## Customize Stripe invoice emails for your application
You can customise your payment reciepts by adding your personalisation like organisation name, logo etc.
Please see the options for invoice personalisation [here](https://dashboard.stripe.com/account/public).

16
README.md
View file

@ -11,16 +11,24 @@
An event management tool tailored to Free and Open Source Software conferences.
OSEM actively participates in [GSoC](https://summerofcode.withgoogle.com/) and [RGSoC](https://railsgirlssummerofcode.org/).
## Versions
OSEM is an [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
3. PATCH version when we make backwards-compatible bug fixes
## Download
You can find the latest OSEM releases on our [release page](https://github.com/openSUSE/osem/releases)
## Installation
Please refer to [INSTALL](INSTALL.md) documentation file
Please refer to [installation guide](INSTALL.md)
## How to contribute to OSEM
Please refer to our [CONTRIBUTING guide](CONTRIBUTING.md)
Please refer to our [contributing guide](CONTRIBUTING.md)
## How to translate OSEM into your language
Please refer to our [TRANSLATION guide](TRANSLATION.md)
Please refer to our [translation guide](TRANSLATION.md)
## Contact
GitHub issues are the primary way for communicating about specific proposed changes to this project. If you have other questions feel free to subscribe to the [opensuse-web@opensuse.org](http://lists.opensuse.org/opensuse-web/) mailinglist, all OSEM contributors are on that list! Additionally you can use #osem channel on freenode IRC.

2
dotenv.example
View file

@ -69,7 +69,7 @@
# OSEM_SUSE_SECRET=5678
# STRIPE Publishable/Secret keys
# test keys for development mode, live for production mode
# -> https://github.com/openSUSE/osem/wiki/Stripe
# STRIPE_PUBLISHABLE_KEY=1234
# STRIPE_SECRET_KEY=5678