From f4cf4173e67db1c1ed9e897a20334be2ce304b1f Mon Sep 17 00:00:00 2001 From: shalafi99 <45401013+shalafi99@users.noreply.github.com> Date: Wed, 18 Sep 2024 15:43:54 -0300 Subject: [PATCH] Documentation update for DROPBOX_REMOTE_PATH environment variable (#473) * Update set-up-dropbox.md Updated text for explanation of DROPBOX_REMOTE_PATH environment variable usage accordingly to how the Dropbox App was scoped during creation. * Update set-up-dropbox.md Minor style edit * Update index.md Replaced /Apps/my-test-app/some_subdir with /somedir in example value for DROPBOX_REMOTE_PATH environment variable under "Backing up to Dropbox" section, to align with updates done to related "how-to" text --- docs/how-tos/set-up-dropbox.md | 6 ++++-- docs/recipes/index.md | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/how-tos/set-up-dropbox.md b/docs/how-tos/set-up-dropbox.md index ca8752a..8236e45 100644 --- a/docs/how-tos/set-up-dropbox.md +++ b/docs/how-tos/set-up-dropbox.md @@ -33,5 +33,7 @@ Note: Using the "Generated access token" in the app console is not supported, as ## Other parameters -Important: If you chose `App folder` access during the creation of your Dropbox app in step 1 above, you can only write in the app's directory! -This means, that `DROPBOX_REMOTE_PATH` must start with e.g. `/Apps/YOUR_APP_NAME` or `/Apps/YOUR_APP_NAME/some_sub_dir` +Important: If you chose `App folder` access during the creation of your Dropbox app in step 1 above, `DROPBOX_REMOTE_PATH` will be a relative path under the App folder! +(_For example, DROPBOX_REMOTE_PATH=/somedir means the backup file will be uploaded to /Apps/myapp/somedir_) +On the other hand if you chose `Full Dropbox` access, the value for `DROPBOX_REMOTE_PATH` will represent an absolute path inside your Dropbox storage area. +(_Still considering the same example above, the backup file will be uploaded to /somedir in your Dropbox root_) diff --git a/docs/recipes/index.md b/docs/recipes/index.md index f5ea77f..2165ae3 100644 --- a/docs/recipes/index.md +++ b/docs/recipes/index.md @@ -190,7 +190,7 @@ services: DROPBOX_REFRESH_TOKEN: REFRESH_KEY # replace DROPBOX_APP_KEY: APP_KEY # replace DROPBOX_APP_SECRET: APP_SECRET # replace - DROPBOX_REMOTE_PATH: /Apps/my-test-app/some_subdir # replace + DROPBOX_REMOTE_PATH: /somedir # replace volumes: - data:/backup/my-app-backup:ro - /var/run/docker.sock:/var/run/docker.sock:ro