From 0e601f27299d129f1ffe85bb6e90c2c13b17043a Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Thu, 28 Mar 2013 21:30:11 -0300 Subject: [PATCH 01/52] created Extend page --- docs/faq/Extend.markdown | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/faq/Extend.markdown diff --git a/docs/faq/Extend.markdown b/docs/faq/Extend.markdown new file mode 100644 index 0000000..311e3ce --- /dev/null +++ b/docs/faq/Extend.markdown @@ -0,0 +1,25 @@ +## Extend Trovebox + +You can do more with your Trovebox photo than upload and organize photos. You may already be familiar with storing your photos in your own storage space, importing photos from other sites, and uploading photos with our mobile apps. Here are a few more tools to make your Trovebox site even more useful. + +### See How Many People Visit Your Site +If you’ve wondered how many people visit your Trovebox site, you can install Google Analytics and start gathering stats. Get started in a few short steps. + +* Log into [Google Analytics](https://google.com/analytics/) and create a new site to track. +* In the admin section, find your tracking ID under the tracking info section. Make a note of this. +* In your Trovebox site settings, click Configure next to Google Analytics and enter your tracking ID. +* You can view your site stats anytime at Google Analytics. + +Don’t like Google Analytics? No problem. We also support site stats through the self-hosted Piwik. + +### Import Photos From Other Sites +Trovebox currently supports imports from Facebook, Flickr, and Instagram, but what about those other photo sites out there? [Pi.pe](http://pi.pe), a media distribution gateway, has some of those covered. + +**If you have a free account, you may go over the 100 photos/month limit with this upload.** + +Pi.pe [has an excellent guide](http://blog.pixelpipe.com/2012/12/10/configuring-openphoto-as-a-pi-pe-service/) on getting started that goes into more detail. We’ll let them take it from here. + +### Use Your Trovebox Photos on Your Blog +If you use WordPress, you can use your individual Trovebox images on your blog. [Download our plugin](https://wordpress.org/extend/plugins/openphoto/) to your WordPress site and go to OpenPhoto in settings to configure it. Enter your site URL and which photo size you’d like to use when inserting an image in your post, and enjoy inserting your Trovebox images into posts. + +The Trovebox source and API are open source, so if you want to build something, [get started](https://trovebox.com/documentation). Email us at support@trovebox.com if you’d like to see your creation here. From dfa9241aabbdcb6af3270a22bcb5a8660189d5b6 Mon Sep 17 00:00:00 2001 From: sushimustwrite Date: Fri, 19 Apr 2013 17:53:22 -0400 Subject: [PATCH 02/52] faq changes --- docs/faq/AccountManagement.markdown | 2 +- docs/faq/MobileApps.markdown | 10 ++++++++-- docs/faq/PhotoManagement.markdown | 28 ++++++++++++++++++---------- docs/faq/PhotoSharing.markdown | 13 ++++++++++--- docs/faq/ProAccounts.markdown | 15 +++++++++++---- docs/faq/Storage.markdown | 21 +++++++++++++++++---- 6 files changed, 65 insertions(+), 24 deletions(-) diff --git a/docs/faq/AccountManagement.markdown b/docs/faq/AccountManagement.markdown index 740d050..e03c9b8 100644 --- a/docs/faq/AccountManagement.markdown +++ b/docs/faq/AccountManagement.markdown @@ -1,7 +1,7 @@ Account Management ======================= -## How do I create an account? +## How do I create a Trovebox account? Visit trovebox.com and click the Sign Up button. Select a username for your Trovebox site along with a password. ## How do I log in? diff --git a/docs/faq/MobileApps.markdown b/docs/faq/MobileApps.markdown index 13a8266..fabded5 100644 --- a/docs/faq/MobileApps.markdown +++ b/docs/faq/MobileApps.markdown @@ -2,20 +2,26 @@ The Trovebox Mobile Apps ======================= ## What phones are supported? -Trovebox has mobile apps for iPhone and Android. You can download them in the App Store (iOS) or Play Store (Android). +Trovebox's mobile apps are available for iPhone and Android. You can download them in the App Store (iOS) or Play Store (Android). ## What can I do with the Trovebox mobile apps? +Lots of things. To name a few: + * Create an Trovebox account * Upload photos to your Trovebox site +* View photos in your gallery, by album, or by tag * Add titles, descriptions, privacy settings, and tags * Share photos via email, Twitter, and Facebook * Add filters to your photos +* Purchase a monthly Pro account plan (iPhone only, Android coming soon) ## I have a limited data plan. Can I limit uploads to wifi only? Sure. ## What is Sync? -Sync lets you view the photos on your phone and select which ones to upload. +Sync lets you view the photos on your phone and select which ones to upload. Think of it as batch upload for your phone. ## Can I automatically upload taken photos to Trovebox? Yes. This is an experimental feature for Android. + diff --git a/docs/faq/PhotoManagement.markdown b/docs/faq/PhotoManagement.markdown index 4705e9c..ff2eeaf 100644 --- a/docs/faq/PhotoManagement.markdown +++ b/docs/faq/PhotoManagement.markdown @@ -4,8 +4,22 @@ Photo Management ## How do I upload a photo? Go to your Trovebox site (it'll look like yourusername.trovebox.com) 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 large can my photo be? +We support photo files of up to 30MB. + +## What file types are supported? +Currently we support .jpg, .gif, and .png files. We want to support more file types in the future, so let us know what you'd like to see. + +## How do I edit multiple photos at once? +Visit your Gallery at your Trovebox site. From there, hover over the photo(s) you want to edit and click the pin that appears. Click Batch Edit and select the detail you want to edit, change the detail, and click Submit. + +## Wait, Batch Edit? How does that work? +Batch Edit lets you edit multiple photos at once. Currently you can add or remove tags or albums. You can also edit privacy settings or delete a set of photos. + +To use Batch Edit, visit your gallery and hover over the photos you want to edit. Click the pushpins of each photo. You can also select all, which will select all the visible photos. Then select Batch Edit and edit away. + ## How do I delete a photo? -Visit your gallery or an album. Hover over the photo you want to delete. You'll see the title of the photo along with a few icons. Click the trash can to delete the photo. +Visit your gallery or an album. Hover over the photo you want to delete. You'll see the title of the photo along with a few icons. Click the trash can to delete the photo, then confirm you want to delete the photo. ## How do I change the privacy setting of a photo? You can do this by visiting the individual photo or by finding that photo in a gallery or album. In gallery or album view, hover over the photo you want to change to private (or public). You'll see the title of the photo along with a few icons, including a lock. In full detail view, you'll see the photo's privacy on the right side with the rest of the photo info. An unlocked lock indicates a public photo, while a locked one means the photo is private. Click the lock to toggle the privacy setting. @@ -13,14 +27,11 @@ You can do this by visiting the individual photo or by finding that photo in a g ## How do I edit the title or description of a photo? Visit the photo whose info you want to edit, then click the title or description. Enter your new title or description in the box that appears and save. You can also edit the title directly from the gallery or album view. -## How do I share a photo? -While viewing your photo gallery or an individual photo, click Share (or the curved right-pointing arrow). Select whether you want to share via email, Twitter, or Facebook, and share away. - ## How do I download an individual photo? You can download a photo directly if you or the user has enabled that option in the settings page. To do so, view the full details of the photo you want to download and click the Download link on the right hand side. -## Where does the image for my user photo come from? How can I change it? -We use Gravatar to set your original user photo, and you can change it across Gravatar by visiting their site and changing your photo there. If you'd like to set one of your uploaded photos as your user photo, visit your gallery, find a photo you'd like to use, and select the human silhouette. +## How can I change my user photo? +If you'd like to set one of your uploaded photos as your user photo, visit your gallery, find a photo you'd like to use, and select the person icon. ## 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. @@ -32,7 +43,4 @@ While you're logged into your Trovebox site, visit Albums. Select Create Album, You can add a photo to an album by hovering over the photo in your gallery and pinning it. Then select Batch Edit and Add to Album. Select the album you want to add the photo to and save. ## How do I delete an album? -Hover over the album you want to delete in the albums page and click the trash can. The photos in that album are still safe. - -## How do I edit multiple photos at once? -Visit your Gallery at your Trovebox site. From there, hover over the photo(s) you want to edit and click the pin that appears. Click Batch Edit and select the detail you want to edit, change the detail, and click Submit. +Hover over the album you want to delete in the albums page and click the trash can. Confirm that you want to delete the album. The photos in that album are still safe. diff --git a/docs/faq/PhotoSharing.markdown b/docs/faq/PhotoSharing.markdown index 40f56c8..5266ef8 100644 --- a/docs/faq/PhotoSharing.markdown +++ b/docs/faq/PhotoSharing.markdown @@ -5,13 +5,14 @@ Photo Sharing You can share a photo by clicking the arrow button at the photo's page or in the gallery. You'll then see the options to share the photo. ## Where can I share a photo to? -Right now we support sharing via email, Facebook, or Twitter. +Right now we support sharing via email, Facebook, or Twitter. We want to add more sites, so let us know where youyour photos to. ## Can I share an album instead of a photo? Yes. Click the Share button that appears when hovering over an album's summary, then share in the same way you'd share a photo. -## How do I share a private photo? -You can share a private photo in the same way that you'd share a public photo. When you share a private photo a sharing token gets added to the photo URL, which a recipient can use to view the photo without logging in. +## How do I share a private photo or album? +You can share a private photo in the same way that you'd share a public photo or album. When you share a private item, a sharing token gets added to the photo URL. The recipient can then use the full URL to view the photo without +logging in. ## Wait, sharing tokens? How do those work? When you share a photo, a sharing token in the photo's URL enables other users to view your photo. These sharing tokens expire after a time period that you'll soon be able to set yourself. @@ -21,3 +22,9 @@ The recipient will be able to see the album and the contents of the album, even ## Can I set a custom expiration date for a sharing token? Soon you'll be able to. + +## I changed my mind about sharing a photo. How can I revoke its sharing token? +Soon you'll be able to manage all your sharing tokens from a separate page, which will let you revoke individual tokens. + +## Can I share a photo's link via HTML? +Not yet. We're working on this. diff --git a/docs/faq/ProAccounts.markdown b/docs/faq/ProAccounts.markdown index a124141..bcb1145 100644 --- a/docs/faq/ProAccounts.markdown +++ b/docs/faq/ProAccounts.markdown @@ -3,14 +3,14 @@ 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 as well as Facebook and Instagram (Picasa and Smugmug coming soon) * Switch storage options as many times as you wish -* Enhanced security with SSL -* Ability to add multiple users to your account +* Collaborators on your account * Top level domain support at yourdomain.com -Check out our chart for the full breakdown. +Check out our plans chart for the full breakdown. ## How much does a Pro account cost? A Pro account costs $29.99 a year. @@ -30,6 +30,10 @@ 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. +## What can collaborators do with my account? +Collaborators can add photos, edit photos, delete photos--just about anything you can do except delete your account. When you add them as a collaborator they can log in with that email via Mozilla Persona. Soon they'll be able to +log in via the regular Trovebox login. + ## How do I add a top level domain? Adding a top level domain to your Trovebox site is currently all manual on our end, so there are two steps to take. First, email support@trovebox.com with the domain or subdomain you'd like to add to your Trovebox site. @@ -41,5 +45,8 @@ After we've replied and confirmed that we've set up your domain, you'll need to It'll take up to 24 hours for your changes to take effect. -## How do I add Twitter cards for my custom domain? +## How do I add Twitter cards for my domain? Twitter cards are added per domain, so you have to apply for them separately for your own domain. + +## My needs go far beyond what a Pro account provides. Can I get even more? +We're working on a [https://trovebox.com/organizations](plan for organizations). Email us at [mailto:support@trovebox.com](support@trovebox.com) if you're interested. diff --git a/docs/faq/Storage.markdown b/docs/faq/Storage.markdown index c643fc8..67547f1 100644 --- a/docs/faq/Storage.markdown +++ b/docs/faq/Storage.markdown @@ -2,7 +2,10 @@ Photo Storage ======================= ## Where can I store my photos? -Right now Trovebox supports Amazon S3, Box.com, Dropbox, CX.com, and DreamHost DreamObjects. +Right now Trovebox supports Amazon S3, Box.com, Dropbox, CX.com, DreamHost DreamObjects, and the Internet Archive. You can also use our storage if you don't want to use your own. + +## What if I don't choose my own storage provider upon signup. +Then your photos get stored in our own S3 bucket. You can change this anytime. ## How do I switch where my photos are stored? Visit the storage migration page while logged in, select where you'd like your photos to go, and follow the instructions. Note that this is a Pro account option. @@ -10,11 +13,21 @@ Visit the storage migration page while ## How can I import my photos? You can import your photos through the Upload photos page when you're logged into Trovebox. 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 Trovebox? +## Can I keep uploading to another photo site and have that photo automatically show up in Trovebox? What about uploading to Trovebox and having a photo show up elsewhere? Not directly through Trovebox, but you can use sites like ifttt or Pixelpipe that will automatically upload a picture to Trovebox when you upload a picture somewhere else (or vice versa). ## Is there a limit to how many photos I can upload? -If you're a free user you can upload up to 100 photos per month. Pro account holders get unlimited uploads. +If you're a free user you can upload up to 100 photos per month. Pro account holders get unlimited uploads, though your storage provider may impose space limits. If you're using our storage then everything is unlimited. -## If I'm a free user, do I lose access to my photos after using a certain amount of space or hitting my montly upload limit? +## Can I sync photos to Trovebox from an existing storage account? +Not yet. It's on our feature wishlist, though. + +## If I'm using the Internet Archive as my storage, does that mean all my photos have to be public? +Not on your Trovebox site! However, the Internet Archive offers free storage for the sake of the public. Right now you can mark a photo as private on your site and it'll show up as public in the archive for archiving purposes. +We're working on this. + +## If I'm a free user, do I lose access to my photos after using a certain amount of space or hitting my monthly upload limit? Nope. Your photos are yours, and you still have access to everything you've previously uploaded. + +## Do I get to access my original photos? +Yes. Free or pro, you'll always have access to the original photos uploaded. From b369f62a7b5bd8d8a2b2f113b822b99baa59cca9 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sun, 21 Apr 2013 19:55:41 -0300 Subject: [PATCH 03/52] Updated docs contrib guide, corrected formatting --- docs/contribute/documentation.markdown | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/contribute/documentation.markdown b/docs/contribute/documentation.markdown index ea43a9f..a2f0eaa 100644 --- a/docs/contribute/documentation.markdown +++ b/docs/contribute/documentation.markdown @@ -7,21 +7,22 @@ We're always looking for writers to contribute to our documentation. If you can ## 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 documentation repository under the docs folder. We have issues tagged documentation on Github, but every area of the project can benefit from better documentation. Choose something you know about and start writing. +All of this documentation is in the documentation repository under the docs folder. We have issues tagged documentation on the frontend repository as well, but every area of the project can benefit from better documentation. Choose something you know about that isn't well-documented here and start writing. -## Forking the OpenPhoto repository -Before you start writing, you need to fork the documentation repository. 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, Github explains how to clone a repository to your own machine. +## Forking the Documentation repository +Before you start writing, you need to fork the documentation repository. 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 a copy of the repository on your computer, Github explains how to clone a repository to your own machine. ## 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 Github's explanation of Markdown as well as the source of OpenPhoto's documentation pages on Github. +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 [our documentation repository](https://github.com/photo/documentation), then write your contribution in a text editor of your choice. If you're not, you may want to take a look at Github's explanation of Markdown as well as the source of OpenPhoto's documentation pages on Github. Or if you're working from the Github site, press **m** on your keyboard when editing a page to see a cheatsheet. 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. + +* 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 friendly to users of all levels, remaining gender-neutral, and being friendly and informative. * Use correct grammar and spelling. Here's a grammar guide 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. +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. If you're editing a copy on your own machine, you can commit like this: # To simply reference an issue with a commit do this git commit -m 'Addressing the foobar component but not yet finished. #123' @@ -29,11 +30,15 @@ When committing your documentation it's important to reference the GitHub issue # 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. +If you didn't fix a specific documentation issue, it's okay if you don't reference an issue number. + +Whether you reference an issue number or not, 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. If you're working from Github, comitting the code automatically pushes it to your repository. If you're working from your local copy, you can do this with: git push origin master -## Getting your change into the main OpenPhoto branch +## Getting your change into the main Documentation 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, Github explains how to send a pull request with git. 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 From 94f14a1d2e50fd5c617c25e8a6d701fba0295545 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sun, 21 Apr 2013 20:08:11 -0300 Subject: [PATCH 04/52] added a short version at top realized docs guide is really long. added tl;dr at top --- docs/contribute/documentation.markdown | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/contribute/documentation.markdown b/docs/contribute/documentation.markdown index a2f0eaa..fcc619f 100644 --- a/docs/contribute/documentation.markdown +++ b/docs/contribute/documentation.markdown @@ -4,13 +4,23 @@ We're working hard to make OpenPhoto the best photo software possible, and part We're always looking for writers to contribute to our documentation. If you can explain technical ideas clearly, we need you. +## The short version +Here's the short version of adding to our documentation. + +* Choose something to document. +* Fork our Documentation repository. +* Write. +* Send a pull request. + +The rest of this guide covers each step in detail. + ## 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 documentation repository under the docs folder. We have issues tagged documentation on the frontend repository as well, but every area of the project can benefit from better documentation. Choose something you know about that isn't well-documented here and start writing. ## Forking the Documentation repository -Before you start writing, you need to fork the documentation repository. 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 a copy of the repository on your computer, Github explains how to clone a repository to your own machine. +Before you start writing, you need to fork the documentation repository. 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, you can go ahead and start writing. If you want to work from a copy of the repository on your computer, Github explains how to clone a repository to your own machine. ## 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 [our documentation repository](https://github.com/photo/documentation), then write your contribution in a text editor of your choice. If you're not, you may want to take a look at Github's explanation of Markdown as well as the source of OpenPhoto's documentation pages on Github. Or if you're working from the Github site, press **m** on your keyboard when editing a page to see a cheatsheet. From 56227e48d08cd93cbc9784f8ac3c0c11827cb404 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sun, 21 Apr 2013 20:28:06 -0300 Subject: [PATCH 05/52] finally fixed that markdown formatting issue --- docs/contribute/frontend.markdown | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/contribute/frontend.markdown b/docs/contribute/frontend.markdown index df04d8b..2799450 100644 --- a/docs/contribute/frontend.markdown +++ b/docs/contribute/frontend.markdown @@ -35,24 +35,26 @@ We've added a _Beginner_ label to issues that don't touch some of the more sensi * Beginner + PHP issues ## Things to keep in mind while you code -Here's what your code should adhere to: +Here are some guidelines for your code: * 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; -```` + + 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 From 8c89764694b313866d989e9fe55b7cf5a42f1435 Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Sat, 4 May 2013 12:32:41 +0200 Subject: [PATCH 06/52] Corrected photo/delete API documentation - was incorrectly using action/delete --- docs/api/PostPhotoDelete.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/PostPhotoDelete.markdown b/docs/api/PostPhotoDelete.markdown index a4d3dfa..7a839c3 100644 --- a/docs/api/PostPhotoDelete.markdown +++ b/docs/api/PostPhotoDelete.markdown @@ -27,7 +27,7 @@ Use this API to delete an action. _Authentication: required_ - POST /action/:id/delete.json + POST /photo/:id/delete.json ### Parameters @@ -42,13 +42,13 @@ _None_ #### Command Line (using [openphoto-php][openphoto-php]) - ./openphoto -p -X POST -h current.openphoto.me -e /action/a/delete.json + ./openphoto -p -X POST -h current.openphoto.me -e /photo/a/delete.json #### PHP (using [openphoto-php][openphoto-php]) $client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret); - $response = $client->post("/action/a/delete.json"); + $response = $client->post("/photo/a/delete.json"); ---------------------------------------- From bd1f82b896ee9de243100ed5577db2636d208b91 Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Sat, 4 May 2013 19:35:45 +0200 Subject: [PATCH 07/52] Added Python example --- docs/api/GetPhoto.markdown | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/api/GetPhoto.markdown b/docs/api/GetPhoto.markdown index 5a6b56d..b60a8b0 100644 --- a/docs/api/GetPhoto.markdown +++ b/docs/api/GetPhoto.markdown @@ -10,6 +10,7 @@ Get Photo 1. [Examples][examples] * [Command line][example-cli] * [PHP][example-php] + * [Python][example-python] 1. [Response][response] * [Sample][sample] @@ -53,6 +54,14 @@ _Authentication: optional_ $client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret); $response = $client->get("/photo/b/view.json"); + +#### Python (using [openphoto-python][openphoto-python]) + + client = openphoto.OpenPhoto() + photo = client.photos.list()[0] # Returns the first photo from the list + photo.view(returnSizes="20x20") # Updates the photo object with the requested size + print photo.path20x20 + ---------------------------------------- @@ -109,8 +118,10 @@ The response is in a standard [response envelope](http://theopenphotoproject.org [examples]: #examples [example-cli]: #example-cli [example-php]: #example-php +[example-python]: #example-python [response]: #response [sample]: #sample [photogeneration]: http://theopenphotoproject.org/documentation/faq/PhotoGeneration [ReturnSizes]: http://theopenphotoproject.org/documentation/faq/ReturnSizes [openphoto-php]: https://github.com/photo/openphoto-php +[openphoto-python]: https://github.com/photo/openphoto-python From eb93b56ae460c75110658aa4cc86581d7a9c99cc Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Sat, 4 May 2013 19:43:36 +0200 Subject: [PATCH 08/52] Added Python example to GetPhotoNextPrevious --- docs/api/GetPhotoNextPrevious.markdown | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/api/GetPhotoNextPrevious.markdown b/docs/api/GetPhotoNextPrevious.markdown index d5e9207..d8a0fad 100644 --- a/docs/api/GetPhotoNextPrevious.markdown +++ b/docs/api/GetPhotoNextPrevious.markdown @@ -10,6 +10,7 @@ Get Next/Previous Photo 1. [Examples][examples] * [Command line][example-cli] * [PHP][example-php] + * [Python][example-python] 1. [Response][response] * [Sample][sample] @@ -53,6 +54,15 @@ _Authentication: optional_ $client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret); $response = $client->get("/photo/b/nextprevious.json"); + +#### Python (using [openphoto-python][openphoto-python]) + + client = openphoto.OpenPhoto() + photo = client.photos.list()[1] # Returns the second photo in the list + print photo.next_previous() + + {'previous': [], 'next': []} + ---------------------------------------- @@ -152,8 +162,10 @@ The response is in a standard [response envelope](http://theopenphotoproject.org [examples]: #examples [example-cli]: #example-cli [example-php]: #example-php +[example-python]: #example-python [response]: #response [sample]: #sample [photogeneration]: http://theopenphotoproject.org/documentation/faq/PhotoGeneration [ReturnSizes]: http://theopenphotoproject.org/documentation/faq/ReturnSizes [openphoto-php]: https://github.com/photo/openphoto-php +[openphoto-python]: https://github.com/photo/openphoto-python From 9c216ec901636d86a6b43666c34c357dd3b648c3 Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Sat, 4 May 2013 19:48:26 +0200 Subject: [PATCH 09/52] Add example Python response --- docs/api/GetPhoto.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api/GetPhoto.markdown b/docs/api/GetPhoto.markdown index b60a8b0..23c8c77 100644 --- a/docs/api/GetPhoto.markdown +++ b/docs/api/GetPhoto.markdown @@ -62,6 +62,8 @@ _Authentication: optional_ photo.view(returnSizes="20x20") # Updates the photo object with the requested size print photo.path20x20 + http://current.openphoto.me/photo/c7/create/baad9/20x20.jpg + ---------------------------------------- From f470635b14ddb9187270defd9d369f9e8917de47 Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Sat, 4 May 2013 19:55:27 +0200 Subject: [PATCH 10/52] Add Python example to GetPhotos --- docs/api/GetPhotos.markdown | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/api/GetPhotos.markdown b/docs/api/GetPhotos.markdown index 43d1c14..c4defe1 100644 --- a/docs/api/GetPhotos.markdown +++ b/docs/api/GetPhotos.markdown @@ -10,6 +10,7 @@ Get Photos 1. [Examples][examples] * [Command line][example-cli] * [PHP][example-php] + * [Python][example-python] 1. [Response][response] * [Sample][sample] @@ -56,6 +57,13 @@ _Authentication: optional_ $client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret); $response = $client->get("/photos/list.json", array('tags' => 'sunnyvale')); + +#### Python (using [openphoto-python][openphoto-python]) + + client = openphoto.OpenPhoto() + print client.photos.list(tags="sunnyvale") + + [, ] ---------------------------------------- @@ -142,8 +150,10 @@ The response is in a standard [response envelope](http://theopenphotoproject.org [examples]: #examples [example-cli]: #example-cli [example-php]: #example-php +[example-python]: #example-python [response]: #response [sample]: #sample [photogeneration]: http://theopenphotoproject.org/documentation/faq/PhotoGeneration [ReturnSizes]: http://theopenphotoproject.org/documentation/faq/ReturnSizes [openphoto-php]: https://github.com/photo/openphoto-php +[openphoto-python]: https://github.com/photo/openphoto-python From eeba72854a8dd5d28f2c32f7f55cf42df11d8675 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Mon, 6 May 2013 14:59:13 -0300 Subject: [PATCH 11/52] added faqs on syncing to storage accounts --- docs/faq/Storage.markdown | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/faq/Storage.markdown b/docs/faq/Storage.markdown index 67547f1..058f161 100644 --- a/docs/faq/Storage.markdown +++ b/docs/faq/Storage.markdown @@ -13,6 +13,15 @@ Visit the storage migration page while ## How can I import my photos? You can import your photos through the Upload photos page when you're logged into Trovebox. 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 link my account to an existing S3 bucket? +Not yet. This is a known bug. + +## Does Trovebox sync photos already stored in my storage account? +Not yet, but this is a common request. + +## Can I upload my photos to Trovebox through Dropbox? +Not directly. This has been an experimental feature for awhile, and we hope to make it available to everyone in the future. + ## Can I keep uploading to another photo site and have that photo automatically show up in Trovebox? What about uploading to Trovebox and having a photo show up elsewhere? Not directly through Trovebox, but you can use sites like ifttt or Pixelpipe that will automatically upload a picture to Trovebox when you upload a picture somewhere else (or vice versa). From 9b9a86b47fdfc29eaf39c4fb23854cf54abe6fc0 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Mon, 6 May 2013 15:37:00 -0300 Subject: [PATCH 12/52] added album cover faq --- docs/faq/PhotoManagement.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/faq/PhotoManagement.markdown b/docs/faq/PhotoManagement.markdown index ff2eeaf..51bb6b8 100644 --- a/docs/faq/PhotoManagement.markdown +++ b/docs/faq/PhotoManagement.markdown @@ -2,7 +2,7 @@ Photo Management ======================= ## How do I upload a photo? -Go to your Trovebox site (it'll look like yourusername.trovebox.com) 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. +Go to your Trovebox site (it'll look like yourusername.trovebox.com) 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. You can also upload a photo through our mobile apps for iPhone and Android. ## How large can my photo be? We support photo files of up to 30MB. @@ -42,5 +42,8 @@ While you're logged into your Trovebox site, visit Albums. Select Create Album, ## How do I add a photo to an album? You can add a photo to an album by hovering over the photo in your gallery and pinning it. Then select Batch Edit and Add to Album. Select the album you want to add the photo to and save. +## How do I set a cover photo for an album? +Visit an album from your album page and hover over the photo you want as your album cover. Click the album button to set that photo as the album cover. + ## How do I delete an album? Hover over the album you want to delete in the albums page and click the trash can. Confirm that you want to delete the album. The photos in that album are still safe. From 96b7bbf98c25407f6682606c8b942aa37269a8b7 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Mon, 6 May 2013 16:10:33 -0300 Subject: [PATCH 13/52] rearranged and added some questions on pro account faq --- docs/faq/ProAccounts.markdown | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/faq/ProAccounts.markdown b/docs/faq/ProAccounts.markdown index bcb1145..699a44b 100644 --- a/docs/faq/ProAccounts.markdown +++ b/docs/faq/ProAccounts.markdown @@ -6,8 +6,8 @@ With a pro account, you get: * Unlimited photo uploads (Free users get 100 photo uploads/month) * Import from Flickr as well as Facebook and Instagram (Picasa and Smugmug coming soon) -* Switch storage options as many times as you wish -* Collaborators on your account +* Switch where you store your photos as many times as you wish +* Give multiple users access on your account * Top level domain support at yourdomain.com Check out our plans chart for the full breakdown. @@ -18,12 +18,12 @@ A Pro account costs $29.99 a year. ## How do I upgrade from a free account to a Pro account? Visit our upgrade page, enter your credit card info, and enjoy your Pro account! -## Do you store users' credit card info? -No. Your credit card info doesn't go through our servers at all, instead traveling securely from your server to our payment processor's. - -## How does unlimited space work with my storage service? +## Is unlimited really unlimited? What's the catch? 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 you store users' credit card info? +No, we don't. Your credit card info doesn't go through our servers at all, instead traveling securely from your server to our payment processor's. + ## Do I have to renew manually every year? Nope. We'll alert you when your Pro account is going to renew. @@ -46,7 +46,12 @@ After we've replied and confirmed that we've set up your domain, you'll need to It'll take up to 24 hours for your changes to take effect. ## How do I add Twitter cards for my domain? -Twitter cards are added per domain, so you have to apply for them separately for your own domain. +Twitter cards are added per domain. You can apply for them separately for your own domain. + +## Can I use a custom domain for my Trovebox thumbnails? +Yes. If you're already using a subdomain on your Trovebox site, you should use a different one for your images so one subdomain doesn't map to two places. + +The easiest way to use a domain for your thumbnails is to store your photos in an Amazon S3 bucket named after your subdomain--that is, your.subdomain.com. Then add a CNAME record pointing your.subdomain.com to something.theirdomain.com.s3.amazonaws.com. Once you've done this email us at [mailto:support@trovebox.com](support@trovebox.com) and we can update the record on our side. ## My needs go far beyond what a Pro account provides. Can I get even more? We're working on a [https://trovebox.com/organizations](plan for organizations). Email us at [mailto:support@trovebox.com](support@trovebox.com) if you're interested. From d5bce2cb4e9f59414366ab36559e0995aa7f9b2b Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Fri, 10 May 2013 16:07:25 -0300 Subject: [PATCH 14/52] updated to include getting oauth and consumer keys --- docs/api/Authentication.markdown | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/api/Authentication.markdown b/docs/api/Authentication.markdown index fe8648b..95bd802 100644 --- a/docs/api/Authentication.markdown +++ b/docs/api/Authentication.markdown @@ -6,11 +6,13 @@ Authentication using OAuth 1.0a A full introduction to OAuth is beyond the scope of the OpenPhoto documentation. 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. -* openphoto/openphoto-php - Our PHP language binding. -* openphoto/openphoto-ruby - Our Ruby language binding. -* openphoto/openphoto-python - Our Python language binding. -* openphoto/openphoto-java - Our Java language binding. -* More coming soon, contact us if you'd like to write bindings in an unlisted language. +* Our PHP language binding +* Our Ruby language binding +* Our Python language binding +* Our Java language binding +* Our Javascript language binding +* Our Objective-C language binding +* More coming soon, contact us if you'd like to write bindings in an unlisted language. ### Obtaining a consumer key and secret @@ -18,10 +20,17 @@ Since OpenPhoto is distributed the flow to obtain a consumer key and secret diff Typically you would sign up for an application ID and be given a key and secret to be used with your app. OpenPhoto differs because the host you'll be sending requests to is arbitrary and there's no central application repository. +The easiest way to create a consumer key and secret is to browse to browse to your OpenPhoto site and go to `/v1/oauth/flow`. Follow the prompts until you get a success message. Then go to `/manage/apps` and you should see the following parameters: + +* Consumer Key +* Consumer Secret +* OAuth Token +* OAuth Secret + ### Resources on the web If you're interested in learning more about OAuth then the following links are a great place to start. -* http://oauth.net/documentation/getting-started/ -* http://hueniverse.com/oauth/guide/intro/ -* http://www.slideshare.net/eran/introduction-to-oauth-presentation +* http://oauth.net/documentation/getting-started/ +* http://hueniverse.com/oauth/guide/intro/ +* http://www.slideshare.net/eran/introduction-to-oauth-presentation From 43771afa83b58273db28a1ffc8de514e0fe7b39d Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Tue, 14 May 2013 19:13:43 +0200 Subject: [PATCH 15/52] Added Python example --- docs/api/GetTags.markdown | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/api/GetTags.markdown b/docs/api/GetTags.markdown index 0ee243e..e0950cd 100644 --- a/docs/api/GetTags.markdown +++ b/docs/api/GetTags.markdown @@ -10,6 +10,7 @@ Get Tags 1. [Examples][examples] * [Command line][example-cli] * [PHP][example-php] + * [Python][example-python] 1. [Response][response] * [Sample][sample] @@ -50,6 +51,14 @@ _None_ $client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret); $response = $client->get("/tags/list.json"); + +#### Python (using [openphoto-python][openphoto-python]) + + client = openphoto.OpenPhoto() + client.tags.list() + + [, , ...] + ---------------------------------------- @@ -102,6 +111,8 @@ The response is in a standard [response envelope](http://theopenphotoproject.org [examples]: #examples [example-cli]: #example-cli [example-php]: #example-php +[example-python]: #example-python [response]: #response [sample]: #sample [openphoto-php]: https://github.com/photo/openphoto-php +[openphoto-python]: https://github.com/photo/openphoto-python From 602e8c2698445ca2e3a2148de9e2cb0512d07f23 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Thu, 28 Mar 2013 21:30:11 -0300 Subject: [PATCH 16/52] created Extend page --- docs/faq/Extend.markdown | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/faq/Extend.markdown diff --git a/docs/faq/Extend.markdown b/docs/faq/Extend.markdown new file mode 100644 index 0000000..311e3ce --- /dev/null +++ b/docs/faq/Extend.markdown @@ -0,0 +1,25 @@ +## Extend Trovebox + +You can do more with your Trovebox photo than upload and organize photos. You may already be familiar with storing your photos in your own storage space, importing photos from other sites, and uploading photos with our mobile apps. Here are a few more tools to make your Trovebox site even more useful. + +### See How Many People Visit Your Site +If you’ve wondered how many people visit your Trovebox site, you can install Google Analytics and start gathering stats. Get started in a few short steps. + +* Log into [Google Analytics](https://google.com/analytics/) and create a new site to track. +* In the admin section, find your tracking ID under the tracking info section. Make a note of this. +* In your Trovebox site settings, click Configure next to Google Analytics and enter your tracking ID. +* You can view your site stats anytime at Google Analytics. + +Don’t like Google Analytics? No problem. We also support site stats through the self-hosted Piwik. + +### Import Photos From Other Sites +Trovebox currently supports imports from Facebook, Flickr, and Instagram, but what about those other photo sites out there? [Pi.pe](http://pi.pe), a media distribution gateway, has some of those covered. + +**If you have a free account, you may go over the 100 photos/month limit with this upload.** + +Pi.pe [has an excellent guide](http://blog.pixelpipe.com/2012/12/10/configuring-openphoto-as-a-pi-pe-service/) on getting started that goes into more detail. We’ll let them take it from here. + +### Use Your Trovebox Photos on Your Blog +If you use WordPress, you can use your individual Trovebox images on your blog. [Download our plugin](https://wordpress.org/extend/plugins/openphoto/) to your WordPress site and go to OpenPhoto in settings to configure it. Enter your site URL and which photo size you’d like to use when inserting an image in your post, and enjoy inserting your Trovebox images into posts. + +The Trovebox source and API are open source, so if you want to build something, [get started](https://trovebox.com/documentation). Email us at support@trovebox.com if you’d like to see your creation here. From 125d7c523c50a4fb2ee1e61707ef4f2490badb02 Mon Sep 17 00:00:00 2001 From: sushimustwrite Date: Fri, 19 Apr 2013 17:53:22 -0400 Subject: [PATCH 17/52] faq changes --- docs/faq/AccountManagement.markdown | 2 +- docs/faq/MobileApps.markdown | 10 ++++++++-- docs/faq/PhotoManagement.markdown | 28 ++++++++++++++++++---------- docs/faq/PhotoSharing.markdown | 13 ++++++++++--- docs/faq/ProAccounts.markdown | 15 +++++++++++---- docs/faq/Storage.markdown | 21 +++++++++++++++++---- 6 files changed, 65 insertions(+), 24 deletions(-) diff --git a/docs/faq/AccountManagement.markdown b/docs/faq/AccountManagement.markdown index 740d050..e03c9b8 100644 --- a/docs/faq/AccountManagement.markdown +++ b/docs/faq/AccountManagement.markdown @@ -1,7 +1,7 @@ Account Management ======================= -## How do I create an account? +## How do I create a Trovebox account? Visit trovebox.com and click the Sign Up button. Select a username for your Trovebox site along with a password. ## How do I log in? diff --git a/docs/faq/MobileApps.markdown b/docs/faq/MobileApps.markdown index 13a8266..fabded5 100644 --- a/docs/faq/MobileApps.markdown +++ b/docs/faq/MobileApps.markdown @@ -2,20 +2,26 @@ The Trovebox Mobile Apps ======================= ## What phones are supported? -Trovebox has mobile apps for iPhone and Android. You can download them in the App Store (iOS) or Play Store (Android). +Trovebox's mobile apps are available for iPhone and Android. You can download them in the App Store (iOS) or Play Store (Android). ## What can I do with the Trovebox mobile apps? +Lots of things. To name a few: + * Create an Trovebox account * Upload photos to your Trovebox site +* View photos in your gallery, by album, or by tag * Add titles, descriptions, privacy settings, and tags * Share photos via email, Twitter, and Facebook * Add filters to your photos +* Purchase a monthly Pro account plan (iPhone only, Android coming soon) ## I have a limited data plan. Can I limit uploads to wifi only? Sure. ## What is Sync? -Sync lets you view the photos on your phone and select which ones to upload. +Sync lets you view the photos on your phone and select which ones to upload. Think of it as batch upload for your phone. ## Can I automatically upload taken photos to Trovebox? Yes. This is an experimental feature for Android. + diff --git a/docs/faq/PhotoManagement.markdown b/docs/faq/PhotoManagement.markdown index 4705e9c..ff2eeaf 100644 --- a/docs/faq/PhotoManagement.markdown +++ b/docs/faq/PhotoManagement.markdown @@ -4,8 +4,22 @@ Photo Management ## How do I upload a photo? Go to your Trovebox site (it'll look like yourusername.trovebox.com) 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 large can my photo be? +We support photo files of up to 30MB. + +## What file types are supported? +Currently we support .jpg, .gif, and .png files. We want to support more file types in the future, so let us know what you'd like to see. + +## How do I edit multiple photos at once? +Visit your Gallery at your Trovebox site. From there, hover over the photo(s) you want to edit and click the pin that appears. Click Batch Edit and select the detail you want to edit, change the detail, and click Submit. + +## Wait, Batch Edit? How does that work? +Batch Edit lets you edit multiple photos at once. Currently you can add or remove tags or albums. You can also edit privacy settings or delete a set of photos. + +To use Batch Edit, visit your gallery and hover over the photos you want to edit. Click the pushpins of each photo. You can also select all, which will select all the visible photos. Then select Batch Edit and edit away. + ## How do I delete a photo? -Visit your gallery or an album. Hover over the photo you want to delete. You'll see the title of the photo along with a few icons. Click the trash can to delete the photo. +Visit your gallery or an album. Hover over the photo you want to delete. You'll see the title of the photo along with a few icons. Click the trash can to delete the photo, then confirm you want to delete the photo. ## How do I change the privacy setting of a photo? You can do this by visiting the individual photo or by finding that photo in a gallery or album. In gallery or album view, hover over the photo you want to change to private (or public). You'll see the title of the photo along with a few icons, including a lock. In full detail view, you'll see the photo's privacy on the right side with the rest of the photo info. An unlocked lock indicates a public photo, while a locked one means the photo is private. Click the lock to toggle the privacy setting. @@ -13,14 +27,11 @@ You can do this by visiting the individual photo or by finding that photo in a g ## How do I edit the title or description of a photo? Visit the photo whose info you want to edit, then click the title or description. Enter your new title or description in the box that appears and save. You can also edit the title directly from the gallery or album view. -## How do I share a photo? -While viewing your photo gallery or an individual photo, click Share (or the curved right-pointing arrow). Select whether you want to share via email, Twitter, or Facebook, and share away. - ## How do I download an individual photo? You can download a photo directly if you or the user has enabled that option in the settings page. To do so, view the full details of the photo you want to download and click the Download link on the right hand side. -## Where does the image for my user photo come from? How can I change it? -We use Gravatar to set your original user photo, and you can change it across Gravatar by visiting their site and changing your photo there. If you'd like to set one of your uploaded photos as your user photo, visit your gallery, find a photo you'd like to use, and select the human silhouette. +## How can I change my user photo? +If you'd like to set one of your uploaded photos as your user photo, visit your gallery, find a photo you'd like to use, and select the person icon. ## 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. @@ -32,7 +43,4 @@ While you're logged into your Trovebox site, visit Albums. Select Create Album, You can add a photo to an album by hovering over the photo in your gallery and pinning it. Then select Batch Edit and Add to Album. Select the album you want to add the photo to and save. ## How do I delete an album? -Hover over the album you want to delete in the albums page and click the trash can. The photos in that album are still safe. - -## How do I edit multiple photos at once? -Visit your Gallery at your Trovebox site. From there, hover over the photo(s) you want to edit and click the pin that appears. Click Batch Edit and select the detail you want to edit, change the detail, and click Submit. +Hover over the album you want to delete in the albums page and click the trash can. Confirm that you want to delete the album. The photos in that album are still safe. diff --git a/docs/faq/PhotoSharing.markdown b/docs/faq/PhotoSharing.markdown index 40f56c8..5266ef8 100644 --- a/docs/faq/PhotoSharing.markdown +++ b/docs/faq/PhotoSharing.markdown @@ -5,13 +5,14 @@ Photo Sharing You can share a photo by clicking the arrow button at the photo's page or in the gallery. You'll then see the options to share the photo. ## Where can I share a photo to? -Right now we support sharing via email, Facebook, or Twitter. +Right now we support sharing via email, Facebook, or Twitter. We want to add more sites, so let us know where youyour photos to. ## Can I share an album instead of a photo? Yes. Click the Share button that appears when hovering over an album's summary, then share in the same way you'd share a photo. -## How do I share a private photo? -You can share a private photo in the same way that you'd share a public photo. When you share a private photo a sharing token gets added to the photo URL, which a recipient can use to view the photo without logging in. +## How do I share a private photo or album? +You can share a private photo in the same way that you'd share a public photo or album. When you share a private item, a sharing token gets added to the photo URL. The recipient can then use the full URL to view the photo without +logging in. ## Wait, sharing tokens? How do those work? When you share a photo, a sharing token in the photo's URL enables other users to view your photo. These sharing tokens expire after a time period that you'll soon be able to set yourself. @@ -21,3 +22,9 @@ The recipient will be able to see the album and the contents of the album, even ## Can I set a custom expiration date for a sharing token? Soon you'll be able to. + +## I changed my mind about sharing a photo. How can I revoke its sharing token? +Soon you'll be able to manage all your sharing tokens from a separate page, which will let you revoke individual tokens. + +## Can I share a photo's link via HTML? +Not yet. We're working on this. diff --git a/docs/faq/ProAccounts.markdown b/docs/faq/ProAccounts.markdown index a124141..bcb1145 100644 --- a/docs/faq/ProAccounts.markdown +++ b/docs/faq/ProAccounts.markdown @@ -3,14 +3,14 @@ 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 as well as Facebook and Instagram (Picasa and Smugmug coming soon) * Switch storage options as many times as you wish -* Enhanced security with SSL -* Ability to add multiple users to your account +* Collaborators on your account * Top level domain support at yourdomain.com -Check out our chart for the full breakdown. +Check out our plans chart for the full breakdown. ## How much does a Pro account cost? A Pro account costs $29.99 a year. @@ -30,6 +30,10 @@ 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. +## What can collaborators do with my account? +Collaborators can add photos, edit photos, delete photos--just about anything you can do except delete your account. When you add them as a collaborator they can log in with that email via Mozilla Persona. Soon they'll be able to +log in via the regular Trovebox login. + ## How do I add a top level domain? Adding a top level domain to your Trovebox site is currently all manual on our end, so there are two steps to take. First, email support@trovebox.com with the domain or subdomain you'd like to add to your Trovebox site. @@ -41,5 +45,8 @@ After we've replied and confirmed that we've set up your domain, you'll need to It'll take up to 24 hours for your changes to take effect. -## How do I add Twitter cards for my custom domain? +## How do I add Twitter cards for my domain? Twitter cards are added per domain, so you have to apply for them separately for your own domain. + +## My needs go far beyond what a Pro account provides. Can I get even more? +We're working on a [https://trovebox.com/organizations](plan for organizations). Email us at [mailto:support@trovebox.com](support@trovebox.com) if you're interested. diff --git a/docs/faq/Storage.markdown b/docs/faq/Storage.markdown index c643fc8..67547f1 100644 --- a/docs/faq/Storage.markdown +++ b/docs/faq/Storage.markdown @@ -2,7 +2,10 @@ Photo Storage ======================= ## Where can I store my photos? -Right now Trovebox supports Amazon S3, Box.com, Dropbox, CX.com, and DreamHost DreamObjects. +Right now Trovebox supports Amazon S3, Box.com, Dropbox, CX.com, DreamHost DreamObjects, and the Internet Archive. You can also use our storage if you don't want to use your own. + +## What if I don't choose my own storage provider upon signup. +Then your photos get stored in our own S3 bucket. You can change this anytime. ## How do I switch where my photos are stored? Visit the storage migration page while logged in, select where you'd like your photos to go, and follow the instructions. Note that this is a Pro account option. @@ -10,11 +13,21 @@ Visit the storage migration page while ## How can I import my photos? You can import your photos through the Upload photos page when you're logged into Trovebox. 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 Trovebox? +## Can I keep uploading to another photo site and have that photo automatically show up in Trovebox? What about uploading to Trovebox and having a photo show up elsewhere? Not directly through Trovebox, but you can use sites like ifttt or Pixelpipe that will automatically upload a picture to Trovebox when you upload a picture somewhere else (or vice versa). ## Is there a limit to how many photos I can upload? -If you're a free user you can upload up to 100 photos per month. Pro account holders get unlimited uploads. +If you're a free user you can upload up to 100 photos per month. Pro account holders get unlimited uploads, though your storage provider may impose space limits. If you're using our storage then everything is unlimited. -## If I'm a free user, do I lose access to my photos after using a certain amount of space or hitting my montly upload limit? +## Can I sync photos to Trovebox from an existing storage account? +Not yet. It's on our feature wishlist, though. + +## If I'm using the Internet Archive as my storage, does that mean all my photos have to be public? +Not on your Trovebox site! However, the Internet Archive offers free storage for the sake of the public. Right now you can mark a photo as private on your site and it'll show up as public in the archive for archiving purposes. +We're working on this. + +## If I'm a free user, do I lose access to my photos after using a certain amount of space or hitting my monthly upload limit? Nope. Your photos are yours, and you still have access to everything you've previously uploaded. + +## Do I get to access my original photos? +Yes. Free or pro, you'll always have access to the original photos uploaded. From fd5301c9a048a17c9ee32d1b6ed853ccf3eb0c60 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sun, 21 Apr 2013 19:55:41 -0300 Subject: [PATCH 18/52] Updated docs contrib guide, corrected formatting --- docs/contribute/documentation.markdown | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/contribute/documentation.markdown b/docs/contribute/documentation.markdown index ea43a9f..a2f0eaa 100644 --- a/docs/contribute/documentation.markdown +++ b/docs/contribute/documentation.markdown @@ -7,21 +7,22 @@ We're always looking for writers to contribute to our documentation. If you can ## 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 documentation repository under the docs folder. We have issues tagged documentation on Github, but every area of the project can benefit from better documentation. Choose something you know about and start writing. +All of this documentation is in the documentation repository under the docs folder. We have issues tagged documentation on the frontend repository as well, but every area of the project can benefit from better documentation. Choose something you know about that isn't well-documented here and start writing. -## Forking the OpenPhoto repository -Before you start writing, you need to fork the documentation repository. 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, Github explains how to clone a repository to your own machine. +## Forking the Documentation repository +Before you start writing, you need to fork the documentation repository. 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 a copy of the repository on your computer, Github explains how to clone a repository to your own machine. ## 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 Github's explanation of Markdown as well as the source of OpenPhoto's documentation pages on Github. +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 [our documentation repository](https://github.com/photo/documentation), then write your contribution in a text editor of your choice. If you're not, you may want to take a look at Github's explanation of Markdown as well as the source of OpenPhoto's documentation pages on Github. Or if you're working from the Github site, press **m** on your keyboard when editing a page to see a cheatsheet. 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. + +* 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 friendly to users of all levels, remaining gender-neutral, and being friendly and informative. * Use correct grammar and spelling. Here's a grammar guide 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. +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. If you're editing a copy on your own machine, you can commit like this: # To simply reference an issue with a commit do this git commit -m 'Addressing the foobar component but not yet finished. #123' @@ -29,11 +30,15 @@ When committing your documentation it's important to reference the GitHub issue # 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. +If you didn't fix a specific documentation issue, it's okay if you don't reference an issue number. + +Whether you reference an issue number or not, 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. If you're working from Github, comitting the code automatically pushes it to your repository. If you're working from your local copy, you can do this with: git push origin master -## Getting your change into the main OpenPhoto branch +## Getting your change into the main Documentation 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, Github explains how to send a pull request with git. 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 From c728863e7693ecfc3adac3d1f6f6bcca4557a2f5 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sun, 21 Apr 2013 20:08:11 -0300 Subject: [PATCH 19/52] added a short version at top realized docs guide is really long. added tl;dr at top --- docs/contribute/documentation.markdown | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/contribute/documentation.markdown b/docs/contribute/documentation.markdown index a2f0eaa..fcc619f 100644 --- a/docs/contribute/documentation.markdown +++ b/docs/contribute/documentation.markdown @@ -4,13 +4,23 @@ We're working hard to make OpenPhoto the best photo software possible, and part We're always looking for writers to contribute to our documentation. If you can explain technical ideas clearly, we need you. +## The short version +Here's the short version of adding to our documentation. + +* Choose something to document. +* Fork our Documentation repository. +* Write. +* Send a pull request. + +The rest of this guide covers each step in detail. + ## 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 documentation repository under the docs folder. We have issues tagged documentation on the frontend repository as well, but every area of the project can benefit from better documentation. Choose something you know about that isn't well-documented here and start writing. ## Forking the Documentation repository -Before you start writing, you need to fork the documentation repository. 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 a copy of the repository on your computer, Github explains how to clone a repository to your own machine. +Before you start writing, you need to fork the documentation repository. 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, you can go ahead and start writing. If you want to work from a copy of the repository on your computer, Github explains how to clone a repository to your own machine. ## 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 [our documentation repository](https://github.com/photo/documentation), then write your contribution in a text editor of your choice. If you're not, you may want to take a look at Github's explanation of Markdown as well as the source of OpenPhoto's documentation pages on Github. Or if you're working from the Github site, press **m** on your keyboard when editing a page to see a cheatsheet. From db34d27814994c1a89daa84326f3a364310bef1c Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sun, 21 Apr 2013 20:28:06 -0300 Subject: [PATCH 20/52] finally fixed that markdown formatting issue --- docs/contribute/frontend.markdown | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/contribute/frontend.markdown b/docs/contribute/frontend.markdown index df04d8b..2799450 100644 --- a/docs/contribute/frontend.markdown +++ b/docs/contribute/frontend.markdown @@ -35,24 +35,26 @@ We've added a _Beginner_ label to issues that don't touch some of the more sensi * Beginner + PHP issues ## Things to keep in mind while you code -Here's what your code should adhere to: +Here are some guidelines for your code: * 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; -```` + + 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 From 6883bd0ba26ff5ba11eeae236b674fc1cb8c79de Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Sat, 4 May 2013 12:32:41 +0200 Subject: [PATCH 21/52] Corrected photo/delete API documentation - was incorrectly using action/delete --- docs/api/PostPhotoDelete.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/PostPhotoDelete.markdown b/docs/api/PostPhotoDelete.markdown index a4d3dfa..7a839c3 100644 --- a/docs/api/PostPhotoDelete.markdown +++ b/docs/api/PostPhotoDelete.markdown @@ -27,7 +27,7 @@ Use this API to delete an action. _Authentication: required_ - POST /action/:id/delete.json + POST /photo/:id/delete.json ### Parameters @@ -42,13 +42,13 @@ _None_ #### Command Line (using [openphoto-php][openphoto-php]) - ./openphoto -p -X POST -h current.openphoto.me -e /action/a/delete.json + ./openphoto -p -X POST -h current.openphoto.me -e /photo/a/delete.json #### PHP (using [openphoto-php][openphoto-php]) $client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret); - $response = $client->post("/action/a/delete.json"); + $response = $client->post("/photo/a/delete.json"); ---------------------------------------- From f85c035f10c6ec0f9ccef6fdff8b02a6b5940b6e Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Mon, 6 May 2013 14:59:13 -0300 Subject: [PATCH 22/52] added faqs on syncing to storage accounts --- docs/faq/Storage.markdown | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/faq/Storage.markdown b/docs/faq/Storage.markdown index 67547f1..058f161 100644 --- a/docs/faq/Storage.markdown +++ b/docs/faq/Storage.markdown @@ -13,6 +13,15 @@ Visit the storage migration page while ## How can I import my photos? You can import your photos through the Upload photos page when you're logged into Trovebox. 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 link my account to an existing S3 bucket? +Not yet. This is a known bug. + +## Does Trovebox sync photos already stored in my storage account? +Not yet, but this is a common request. + +## Can I upload my photos to Trovebox through Dropbox? +Not directly. This has been an experimental feature for awhile, and we hope to make it available to everyone in the future. + ## Can I keep uploading to another photo site and have that photo automatically show up in Trovebox? What about uploading to Trovebox and having a photo show up elsewhere? Not directly through Trovebox, but you can use sites like ifttt or Pixelpipe that will automatically upload a picture to Trovebox when you upload a picture somewhere else (or vice versa). From f40dabe0dcb87a8c6b55713a0dc552150baea375 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Mon, 6 May 2013 15:37:00 -0300 Subject: [PATCH 23/52] added album cover faq --- docs/faq/PhotoManagement.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/faq/PhotoManagement.markdown b/docs/faq/PhotoManagement.markdown index ff2eeaf..51bb6b8 100644 --- a/docs/faq/PhotoManagement.markdown +++ b/docs/faq/PhotoManagement.markdown @@ -2,7 +2,7 @@ Photo Management ======================= ## How do I upload a photo? -Go to your Trovebox site (it'll look like yourusername.trovebox.com) 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. +Go to your Trovebox site (it'll look like yourusername.trovebox.com) 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. You can also upload a photo through our mobile apps for iPhone and Android. ## How large can my photo be? We support photo files of up to 30MB. @@ -42,5 +42,8 @@ While you're logged into your Trovebox site, visit Albums. Select Create Album, ## How do I add a photo to an album? You can add a photo to an album by hovering over the photo in your gallery and pinning it. Then select Batch Edit and Add to Album. Select the album you want to add the photo to and save. +## How do I set a cover photo for an album? +Visit an album from your album page and hover over the photo you want as your album cover. Click the album button to set that photo as the album cover. + ## How do I delete an album? Hover over the album you want to delete in the albums page and click the trash can. Confirm that you want to delete the album. The photos in that album are still safe. From faa69536f6d730cb0cde88629815a73656ba8771 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Mon, 6 May 2013 16:10:33 -0300 Subject: [PATCH 24/52] rearranged and added some questions on pro account faq --- docs/faq/ProAccounts.markdown | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/faq/ProAccounts.markdown b/docs/faq/ProAccounts.markdown index bcb1145..699a44b 100644 --- a/docs/faq/ProAccounts.markdown +++ b/docs/faq/ProAccounts.markdown @@ -6,8 +6,8 @@ With a pro account, you get: * Unlimited photo uploads (Free users get 100 photo uploads/month) * Import from Flickr as well as Facebook and Instagram (Picasa and Smugmug coming soon) -* Switch storage options as many times as you wish -* Collaborators on your account +* Switch where you store your photos as many times as you wish +* Give multiple users access on your account * Top level domain support at yourdomain.com Check out our plans chart for the full breakdown. @@ -18,12 +18,12 @@ A Pro account costs $29.99 a year. ## How do I upgrade from a free account to a Pro account? Visit our upgrade page, enter your credit card info, and enjoy your Pro account! -## Do you store users' credit card info? -No. Your credit card info doesn't go through our servers at all, instead traveling securely from your server to our payment processor's. - -## How does unlimited space work with my storage service? +## Is unlimited really unlimited? What's the catch? 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 you store users' credit card info? +No, we don't. Your credit card info doesn't go through our servers at all, instead traveling securely from your server to our payment processor's. + ## Do I have to renew manually every year? Nope. We'll alert you when your Pro account is going to renew. @@ -46,7 +46,12 @@ After we've replied and confirmed that we've set up your domain, you'll need to It'll take up to 24 hours for your changes to take effect. ## How do I add Twitter cards for my domain? -Twitter cards are added per domain, so you have to apply for them separately for your own domain. +Twitter cards are added per domain. You can apply for them separately for your own domain. + +## Can I use a custom domain for my Trovebox thumbnails? +Yes. If you're already using a subdomain on your Trovebox site, you should use a different one for your images so one subdomain doesn't map to two places. + +The easiest way to use a domain for your thumbnails is to store your photos in an Amazon S3 bucket named after your subdomain--that is, your.subdomain.com. Then add a CNAME record pointing your.subdomain.com to something.theirdomain.com.s3.amazonaws.com. Once you've done this email us at [mailto:support@trovebox.com](support@trovebox.com) and we can update the record on our side. ## My needs go far beyond what a Pro account provides. Can I get even more? We're working on a [https://trovebox.com/organizations](plan for organizations). Email us at [mailto:support@trovebox.com](support@trovebox.com) if you're interested. From 8a43267f456265628caf752847c3b8fa89804606 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Fri, 10 May 2013 16:07:25 -0300 Subject: [PATCH 25/52] updated to include getting oauth and consumer keys --- docs/api/Authentication.markdown | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/api/Authentication.markdown b/docs/api/Authentication.markdown index fe8648b..95bd802 100644 --- a/docs/api/Authentication.markdown +++ b/docs/api/Authentication.markdown @@ -6,11 +6,13 @@ Authentication using OAuth 1.0a A full introduction to OAuth is beyond the scope of the OpenPhoto documentation. 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. -* openphoto/openphoto-php - Our PHP language binding. -* openphoto/openphoto-ruby - Our Ruby language binding. -* openphoto/openphoto-python - Our Python language binding. -* openphoto/openphoto-java - Our Java language binding. -* More coming soon, contact us if you'd like to write bindings in an unlisted language. +* Our PHP language binding +* Our Ruby language binding +* Our Python language binding +* Our Java language binding +* Our Javascript language binding +* Our Objective-C language binding +* More coming soon, contact us if you'd like to write bindings in an unlisted language. ### Obtaining a consumer key and secret @@ -18,10 +20,17 @@ Since OpenPhoto is distributed the flow to obtain a consumer key and secret diff Typically you would sign up for an application ID and be given a key and secret to be used with your app. OpenPhoto differs because the host you'll be sending requests to is arbitrary and there's no central application repository. +The easiest way to create a consumer key and secret is to browse to browse to your OpenPhoto site and go to `/v1/oauth/flow`. Follow the prompts until you get a success message. Then go to `/manage/apps` and you should see the following parameters: + +* Consumer Key +* Consumer Secret +* OAuth Token +* OAuth Secret + ### Resources on the web If you're interested in learning more about OAuth then the following links are a great place to start. -* http://oauth.net/documentation/getting-started/ -* http://hueniverse.com/oauth/guide/intro/ -* http://www.slideshare.net/eran/introduction-to-oauth-presentation +* http://oauth.net/documentation/getting-started/ +* http://hueniverse.com/oauth/guide/intro/ +* http://www.slideshare.net/eran/introduction-to-oauth-presentation From 31335d9cb6d6e7d35fa095a2e532f25428b03934 Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Tue, 14 May 2013 19:22:24 +0200 Subject: [PATCH 26/52] Added Python example to PostPhotoDelete --- docs/api/PostPhotoDelete.markdown | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/api/PostPhotoDelete.markdown b/docs/api/PostPhotoDelete.markdown index 7a839c3..c928981 100644 --- a/docs/api/PostPhotoDelete.markdown +++ b/docs/api/PostPhotoDelete.markdown @@ -10,6 +10,7 @@ Delete Photo 1. [Examples][examples] * [Command line][example-cli] * [PHP][example-php] + * [Python][example-python] 1. [Response][response] * [Sample][sample] @@ -50,6 +51,13 @@ _None_ $client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret); $response = $client->post("/photo/a/delete.json"); + +#### Python (using [openphoto-python][openphoto-python]) + + client = openphoto.OpenPhoto() + photo = client.photos.list()[0] # Returns the first photo in the list + photo.delete() + ---------------------------------------- @@ -77,6 +85,8 @@ The response is in a standard [response envelope](http://theopenphotoproject.org [examples]: #examples [example-cli]: #example-cli [example-php]: #example-php +[example-python]: #example-python [response]: #response [sample]: #sample [openphoto-php]: https://github.com/photo/openphoto-php +[openphoto-python]: https://github.com/photo/openphoto-python From 957c053739bcbe43a3961425d51699b1f4f45be2 Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Tue, 14 May 2013 19:36:03 +0200 Subject: [PATCH 27/52] Add Python example to PostPhotoUpdate --- docs/api/PostPhotoUpdate.markdown | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/api/PostPhotoUpdate.markdown b/docs/api/PostPhotoUpdate.markdown index 66c9590..6c738bc 100644 --- a/docs/api/PostPhotoUpdate.markdown +++ b/docs/api/PostPhotoUpdate.markdown @@ -10,6 +10,7 @@ Update Photo 1. [Examples][examples] * [Command line][example-cli] * [PHP][example-php] + * [Python][example-python] 1. [Response][response] * [Sample][sample] @@ -61,6 +62,13 @@ _Authentication: required_ $client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret); $response = $client->post("/photo/a/update.json", array('title' => 'My Photo Title', 'tags' => 'sunnyvale,downtown')); + +#### Python (using [openphoto-python][openphoto-python]) + + client = openphoto.OpenPhoto() + photo = client.photos.list()[0] # Returns the first photo in the list + photo.update(title="My Photo Title", tags=["sunnyvale", "downtown"]) + ---------------------------------------- @@ -120,6 +128,8 @@ The response is in a standard [response envelope](http://theopenphotoproject.org [examples]: #examples [example-cli]: #example-cli [example-php]: #example-php +[example-python]: #example-python [response]: #response [sample]: #sample [openphoto-php]: https://github.com/photo/openphoto-php +[openphoto-python]: https://github.com/photo/openphoto-python From 18d93709b592ab73cbcd447ea02d34c58ea5edf9 Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Tue, 14 May 2013 19:40:47 +0200 Subject: [PATCH 28/52] Added Python example to PostPhotoUpload --- docs/api/PostPhotoUpload.markdown | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/api/PostPhotoUpload.markdown b/docs/api/PostPhotoUpload.markdown index ae00786..ebf6de0 100644 --- a/docs/api/PostPhotoUpload.markdown +++ b/docs/api/PostPhotoUpload.markdown @@ -10,6 +10,7 @@ Upload Photo 1. [Examples][examples] * [Command line][example-cli] * [PHP][example-php] + * [Python][example-python] 1. [Response][response] * [Sample][sample] @@ -75,6 +76,16 @@ _Authentication: required_ $photoBase64Encoded = base64_encode(file_get_contents('/path/to/photo.jpg')); $response = $client->post("/photo/upload.json", array('photo' => $photoBase64Encoded, 'tags' => 'sunnyvale,downtown')); + +#### Python (using [openphoto-python][openphoto-python]) + + # multipart + client = openphoto.OpenPhoto() + client.photo.upload("path/to/photo.jpg", tags=["sunnyvale", "downtown"]) + + # base64 encoded + client.photo.upload_encoded("path/to/photo.jpg", tags=["sunnyvale", "downtown"]) + ---------------------------------------- @@ -134,6 +145,8 @@ The response is in a standard [response envelope](http://theopenphotoproject.org [examples]: #examples [example-cli]: #example-cli [example-php]: #example-php +[example-python]: #example-python [response]: #response [sample]: #sample [openphoto-php]: https://github.com/photo/openphoto-php +[openphoto-python]: https://github.com/photo/openphoto-python From c9e2337fbdba51b38d8133a9abe05af57c5069a6 Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Tue, 14 May 2013 19:43:55 +0200 Subject: [PATCH 29/52] Use Python3 print syntax --- docs/api/GetPhoto.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/GetPhoto.markdown b/docs/api/GetPhoto.markdown index 23c8c77..6fa4d9e 100644 --- a/docs/api/GetPhoto.markdown +++ b/docs/api/GetPhoto.markdown @@ -59,8 +59,8 @@ _Authentication: optional_ client = openphoto.OpenPhoto() photo = client.photos.list()[0] # Returns the first photo from the list - photo.view(returnSizes="20x20") # Updates the photo object with the requested size - print photo.path20x20 + photo.view(returnSizes="20x20") + print(photo.path20x20) http://current.openphoto.me/photo/c7/create/baad9/20x20.jpg From 456f53cb6eca0755174e3cbce3304205cd66da20 Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Tue, 14 May 2013 19:45:12 +0200 Subject: [PATCH 30/52] Use Python3-compatible print syntax --- docs/api/GetPhotoNextPrevious.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/GetPhotoNextPrevious.markdown b/docs/api/GetPhotoNextPrevious.markdown index d8a0fad..14e1e6d 100644 --- a/docs/api/GetPhotoNextPrevious.markdown +++ b/docs/api/GetPhotoNextPrevious.markdown @@ -59,7 +59,7 @@ _Authentication: optional_ client = openphoto.OpenPhoto() photo = client.photos.list()[1] # Returns the second photo in the list - print photo.next_previous() + print(photo.next_previous()) {'previous': [], 'next': []} From 2abef8e65b1352c6f95f076720c17dfffbb3b407 Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Tue, 14 May 2013 19:46:28 +0200 Subject: [PATCH 31/52] Use Python3-compatible print syntax --- docs/api/GetTags.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/GetTags.markdown b/docs/api/GetTags.markdown index e0950cd..5ad48e7 100644 --- a/docs/api/GetTags.markdown +++ b/docs/api/GetTags.markdown @@ -55,7 +55,7 @@ _None_ #### Python (using [openphoto-python][openphoto-python]) client = openphoto.OpenPhoto() - client.tags.list() + print(client.tags.list()) [, , ...] From 8bb06e8d81e5905f04d87beebee735b405b2752b Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Thu, 23 May 2013 14:39:53 -0300 Subject: [PATCH 32/52] added change of username faq --- docs/faq/AccountManagement.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/faq/AccountManagement.markdown b/docs/faq/AccountManagement.markdown index e03c9b8..4ea72d2 100644 --- a/docs/faq/AccountManagement.markdown +++ b/docs/faq/AccountManagement.markdown @@ -13,6 +13,9 @@ Go to the Sign In page and click "Forgot Password" next to the password entry fi ## Can I change the email I signed up with? Not at this time. We're working on it. +## Can I change my username? +Not at this time. You can always create a new account with your desired username. If you want or need your current account to be deleted, you can request a deletion by emailing [support@trovebox.com](mailto:support@trovebox.com). + ## I previously signed in with BrowserID or Facebook Connect, so I don't have a password. How do I sign in now? You can use the same email associated with either of those accounts. When you sign in, enter that email and click "Forgot password?". You'll get a link to set a password. @@ -20,4 +23,4 @@ You can use the same email associated with either of those accounts. When you si 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@trovebox.com and we'll delete your account for you. +We're sad to see you go. Right now account deletion is manual, so email [support@trovebox.com](mailto:support@trovebox.com) and we'll delete your account for you. From 9657009c7c014daba8f389b784d17752fe79bc51 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Thu, 23 May 2013 15:26:33 -0300 Subject: [PATCH 33/52] added more pro account info --- docs/faq/ProAccounts.markdown | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/faq/ProAccounts.markdown b/docs/faq/ProAccounts.markdown index 699a44b..f3b20e0 100644 --- a/docs/faq/ProAccounts.markdown +++ b/docs/faq/ProAccounts.markdown @@ -4,10 +4,10 @@ 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 as well as Facebook and Instagram (Picasa and Smugmug coming soon) +* Unlimited photo uploads (Compare to 100 photos/month for free users) +* Import from Flickr as well as Facebook and Instagram. Picasa and Smugmug are coming soon. * Switch where you store your photos as many times as you wish -* Give multiple users access on your account +* Give multiple users access on your account without giving them your password * Top level domain support at yourdomain.com Check out our plans chart for the full breakdown. @@ -18,6 +18,15 @@ A Pro account costs $29.99 a year. ## How do I upgrade from a free account to a Pro account? Visit our upgrade page, enter your credit card info, and enjoy your Pro account! +## Can I select a Pro plan when I sign up for Trovebox? +Yes. When you sign up, select the Pro plan, and you'll be prompted for your credit card info. + +## Can I pay via PayPal? Google Wallet? Some other way? +Not yet. If you have any trouble getting your Pro account with a credit card contact us at [support@trovebox.com](mailto:support@trovebox.com) and we can figure out a way. + +## Is there a monthly Pro plan? +Not directly through the website, but you can purchase a monthly plan for $2.99/month straight through the iPhone app. Monthly plan support for the Android app is planned. + ## Is unlimited really unlimited? What's the catch? 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. @@ -51,7 +60,7 @@ Twitter cards are added per domain. You can ifttt or Pixelpipe that will automatically upload a picture to Trovebox when you upload a picture somewhere else (or vice versa). We've created two ifttt recipes for [Flickr to Trovebox](https://ifttt.com/recipes/16965) and [Instagram to Trovebox](https://ifttt.com/recipes/16959). + +## You don't have an importer for my site or photo manager. Can I request it? +Yes. The more requests we get for an importer the faster it'll get built. Email [support@trovebox.com](support@trovebox.com) to request an importer for your photo site. From b8058a226cab247c25a47eb281c144cf4fe0f988 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Fri, 24 May 2013 16:39:23 -0300 Subject: [PATCH 35/52] moved stuff to PhotoImports and rearranged --- docs/faq/Storage.markdown | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/docs/faq/Storage.markdown b/docs/faq/Storage.markdown index 058f161..ee2855e 100644 --- a/docs/faq/Storage.markdown +++ b/docs/faq/Storage.markdown @@ -4,29 +4,20 @@ Photo Storage ## Where can I store my photos? Right now Trovebox supports Amazon S3, Box.com, Dropbox, CX.com, DreamHost DreamObjects, and the Internet Archive. You can also use our storage if you don't want to use your own. -## What if I don't choose my own storage provider upon signup. +## What if I don't choose my own storage provider upon signup? Then your photos get stored in our own S3 bucket. You can change this anytime. ## How do I switch where my photos are stored? Visit the storage migration page while logged in, select where you'd like your photos to go, and follow the instructions. Note that this is a Pro account option. -## How can I import my photos? -You can import your photos through the Upload photos page when you're logged into Trovebox. 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 link my account to an existing S3 bucket? Not yet. This is a known bug. -## Does Trovebox sync photos already stored in my storage account? -Not yet, but this is a common request. - ## Can I upload my photos to Trovebox through Dropbox? -Not directly. This has been an experimental feature for awhile, and we hope to make it available to everyone in the future. - -## Can I keep uploading to another photo site and have that photo automatically show up in Trovebox? What about uploading to Trovebox and having a photo show up elsewhere? -Not directly through Trovebox, but you can use sites like ifttt or Pixelpipe that will automatically upload a picture to Trovebox when you upload a picture somewhere else (or vice versa). +Yes. This has been an experimental feature for awhile, and we hope to make it available to everyone in the future. Get started at [http://openphotoapps.com](http://openphotoapps.com). ## Is there a limit to how many photos I can upload? -If you're a free user you can upload up to 100 photos per month. Pro account holders get unlimited uploads, though your storage provider may impose space limits. If you're using our storage then everything is unlimited. +If you're a free user you can upload up to 100 photos per month. Pro account holders get unlimited uploads, though your storage provider may impose space limits. If you're using our storage then everything is unlimited for a Pro account. ## Can I sync photos to Trovebox from an existing storage account? Not yet. It's on our feature wishlist, though. @@ -38,5 +29,5 @@ We're working on this. ## If I'm a free user, do I lose access to my photos after using a certain amount of space or hitting my monthly upload limit? Nope. Your photos are yours, and you still have access to everything you've previously uploaded. -## Do I get to access my original photos? -Yes. Free or pro, you'll always have access to the original photos uploaded. +## Can I access my original photos? +Yes. Free or pro, you'll always have access to your original photos in the resolution you uploaded them in. From 13b77b32dc402de59fc1baa90b82fb6d99391435 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sat, 25 May 2013 14:48:20 -0300 Subject: [PATCH 36/52] updated with pro monthly and ipad question --- docs/faq/MobileApps.markdown | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/faq/MobileApps.markdown b/docs/faq/MobileApps.markdown index fabded5..ff27de7 100644 --- a/docs/faq/MobileApps.markdown +++ b/docs/faq/MobileApps.markdown @@ -14,7 +14,10 @@ Lots of things. To name a few: * Add titles, descriptions, privacy settings, and tags * Share photos via email, Twitter, and Facebook * Add filters to your photos -* Purchase a monthly Pro account plan (iPhone only, Android coming soon) +* Purchase a monthly Pro account plan + +## Does the iPhone app work on iPad too? +Yes. ## I have a limited data plan. Can I limit uploads to wifi only? Sure. @@ -25,3 +28,5 @@ Sync lets you view the photos on your phone and select which ones to upload. Thi ## Can I automatically upload taken photos to Trovebox? Yes. This is an experimental feature for Android. +## How do I purchase a monthly Pro account? +Visit the Account section of the navigation menu. Then select Upgrade to Pro account and approve the charge. You'll be charged monthly until you choose to unsubscribe. You can unsubscribe anytime. From adde4426753a9e01c3c023b51aeb2628f50385a3 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sat, 25 May 2013 14:59:59 -0300 Subject: [PATCH 37/52] updated sharing token info --- docs/faq/PhotoSharing.markdown | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/faq/PhotoSharing.markdown b/docs/faq/PhotoSharing.markdown index 5266ef8..f0b9170 100644 --- a/docs/faq/PhotoSharing.markdown +++ b/docs/faq/PhotoSharing.markdown @@ -5,7 +5,7 @@ Photo Sharing You can share a photo by clicking the arrow button at the photo's page or in the gallery. You'll then see the options to share the photo. ## Where can I share a photo to? -Right now we support sharing via email, Facebook, or Twitter. We want to add more sites, so let us know where youyour photos to. +Right now we support sharing via email, Facebook, or Twitter. We want to add more sites, so let us know where you want to share your photos. ## Can I share an album instead of a photo? Yes. Click the Share button that appears when hovering over an album's summary, then share in the same way you'd share a photo. @@ -24,7 +24,9 @@ The recipient will be able to see the album and the contents of the album, even Soon you'll be able to. ## I changed my mind about sharing a photo. How can I revoke its sharing token? -Soon you'll be able to manage all your sharing tokens from a separate page, which will let you revoke individual tokens. +In the Sharing Tokens section of your settings, find the photo ID of the photo whose token you want to revoke. Click Revoke, and your sharing token will no longer work. + +Don't know where the photo ID is? Look at the photo's URL. The URL looks like yourusername.trovebox.com/p/PhotoID, where PhotoID is the photo ID. The Photo ID does not include the sharing token in the URL. ## Can I share a photo's link via HTML? -Not yet. We're working on this. +Not yet, but this is a very popular request. We're working on this. From 9d2d01ccb0d0f1e418cbd471d8ea63f14a46effc Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sat, 25 May 2013 15:00:26 -0300 Subject: [PATCH 38/52] tyop --- docs/faq/PhotoImports.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq/PhotoImports.markdown b/docs/faq/PhotoImports.markdown index 12e0e38..2373c67 100644 --- a/docs/faq/PhotoImports.markdown +++ b/docs/faq/PhotoImports.markdown @@ -19,7 +19,7 @@ From Instagram we import: images, titles, hashtags (as tags), and location From S3 we import as much as we can based on what's already in your photo's metadata. ## How do your importers work? -Our importers fetch the information from the site requested and downloads it to our servers, then uploads the photos and metadata to your Trovebox site. Nothing gets downloaded to your computer. +Our importers fetch the information from the site requested and download it to our servers, then uploads the photos and metadata to your Trovebox site. Nothing gets downloaded to your computer. ## Can I import my photos from an existing S3 bucket? Yes. Visit [our S3 import page](https://trovebox.com/for/s3/import) to get started. This is a Pro account feature. From 587e060ce408c75f315cbec0f79a59c02c275b52 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sun, 26 May 2013 11:40:51 -0300 Subject: [PATCH 39/52] added question --- docs/faq/PhotoImports.markdown | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/faq/PhotoImports.markdown b/docs/faq/PhotoImports.markdown index 2373c67..da943b8 100644 --- a/docs/faq/PhotoImports.markdown +++ b/docs/faq/PhotoImports.markdown @@ -21,6 +21,9 @@ From S3 we import as much as we can based on what's already in your photo's meta ## How do your importers work? Our importers fetch the information from the site requested and download it to our servers, then uploads the photos and metadata to your Trovebox site. Nothing gets downloaded to your computer. +## What happens if I run the importer again after a successful importer? +The importer skips the previously imported photos and imports only the photos that aren't already in your Trovebox site. + ## Can I import my photos from an existing S3 bucket? Yes. Visit [our S3 import page](https://trovebox.com/for/s3/import) to get started. This is a Pro account feature. From 02bef45c49b02c23719a529c228830299339299f Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sun, 26 May 2013 11:41:14 -0300 Subject: [PATCH 40/52] tyop one day I'll learn --- docs/faq/PhotoImports.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq/PhotoImports.markdown b/docs/faq/PhotoImports.markdown index da943b8..7695f6d 100644 --- a/docs/faq/PhotoImports.markdown +++ b/docs/faq/PhotoImports.markdown @@ -21,7 +21,7 @@ From S3 we import as much as we can based on what's already in your photo's meta ## How do your importers work? Our importers fetch the information from the site requested and download it to our servers, then uploads the photos and metadata to your Trovebox site. Nothing gets downloaded to your computer. -## What happens if I run the importer again after a successful importer? +## What happens if I run the importer again after a successful import? The importer skips the previously imported photos and imports only the photos that aren't already in your Trovebox site. ## Can I import my photos from an existing S3 bucket? From 04b9ac9ecd862754ed9155236752f592673c8bec Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Sun, 26 May 2013 21:22:44 -0400 Subject: [PATCH 41/52] corrected album privacy --- docs/faq/PhotoManagement.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/faq/PhotoManagement.markdown b/docs/faq/PhotoManagement.markdown index 51bb6b8..5be3f29 100644 --- a/docs/faq/PhotoManagement.markdown +++ b/docs/faq/PhotoManagement.markdown @@ -34,7 +34,9 @@ You can download a photo directly if you or the user has enabled that option in If you'd like to set one of your uploaded photos as your user photo, visit your gallery, find a photo you'd like to use, and select the person icon. ## 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. +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. While albums are public on your albums page, the individual photos in the albums will retain the privacy setting you gave them. + +Since album photos retain their individual privacy settings, an album consisting entirely of private photos won't have a cover photo. ## How do I create an album? While you're logged into your Trovebox site, visit Albums. Select Create Album, enter the name of your album under the Create Album section, and click Create. From 6686bde0152b79fcb98dd1e1eb59ddc87565e02c Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Mon, 27 May 2013 12:48:48 -0300 Subject: [PATCH 42/52] correct info on album permissions --- docs/faq/PhotoSharing.markdown | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/faq/PhotoSharing.markdown b/docs/faq/PhotoSharing.markdown index f0b9170..1c6e26e 100644 --- a/docs/faq/PhotoSharing.markdown +++ b/docs/faq/PhotoSharing.markdown @@ -7,23 +7,23 @@ You can share a photo by clicking the arrow button at the photo's page or in the ## Where can I share a photo to? Right now we support sharing via email, Facebook, or Twitter. We want to add more sites, so let us know where you want to share your photos. -## Can I share an album instead of a photo? -Yes. Click the Share button that appears when hovering over an album's summary, then share in the same way you'd share a photo. - -## How do I share a private photo or album? -You can share a private photo in the same way that you'd share a public photo or album. When you share a private item, a sharing token gets added to the photo URL. The recipient can then use the full URL to view the photo without +## How do I share a private photo? +You can share a private photo in the same way that you'd share a public photo. When you share a private item, a sharing token gets added to the photo URL. The recipient can then use the full URL to view the photo without logging in. ## Wait, sharing tokens? How do those work? When you share a photo, a sharing token in the photo's URL enables other users to view your photo. These sharing tokens expire after a time period that you'll soon be able to set yourself. -## What happens when I share a private album? -The recipient will be able to see the album and the contents of the album, even if those photos are private. +## Can I share an album instead of a photo? +Yes. Click the Share button that appears when hovering over an album's summary, then share in the same way you'd share a photo. + +## What happens when I share an album? +The album gets shared with a sharing token. The recipient will be able to see the album and the full contents of the album, even if those photos are private. ## Can I set a custom expiration date for a sharing token? Soon you'll be able to. -## I changed my mind about sharing a photo. How can I revoke its sharing token? +## I changed my mind about sharing a photo or album. How can I revoke its sharing token? In the Sharing Tokens section of your settings, find the photo ID of the photo whose token you want to revoke. Click Revoke, and your sharing token will no longer work. Don't know where the photo ID is? Look at the photo's URL. The URL looks like yourusername.trovebox.com/p/PhotoID, where PhotoID is the photo ID. The Photo ID does not include the sharing token in the URL. From e1d4f462843d5462941ab8bf3870b2a418ac2d0b Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Thu, 30 May 2013 18:24:09 -0300 Subject: [PATCH 43/52] added readme to libraries folder --- docs/libraries/readme.markdown | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/libraries/readme.markdown diff --git a/docs/libraries/readme.markdown b/docs/libraries/readme.markdown new file mode 100644 index 0000000..2b7f4f8 --- /dev/null +++ b/docs/libraries/readme.markdown @@ -0,0 +1,12 @@ +If you're looking for our language libraries, you're in the right place. The documentation for our various language libraries lives here. + +Currently we have libraries for: + +* PHP +* Python +* Javascript +* Java +* Objective-C +* Ruby + +Is your favorite language not listed? Contact us or better yet, write your own. From 18f86d0cd463b57cc0f46f306dba40c48d40827d Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Thu, 30 May 2013 19:39:05 -0300 Subject: [PATCH 44/52] created readme for plugins --- docs/plugins/readme.markdown | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 docs/plugins/readme.markdown diff --git a/docs/plugins/readme.markdown b/docs/plugins/readme.markdown new file mode 100644 index 0000000..6e35e29 --- /dev/null +++ b/docs/plugins/readme.markdown @@ -0,0 +1,3 @@ +If you're looking for documentation on Trovebox's various plugins, you're in the right place. + +Questions? Want to write your own plugin? Email our mailing list at openphoto@googlegroups.com. From 587a01f819c94b68fad4df756e6de703fda56b13 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Mon, 3 Jun 2013 19:21:27 -0300 Subject: [PATCH 45/52] markdown errors --- docs/faq/ProAccounts.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/faq/ProAccounts.markdown b/docs/faq/ProAccounts.markdown index f3b20e0..8e1b271 100644 --- a/docs/faq/ProAccounts.markdown +++ b/docs/faq/ProAccounts.markdown @@ -60,7 +60,7 @@ Twitter cards are added per domain. You can +### How to use the library + +To use the library you need to first include `OpenPhotoOAuth.php`, then instantiate an instance of the class and start making calls. + + include 'OpenPhotoOAuth.php'; + $client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $token, $tokenSecret); + $resp = $client->get('/photos/list.json'); + $resp = $client->post('/photo/62/update.json', array('tags' => 'tag1,tag2')); + +---------------------------------------- + + +### Using from the command line + +Make sure that the `openphoto` file is executable. + + chown o+x openphoto + +You'll then want to export your secrets to the environment. +We suggest putting them in a file and sourcing it prior to running `openphoto` commands. +Click here for instructions on getting credentials. + + # env.sh + export consumerKey=your_consumer_key + export consumerSecret=your_consumer_secret + export token=your_access_token + export tokenSecret=your_access_token_secret + +You'll need to source that file once for each terminal session. + + source env.sh + +These are the options you can pass to the shell program. + + -h hostname # default=localhost + -e endpoint # default=/photos/list.json + -X method # default=GET + -F params # i.e. -F 'title=my title' -F 'tags=mytag1,mytag1' + -p # pretty print the json + -v # verbose output + --encode # base 64 encode the photo + +Now you can run commands to the OpenPhoto API from your shell! + + ./openphoto -h current.openphoto.me -p -e /photo/62/view.json -F 'returnSizes=20x20' + { + "message" : "Photo 62", + "code" : 200, + "result" : { + "tags" : [ + + ], + "id" : "62", + "appId" : "current.openphoto.me", + "pathBase" : "\/base\/201108\/1312956581-opmeqViHrD.jpg", + "dateUploadedMonth" : "08", + "dateTakenMonth" : "08", + "exifCameraMake" : "", + "dateTaken" : "1312956581", + "title" : "Tomorrowland Main Stage 2011", + "height" : "968", + "description" : "", + "creativeCommons" : "BY-NC", + "dateTakenYear" : "2011", + "dateUploadedDay" : "09", + "longitude" : "4", + "host" : "opmecurrent.s3.amazonaws.com", + "hash" : "0455675a8c42148238b81ed1d8db655c45ae055a", + "status" : "1", + "width" : "1296", + "dateTakenDay" : "09", + "permission" : "1", + "pathOriginal" : "\/original\/201108\/1312956581-opmeqViHrD.jpg", + "size" : "325", + "dateUploadedYear" : "2011", + "views" : "0", + "latitude" : "50.8333", + "dateUploaded" : "1312956583", + "exifCameraModel" : "", + "Name" : "62", + "path20x20" : "http:\/\/current.openphoto.me\/photo\/62\/create\/ceb90\/20x20.jpg" + } + } + + +#### Getting your credentials + +You can get your credentals by clicking on the arrow next to your email address once you're logged into your site and then clicking on settings. +If you don't have any credentials then you can create one for yourself by going to `/v1/oauth/flow`. +Once completed go back to the settings page and you should see the credential you just created From 860fa3ce64fe7f2d17610ae3af228790b91db75a Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Tue, 4 Jun 2013 12:39:38 -0300 Subject: [PATCH 49/52] created python library docs file --- docs/libraries/python.markdown | 131 +++++++++++++++++++++++++++++++++ 1 file changed, 131 insertions(+) create mode 100644 docs/libraries/python.markdown diff --git a/docs/libraries/python.markdown b/docs/libraries/python.markdown new file mode 100644 index 0000000..ad8c113 --- /dev/null +++ b/docs/libraries/python.markdown @@ -0,0 +1,131 @@ +Open Photo API / Python Library +======================= +#### OpenPhoto, a photo service for the masses +[![Build Status](https://api.travis-ci.org/photo/openphoto-python.png)](https://travis-ci.org/photo/openphoto-python) + +---------------------------------------- + +### Installation + python setup.py install + +---------------------------------------- + +### Credentials + +For full access to your photos, you need to create the following config file in ``~/.config/openphoto/default`` + + # ~/.config/openphoto/default + host = your.host.com + consumerKey = your_consumer_key + consumerSecret = your_consumer_secret + token = your_access_token + tokenSecret = your_access_token_secret + +The ``config_file`` switch lets you specify a different config file. + +To get your credentials: + * Log into your Trovebox site + * Click the arrow on the top-right and select 'Settings' + * Click the 'Create a new app' button + * Click the 'View' link beside the newly created app + +---------------------------------------- + +### How to use the library + +You can use the library in one of two ways: + + * Direct GET/POST calls to the server + * Access via Python classes/methods + + +#### Direct GET/POST: + + from openphoto import OpenPhoto + client = OpenPhoto() + resp = client.get("/photos/list.json") + resp = client.post("/photo/62/update.json", tags=["tag1", "tag2"]) + + +#### Python classes/methods + + from openphoto import OpenPhoto + client = OpenPhoto() + photos = client.photos.list() + photos[0].update(tags=["tag1", "tag2"]) + print photos[0].tags + +The OpenPhoto Python class hierarchy mirrors the [OpenPhoto API](http://theopenphotoproject.org/documentation) endpoint layout. For example, the calls in the example above use the following API endpoints: + +* ``client.photos.list() -> /photos/list.json`` +* ``photos[0].update() -> /photo//update.json`` + + +### API Versioning + +It may be useful to lock your application to a particular version of the OpenPhoto API. +This ensures that future API updates won't cause unexpected breakages. + +To do this, add the optional ```api_version``` parameter when creating the client object: + + from openphoto import OpenPhoto + client = OpenPhoto(api_version=2) + +---------------------------------------- + + +### Using from the command line + +You can run commands to the OpenPhoto API from your shell! + +These are the options you can pass to the shell program: + + --help # Display help text + -c config_file # Either the name of a config file in ~/.config/openphoto/ or a full path to a config file + -h hostname # Overrides config_file for unauthenticated API calls + -e endpoint # [default=/photos/list.json] + -X method # [default=GET] + -F params # e.g. -F 'title=my title' -F 'tags=mytag1,mytag2' + -p # Pretty print the json + -v # Verbose output + + +#### Command line examples + + # Upload a public photo to the host specified in ~/.config/openphoto/default + openphoto -p -X POST -e /photo/upload.json -F 'photo=@/path/to/photo/jpg' -F 'permission=1' + { + "code":201, + "message":"Photo 1eo uploaded successfully", + "result":{ + "actor":"user@example.com", + "albums":[], + ... + ... + } + } + + # Get a thumbnail URL from current.openphoto.me (unauthenticated access) + openphoto -h current.openphoto.me -p -e /photo/62/view.json -F 'returnSizes=20x20' + { + "code":200, + "message":"Photo 62", + "result":{ + "actor":"", + "albums":[ + "1" + ], + ... + ... + "path20x20":"http://current.openphoto.me/photo/62/create/36c0a/20x20.jpg", + "pathBase":"http://awesomeness.openphoto.me/base/201203/7ae997-Boracay-Philippines-007.jpg", + "permission":"1", + "photo20x20":[ + "http://current.openphoto.me/photo/62/create/36c0a/20x20.jpg", + 13, + 20 + ], + ... + ... + } + } From 86ab5cc0655a75fd1edc3c5f2f1668056f1cab06 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Tue, 4 Jun 2013 18:08:43 -0400 Subject: [PATCH 50/52] added contact info --- docs/configs/readme.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/configs/readme.markdown b/docs/configs/readme.markdown index 8b1b97b..b956dc2 100644 --- a/docs/configs/readme.markdown +++ b/docs/configs/readme.markdown @@ -1 +1,3 @@ Your Trovebox installation comes with a number of configuration files and settings. This section explains the settings and what you can set them to. + +Questions? We can help. Send us an email at openphoto@googlegroups.com or ask in #openphoto on Freenode. From d93f864e1cb1118f118be49c5fa5b7310e9a5c67 Mon Sep 17 00:00:00 2001 From: Sujin/Sushi Date: Fri, 14 Jun 2013 12:15:18 -0300 Subject: [PATCH 51/52] added introductory question on photo storage Hey, this is a new thing for lots of folks! --- docs/faq/Storage.markdown | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/faq/Storage.markdown b/docs/faq/Storage.markdown index ee2855e..100c90c 100644 --- a/docs/faq/Storage.markdown +++ b/docs/faq/Storage.markdown @@ -1,6 +1,9 @@ Photo Storage ======================= +## Wait, I can choose not to store my photos with you? +Absolutely. This is so important to us that it's the very first thing we built into the site. If you don't want to bring your own storage account, that's okay too. You can connect a storage account anytime if you change your mind. + ## Where can I store my photos? Right now Trovebox supports Amazon S3, Box.com, Dropbox, CX.com, DreamHost DreamObjects, and the Internet Archive. You can also use our storage if you don't want to use your own. From 4305d9c03177543c10a747a42ce93050e0280119 Mon Sep 17 00:00:00 2001 From: sneakypete81 Date: Sun, 7 Jul 2013 15:04:52 +0100 Subject: [PATCH 52/52] GET /photos.json should be GET /photos/list.json --- docs/api/GetPhotos.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/GetPhotos.markdown b/docs/api/GetPhotos.markdown index c4defe1..e0e4176 100644 --- a/docs/api/GetPhotos.markdown +++ b/docs/api/GetPhotos.markdown @@ -30,7 +30,7 @@ _NOTE:_ Always pass in the `returnSizes` parameter for sizes you plan on using. _Authentication: optional_ - GET /photos.json + GET /photos/list.json ### Parameters