https://github.com/gocom/rah_backup_dropbox
Dropbox module for rah_backup
https://github.com/gocom/rah_backup_dropbox
Last synced: 29 days ago
JSON representation
Dropbox module for rah_backup
- Host: GitHub
- URL: https://github.com/gocom/rah_backup_dropbox
- Owner: gocom
- License: gpl-2.0
- Created: 2013-05-12T11:09:05.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2013-05-13T14:30:20.000Z (about 13 years ago)
- Last Synced: 2025-10-12T19:51:48.141Z (8 months ago)
- Language: PHP
- Size: 167 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.textile
- License: LICENSE
Awesome Lists containing this project
README
h1. Dropbox module for rah_backup
p. "Packagist":https://packagist.org/packages/rah/rah_backup_dropbox | "Twitter":http://twitter.com/gocom | "Donate":http://rahforum.biz/donate/rah_backup_dropbox
p. Uploads backups to your "Dropbox":https://www.dropbox.com/ account.
h2. Installing
p. Using "Composer":http://getcomposer.org:
bc. $ composer.phar require rah/rah_backup_dropbox
p. Installing rah_backup_dropbox requires that your "minimum-stability":http://getcomposer.org/doc/04-schema.md#minimum-stability is set to dev. Some of the dependencies do not have stable releases.
h2. Getting started
h3. Creating Dropbox app keys
p. 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":https://www.dropbox.com/developers/apps.
p. 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.
p. 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.
p. 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:
bq. *App name:* rah_backup@yoursitedomain.tld
*App status:* Development
*App key:* 12345x789a
*App secret:* 12345x789a
*Name of app folder:* rah_backup@yoursitedomain.tld
h3. Setting up preferences
p. 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.
p. Fill in the three fields and *save*.
h3. Authorizing application
p. 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:
bq. Authenticated successfully. You can now go to your Textpattern control panel.
h2. Preferences
p. The module adds few options to "Advanced Preferences":http://textpattern.net/wiki/index.php?title=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.
h3. Dropbox app key
p. 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":https://www.dropbox.com/developers/apps.
p. 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.
h3. Dropbox app secret
p. Is your personal Dropbox app secret. See *Dropbox app key* above.
h3. Account actions
p. 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.
p. 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.
h2. Changelog
h3. Version 0.1.0 - upcoming
* Initial release.