Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 67 lines (41 sloc) 2.185 kB
9e5c20f @maccesch Updated Docs and install script
authored
1 ==============================
2 Django CMS Contact Form Plugin
3 ==============================
4
bf7eb0d @maccesch Added admin usability candy
authored
5 Contact form plugin for `Django CMS <http://www.django-cms.org/>`_ with spam protection and i18n.
9e5c20f @maccesch Updated Docs and install script
authored
6
c0f7f34 @maccesch Tiny adjustments to docs and template
authored
7 Spam protection is done through `glamkit-stopspam <http://github.com/maccesch/glamkit-stopspam>`_ which provides three different protection methods.
8
9e5c20f @maccesch Updated Docs and install script
authored
9 If you want to use ReCAPTCHA you have to get a Public and Private Key from http://www.google.com/recaptcha. You can get them for free.
10
5e402ca @maccesch You can set recaptcha nad akismet keys by settings now
authored
11 The Akismet spam protection method requires an Akismet API Key which is obtainable from http://akismet.com/ For private persons this is free, too.
9e5c20f @maccesch Updated Docs and install script
authored
12
13 For more Information on the spam protection methods see the glamkit-stopspam link below.
14
15 Dependencies
16 ============
17
18 Django Apps
19 -----------
20
32bbaf2 @maccesch Doc changed link
authored
21 `glamkit-stopspam <https://github.com/glamkit/glamkit-stopspam/>`_ provides nice spam protection support.
5fabb72 @masarliev Documentation
masarliev authored
22 You have to use the latest version from https://github.com/glamkit/glamkit-stopspam/ as the version in PyPI is outdated.
9e5c20f @maccesch Updated Docs and install script
authored
23
24 Python Libs
25 -----------
26
27 If you decide to use the ReCAPTCHA spam protection method glamkit-stopspam needs "recaptcha-client".
28
851e3fe @maccesch Small docs update
authored
29 If you use Akismet for spam protection "akismet" is needed. You also need to set your domain url in django admin "sites".
9e5c20f @maccesch Updated Docs and install script
authored
30
31 Both libraries can be installed by ``easy_install`` or ``pip``.
32
bf7eb0d @maccesch Added admin usability candy
authored
33 Installation
34 ============
9e5c20f @maccesch Updated Docs and install script
authored
35
8229a68 @maccesch setup dependency fixes and smal docs upgrade
authored
36 Download
37 --------
38
7639f18 @maccesch Readying for PyPI
authored
39 From PyPI
8229a68 @maccesch setup dependency fixes and smal docs upgrade
authored
40 '''''''''
7639f18 @maccesch Readying for PyPI
authored
41
42 You can simply type into a terminal ``pip install cmsplugin-contact`` or ``easy_install cmsplugin-contact``.
43
8229a68 @maccesch setup dependency fixes and smal docs upgrade
authored
44 Manually
45 ''''''''
7639f18 @maccesch Readying for PyPI
authored
46
c0f7f34 @maccesch Tiny adjustments to docs and template
authored
47 You can download a zipped archive from http://github.com/maccesch/cmsplugin-contact/downloads.
48
851e3fe @maccesch Small docs update
authored
49 Unzip the file you downloaded. Then go in your terminal and ``cd`` into the unpacked folder. Then type ``python setup.py install`` in your terminal.
9e5c20f @maccesch Updated Docs and install script
authored
50
8229a68 @maccesch setup dependency fixes and smal docs upgrade
authored
51 Setup
52 -----
53
584b059 @maccesch renaming
authored
54 Put "cmsplugin_contact" in your ``INSTALLED_APPS`` section in settings.py. Don't forget to syncdb your database.
9e5c20f @maccesch Updated Docs and install script
authored
55
5e402ca @maccesch You can set recaptcha nad akismet keys by settings now
authored
56 Settings
57 ========
58
59 RECAPTCHA_PUBLIC_KEY and RECAPTCHA_PRIVATE_KEY
60 ----------------------------------------------
61
62 If you don't want to enter the ReCATPCHA keys in the admin interface you can provide them through these settings.
63
64 AKISMET_API_KEY
65 ---------------
66
67 The same as for ReCAPTCHA goes fo Akismet.
Something went wrong with that request. Please try again.