codex/filesystems

Codex Addon - Adds a collection of common filesystem adapters. These can be used by your projects.

dev-master / 2.1.x-dev 2019-04-27 07:24 UTC

Requires

• codex/core: ~2.0
• league/flysystem-rackspace: ~1.0
• league/flysystem-sftp: ~1.0
• league/flysystem-webdav: ~1.0
• league/flysystem-ziparchive: ~1.0
• spatie/flysystem-dropbox: ~1.0
• superbalist/flysystem-google-storage: ~5.0

Suggests

• codex/algolia-search: Integrates algolia search into codex (~2.0)
• codex/auth: Provides authentication using oauth providers (socialite) to restrict project access (~2.0)
• codex/blog: Provides blogging capability with categories containing posts (~2.0)
• codex/comments: Adds comments to your documents like Disqus or create your own adapter (~2.0)
• codex/git: Enables Github/Bitbucket integration & synchronisation (auto-webhook or manual) based on tags/branches. (~2.0)
• codex/packagist: Integrates Packagist information links and macros in your projects (~2.0)
• codex/phpdoc: Integrates PHPDoc documentation, links and macros in your projects (~2.0)
• codex/sitemap: Generates a sitemap.xml (~2.0)

MIT

• Robin Radic

• documentation
• filesystem
• markdown
• remote
• laravel
• Flysystem
• codex
• disks

README

Filesystems Addon

Adds a collection of common filesystem adapters. These can be used by your projects.

Installation

composer require codex/filesystems
php artisan codex:addons:enable codex/filesystems

Configuration

[project]/config.php

[
    // ...
    'disk' => 'my-dropbox-project',
    // ...
];

config/filesystems.php

[
    'my-webdav-project' => [
        'driver'   => 'webdav',
        'root'     => 'test-dav-project',
        'baseUri'  => env('STACK_URI'),
        'proxy'    => env('STACK_PROXY'),
        'userName' => env('STACK_USERNAME'),
        'password' => env('STACK_PASSWORD'),
        'prefix'   => env('STACK_PREFIX', ''),
    ],

    'my-google-project' => [
        'driver'    => 'google-cloud',
        'projectId' => '',
        'bucket'    => '',
    ],

    'my-dropbox-project' => [
        'driver' => 'dropbox',
        'prefix' => env('DROPBOX_PREFIX', ''),
        'token'  => env('DROPBOX_TOKEN'),
    ],

    'my-zip-project' => [
        'driver' => 'zip',
        'path'   => resource_path('docs/test-zip-project/test-zip-project.zip'),
    ],

    'my-s3-project' => [
        'driver' => 's3',
        'key'    => env('AWS_ACCESS_KEY_ID'),
        'secret' => env('AWS_SECRET_ACCESS_KEY'),
        'region' => env('AWS_DEFAULT_REGION'),
        'bucket' => env('AWS_BUCKET'),
        'url'    => env('AWS_URL'),
    ], 
    
    'my-sftp-project' => [
        'driver'        => 'sftp',
        'host'          => env('SFTP_HOST'),
        'port'          => env('SFTP_PORT'),
        'username'      => env('SFTP_USERNAME'),
        'password'      => env('SFTP_PASSWORD'),
        'privateKey'    => env('SFTP_PRIVATEKEY'),
        'root'          => env('SFTP_ROOT'),
        'timeout'       => 10,
        'directoryPerm' => 0755,
    ],
    
    'my-rackspace-project' => [
        'driver'   => 'rackspace',
        'url'      => env('RACKSPACE_URL'),
        'secret' => [
            'username' => env('RACKSPACE_USERNAME'),
            'apiKey'   => env('RACKSPACE_APIKEY'),
        ],
        'region'   => env('RACKSPACE_REGION'),
        'options'  => [],
    ],
]

Copyright/License

Copyright 2019 Robin Radic - MIT Licensed