Adding additions from @sushimustwrite

This commit is contained in:
Jaisen Mathai 2013-01-29 11:10:50 -05:00
parent 44d4b69483
commit 224e789312
12 changed files with 244 additions and 35 deletions

View file

@ -4,7 +4,7 @@ Authentication using OAuth 1.0a
### Using OAuth (1.0a) ### Using OAuth (1.0a)
A full introduction to OAuth is beyond the scope of the OpenPhoto documentation. A full introduction to OAuth is beyond the scope of the OpenPhoto documentation.
In all reality you probably don't need to understand the ins and outs of OAuth, just grab one of our libraries. In all reality you probably don't need to understand all the ins and outs of OAuth; just grab one of our libraries and start building.
* <a href="https://github.com/photo/openphoto-php">openphoto/openphoto-php</a> - Our PHP language binding. * <a href="https://github.com/photo/openphoto-php">openphoto/openphoto-php</a> - Our PHP language binding.
* <a href="https://github.com/photo/openphoto-ruby">openphoto/openphoto-ruby</a> - Our Ruby language binding. * <a href="https://github.com/photo/openphoto-ruby">openphoto/openphoto-ruby</a> - Our Ruby language binding.

View file

@ -34,7 +34,7 @@ _Authentication: optional_
<a name="parameters"></a> <a name="parameters"></a>
### Parameters ### Parameters
1. returnSizes (optional), (i.e. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes) 1. returnSizes (optional), (e.g. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes)
1. generate (optional), (i.e. true or false) Tells the API to generate the sizes from `returnSizes` instead of returning a _create_ URL. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes) 1. generate (optional), (i.e. true or false) Tells the API to generate the sizes from `returnSizes` instead of returning a _create_ URL. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes)
---------------------------------------- ----------------------------------------

View file

@ -34,11 +34,11 @@ _Authentication: optional_
<a name="parameters"></a> <a name="parameters"></a>
### Parameters ### Parameters
1. returnSizes (optional), (i.e. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes) 1. returnSizes (optional), (e.g. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes)
1. generate (optional), (i.e. true or false) Tells the API to generate the sizes from `returnSizes` instead of returning a _create_ URL. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes) 1. generate (optional), (i.e. true or false) Tells the API to generate the sizes from `returnSizes` instead of returning a _create_ URL. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes)
1. pageSize (optional), Number of photos to return per request. 1. pageSize (optional), Number of photos to return per request.
1. page (optional), Page number when browsing through photos. Starts at 1. 1. page (optional), Page number when browsing through photos. Starts at 1.
1. tags (optional), _i.e. dog,cat_ - A comma delimited string of strings. 1. tags (optional), _e.g. dog,cat_ - A comma delimited string of strings.
---------------------------------------- ----------------------------------------

View file

