Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge branch 'master' of github.com:photo/frontend

  • Loading branch information...
commit c5389144b065161f8b4d7eee9089cfabb477ec81 2 parents 5d20432 + 931e5d7
@jmathai jmathai authored
View
2  Readme.markdown
@@ -13,7 +13,7 @@
# Run this from the command line as root.
# As always, view any script before running it ;).
- curl https://raw.github.com/openphoto/frontend/master/documentation/guides/InstallationUbuntuApache.sh | /bin/bash
+ curl https://raw.github.com/photo/frontend/master/documentation/guides/InstallationUbuntuApache.sh | /bin/bash
----------------------------------------
View
16 documentation/api/PostPhotoUpload.markdown
@@ -38,15 +38,15 @@ _Authentication: required_
* This can be the binary photo in multipart/formdata
* This can be the base64 encoded value of the photo in application/x-www-form-urlencoded
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. description (optional), _i.e. 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. title (optional), _e.g. My first day at work_ - A string title to describe the photo.
+1. description (optional), _e.g. A much longer description of my first day_ - A string to describe the photo in detail.
+1. tags (optional), _e.g. dog,cat_ - A comma delimited string of alpha numeric strings.
1. dateUploaded (optional), _i.e. 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. license (optional), _i.e. 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. longitude (optional), _i.e. -87.45_ - A decimal representation of longitude.
-1. returnSizes (optional), _i.e. 200x200,300x300xBW_ - A string instructing specific versions of the photo to be autogenerated.
+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), _e.g. CC BY-SA or My Custom License_ - A string representing a custom or Creative Commons license.
+1. latitude (optional), _e.g. 34.76_ - A decimal representation of latitude.
+1. longitude (optional), _e.g. -87.45_ - A decimal representation of longitude.
+1. returnSizes (optional), _e.g. 200x200,300x300xBW_ - A string instructing specific versions of the photo to be autogenerated.
To specify multiple sizes then separate each with a comman.
The url will be present in the response.
* 300x300 - A photo which maintains aspect ratio and fits inside a 300x300 square
View
14 documentation/api/PostTagCreate.markdown
@@ -1,4 +1,4 @@
-Creae Tag
+Create Tag
=======================
@@ -46,13 +46,13 @@ _Authentication: required_
<a name="example-cli"></a>
#### Command Line (using [openphoto-php][openphoto-php])
- ./openphoto -p -X POST -h current.openphoto.me -e /tag/sunnyvale/create.json -F 'count=10'
+ ./openphoto -p -X POST -h current.openphoto.me -e /tag/create.json -F 'tag=sunnyvale' -F 'count=10'
<a name="example-php"></a>
#### PHP (using [openphoto-php][openphoto-php])
$client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret);
- $response = $client->post("/tag/sunnyvale/create.json", array('count' => 10));
+ $response = $client->post("/tag/create.json", array('tag' => 'sunnyvale', 'count' => 10));
----------------------------------------
@@ -62,7 +62,7 @@ _Authentication: required_
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
-* _code_, _200_ on success
+* _code_, _201_ on success
* _result_, A [Tag][Tag] object or FALSE on error
<a name="sample"></a>
@@ -70,11 +70,11 @@ The response is in a standard [response envelope](http://theopenphotoproject.org
{
"message":"",
- "code":200,
- "result":
+ "code":201,
+ "result":
{
"id": "mountain",
- "count": 1
+ "count": 0
}
}
View
2  documentation/api/Readme.markdown
@@ -49,7 +49,7 @@ Every API endpoint returns a JSON response in a [standard envelope](http://theop
#### Tag endpoints
1. [GET /tags/list.json](http://theopenphotoproject.org/documentation/api/GetTags)
Get a user's tags.
-1. [POST /tag/:id/create.json](http://theopenphotoproject.org/documentation/api/PostTagCreate)
+1. [POST /tag/create.json](http://theopenphotoproject.org/documentation/api/PostTagCreate)
Create a tag for the user.
1. [POST /tag/:id/update.json](http://theopenphotoproject.org/documentation/api/PostTagUpdate)
Modify meta data for a user's tag.
View
18 documentation/contribute/Readme.markdown
@@ -7,7 +7,7 @@ Alright, we get it. You'd rather code than read. Here's the checklist.
1. Fork the <a href="https://github.com/photo/frontend">frontend</a> repository. <a href="http://help.github.com/fork-a-repo/">More info on forking</a>.
1. Follow one of our <a href="/documentation">guides</a> on setting the software up.
1. Get coding!
-1. <a href="/contribute/frontend">More details</a> if you need.
+1. <a href="/contribute/frontend">More details</a> if you need them.
<div></div>
@@ -24,7 +24,7 @@ Alright, we get it. You'd rather code than read. Here's the checklist.
# as a result it maybe unstable so you can always use master which should work
user@[frontend] git checkout development
- # make your changes and commit then locally
+ # make your changes and commit them locally
user@[frontend] git commit -m 'Lots of details! Closes #123'
user@[frontend] git push origin development
@@ -32,9 +32,9 @@ Now you're ready to <a href="http://help.github.com/send-pull-requests/">send a
## There's a spot for everyone to be a part of something BIG
-Hear ye, hear ye! <a href="#developers">Developers</a>, <a href="designers">designers</a>, <a href="#copywriters">copywriters</a>, <a href="#community">community managers</a>, <a href="#translators">translators</a>, and anyone else who wants to help. If you want to contribute to The OpenPhoto Project, the good news is that there's probably a place where we could use your help!
+Hear ye, hear ye! <a href="#developers">Developers</a>, <a href="#designers">designers</a>, <a name="#powerusers">power users</a>, <a href="#copywriters">copywriters</a>, <a href="#community">community managers</a>, <a href="#translators">translators</a>, and anyone else who wants to help. If you want to contribute to The OpenPhoto Project, the good news is that there's probably a place where we could use your help!
-It's easy to get in touch with us, as many of us hang out in #openphoto on Freenode. Don't hesitate to come and <a href="http://webchat.freenode.net/">chat with us</a>. We're happy to answer any questions you might have.
+It's easy to get in touch with us, as many of us hang out in #openphoto on Freenode. Come in and <a href="http://webchat.freenode.net/">chat with us</a>. We're happy to answer any questions you might have.
Here's a full list of ways to contact us:
@@ -65,16 +65,20 @@ That being said, the largest part of the code base is the <a href="https://githu
If you've got a gift with words we're in desperate need of your help. Much of the community consists of engineers and well, we suck at taking complex ideas and distilling them into small and easy to understand sentences.
-The best way to get started is to read the copy at the <a href="http://theopenphotoproject.org">The OpenPhoto Project</a> website. Some of it is technical, like the documentation, but much of it is also trying to explain why users should care about what we're building. Wherever your passion lies, we will definitely appreciate the help.
+The best way to get started is to read the copy at <a href="http://theopenphotoproject.org">The OpenPhoto Project</a>'s website. Some of it is technical, like the documentation, but much of it is also trying to explain why users should care about what we're building. Wherever your passion lies, we will definitely appreciate the help.
Everything can be found in the <a href="https://github.com/photo/community">community</a> repository for the non-technical bits or the <a href="https://github.com/photo/frontend">frontend</a> repository for the documentation.
-You can open an issue for the appropriate repository or fork it and send us a pull request. If you have any questions, let us know using one of the channels above.
+We have <a href="https://github.com/photo/frontend/issues?labels=Documentation&page=1&state=open">issues tagged documentation</a> on Github, but just about every area of the site needs some attention. You can open an issue for the appropriate repository or fork it and send us a pull request. If you have any questions, let us know using one of the channels above.
+
+<a name="powerusers"></a>
+## Power Users
+Do you know OpenPhoto inside out, including all its little quirks? Then we need you! A lot of people ask questions about OpenPhoto on our mailing list or on IRC, so hang out on those channels and help someone out. This is a great way to get to know other OpenPhoto users. You can also help out by filing Github issues when you find bugs and discussing them on our issues board.
<a name="community"></a>
## Community Managers and Social Media
-Send an email to <a href="mailto:hello@openphoto.me">hello@openphoto.me</a> or <a href="https://twitter.com/photo">@mention us</a> on Twitter if you'd like to help with Community Management or Social Media.
+Send an email to <a href="mailto:hello@openphoto.me">hello@openphoto.me</a> or <a href="https://twitter.com/openphoto">@mention us</a> on Twitter if you'd like to help with Community Management or Social Media.
<a name="translators"></a>
## Translators
View
43 documentation/contribute/frontend.markdown
@@ -3,23 +3,27 @@ Contributing to the Web and API components
## Up and contributing in under 5 minutes
-So what do you need to start contributing?
+So what do you need to get started?
A computer! Once you've secured one of those all you need is a Github account. It helps to have a locally installed version of the frontend repository to test your changes. We've got <a href="http://theopenphotoproject.org/documentation">lots of guides</a> to help you get started. If you're updating any of the PHP code you should get PHPUnit as well.
pear channel-discover pear.phpunit.de
+ pear channel-discover pear.bovigo.org
pear install pear.phpunit.de/PHPUnit
+ pear install bovigo/vfsStream-beta
# problems? check the links below
# http://www.phpunit.de/manual/3.6/en/installation.html
# http://stackoverflow.com/questions/3301300/setting-up-phpunit-on-osx
-Now that you've got the following we can continue.
+Now that you've got:
* A computer
* <a href="https://github.com">A GitHub account</a>
* An <a href="http://theopenphotoproject.org/documentation">installation of the frontend repository</a>
-* <a href="http://www.phpunit.de/manual/3.6/en/installation.html">PHPUnit</a>
+* <a href="http://www.phpunit.de/manual/3.6/en/installation.html">PHPUnit</a>,
+
+let's continue.
## Deciding what to fix
@@ -30,11 +34,32 @@ We've added a _Beginner_ label to issues that don't touch some of the more sensi
* <a href="https://github.com/photo/frontend/issues?labels=Beginner%2CJavaScript&sort=created&direction=desc&state=open&page=1">Beginner + JavaScript issues</a>
* <a href="https://github.com/photo/frontend/issues?labels=Beginner%2CPHP&sort=created&direction=desc&state=open&page=1">Beginner + PHP issues</a>
+## Things to keep in mind while you code
+Here's what your code should adhere to:
+
+* Unit tests should pass (more on that in the next section)
+* Spacing matters: two spaces, no tabs
+* Commits should reference an issue number (more on that below)
+* Comment your code so future developers can tell what's going on
+* Curly braces go on their own line. For example:
+````php
+ if(condition)
+ {
+ statement 1;
+ statement 2;
+ }
+
+ // or
+ if(condition)
+ only statement;
+````
+All in all, we recognize that everyone has a different style and level of experience, and we welcome all pull requests.
+
## Testing that your change didn't break anything
Once you've made your change and verified it does what it should it's time to make sure it's not doing something it shouldn't. This is as easy as a single command.
- phpunit src/tests
+ phpunit -c src/tests/phpunit.xml
............................................................ 60 / 311
............................................................ 120 / 311
............................................................ 180 / 311
@@ -47,14 +72,14 @@ Once you've made your change and verified it does what it should it's time to ma
OK, but incomplete or skipped tests!
Tests: 311, Assertions: 661, Incomplete: 4.
-Those `I`s are okay but you shouldn't see any `E`s or `F`s and definitely look for the _OK_ message at the end. If all the tests pass then you're good to go and can commit it.
+Those `I`s are okay but you shouldn't see any `E`s or `F`s and definitely look for the `OK` message at the end. If all the tests pass then you're good to go and can commit your changes.
-You can also automate this by adding a pre-commit hook. Just copy <a href="https://github.com/photo/frontend/blob/master/documentation/hooks/pre-commit">this file</a> into your `.git/hooks` directory or run the command below.
+You can automate this by adding a pre-commit hook. Just copy <a href="https://github.com/photo/frontend/blob/master/documentation/hooks/pre-commit">this file</a> into your `.git/hooks` directory or run the command below.
wget --no-check-certificate https://raw.github.com/photo/frontend/master/documentation/hooks/pre-commit -O .git/hooks/pre-commit
chmod u+x .git/hooks/pre-commit
-Now everytime you make a commit it will first run the unit tests, automatically.
+Now every time you make a commit it will first run the unit tests automatically.
## Committing your code
@@ -72,9 +97,9 @@ Be descriptive, it helps a ton. Once you've committed your code it's time to pus
## Getting your change into the OpenPhoto branch
-To get your change merged into the official OpenPhoto branch you should submit a pull request. <a href="http://help.github.com/send-pull-requests/"GitHub's tutorial</a> is better than anything we could do so we'll link to it.
+To get your change merged into the official OpenPhoto branch, submit a pull request. <a href="http://help.github.com/send-pull-requests/">GitHub's tutorial</a> is better than anything we could do so we'll link to it.
-It makes everyone's life easier if you can remember to issue the pull request to OpenPhoto's development. If you forget, no big deal. The important thing is we get your change and your awesomeness can be merged into everyone else's awesomeness.
+It makes everyone's lives easier if you can remember to issue the pull request to OpenPhoto's development branch. If you forget, no big deal. The important thing is we get your change and your awesomeness can be merged into everyone else's awesomeness.
## Help! I'm stuck and have questions
View
140 documentation/faq/Faq.markdown
@@ -1,61 +1,129 @@
-Frequently asked questions
+Frequently Asked Questions
=======================
-This is a list of common questions that people have about The OpenPhoto Project.
-If you have one which is not on this list send us a message via <a href="http://twitter.com/photo">Twitter</a> or <a href="mailto:hello@openphoto.me">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 exactly 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.
-tl;dr Dropbox for your photos
+It's the photo service you never knew you wanted until it existed.
-OpenPhoto lets you aggregate, archive, organize your photos using your personal cloud accounts such as Dropbox or Amazon S3.
+### What makes OpenPhoto different than Flickr/Smugmug/Instagram/any other photo site?
+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.
-#### Aggregate
+With OpenPhoto you can switch between services, use more than one at a time, or stop using the service without losing a single photo.
-OpenPhoto import tools help you rescue your photos from 3rd party services (including OpenPhoto itself).
-Easily and seamlessly import your photos from Flickr, Picasa, Facebook or Smugmug.
+## Account Management
-#### Archive
+### 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.
-By using OpenPhoto all of your photos are being stored into your storage accounts.
-This means they're archived for good.
-It's the master shoebox for all of your photos and you can relax that it'll always be available to you.
+### 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.
-#### Organize
+### 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.
-OpenPhoto automatically does some organization of your photos by date and location.
-You can add additional organization by adding tags to your photos or putting them into folders.
+### 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.
-### What makes OpenPhoto different from Flickr, Smugmug, iCloud or any other service?
+### 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
-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, shut down their service or another site comes along.
+## Photo Storage
-These sites may offer APIs but it's often limited what you can do with their API.
-Your photos are still stored on the company's servers who provide the base service.
+### Where can I store my photos?
+Right now OpenPhoto supports Amazon S3, Box.com, Dropbox, CX.com, and DreamHost DreamObjects.
-With OpenPhoto you can switch between services, use more than one at a time or stop using the service without losing a single photo.
+### 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.
-### If OpenPhoto is open sourced then why isn't it free?
+### 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).
-All of the <a href="https://github.com/photo">source for OpenPhoto</a> is available on Github.
-This includes the web application, mobile apps and plugins for Wordpress just to name a few.
-We've also got <a href="http://theopenphotoproject.org/documentation">lots of guides</a> to help you get started.
+## Photo Management
-If you'd rather not install the software yourself you can <a href="http://openphoto.me">sign up for a hosted account</a>.
-The hosted account may or may not be free depending on the service and what features you use.
+### 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.
-### How much does the storage cost?
+### 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.
-It depends on what you use but here are some base prices from Amazon.
+### 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.
-1. 20GB of storage on Amazon S3 costs ≈_$2/mo_
-1. A 250KB photo served up 4,000 times on Amazon S3 costs ≈_$.10/mo_
-1. A simpleDb database for a personal account is typically _free_
+### 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
21 documentation/faq/SelfHostedFaq.markdown
@@ -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.
View
8 documentation/guides/InstallationOSXMacports.markdown
@@ -16,7 +16,7 @@ This guide instructs you on how to install OpenPhoto on a Macintosh OSX computer
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.
##### 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/s3/
@@ -24,7 +24,7 @@ If you're going to use AWS services then You'll need to be signed up for them.
#### 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.
-This guide assumes you have [get it here][Macports installed]. If not you can . The easiest option is to use `.pkg` installer.
+This guide assumes you have Macports installed. If not you can [get it here](http://www.macports.org/install.php). The easiest option is to use `.pkg` installer.
sudo port install apache2
sudo port install php5 +apache2
@@ -141,7 +141,7 @@ If you happen to not have `yourdomain.com` registered, you can fake it by editin
Now you're ready to launch your OpenPhoto site. Point your browser to your host and you'll be taken to a setup screen. You'll need your cloud account credentials to continue.
-Once you complete the 3 steps your site will be up and running and you'll be redirected there. The _setup_ screen won't show up anymore.
+Once you complete the 3 steps your site will be up and running and you'll be redirected there. The setup screen won't show up anymore.
### Performing setup again ###
@@ -150,5 +150,3 @@ If for any reason you want to go through the setup again you will need to delete
rm ~/Sites/yourdomain.com/src/userdata/configs/settings.ini
**ENJOY!**
-
-[macports]: http://www.macports.org/install.php
View
131 documentation/guides/InstallationSharedHosting.markdown
@@ -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.
View
6 documentation/guides/InstallationUbuntuApache.markdown
@@ -86,7 +86,7 @@ Now enable openphoto and disable Apache's default virtual host.
a2ensite openphoto
-By default, any access to ini files is denied with a "Not Found" 404 HTTP code. To enable a 404, or Forbidden return code, change the following lines in the virtual host file.
+By default, any access to ini files is denied with a "Not Found" 404 HTTP code. To enable a 403, or Forbidden return code, change the following lines in the virtual host file.
Uncomment:
@@ -95,8 +95,8 @@ Uncomment:
Comment:
- # 404 Not Found for ini files
- AliasMatch \.ini$ /404
+ # 404 Not Found for ini files
+ AliasMatch \.ini$ /404
### PHP
View
2  documentation/guides/InstallationUbuntuApache.sh
@@ -66,7 +66,7 @@ echo ""
wget https://github.com/photo/frontend/tarball/master -O openphoto.tar.gz
tar -zxvf openphoto.tar.gz > /dev/null 2>&1
-mv openphoto-frontend-* /var/www/openphoto
+mv photo-frontend-* /var/www/openphoto
sudo rm openphoto.tar.gz
echo ""
View
2  src/templates/setup.php
@@ -52,7 +52,7 @@
<div id="setup-step-2"<?php echo ($step != 2) ? ' class="hidden"' : ''?>>
<form action="/setup/2<?php echo $qs; ?>" method="post">
<h2>Site Settings <em>(the defaults work just fine<!--<a href="">what's this?</a>-->)</em></h2>
- <label for="imageLibrary">Select Image Library (see <a href="https://github.com/openphoto/frontend/issues/662" target="_blank">#662</a> if using GD)</label>
+ <label for="imageLibrary">Select Image Library (see <a href="https://github.com/photo/frontend/issues/662" target="_blank">#662</a> if using GD)</label>
<?php if(isset($imageLibs)) { ?>
<select name="imageLibrary" id="imageLibrary">
<?php foreach($imageLibs as $key => $val) { ?>

0 comments on commit c538914

Please sign in to comment.
Something went wrong with that request. Please try again.