Stripping CVS keywords
[project/gallery.git] / INSTALL.txt
1
2 HELP
3 ----
4 For more help, check out: http://drupal.galleryembedded.com
5
6 Requirements
7 ------------
8 Gallery2.1 (or above) installed and working (see http://gallery.menalto.com)
9 Image Block module installed and activated in Gallery2
10 Image Frame module installed and activated in Gallery2
11 Drupal 5.x
12 Gallery module (this Drupal module)
13
14 Note that this module does not provide any photo/album functions itelf, but uses
15 Gallery2 (http://gallery.menalto.com) to provide this functionality.
16
17 Installation Instructions
18 -------------------------
19
20 1. Install Gallery 2.1 and Drupal 5.x (see their respective installation
21    documents).  
22    
23    ***Warning*** - Do not name your Gallery2 directory "gallery", call it something else 
24    (eg "gallery2"). Calling it "gallery" will cause a conflict with the Drupal gallery.module 
25    as Drupal assumes that http://www.example.com/gallery refers to the Drupal module.
26
27 2. Ensure that "Image Block" and "Image Frame" modules are installed and activated in Gallery2.
28    Check them in the non-embedded Gallery. See 
29    http://codex.gallery2.org/index.php/Gallery2:Download for instructions to download it 
30    if it was not included in your installation.
31
32 3. Log out of Gallery2 (non-embedded) - people have reported errors relating to sessions if this 
33    is not done.
34
35 4. Copy the entire gallery module directory to your Drupal modules/ directory.
36
37 5. Enable the gallery module in Administer -> Site building -> Modules in your Drupal
38    installation.
39
40 6. Go to Administer -> Site configuration -> Gallery and enter the URI of Gallery2. 
41    Leave "autodetect" selected and click "Save configuration". A series of tests will run to check
42    if everything is OK. There is a HELP link.
43
44 7. Enable the "Gallery Block" in Administer -> Site building -> Blocks, and optionally the 
45    "Gallery Navigation" block and the "Gallery Grid Block".
46    
47 8. Enable the "Access Gallery" permission for the roles that you want to be able to see the gallery
48    and gallery blocks. Go to Administer -> User management -> Access control.
49    
50 9. If necessary, disable the Register module in Gallery2 and remove the Login item from the sidebar
51    block. All login and registration functions now need to go through Drupal (and from there
52    automatically to Gallery2, not Gallery2 directly.)
53
54 Optional Steps
55 --------------
56                        
57  1. Sidebar.     Go to your Gallery2 site admin and include the blocks you want in the sidebar
58                  (under Themes). I use "Item Actions" and "Album Quick Links (DHTML)". To use 
59                  the latter you need to have installed the Album Select module.
60
61  2. URL Rewrite. 
62  
63  3. g2image. If you install g2image http://g2image.steffensenfamily.com as either a standalone or
64              TinyMCE plugin you will have an excellent image chooser for Drupal/Gallery2. The
65              configuration is automatic when you hit the "Save configuration' button on the gallery
66              settings page. See http://drupal.galleryembedded.com/index.php/G2Image for 
67              installation instructions.
68
69 Troubleshooting
70 ---------------
71 See http://drupal.galleryembedded.com