@ -65,7 +65,7 @@ The response is in a standard [response envelope](http://theopenphotoproject.org
* _message_, A string describing the result. Don't use this for anything but reading. * _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success * _code_, _200_ on success
* _result_, A [Action][Action] object or FALSE on error * _result_, An [Action][Action] object or FALSE on error
<a name="sample"></a> <a name="sample"></a>
#### Sample #### Sample

View file

@ -33,16 +33,16 @@ _Authentication: required_
### Parameters ### Parameters
1. permission (optional), 0 for private and 1 for public. 1. permission (optional), 0 for private and 1 for public.
1. title (optional), _i.e. My first day at work_ - A string title to describe the photo. 1. title (optional), _e.g. My first day at work_ - A string title to describe the photo.
1. description (optional), _i.e. A much longer description of my first day_ - A string to describe the photo in detail. 1. description (optional), _e.g. A much longer description of my first day_ - A string to describe the photo in detail.
1. tags (optional), _i.e. dog,cat_ - A comma delimited string of alpha numeric strings. 1. tags (optional), _e.g. dog,cat_ - A comma delimited string of alpha numeric strings.
1. tagsAdd (optional), _i.e. dog,cat_ - A comma delimited string of alpha numeric strings to be added. 1. tagsAdd (optional), _e.g. dog,cat_ - A comma delimited string of alpha numeric strings to be added.
1. tagsRemove (optional), _i.e. dog,cat_ - A comma delimited string of alpha numeric strings to be removed. 1. tagsRemove (optional), _e.g. dog,cat_ - A comma delimited string of alpha numeric strings to be removed.
1. dateUploaded (optional), _i.e. 1311059035_ - A unix timestamp of the date the photo was uploaded 1. dateUploaded (optional), _e.g. 1311059035_ - A unix timestamp of the date the photo was uploaded
1. dateTaken (optional), _i.e. 1311059035_ - A unix timestamp of the date the photo was taken which overrides EXIF data if present 1. dateTaken (optional), _e.g. 1311059035_ - A unix timestamp of the date the photo was taken which overrides EXIF data if present
1. license (optional), _i.e. CC BY-SA or My Custom License_ - A string representing a custom or Creative Commons license. 1. license (optional), _e.g. CC BY-SA or My Custom License_ - A string representing a custom or Creative Commons license.
1. latitude (optional), _i.e. 34.76_ - A decimal representation of latitude. 1. latitude (optional), _e.g. 34.76_ - A decimal representation of latitude.
1. longitude (optional), _i.e. -87.45_ - A decimal representation of longitude. 1. longitude (optional), _e.g. -87.45_ - A decimal representation of longitude.
---------------------------------------- ----------------------------------------

View file

@ -0,0 +1,40 @@
# Contributing to OpenPhoto's Documentation
We're working hard to make OpenPhoto the best photo software possible, and part of that is making sure it's well-documented and accessible to beginners and experts alike. Writing good documentation is a big step toward that goal, and what you see here is the beginning of that effort.
We're always looking for writers to contribute to our documentation. If you can explain technical ideas clearly, we need you.
## Deciding what to contribute
We currently have documentation for the API and setting up OpenPhoto on a variety of servers (including shared hosting services), along with FAQs for the hosted and self-hosted sites. You can contribute by adding to these guides or by adding your own guide--for example, how to install OpenPhoto on your webhost. Your contributions will help users of the present and future who have the same questions.
All of this documentation is in the frontend repository under the Documentation folder. You can also contribute to the copy for theopenphotoproject.org, which is stored in <a href="https://github.com/photo/community/">the community repository</a>. We have <a href="https://github.com/photo/frontend/issues?labels=Documentation&page=1&state=open">issues tagged documentation on Github</a>, but every area of the project can benefit from better documentation. Choose something you know about and start writing.
## Forking the OpenPhoto repository
Before you start writing, you need to fork the repository you'll be working from. You can fork the repository right from the main OpenPhoto repository page by clicking the "Fork" button. If you plan on writing your documentation directly in Github, that's all you need to do. If you want to work from your local copy of the repository, <a href="https://help.github.com/articles/fork-a-repo">Github explains how to clone a repository</a>.
## Writing the documentation
We write our documentation in Github Standard Markdown and save the files as .Markdown files. If you're familiar with Markdown and Github, go ahead and fork OpenPhoto, then write your contribution in a text editor of your choice. If you're not, you may want to take a look at <a href="http://github.github.com/github-flavored-markdown/">Github's explanation of Markdown</a> as well as the source of OpenPhoto's documentation pages on Github.
A few things to keep in mind while writing the documentation:
* Remember that users of all skill levels will be reading the documentation. What you write should be accessible to all of them. This includes staying beginner- and expert-friendly, remaining gender-neutral, and being friendly and informative.
* Use correct grammar and spelling. <a href="https://owl.english.purdue.edu/owl/section/1/5/">Here's a grammar guide</a> if you need a refresher.
* Stay away from slang and other terms that don't translate well. This is for a couple for a reasons. First, OpenPhoto has an international userbase, and English may not be everyone's first language. Second, this makes translating easier when the time comes.
## Committing your documentation
When committing your documentation it's important to reference the GitHub issue you're fixing, if applicable. You can do it by adding a _#_ followed by the issue number.
# To simply reference an issue with a commit do this
git commit -m 'Addressing the foobar component but not yet finished. #123'
# To commit and close an issue do this
git commit -m 'Wrote the longest guide ever. Closes #123'
Be descriptive, it helps a ton. If you're working on the Github website you can do this in the commit summary at the bottom of the page you're writing in. Once you've committed your code it's time to push it to GitHub.
git push origin master
## Getting your change into the main OpenPhoto branch
You can send your documentation to us by submitting a pull request. This way it can get reviewed and merged with the rest of the documentation. If you forked a copy of OpenPhoto to your local machine, <a href="http://help.github.com/send-pull-requests/">Github explains how to send a pull request with git.</a> If you wrote all the documentation through the Github website, you can press the Pull Request button that appears on the page containing your copy of the OpenPhoto repository.
## Help! I'm stuck and I have questions
If you have questions we're always around to help. We've got several contact options listed on the <a href="http://theopenphotoproject.org/contribute">contribute</a> page.

View file

@ -2,10 +2,10 @@ Account Management
======================= =======================
## How do I create an account? ## How do I create an account?
Visit https://trovebox.com and sign up for an account. Visit http://openphoto.me and click the Sign Up button. Select a username for your OpenPhoto site along with a password.
## How do I log in? ## How do I log in?
You can do this in two ways: through the main https://trovebox.com site or through your own site. Click Sign In, and then enter your email address and password. You can do this in two ways: through the main openphoto.me site or through your own site. Click Sign In, and then enter your email address and password.
## How can I retrieve a lost password? ## How can I retrieve a lost password?
Go to the Sign In page and click "Forgot Password" next to the password entry field. Enter the email address you signed up with and click Submit. You'll receive a link where you can reset your password. Go to the Sign In page and click "Forgot Password" next to the password entry field. Enter the email address you signed up with and click Submit. You'll receive a link where you can reset your password.
@ -17,4 +17,4 @@ Not at this time, no. We're working on it.
Yes. When you sign in, click "Forgot password?" and enter your email address. You'll get a link to reset your password as if you had forgotten it. Yes. When you sign in, click "Forgot password?" and enter your email address. You'll get a link to reset your password as if you had forgotten it.
## How do I delete my account? ## How do I delete my account?
We're sad to see you go. Right now account deletion is manual, so email support@trovebox.com and we'll delete your account for you. Before you delete your account, make sure to migrate your photos to an external account that you control. You can do that at https://trovebox.com/migrate We're sad to see you go. Right now account deletion is manual, so email support@openphoto.me and we'll delete your account for you. Before you delete your account, make sure to migrate your photos to an external account that you control. You can do that at https://openphoto.me/migrate

View file

@ -1,7 +1,7 @@
Frequently Asked Questions Frequently Asked Questions
======================= =======================
Here are some questions that people have about The OpenPhoto Project. If you have one that's not on this list send an <a href="mailto:openphoto@googlegroups.com">email</a>. Here are some questions that people have about The OpenPhoto Project. If you have one that's not on this list send us a message via <a href="https://twitter.com/OpenPhoto">Twitter</a> or <a href="mailto:support@openphoto.me">email</a>.
### What is OpenPhoto? ### What is OpenPhoto?
OpenPhoto is a photo hosting service that puts you in control. It lets you import, archive, and organize your photos on OpenPhoto's servers or your personal cloud accounts such as Dropbox or Amazon S3. Your choice. OpenPhoto is a photo hosting service that puts you in control. It lets you import, archive, and organize your photos on OpenPhoto's servers or your personal cloud accounts such as Dropbox or Amazon S3. Your choice.
@ -12,3 +12,118 @@ It's the photo service you never knew you wanted until it existed.
Normally you pay one company to store your photos and to provide services to share them. This means that you can't do much if they raise their prices or shut down their site. If you decide you don't like their site anymore, the process of leaving and setting up somewhere new can be long and frustrating if you care about keeping your photos. Normally you pay one company to store your photos and to provide services to share them. This means that you can't do much if they raise their prices or shut down their site. If you decide you don't like their site anymore, the process of leaving and setting up somewhere new can be long and frustrating if you care about keeping your photos.
With OpenPhoto you can switch between services, use more than one at a time, or stop using the service without losing a single photo. With OpenPhoto you can switch between services, use more than one at a time, or stop using the service without losing a single photo.
## Account Management
### How do I create an account?
Visit http://openphoto.me and click the Sign Up button. Select a username for your OpenPhoto site along with a password.
### How do I log in?
You can do this in two ways: through the main openphoto.me site or through your own site. Click Sign In, and then enter your email address and password.
### How can I retrieve a lost password?
Go to the Sign In page and click "Forgot Password" next to the password entry field. Enter the email address you signed up with and click Submit. You'll receive a link where you can reset your password.
### Can I change the email I signed up with?
Not at this time, no. We're working on it.
### Can I change my password?
Yes. When you sign in, click "Forgot password?" and enter your email address. You'll get a link to reset your password as if you had forgotten it.
### How do I delete my account?
We're sad to see you go. Right now account deletion is manual, so email support@openphoto.me and we'll delete your account for you. Before you delete your account, make sure to migrate your photos to an external account that you control. You can do that at https://openphoto.me/migrate
## Photo Storage
### Where can I store my photos?
Right now OpenPhoto supports Amazon S3, Box.com, Dropbox, CX.com, and DreamHost DreamObjects.
### How do I switch where my photos are stored?
Visit http://openphoto.me/migrate while logged in, select where you'd like your photos to go, and follow the instructions.
### How can I import my photos?
You can import your photos through the Upload photos page when you're logged into OpenPhoto. At the bottom of the Upload photos page are links to import photos from Flickr, Facebook, and Instagram. Select the site(s) you'd like to import from and follow the instructions.
### Can I keep uploading to another photo site and have that photo automatically show up in OpenPhoto?
Not directly through OpenPhoto, but you can use sites like ifttt or Pi.pe that will automatically upload a picture to OpenPhoto when you upload a picture somewhere else (or vice versa).
## Photo Management
### How do I upload a photo?
Go to your OpenPhoto site (it'll look like yourusername.openphoto.me) and click Upload. Click Add Photos and add the photos you'd like to upload. You can also add attributes that'll apply to all the photos uploaded in that batch, such as a tag, an album, a privacy setting, or a license.
### How do I delete a photo?
Visit Photos under the Manage dropdown menu at your OpenPhoto site while logged in. From there, hover over the photo(s) you want to delete and click the checkmark that appears. Click Batch Edit and select Delete.
### What are albums? How do they work?
An album is a collection of photos grouped around a theme of your choice. This lets you share many photos with friends or browse your own photos more easily. Albums can be public or private on your albums page.
### How do I create an album?
While you're logged into your OpenPhoto site, visit Albums under the Manage menu. Enter the name of your album under the Create Album section and click Create.
### How do I add a photo to an album?
You can add a photo to an album by editing an individual photo's details or batch editing photos.
### How do I edit a photo's details?
Visit the photo's page and click "Edit Details". Then you can edit the title, description, tags, location, albums, groups, privacy, and license.
### How do I edit multiple photos at once?
Visit Photos under the Manage dropdown menu at your OpenPhoto site while logged in. From there, hover over the photo(s) you want to edit and click the checkmark that appears. Click Batch Edit and select the detail you want to edit, change the detail, and click Submit.
### What are groups? How do they work?
Groups let you share a photo with certain people without exposing the photo to the entire Web. Want to share photos from that party last week but don't want just anyone seeing them? Add the photos to a private group that only your friends have access to.
### How do I add a friend to a group?
Visit Groups under the Manage menu and create a name for a group. From there you can add your friends by email address. They can log in with Mozilla Persona or Facebook to view the photos.
### How do I add a photo to a group?
When you upload a photo, you can select a group for the photo to be part of. This is completely optional. You can also change the group(s) a photo is part of at the Manage Photos menu.
## The OpenPhoto Mobile Apps
### What phones are supported?
OpenPhoto has mobile apps for iPhone and Android. You can download them in the App Store (iOS) or Play Store (Android).
### What can I do with the OpenPhoto mobile apps?
* Create an OpenPhoto account
* Upload photos to your OpenPhoto site
* Add titles, descriptions, privacy settings, and tags
* Share photos via email, Twitter, and Facebook
* Add filters to your photos (iOS)
## The Project
### Who works on OpenPhoto?
Lots of people. Check out our <a href="http://www.theopenphotoproject.org/team">Team page</a> for the core team.
### How can I help make OpenPhoto better?
Lots of ways! To name a few:
* Using OpenPhoto
* Buying a Pro account
* Telling your friends about us
* Suggesting new features
* Reporting bugs when you see them
* Building and fixing new things in the software
### How can I contribute to OpenPhoto itself?
OpenPhoto was built by lots of people just like you, most of them volunteers. We're always looking for more people to help make OpenPhoto better, especially in the following areas:
* Development
* Mobile development (iOS, Android)
* Design
* Documentation
* Community Management
Check out our longer <a href="http://theopenphotoproject.org/contribute">guide to contributing</a>, along with <a href="http://theopenphotoproject.org/contribute/frontend">our separate guide for the web parts of the project</a>. Even if your skills aren't listed here, get in touch or make something cool. A great place to get started is <a href="http://github.com/photo">on our Github page</a>. Our main repository is frontend, which contains the main code that runs OpenPhoto. If you're interested in mobile development, check out the mobile-ios or mobile-android repositories.
### Where can I talk to the OpenPhoto team?
We have <a href="http://groups.google.com/group/openphoto">a Google group</a> for project discussion, and we have <a href="http://webchat.freenode.net/">an IRC channel</a> at #openphoto on Freenode.
## Contact Us
### Help! Something went wrong.
Email support@openphoto.me and we'll investigate.
### My question isn't answered here. How can I contact you?
Several ways:
* Email support@openphoto.me
* Tweet at <a href="http://twitter.com/openphoto">@openphoto</a>
* Chat with us at <a href="http://webchat.freenode.net/">#openphoto</a> on Freenode

View file

@ -0,0 +1,26 @@
Pro Accounts
===========================
## What do I get with a Trovebox Pro account?
With a pro account, you get:
* Unlimited photo uploads (Free users get 100 photo uploads/month)
* Import from Flickr and Picasa as well as Facebook and Instagram
* Switch storage options as many times as you wish (Free users can switch once)
* Top level domain support at yourdomain.com
<a href="https://trovebox.com/plans">Check out our chart</a> for the full breakdown.
## How much does a Pro account cost?
A Pro account costs $29.99 a year.
## How do I upgrade from a free account to a Pro account?
Visit https://trovebox.com/upgrade, enter your credit card info, and enjoy your Pro account!
## How does unlimited space work with my storage service?
We don't limit uploads for Pro users, but you may face limits from your storage provider. If we're your storage provider then everything is unlimited.
## Do I have to renew manually every year?
Nope. We'll alert you when your Pro account is going to renew.
## What happens if my Pro subscription ends?
Don't panic! Nothing has been deleted. You resume using a free account, though you're now subject to the free account limitations. You can still access all your photos, free or pro.

View file

@ -1,6 +1,9 @@
## Self-Hosted OpenPhoto FAQ ## Self-Hosted OpenPhoto FAQ
### How can I install OpenPhoto? ### 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. 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 or want to add one.
### I'm using a shared hosting webservice. Can I still install OpenPhoto?
Yes, but you may have to configure some settings differently. Check out our <a href="https://github.com/photo/frontend/blob/master/documentation/guides/InstallationSharedHosting.markdown">shared hosting guide</a>. If you're using Dreamhost we have <a href="https://github.com/photo/frontend/blob/master/documentation/guides/InstallationDreamhost.markdown">a community-written guide for Dreamhost users</a>.
### Can I install OpenPhoto to a subdirectory of my site? ### Can I install OpenPhoto to a subdirectory of my site?
Not yet, but it's on our wishlist. Not yet, but it's on our wishlist.
@ -8,6 +11,12 @@ Not yet, but it's on our wishlist.
### How does support for multiple users work? ### 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> 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>
### What cloud services are supported for self-hosted sites?
OpenPhoto currently supports Amazon S3 and Dropbox for self-hosted sites.
### Can I import my photos from other photo sites?
Yes, you can use the scripts available on our Github. We have <a href="https://github.com/photo/export-flickr">a Flickr export script</a> and an <a href="https://github.com/photo/import">import script</a> available on Github. You can also configure something like Ifttt or Pi.pe to continuously import photos from a site.
### Is your mobile app available for self-hosted users? ### 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>. 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>.
@ -18,4 +27,7 @@ This is normal. OpenPhoto configs are bound to a site, not a server. Since a sit
<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. <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? ### 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. 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. The more detail you can give us, the better.
### Help! I'm stuck and I have questions.
If you have questions we're always around to help. We've got several contact options listed on the <a href="http://theopenphotoproject.org/contribute">contribute</a> page.

View file

@ -13,16 +13,16 @@ This guide instructs you on how to install OpenPhoto on a Fedora server.
#### Database and File System Options #### Database and File System Options
##### MySql ##### MySql
You'll need to provide credentials for a MySql database. If the database doesn't already exist it will be created. If the user doesn't have `CREATE DATABASE` permissions then make sure it's already created. You'll need to provide credentials for a MySql database. If the database doesn't already exist it will be created. If the user doesn't have `CREATE DATABASE` permissions then make sure to create the database.
##### AWS ##### AWS
If you're going to use AWS services then You'll need to be signed up for them. If you're going to use AWS services then you'll need to be signed up for them.
* http://aws.amazon.com/simpledb/ * http://aws.amazon.com/simpledb/
* http://aws.amazon.com/s3/ * http://aws.amazon.com/s3/
#### Server Packages and Modules #### Server Packages and Modules
Once you've confirmed that your cloud account is setup you can get started on your server. For that you'll need to have _Apache_, _PHP_ and _curl_ installed with a few modules. Once you've confirmed that your cloud account is set up, you can get started on your server. For that you'll need to have _Apache_, _PHP_ and _curl_ installed with a few modules.
yum groupinstall 'Development Tools' yum groupinstall 'Development Tools'
yum groupinstall 'Development Libraries' yum groupinstall 'Development Libraries'
@ -46,7 +46,7 @@ The _Apache 2_ user in Fedora 16 is `apache` so run the following commands to ta
git clone git://github.com/photo/frontend.git /var/www/yourdomain.com git clone git://github.com/photo/frontend.git /var/www/yourdomain.com
chown -R apache: /var/www/yourdomain.com chown -R apache: /var/www/yourdomain.com
Assuming that this is a development machine you only need to make the config writable by the user Apache runs as. Most likely `apache`. Assuming that this is a development machine you only need to make the config writable by the user Apache runs as. This user is likely `apache`.
mkdir /var/www/yourdomain.com/src/userdata mkdir /var/www/yourdomain.com/src/userdata
mkdir /var/www/yourdomain.com/src/html/photos mkdir /var/www/yourdomain.com/src/html/photos

View file

@ -20,6 +20,7 @@ This guide assumes you have:
* Shell or FTP access to your web server * Shell or FTP access to your web server
* An FTP or SSH client * An FTP or SSH client
* A web browser of choice * A web browser of choice
* A text editor (optional)
* An external cloud service account on Amazon or Dropbox (if you want to store your photos there) * An external cloud service account on Amazon or Dropbox (if you want to store your photos there)
@ -59,12 +60,12 @@ That's it! OpenPhoto should now be installed. Because there are so many special
#### 2. Install any dependencies or modules needed. #### 2. Install any dependencies or modules needed.
Your webhost may include them by default. Check their documentation. Here's what you'll need: Your webhost may include them by default. Check their documentation. Here's what you'll need:
* The Pecl extension oauth for authentication * The Pecl extension `oauth` for authentication
* ImageMagick or GD for photo rendering * 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. 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). #### 3. Create your cloud accounts (if you plan on using them).
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. 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: At Amazon:
@ -80,16 +81,26 @@ At Dropbox:
This will give you a development app to use for your photos. Save your access keys; you'll need them soon. 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. #### 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. Visit your control panel for managing databases and create a new database and new user for the database. Give the user `CREATE DATABASE` privileges if you haven't created the database yet. 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. #### 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. 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. Here's what you need to set up.
* PHP: Select the latest version, FastCGI configuration if available * PHP: Select the latest version, FastCGI configuration if available
* Web directory: OpenPhotoRoot/src/html * Web directory: OpenPhotoRoot/src/html
If you can't set the web directory to OpenPhotoRoot/src/html through a web interface, you can create an .htaccess file in the root directory. Open a text editor and include the following:
RewriteEngine on
RewriteBase /
RewriteCond %{HTTP_HOST} ^your.domain.com$ [NC,OR]
RewriteCond %{REQUEST_URI} !src/html/
RewriteRule (.*) /src/html/$1 [L]
Save the file as .htaccess and upload it to the root folder of your site if you haven't already, along with the OpenPhoto folder.
#### 6. Upload OpenPhoto. #### 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. Upload the contents of the downloaded OpenPhoto folder to the root directory if you haven't already. You can do this with an FTP or SSH client.
#### 7. Create the following directories. #### 7. Create the following directories.
@ -105,8 +116,10 @@ Upload the contents of the downloaded OpenPhoto folder to OpenPhotoRoot if you h
mkdir OpenPhotoRoot/src/userdata mkdir OpenPhotoRoot/src/userdata
chmod 775 OpenPhotoRoot/src/userdata chmod 775 OpenPhotoRoot/src/userdata
You can also do this with your FTP client. If you do, the user and group should have read, write, and execute privileges. World should have read and execute privileges.
#### 8. Install OpenPhoto #### 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. 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 site.
* Enter your email address and select a password. * Enter your email address and select a password.
@ -125,7 +138,10 @@ If the setup page is not colorful and well formatted, then the css and javascrip
- src/html/assets/cache directory is not writeable by Apache (check your permissions) - 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. #### 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. You can set this in the .htaccess page at OpenPhotoRoot. If your webhost lets you set this through the web panel you can also do that there.
#### Error setting up the database #### 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. 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 if you haven't already created a database.
####Help! I'm stuck and I have questions!
If you have questions we're always around to help. We've got several contact options listed on the <a href="http://theopenphotoproject.org/contribute">contribute</a> page.