PHPackages                             numencode/wn-dropboxadapter-plugin - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [File &amp; Storage](/categories/file-storage)
4. /
5. numencode/wn-dropboxadapter-plugin

ActiveWinter-plugin[File &amp; Storage](/categories/file-storage)

numencode/wn-dropboxadapter-plugin
==================================

NumenCode Dropbox Adapter plugin for Winter CMS

v1.1.0(1y ago)16MITPHPPHP ^8.0.2CI passing

Since Jul 9Pushed 1y agoCompare

[ Source](https://github.com/numencode/wn-dropboxadapter-plugin)[ Packagist](https://packagist.org/packages/numencode/wn-dropboxadapter-plugin)[ Docs](https://www.numencode.com)[ RSS](/packages/numencode-wn-dropboxadapter-plugin/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (2)Dependencies (3)Versions (3)Used By (0)

Dropbox Adapter Plugin
======================

[](#dropbox-adapter-plugin)

The **Dropbox Adapter Plugin** provides Dropbox v2 API integration with Winter CMS as a custom filesystem disk driver. This allows limited usage of Dropbox with Laravel's Storage facade — primarily for custom logic and backup tools such as [`NumenCode.SyncOps`](https://github.com/numencode/wn-syncops-plugin).

[![Version](https://camo.githubusercontent.com/4a5056e2893fd8c392fb9cb7342b09dbe88df97091397741497ec290889af9ea/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f6e756d656e636f64652f776e2d64726f70626f78616461707465722d706c7567696e3f7374796c653d666c61742d73717561726526636f6c6f723d303039394646)](https://github.com/numencode/wn-dropboxadapter-plugin/releases)[![Packagist PHP Version Support](https://camo.githubusercontent.com/286398ff8b81c0b30fa1d6c1ef7034910f2018431cdd4135ea6034555e6affb1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6e756d656e636f64652f776e2d64726f70626f78616461707465722d706c7567696e3f7374796c653d666c61742d73717561726526636f6c6f723d303039394646)](https://packagist.org/packages/numencode/wn-dropboxadapter-plugin)[![Checks](https://camo.githubusercontent.com/b40d3c3455a6dc9a9e9db8f1eae67d22330c4304ca69475ece47e270d98ec7b4/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636865636b2d72756e732f6e756d656e636f64652f776e2d64726f70626f78616461707465722d706c7567696e2f6d61696e3f7374796c653d666c61742d737175617265)](https://github.com/numencode/wn-dropboxadapter-plugin/actions)[![Tests](https://camo.githubusercontent.com/fd90d5f2fb66ab4ffc845c16a05075b0621d2e69126a545835ad83160ce7af26/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6e756d656e636f64652f776e2d64726f70626f78616461707465722d706c7567696e2f74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/numencode/wn-dropboxadapter-plugin/actions)[![License](https://camo.githubusercontent.com/06f1b80dfe29f7e54426ac11c0ddc528d9e6965befa5fe9174c0ecb4ea7d8a08/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6e756d656e636f64652f776e2d64726f70626f78616461707465722d706c7567696e3f6c6162656c3d6f70656e253230736f75726365267374796c653d666c61742d73717561726526636f6c6f723d303039394646)](https://github.com/numencode/wn-dropboxadapter-plugin/blob/main/LICENSE.md)

---

Target Audience
---------------

[](#target-audience)

This plugin is designed for developers who want to interact with Dropbox from within Winter CMS using Laravel’s filesystem abstraction, especially for automation, remote syncing, and backup scenarios.

> **Note:** Due to framework limitations, Winter CMS (as of version 1.2) does not support using Dropbox as a filesystem for core `media` or `uploads` disks. This plugin is not intended for direct media asset management, but rather for use cases like backup transport, cloud storage sync, or custom plugin integration (e.g. [`NumenCode.SyncOps`](https://github.com/numencode/wn-syncops-plugin)).

---

Installation
------------

[](#installation)

This plugin is available for installation via [Composer](http://getcomposer.org/).

```
composer require numencode/wn-dropboxadapter-plugin
```

Once the plugin is installed, ensure all migrations are executed:

```
php artisan winter:up
```

Requirements
------------

[](#requirements)

- [Winter CMS](https://wintercms.com) version 1.2.7 or newer
- PHP 8.0 or later
- A Dropbox App (created in the [Dropbox App Console](https://www.dropbox.com/developers/apps))
    - For **Refresh Token Flow**: You'll need your `App key` and `App secret`.
    - For **Temporary Token Flow**: You'll need a manually generated `Access token`.

Configuration and Authentication
--------------------------------

[](#configuration-and-authentication)

This plugin offers two methods for authenticating with the Dropbox API: the **Refresh Token Flow** (recommended for production and long-term use) and the **Temporary Token Flow** (ideal for quick development or testing). You can switch between these modes in your `.env` file.

### 1. Create a Dropbox App

[](#1-create-a-dropbox-app)

Regardless of the authentication method, you need to [create a Dropbox App](https://www.dropbox.com/developers/apps).

When creating your app:

- Choose **"Scoped access"** and select the permissions your application needs (e.g., `files.content.write`, `files.content.read` for read/write access).

### 2. Choose your authentication method

[](#2-choose-your-authentication-method)

You specify the authentication method in your `.env` file using the `DROPBOX_AUTH_MODE` variable. You can choose between `refresh_token` and `temp_token` modes.

#### a. Refresh Token Flow (recommended for production)

[](#a-refresh-token-flow-recommended-for-production)

This is the **secure and persistent** way to authenticate. It uses a long-lived **refresh token** to automatically obtain new, short-lived **access tokens** as needed, eliminating the need for manual intervention when tokens expire.

##### Setup Steps

[](#setup-steps)

1. **Add Dropbox App credentials to `.env`**:

    You'll need your Dropbox `App key` and `App secret`.

    ```
    DROPBOX_AUTH_MODE=refresh_token
    DROPBOX_APP_KEY=
    DROPBOX_APP_SECRET=
    DROPBOX_REFRESH_TOKEN=
    ```
2. **Generate your refresh token**:

    Use the provided console command to go through the OAuth2 authorization process and obtain your refresh token:

    ```
    php artisan dropboxadapter:setup
    ```

    Follow the on-screen prompts:

    - It will ask for your **Dropbox App key**.
    - It will provide a URL to open in your browser. Authorize your app on Dropbox. After authorization, Dropbox will provide an "authorization code" (often in the URL parameters if no redirect URI is set, or directly on the success page). Copy this `code`.
    - Paste the `authorization code` back into the console.
    - Enter your **Dropbox App secret**.
    - The command will then exchange this code for a refresh token and display it.
3. **Update `.env` with refresh token**:

    Copy the generated refresh token and add it to your `.env` file.

#### b. Temporary Token Flow (for development/testing only)

[](#b-temporary-token-flow-for-developmenttesting-only)

This method is quick and easy for **temporary testing**, but the token will **expire after 4 hours** and requires manual renewal. **Do not use this in production.**

##### Setup Steps

[](#setup-steps-1)

1. **Generate a temporary access token:**

    - Go to your [Dropbox App Console](https://www.dropbox.com/developers/apps).
    - Navigate to your app's settings.
    - Under "OAuth 2", find the "Generated access token" section and click "Generate". Copy this token.
2. **Add temporary token to `.env`:**

    ```
    DROPBOX_AUTH_MODE=temp_token
    DROPBOX_TEMP_TOKEN=
    ```

    **Important:** If using this mode, the `DROPBOX_APP_KEY`, `DROPBOX_APP_SECRET`, and `DROPBOX_REFRESH_TOKEN` variables are ignored by the plugin.

### 3. Define the dropbox disk

[](#3-define-the-dropbox-disk)

Once you have configured your chosen authentication method in `.env`, define a new filesystem disk in your `config/filesystems.php` file:

```
'dropbox' => [
    'driver' => 'dropbox',
],
```

### 4. Usage with Storage Facade

[](#4-usage-with-storage-facade)

You can now interact with Dropbox programmatically using the Storage facade in Laravel:

```
Storage::disk('dropbox')->put('backups/site.zip', $contents);
```

This is especially useful for custom automation (e.g., deployment scripts or remote backup workflows).

Limitations
-----------

[](#limitations)

- **Not compatible with Winter CMS native `media` or `uploads` disks.**
- **Not suitable for asset serving or file uploading through the CMS backend UI.**

Use Dropbox through this plugin **only for custom filesystem operations** that are manually invoked or triggered via automation (e.g., within the [`NumenCode.SyncOps`](https://github.com/numencode/wn-syncops-plugin) plugin or similar).

Example Use Case
----------------

[](#example-use-case)

This plugin was created to support [`NumenCode.SyncOps`](https://github.com/numencode/wn-syncops-plugin), a Winter CMS plugin for managing deployments, backups, and environment synchronization. Dropbox serves as a remote storage destination for sync packages or archive backups.

---

Changelog
---------

[](#changelog)

All notable changes are documented in the [CHANGELOG](CHANGELOG.md).

---

Contributing
------------

[](#contributing)

Please refer to the [CONTRIBUTING](CONTRIBUTING.md) guide for details on contributing to this project.

---

Security
--------

[](#security)

If you identify any security issues, email  rather than using the issue tracker.

---

Author
------

[](#author)

The **NumenCode.DropboxAdapter** plugin is created and maintained by [Blaz Orazem](https://orazem.si/).

For inquiries, contact:

---

License
-------

[](#license)

This project is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

[![License](https://camo.githubusercontent.com/a265c16515d2f68c248b25be8ae1c9b499a5e0d5b03581548fc0ea4b2f379240/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6e756d656e636f64652f776e2d64726f70626f78616461707465722d706c7567696e3f7374796c653d666c61742d73717561726526636f6c6f723d303039394646)](https://github.com/numencode/wn-dropboxadapter-plugin/blob/main/LICENSE.md)

###  Health Score

27

—

LowBetter than 46% of packages

Maintenance47

Moderate activity, may be stable

Popularity6

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~5 days

Total

2

Last Release

399d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/5699173?v=4)[Blaž Oražem](/maintainers/blazorazem)[@BlazOrazem](https://github.com/BlazOrazem)

---

Top Contributors

[![BlazOrazem](https://avatars.githubusercontent.com/u/5699173?v=4)](https://github.com/BlazOrazem "BlazOrazem (2 commits)")

---

Tags

dropboxlaravelnumencodephppluginstoragewinterwintercmswintercms-pluginpluginlaravelstoragedropboxwinterwinter cmsnumencode

### Embed Badge

![Health badge](/badges/numencode-wn-dropboxadapter-plugin/health.svg)

```
[![Health](https://phpackages.com/badges/numencode-wn-dropboxadapter-plugin/health.svg)](https://phpackages.com/packages/numencode-wn-dropboxadapter-plugin)
```

###  Alternatives

[helsingborg-stad/municipio

A bootstrap theme for creating municipality sites.

4028.6k10](/packages/helsingborg-stad-municipio)[benjamincrozat/laravel-dropbox-driver

Dropbox storage driver for Laravel.

55292.6k2](/packages/benjamincrozat-laravel-dropbox-driver)[winter/wn-user-plugin

User plugin for Winter CMS

1340.0k17](/packages/winter-wn-user-plugin)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
