1 | Installation |
---|
2 | ============ |
---|
3 | |
---|
4 | Buildout |
---|
5 | -------- |
---|
6 | |
---|
7 | To install quintagroup.plonecaptchas to your buildout-based project: |
---|
8 | |
---|
9 | * Add ``quintagroup.plonecaptchas`` to the list of eggs to install:: |
---|
10 | |
---|
11 | [buildout] |
---|
12 | ... |
---|
13 | eggs = |
---|
14 | ... |
---|
15 | quintagroup.plonecaptchas |
---|
16 | |
---|
17 | * Tell the plone.recipe.zope2instance recipe to install a ZCML slug:: |
---|
18 | |
---|
19 | [instance] |
---|
20 | recipe = plone.recipe.zope2instance |
---|
21 | ... |
---|
22 | zcml = |
---|
23 | quintagroup.plonecaptchas |
---|
24 | |
---|
25 | * Re-run buildout, e.g. with:: |
---|
26 | |
---|
27 | $ ./bin/buildout |
---|
28 | |
---|
29 | * Restart the Zope server, e.g with the following command in the terminal:: |
---|
30 | |
---|
31 | $ ./bin/instance restart |
---|
32 | |
---|
33 | * Install ``Plone Captchas`` with Quickinstaller in Plone (Site Setup -> Add/Remove Products). |
---|
34 | ``Quintagroup Captcha Core`` will automatically be installed as dependency. |
---|
35 | |
---|
36 | |
---|
37 | Traditional Zope 2 instance |
---|
38 | --------------------------- |
---|
39 | |
---|
40 | To install quintagroup.plonecaptchas into the global Python environment (or a workingenv), |
---|
41 | using a traditional Zope 2 instance, you can do this: |
---|
42 | |
---|
43 | * Copy ``quintagroup`` folder to your instance's ``/lib/python`` directory. |
---|
44 | |
---|
45 | * Create a file called ``quintagroup.plonecaptchas-configure.zcml`` in your instance's ``/etc/package-includes`` directory. The file |
---|
46 | should only contain this:: |
---|
47 | |
---|
48 | <include package="quintagroup.plonecaptchas" /> |
---|
49 | |
---|
50 | * Restart the Zope server, for example with the following command in the terminal:: |
---|
51 | |
---|
52 | $ ./bin/zopectl restart |
---|
53 | |
---|
54 | * Install ``Plone Captchas`` with Quickinstaller in Plone (Site Setup -> Add/Remove Products). |
---|
55 | ``Quintagroup Captcha Core`` will automatically be installed as dependency. |
---|
56 | |
---|
57 | |
---|
58 | Protecting Register form with captcha |
---|
59 | ------------------------------------- |
---|
60 | |
---|
61 | quintagroup.plonecaptchas does not automatically plug to Plone's default registration |
---|
62 | (/@@register), to protect register form with captcha - you must follow the instructions here: |
---|
63 | http://projects.quintagroup.com/products/wiki/quintagroup.plonecaptchas#JoinForm |
---|
64 | |
---|
65 | |
---|
66 | Migration notes |
---|
67 | =============== |
---|
68 | |
---|
69 | Following migration notes must be done only if you protect join (registration) form with captcha. |
---|
70 | All steps performed in ZMI (<portal>/manage_main). |
---|
71 | |
---|
72 | === Migration from Plone-3.X to Plone-3.Y === |
---|
73 | |
---|
74 | If you have Plone-3.X site with installed quintagroup.plonecaptchas v3 package, and want to migrate site to Plone-3.Y, you must perform following steps: |
---|
75 | * migrate your plone site to Plone-3.Y |
---|
76 | * update *Directory:* property of `<portal>/portal_skins/captchas_join_form` Filesystem Directory View' - go to `<portal>/portal_skins/captchas_join_form/manage_propertiesForm` and update value of the *Directory* property according to the following rooles: |
---|
77 | * for Plone-3.0: quintagroup.plonecaptchas:skins/captchas_join_form_30 |
---|
78 | * for Plone-3.1 or Plone-3.2: quintagroup.plonecaptchas:skins/captchas_join_form_31_32 |
---|
79 | * for Plone-3.3+: quintagroup.plonecaptchas:skins/captchas_join_form_33 |
---|
80 | |
---|
81 | |
---|
82 | === Migration from Plone-3 to Plone-4 === |
---|
83 | |
---|
84 | If you have Plone-3 site with installed quintagroup.plonecaptchas v3 package, and want to migrate site to Plone-4, you must perform following steps: |
---|
85 | * update plone-4 buildout/instance - to use quintagroup.plonecaptchas v4 package instead of quintagroup.plonecaptchas v3 |
---|
86 | * migrate your plone site to Plone-4 |
---|
87 | * remove `<portal>/portal_skins/captchas_join_form` Filesystem Directory View' |
---|
88 | * remove *captchas_join_form* layer from all skins in `<portal>/portal_skins/manage_propertiesForm` |
---|
89 | * run all steps with "Plone Captchas Register Forms for Plone 4" upgrade profile - go to `<portal>/portal_setup/manage_importSteps`, select mentioned profile and push "Import all steps" button. |
---|
90 | |
---|