Skip to content

Commit

Permalink
Merge pull request #37 from froemken/updateDocumentation
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
froemken authored Nov 11, 2023
2 parents 91f81bb + 11f070f commit 4520299
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 22 deletions.
34 changes: 16 additions & 18 deletions Documentation/Configuration/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,34 @@ Create APP at dropbox.com

Simply visit: https://www.dropbox.com/developers

If this link is not valid anymore go to https://www.dropbox.com/, click the upper left menu icon with the 9 dots.
Choose the App Center. In the left menu of the `App Center` you will find a link to `Develop Apps`. Now
If this link is not valid anymore go to https://www.dropbox.com/, click the
upper left menu icon with the 9 dots. Choose the App Center. In the left
menu of the `App Center` you will find a link to `Develop Apps`. Now
you should be in the developer corner of Dropbox.

2. Create new Dropbox App

Click the `App Console` button in the upper right corner. Now you see all your apps (if you have created some).
Click the `Create app` button.
Click the `App Console` button in the upper right corner. Now you see all
your apps (if you have created some). Click the `Create app` button.

3. Choose API

With a free or simple Dropbox account you only have the possibility to choose the API with `Scoped access`.
The TYPO3 Dropbox extension can only work with this API. Do not choose any other API.
With a free or simple Dropbox account you only have the possibility to
choose the API with `Scoped access`. The TYPO3 Dropbox extension can only
work with this API. Do not choose any other API.

4. Choose App type

For security reasons I prefer to choose `App folder`. But if you`re sure, you also can give your app
full access to all of your Dropbox files.
For security reasons I prefer to choose `App folder`. But if you`re sure,
you also can give your app full access to all of your Dropbox files.

5. Give it a name

Assign a Dropbox global unique name to your new app. Please consider, that words like `dropbox` are not allowed
as part of the name.
Assign a Dropbox global unique name to your new app. Please consider, that
words like `dropbox` are not allowed as part of the name.

Confirm your settings with button `Create App`. You will be redirected to detail view of your app.
Confirm your settings with button `Create App`. You will be redirected to
detail view of your app.

6. Configure your new app

Expand All @@ -50,14 +53,9 @@ Create APP at dropbox.com
* `files.content.write`
* `files.content.read`

7. Locate `App key` and `App secret`
7. Locate `App key`

For next section you will need to copy `App key` and `App secret`. from tab `Settings`.

8. Optional: Generate Access Token

If you don`t want to use the Wizard, you can click the `Generate` button on tab `Settings`. This will generate
an access token which you can copy&paste directly into the FAL storage record.
For next section you will need to copy `App key` from tab `Settings`.


Create File Storage
Expand Down
10 changes: 10 additions & 0 deletions Documentation/FAQ/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@
FAQ
===

Bad Request
===========

In most cases you get that error, if your Dropbox App does not have the
required permissions. PLease visit App Console at Dropbox again and make
sure you have activated `files.metadata.read`, `files.content.read` and
`files.content.write`. Save your App. After each change at the Dropbox App you
have to restart the AccessToken Wizard in your Dropbox TYPO3 FAL Storage and
save the record again.

Upload of file XY failed
========================

Expand Down
2 changes: 1 addition & 1 deletion Documentation/Settings.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[general]

project = Dropbox FAL Driver
version = 5.0.0
version = 5.0.1
release = 5.0
copyright = by Stefan Froemken

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ up to 5 devices can connect to this app:
6. Give it a name
7. Save app with "Create App"
8. Open your newly created app
9. On tab "settings" you will find app key and app secret
9. On tab "settings" you will find app key
10. Open new tab and start configuring TYPO3

## Configure TYPO3

1. Create a new file storage record on pid 0 and give it a name like "Dropbox"
2. On Tab "Configuration" choose "Dropbox" (FlexForm reloads)
3. Click the + icon right of the access token field to start the wizard
4. Enter app key and app secret from your new Dropbox app
4. Enter app key from your new Dropbox app
5. Click the link to retrieve a Dropbox auth code
1. It will open a new browser tab, where you have to allow TYPO3 to access your app
2. After confirmation, you will see the auth code
Expand Down
2 changes: 1 addition & 1 deletion ext_emconf.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
'author_email' => '[email protected]',
'state' => 'stable',
'clearCacheOnLoad' => true,
'version' => '5.0.0',
'version' => '5.0.1',
'constraints' => [
'depends' => [
'php' => '7.4.0-8.2.99',
Expand Down

0 comments on commit 4520299

Please sign in to comment.