Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 184 lines (126 sloc) 5.895 kb
e8b430b Chris Kankiewicz Changed README to rich text for Github
authored
1 UberGallery - The simple PHP photo gallery
2 ==========================================
3 Created by, [Chris Kankiewicz](http://www.ChrisKankiewicz.com)
4
5
6 Introduction
7 ------------
b57f19f Chris Kankiewicz More license change updates
authored
8 UberGallery is an easy to use, simple to manage, web photo gallery written in PHP and distributed
9 under the [MIT License](http://www.opensource.org/licenses/mit-license.php). UberGallery
10 **does not** require a database and supports JPEG, GIF and PNG file types. Simply upload your images
11 and UberGallery will automatically generate thumbnails and output standards compliant XHTML markup
12 on the fly.
e8b430b Chris Kankiewicz Changed README to rich text for Github
authored
13
14
15 Features
16 --------
1ea7b0d Chris Kankiewicz Removed GPL license to reduce redundancy and restrictions
authored
17 * Simple first time installation
18 * Database-less configuration
19 * Include galleries within pre-existing sites
20 * Create multiple galleries with a single installation
21 * Easily customize your gallery styles via CSS
22 * Install and update the gallery easily wth Git (optional)
e8b430b Chris Kankiewicz Changed README to rich text for Github
authored
23
24
25 Requirements
26 ------------
1ea7b0d Chris Kankiewicz Removed GPL license to reduce redundancy and restrictions
authored
27 UberGallery requires PHP 5.2+ and the PHP-GD image library to work properly. For more information on
28 PHP and the PHP-GD image library, please visit [http://php.net](http://php.net).
e8b430b Chris Kankiewicz Changed README to rich text for Github
authored
29
30
31 Simple Installation
32 -------------------
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
33 1. Copy `resources/sample.galleryConfig.ini` to `resources/galleryConfig.ini` and modify the settings
09e8228 Chris Kankiewicz Wrapping README text to 100 characters per line
authored
34 to your liking.
dee5ce3 Chris Kankiewicz Added step to configure gallery settings
authored
35
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
36 2. Upload `index.php`, `resources/` and `gallery-images/` to your web server.
e8b430b Chris Kankiewicz Changed README to rich text for Github
authored
37
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
38 3. Upload images to the `gallery-images/` directory.
e8b430b Chris Kankiewicz Changed README to rich text for Github
authored
39
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
40 4. Make the `resources/cache/` directory writable by the web server:
41
42 ```
e938615 Chris Kankiewicz Updated README with some fixes and added the Troubleshooting section.
authored
43 chmod 777 /path/to/resources/cache
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
44 ```
45
46 5. Open your web browser and load the page where you installed UberGallery.
e8b430b Chris Kankiewicz Changed README to rich text for Github
authored
47
48
7e45c90 Chris Kankiewicz Updated the README to more accurately reflect ubergallery.net
authored
49 Custom Installation
50 -------------------
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
51 1. Copy `resources/sample.galleryConfig.ini` to `resources/galleryConfig.ini` and modify the settings
1ea7b0d Chris Kankiewicz Removed GPL license to reduce redundancy and restrictions
authored
52 to your liking.
dee5ce3 Chris Kankiewicz Added step to configure gallery settings
authored
53
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
54 2. Upload the `resources/` folder to your web server.
e8b430b Chris Kankiewicz Changed README to rich text for Github
authored
55
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
56 3. Insert the following code into the PHP page where you would like the gallery to be displayed
09e8228 Chris Kankiewicz Wrapping README text to 100 characters per line
authored
57 (be sure to change the include and image folder path to match your configuration):
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
58
59 ```php
1486d5a Chris Kankiewicz Fixed a few back-ticks that should be singl quotes in the README
authored
60 <?php include_once('path/to/resources/UberGallery.php'); $gallery = UberGallery::init()->createGallery('path/to/images-folder'); ?>
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
61 ```
62
63 4. Include the UberGallery and desired Colorbox style sheet in your page header:
64
65 ```html
d9e6fe7 Chris Kankiewicz Updated README.md to reflect recent updates
authored
66 <link rel="stylesheet" type="text/css" href="path/to/resources/UberGallery.css" />
67 <link rel="stylesheet" type="text/css" href="path/to/resources/colorbox/{1-5}/colorbox.css" />
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
68 ```
d9e6fe7 Chris Kankiewicz Updated README.md to reflect recent updates
authored
69
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
70 5. Include the jQuery and Colorbox javascript files in your page header:
d9e6fe7 Chris Kankiewicz Updated README.md to reflect recent updates
authored
71
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
72 ```html
c97f93f Chris Kankiewicz Modified README to reflect jQuery version bump
authored
73 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
d9e6fe7 Chris Kankiewicz Updated README.md to reflect recent updates
authored
74 <script type="text/javascript" src="path/to/resources/colorbox/jquery.colorbox.js"></script>
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
75 ```
0570962 Chris Kankiewicz Update README.md with missing documentation
authored
76
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
77 6. Include the Colorbox jquery call in your header:
78
79 ```html
0570962 Chris Kankiewicz Update README.md with missing documentation
authored
80 <script type="text/javascript">
81 $(document).ready(function(){
82 $("a[rel='colorbox']").colorbox({maxWidth: "90%", maxHeight: "90%", opacity: ".5"});
83 });
84 </script>
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
85 ```
e8b430b Chris Kankiewicz Changed README to rich text for Github
authored
86
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
87 7. Upload images to your images directory.
88
89 8. Make the `resources/cache/` directory writable by the web server.
90
91 ```
e938615 Chris Kankiewicz Updated README with some fixes and added the Troubleshooting section.
authored
92 chmod 777 /path/to/resources/cache
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
93 ```
94
95 9. Open your web browser and load the page where you installed UberGallery.
e8b430b Chris Kankiewicz Changed README to rich text for Github
authored
96
97
8180d74 Chris Kankiewicz Fixing typos and finalizing README
authored
98 Install with Git
99 ----------------
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
100 1. SSH into the your server and clone the UberGallery repository and submodules:
fa6cb49 Chris Kankiewicz Adding more content to the README
authored
101
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
102 ```
37688ca Chris Kankiewicz Modified the Install with Git method to use the --recursive option on cl...
authored
103 git clone --recursive git://github.com/UberGallery/UberGallery.git /path/to/gallery-directory
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
104 ```
105
106 2. CD to your UberGallery installation:
2742b0a Chris Kankiewicz Refined the new Git installation instructions
authored
107
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
108 ```
2742b0a Chris Kankiewicz Refined the new Git installation instructions
authored
109 cd /path/to/gallery-directory
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
110 ```
fa6cb49 Chris Kankiewicz Adding more content to the README
authored
111
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
112 3. Copy `resources/sample.galleryConfig.ini` to `resources/galleryConfig.ini` and modify the settings
0a1056f Chris Kankiewicz Fixed a few typos in README and modified the Install with Git section a ...
authored
113
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
114 ```
2742b0a Chris Kankiewicz Refined the new Git installation instructions
authored
115 cp resource/sample.galleryConfig.ini resources/galleryConfig.ini
116 nano resources/galleryConfig.ini
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
117 ```
8180d74 Chris Kankiewicz Fixing typos and finalizing README
authored
118
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
119 4. Make the `resources/cache/` directory writable by the web server.
120
121 ```
e938615 Chris Kankiewicz Updated README with some fixes and added the Troubleshooting section.
authored
122 chmod 777 resources/cache
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
123 ```
124
125 5. Upload images to the `gallery-images/` folder within your gallery directory.
2742b0a Chris Kankiewicz Refined the new Git installation instructions
authored
126
516093d Chris Kankiewicz Updated README with numbered bullets and some code highlighting.
authored
127 6. Open your web browser and load the page where you installed UberGallery.
fa6cb49 Chris Kankiewicz Adding more content to the README
authored
128
7e45c90 Chris Kankiewicz Updated the README to more accurately reflect ubergallery.net
authored
129 **NOTE:** When using this method to install UberGallery, you may update your installation by running
130 the following commands:
fa6cb49 Chris Kankiewicz Adding more content to the README
authored
131
132 cd /path/to/gallery-directory
133 git pull origin master
8b6df2c Chris Kankiewicz Updated README section on updating via git
authored
134 git submodule update
fa6cb49 Chris Kankiewicz Adding more content to the README
authored
135
136
e938615 Chris Kankiewicz Updated README with some fixes and added the Troubleshooting section.
authored
137 Troubleshooting
138 ---------------
139 If you're having issues with UberGallery here are a few troubleshooting tips:
140
28ec5be Chris Kankiewicz Fixed a few typos in the README
authored
141 * Verify that you have PHP 5.2 or later installed. You can verify your PHP version by running:
e938615 Chris Kankiewicz Updated README with some fixes and added the Troubleshooting section.
authored
142
143 ```
144 php --version
145 ```
146
147 * Make sure you have the latest version of UberGallery installed. You can always find the latest
148 version at <http://www.ubergallery.net/#download>
149
28ec5be Chris Kankiewicz Fixed a few typos in the README
authored
150 * Replace your `galleryConfig.ini` with `sample.galleryConfig.ini` to ensure proper configuration:
e938615 Chris Kankiewicz Updated README with some fixes and added the Troubleshooting section.
authored
151
152 ```
153 rm resources/galleryConfig.ini
154 cp resource/sample.galleryConfig.ini resources/galleryConfig.ini
155 ```
156
157 * Clear your cache and make sure the directory is writable by the web server:
158
159 ```
160 rm -f resources/cache/*
161 chmod 777 resources/cache
162 ```
163
164 * Enable debugging by setting the `enable_debugging` option in `resources/galleryConfig.ini` to
165 `true`, try loading your gallery in a web browser then inspect the debug.log file in your cache
166 directory for any errors.
167
168 If you continue to have issues, please email me at: <Chris@ChrisKankiewicz.com>
169
7e45c90 Chris Kankiewicz Updated the README to more accurately reflect ubergallery.net
authored
170
e938615 Chris Kankiewicz Updated README with some fixes and added the Troubleshooting section.
authored
171 News & Updates
172 --------------
533d376 Chris Kankiewicz Tweaking README documentation
authored
173 UberGallery updates and news can be found on our [blog](http://news.ubergallery.net/) or by
7e45c90 Chris Kankiewicz Updated the README to more accurately reflect ubergallery.net
authored
174 [following us on Twitter](http://twitter.com/ubergallery).
175
f0a0b75 Chris Kankiewicz Updated bug reporting wording
authored
176 Please report bugs to the [Github issue tracker](http://github.com/UberGallery/ubergallery/issues).
7e45c90 Chris Kankiewicz Updated the README to more accurately reflect ubergallery.net
authored
177
178
e8b430b Chris Kankiewicz Changed README to rich text for Github
authored
179 License
180 -------
b57f19f Chris Kankiewicz More license change updates
authored
181 UberGallery is distributed under the terms of the
1ea7b0d Chris Kankiewicz Removed GPL license to reduce redundancy and restrictions
authored
182 [MIT License](http://www.opensource.org/licenses/mit-license.php).
f114f23 Chris Kankiewicz Added UTF-8 copyright symbol to the README in place of (C)
authored
183 Copyright © 2012 [Chris Kankiewicz](http://www.chriskankiewicz.com)
Something went wrong with that request. Please try again.