Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1057 from sushimustwrite/master
Documentation updates
- Loading branch information
Showing
4 changed files
with
194 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
## Self-Hosted OpenPhoto FAQ | ||
### How can I install OpenPhoto? | ||
We have lots of guides to help you through the installation process. <a href="http://theopenphotoproject.org/documentation">Check them out here</a>. We welcome <a href="http://github.com/photo/frontend">contributions on Github</a> if you see one that's incomplete. | ||
|
||
### Can I install OpenPhoto to a subdirectory of my site? | ||
Not yet, but it's on our wishlist. | ||
|
||
### How does support for multiple users work? | ||
We support multiple users through separate domains. <a href="https://github.com/photo/frontend/issues/318">See this issue on why it works that way.</a> | ||
|
||
### Is your mobile app available for self-hosted users? | ||
Yes! Download the app <a href="http://itunes.com/apps/theopenphotoapp">for iOS</a> or <a href="https://play.google.com/store/apps/details?id=me.openphoto.android.app">Android</a>. | ||
|
||
### I just changed my domain name. Why am I getting prompted for new settings? | ||
This is normal. OpenPhoto configs are bound to a site, not a server. Since a site is defined by its hostname, you can have multiple sites on one host provided that they have different hostnames. So go ahead and change your settings. | ||
|
||
### I encountered a security issue in OpenPhoto. What's the best way to let you know? | ||
<a href="https://github.com/photo/frontend/issues">Report it as an issue at Github</a>. If you don't feel comfortable exposing a security issue, reach out to someone on the core team and email us individually. | ||
|
||
### Something broke. How do I let you know? | ||
Check <a href="https://github.com/photo/frontend/issues">our issue tracker at Github</a> first; if the issue you're encountering isn't already there, then start a new issue and describe what you ran across. |
131 changes: 131 additions & 0 deletions
131
documentation/guides/InstallationSharedHosting.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
# OpenPhoto / Installation for Shared Hosting | ||
|
||
#### OpenPhoto, a photo service for the masses | ||
|
||
## Installation on Shared Hosting | ||
|
||
This guide instructs you on how to install OpenPhoto on shared hosting sites such as Dreamhost or Bluehost. OpenPhoto can be difficult to install for users not experienced with performing such installations. If you'd like to use OpenPhoto without installing the software yourself, <a href="http://openphoto.me">get started here</a>. | ||
|
||
If you're using Dreamhost <a href="https://github.com/photo/frontend/blob/master/documentation/guides/InstallationDreamhost.markdown">we have a community-written guide for Dreamhost users</a>. Because every webhost is unique, we welcome additions to this guide as well as guides on installing OpenPhoto on your webhost. | ||
|
||
*OpenPhoto should be installed in the root directory of a domain or subdomain.* | ||
|
||
Variables: | ||
|
||
- *OpenPhotoRoot*: the root directory for OpenPhoto (e.g., ~/openphoto) | ||
|
||
### Before you install OpenPhoto | ||
This guide assumes you have: | ||
* Checked that your webhost supports MySQL and PHP | ||
* Shell or FTP access to your web server | ||
* An FTP or SSH client | ||
* A web browser of choice | ||
* An external cloud service account on Amazon or Dropbox (if you want to store your photos there) | ||
|
||
|
||
### The short version | ||
Here's the short version of the instructions for those already comfortable with installing software on a web server. You can check out the detailed instructions below for more information on each step. | ||
|
||
1. Download the latest version of OpenPhoto from Github and extract it to the root folder of your website. <a href="https://github.com/photo/frontend/archive/master.zip">Direct link to latest version as a .zip file</a> | ||
|
||
2. Prepare your cloud storage option and have your credentials ready. (Optional) | ||
|
||
3. Create a new MySQL database and a new user for that database. Remember the hostname (the default should be fine), database name, username, and password. Your webhost may have a MySQL control panel such as PhpMyAdmin that you can do this in. | ||
|
||
4. Create the following folders and chmod them to 775: | ||
|
||
mkdir OpenPhotoRoot/src/html/assets/cache | ||
chmod 775 OpenPhotoRoot/src/html/assets/cache | ||
mkdir OpenPhotoRoot/src/html/photos | ||
chmod 775 OpenPhotoRoot/src/html/photos | ||
mkdir OpenPhotoRoot/src/userdata | ||
chmod 775 OpenPhotoRoot/src/userdata | ||
5. Visit your website and follow the instructions. | ||
|
||
That's it! OpenPhoto should now be installed. Because there are so many special cases specific to individual webhosts along with things that could go wrong, you may want to read the full instructions below. | ||
|
||
### The detailed version | ||
|
||
#### 1. Download OpenPhoto from Github. | ||
<a href="https://github.com/photo/frontend/archive/master.zip">Direct link to latest version as a .zip file</a>. You can also do the following: | ||
|
||
wget https://github.com/photo/frontend/tarball/master -O openphoto.tar.gz | ||
tar -zxvf openphoto.tar.gz | ||
mv openphoto-frontend-* OpenPhotoRoot | ||
|
||
#### 2. Install any dependencies or modules needed. | ||
Your webhost may include them by default. Check their documentation. Here's what you'll need: | ||
|
||
* The Pecl extension oauth for authentication | ||
* ImageMagick or GD for photo rendering | ||
|
||
The method of installing these varies by webhost. Some webhosts let you install them by yourself; others will install these for you if you contact them. | ||
|
||
#### 3. Create your cloud accounts (optional). | ||
Create an account at <a href="https://aws.amazon.com/s3">Amazon AWS</a> or <a href="http://www.dropbox.com">Dropbox</a> if you plan to use them. Create a new bucket (S3) or app (Dropbox). Save your keys since you'll need them soon. | ||
|
||
At Amazon: | ||
* Sign in and visit <a href="https://console.aws.amazon.com/s3/home">the S3 panel</a> and select Create a New Bucket. | ||
* Give your bucket a name and select a region, then select Create. | ||
* <a href="https://portal.aws.amazon.com/gp/aws/securityCredentials">Obtain your access keys</a> and save them. | ||
|
||
At Dropbox: | ||
* Sign in and create a folder for your photos to go in. | ||
* Visit <a href="https://www.dropbox.com/developers/apps">the developers page</a> | ||
* Select Create an App, and select Core API for App Type and Full Dropbox Access. | ||
|
||
This will give you a development app to use for your photos. Save your access keys; you'll need them soon. | ||
|
||
#### 4. Create a database and user. | ||
Visit your control panel for managing databases and create a new database and new user for the database. Give the user `CREATE DATABASE` privileges. Remember the hostname (the default should be fine), database name, username, and password. You'll need these during setup. | ||
|
||
#### 5. Configure the subdomain or domain. | ||
You may have to add the domain if you're bringing in a new domain. Consult your webhost's documentation if needed. Depending on your webhost you may have to visit multiple areas of the site to configure everything, or you may have to configure these separately. But here's what you need to set up. | ||
|
||
* PHP: Select the latest version, FastCGI configuration if available | ||
* Web directory: OpenPhotoRoot/src/html | ||
|
||
#### 6. Upload OpenPhoto. | ||
Upload the contents of the downloaded OpenPhoto folder to OpenPhotoRoot if you haven't already done that. You can do this with an FTP or SSH client. | ||
|
||
#### 7. Create the following directories. | ||
|
||
the cache: | ||
mkdir OpenPhotoRoot/src/html/assets/cache | ||
chmod 775 OpenPhotoRoot/src/html/assets/cache | ||
to store your photos if you're planning on local storage: | ||
mkdir OpenPhotoRoot/src/html/photos | ||
chmod 775 OpenPhotoRoot/src/html/photos | ||
to store userdata: | ||
mkdir OpenPhotoRoot/src/userdata | ||
chmod 775 OpenPhotoRoot/src/userdata | ||
|
||
#### 8. Install OpenPhoto | ||
After waiting a sufficient amount of time for the subdomain name to propagate, use the browser to connect to the new subdomain. You should see a setup page for OpenPhoto which will allow you to configure your OpenPhoto project. | ||
|
||
* Enter your email address and select a password. | ||
|
||
* Select your image renderer (ImageMagick or GD are the most common options), database (MySQL or InnoDB), and storage (Local filesystem, Amazon S3, Amazon S3+Dropbox, Local filesystem+Dropbox). | ||
|
||
* Enter your credentials for your database, Amazon S3, or Dropbox. | ||
|
||
**ENJOY!** | ||
|
||
### Troubleshooting | ||
|
||
#### Setup page looks strange (black and white, unstyled) | ||
If the setup page is not colorful and well formatted, then the css and javascript files are most likely not being loaded. Possible causes: | ||
|
||
- Web directory root is not properly set (check control panel for the subdomain) | ||
- src/html/assets/cache directory is not writeable by Apache (check your permissions) | ||
|
||
#### My webhost doesn't recognize OpenPhotoRoot/src/html as the index directory. | ||
You can set this in the .htaccess page at OpenPhotoRoot/src. If your webhost lets you set this through the web panel you can also do that there. | ||
|
||
#### Error setting up the database | ||
Double check all the parameters. Check your database control panel and verify that everything is correct. Also double check that the user for your database has permission to create a database. |