README

Uploads backups to your Dropbox account.

Installing

$ composer.phar require rah/rah_backup_dropbox

Installing rah_backup_dropbox requires that your minimum-stability is set to dev. Some of the dependencies do not have stable releases.

Getting started

Creating Dropbox app keys

For the Dropbox application to be able to connect to your Dropbox application, it needs to be register to Dropbox’s application database. You can create your personal app key and secret by registering a new dummy application in Dropbox’s Developer Center.

This application is “dummy” and will be used just for your personal keys. Don’t try to publish the application or anything, just create a personal developer keys.

When you name the application give it an unique name that doesn’t interfere with other, real applications. I suggest giving it a name following a pattern as rah_backup@yoursitedomain.tld, where yoursitedomain.tld is your site’s domain. If you don’t own your own top-level domain name, you can use your real name or a random hash.

When you are asked about application’s Access type, set it as App folder. Applications description can be pretty much anything. I would use Rah_backup instance for yoursitedomain.tld. After you have done, your application details should look similar to this:

App name: rah_backup@yoursitedomain.tld
App status: Development
App key: 12345×789a
App secret: 12345×789a
Name of app folder: rah_backup@yoursitedomain.tld

Setting up preferences

After you have your application keys, it’s time to deploy them. You can find set them in use from Textpattern’s Advanced preferences. The modules settings are organized under Dropbox module for rah_backup section. For there you will find a field to set your app key, secret and Dropbox SDK’s installation directory. Please refer to Preferences section for detailed information about each available settings.

Fill in the three fields and save.

Authorizing application

After you have saved your app keys, scroll back to the module’s preferences section, Dropbox module for rah_backup. You will see that there is an Authorize link present. Press it to start your Authorization process. The process is pretty much automated and should only take couple of seconds. You will be asked to login with the account you want to link if you aren’t already logged in your browser, and to authorize the application by a press of a button. That’s it. If everything went well you should see a following message in the end:

Authenticated successfully. You can now go to your Textpattern control panel.

Preferences

The module adds few options to Advanced Preferences, neatly organized under Dropbox module for rah_backup section. All these options are mandatory and must be configured before the module can be used. Options are as follows.

Dropbox app key

Is your personal Dropbox App key. Due to rah_backup being open source project written in PHP, for security reasons every user of the module needs to sign their own app to Dropbox and use their own keys. You can create your personal app key and secret by creating a new application in Dropbox’s Developer Center.

When you name the application give it an unique name that doesn’t interfere with other uses. Good name could be rah_backup@yoursitedomain.tld. Don’t try to publish the application or anything, just create a personal developer keys.

Dropbox app secret

Is your personal Dropbox app secret. See Dropbox app key above.

Account actions

The last option you see isn’t actually a configurable field, but an row with links. This the row that gets populated by buttons used for linking and unlinking your application keys and rah_backup with Dropbox.

After you have set all the module’s preferences, this line gets a Authorize link, which you then would use to do linking of the application and Dropbox. After a successful authorization, this line would display Unlink account and app link.

Changelog

Version 0.1.0 – upcoming

Initial release.

rah / rah_backup_dropbox

Maintainers

Details