aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCédric Bonhomme <cedric@cedricbonhomme.org>2014-05-13 22:50:25 +0200
committerCédric Bonhomme <cedric@cedricbonhomme.org>2014-05-13 22:50:25 +0200
commitd0afb4c3123ae32a5d5e7ec08dce99416e4d4ddb (patch)
tree6255f03cc36d227d1318267275e576003ec52517
parentAccounts created by the administrator are automatically activated. (diff)
downloadnewspipe-d0afb4c3123ae32a5d5e7ec08dce99416e4d4ddb.tar.gz
newspipe-d0afb4c3123ae32a5d5e7ec08dce99416e4d4ddb.tar.bz2
newspipe-d0afb4c3123ae32a5d5e7ec08dce99416e4d4ddb.zip
Updated README.
-rw-r--r--README.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 36ab9a65..8c6f05be 100644
--- a/README.rst
+++ b/README.rst
@@ -35,6 +35,8 @@ After installation, you will be able to connect with the email *root@pyAggr3g470
Deploying the application on Heroku
'''''''''''''''''''''''''''''''''''
+An instance of pyAggr3g470r is running `here <https://pyaggr3g470r.herokuapp.com/>`_ .
+
.. code:: bash
$ git clone https://bitbucket.org/cedricbonhomme/pyaggr3g470r.git
@@ -46,7 +48,20 @@ Deploying the application on Heroku
$ heroku run init
$ heroku ps:scale web=1
-An instance of pyAggr3g470r is running `here <https://pyaggr3g470r.herokuapp.com/>`_ .
+To enable account creation for users, you have to set some environment variables:
+
+.. code:: bash
+
+ $ heroku config:set PLATFORM_URL=<URL-of-your-platform>
+ $ heroku config:set RECAPTCHA_PUBLIC_KEY=<your-recaptcha-public-key>
+ $ heroku config:set RECAPTCHA_PRIVATE_KEY=<your-recaptcha-private-key>
+ $ heroku config:set ADMIN_EMAIL=<administrator-email>
+ $ heroku config:set POSTMARK_API_KEY=<your-postmark-api-key>
+
+`Postmark <https://postmarkapp.com/>`_ is used to send account confirmation links.
+
+If you don't want to open your platform you will be still able to create accounts via the administration page.
+
Deploying the application on a traditional server
'''''''''''''''''''''''''''''''''''''''''''''''''
bgstack15