PHPackages                             pkzhilong/oos - 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 & Storage](/categories/file-storage)
4. /
5. pkzhilong/oos

ActiveLibrary[File & Storage](/categories/file-storage)

pkzhilong/oos
=============

aliyun oss filesystem storage for laravel 5+

00PHP

Since Feb 20Pushed 4y ago1 watchersCompare

[ Source](https://github.com/PKzhilong/oos)[ Packagist](https://packagist.org/packages/pkzhilong/oos)[ RSS](/packages/pkzhilong-oos/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependenciesVersions (1)Used By (0)

Aliyun-oss-storage for Laravel 5+
=================================

[](#aliyun-oss-storage-for-laravel-5)

Aliyun oss filesystem storage adapter for laravel 5. You can use Aliyun OSS just like laravel Storage as usual.
借鉴了一些优秀的代码，综合各方，同时做了更多优化，将会添加更多完善的接口和插件，打造Laravel最好的OSS Storage扩展

Inspired By
-----------

[](#inspired-by)

- [thephpleague/flysystem-aws-s3-v2](https://github.com/thephpleague/flysystem-aws-s3-v2)
- [apollopy/flysystem-aliyun-oss](https://github.com/apollopy/flysystem-aliyun-oss)

Require
-------

[](#require)

- Laravel 5+
- cURL extension

\##Installation In order to install AliOSS-storage, just add

```
"jacobcyl/ali-oss-storage": "^2.1"

```

to your composer.json. Then run `composer install` or `composer update`.
Or you can simply run below command to install:

```
"composer require jacobcyl/ali-oss-storage:^2.1"

```

Then in your `config/app.php` add this line to providers array:

```
Jacobcyl\AliOSS\AliOssServiceProvider::class,
```

Configuration
-------------

[](#configuration)

Add the following in app/filesystems.php:

```
'disks'=>[
    ...
    'oss' => [
            'driver'        => 'oss',
            'access_id'     => '',
            'access_key'    => '',
            'bucket'        => '',
            'endpoint'      => '', // OSS 外网节点或自定义外部域名
            //'endpoint_internal' => '', // v2.0.4 新增配置属性，如果为空，则默认使用 endpoint 配置(由于内网上传有点小问题未解决，请大家暂时不要使用内网节点上传，正在与阿里技术沟通中)
            'cdnDomain'     => '', // 如果isCName为true, getUrl会判断cdnDomain是否设定来决定返回的url，如果cdnDomain未设置，则使用endpoint来生成url，否则使用cdn
            'ssl'           =>  // true to use 'https://' and false to use 'http://'. default is false,
            'isCName'       =>  // 是否使用自定义域名,true: 则Storage.url()会使用自定义的cdn或域名生成文件url， false: 则使用外部节点生成url
            'debug'         =>
    ],
    ...
]
```

Then set the default driver in app/filesystems.php:

```
'default' => 'oss',
```

Ok, well! You are finish to configure. Just feel free to use Aliyun OSS like Storage!

Usage
-----

[](#usage)

See [Larave doc for Storage](https://laravel.com/docs/5.2/filesystem#custom-filesystems)Or you can learn here:

> First you must use Storage facade

```
use Illuminate\Support\Facades\Storage;
```

> Then You can use all APIs of laravel Storage

```
Storage::disk('oss'); // if default filesystems driver is oss, you can skip this step

//fetch all files of specified bucket(see upond configuration)
Storage::files($directory);
Storage::allFiles($directory);

Storage::put('path/to/file/file.jpg', $contents); //first parameter is the target file path, second paramter is file content
Storage::putFile('path/to/file/file.jpg', 'local/path/to/local_file.jpg'); // upload file from local path

Storage::get('path/to/file/file.jpg'); // get the file object by path
Storage::exists('path/to/file/file.jpg'); // determine if a given file exists on the storage(OSS)
Storage::size('path/to/file/file.jpg'); // get the file size (Byte)
Storage::lastModified('path/to/file/file.jpg'); // get date of last modification

Storage::directories($directory); // Get all of the directories within a given directory
Storage::allDirectories($directory); // Get all (recursive) of the directories within a given directory

Storage::copy('old/file1.jpg', 'new/file1.jpg');
Storage::move('old/file1.jpg', 'new/file1.jpg');
Storage::rename('path/to/file1.jpg', 'path/to/file2.jpg');

Storage::prepend('file.log', 'Prepended Text'); // Prepend to a file.
Storage::append('file.log', 'Appended Text'); // Append to a file.

Storage::delete('file.jpg');
Storage::delete(['file1.jpg', 'file2.jpg']);

Storage::makeDirectory($directory); // Create a directory.
Storage::deleteDirectory($directory); // Recursively delete a directory.It will delete all files within a given directory, SO Use with caution please.

// upgrade logs
// new plugin for v2.0 version
Storage::putRemoteFile('target/path/to/file/jacob.jpg', 'http://example.com/jacob.jpg'); //upload remote file to storage by remote url
// new function for v2.0.1 version
Storage::url('path/to/img.jpg') // get the file url
```

Documentation
-------------

[](#documentation)

More development detail see [Aliyun OSS DOC](https://help.aliyun.com/document_detail/32099.html?spm=5176.doc31981.6.335.eqQ9dM)

License
-------

[](#license)

Source code is release under MIT license. Read LICENSE file for more information.

###  Health Score

14

—

LowBetter than 2% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity0

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity26

Early-stage or recently created project

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/7ebf206274e17a7d02dc5c0c7621019a5b49e71e406e5fc5f9a07de61c71aafa?d=identicon)[PKzhilong](/maintainers/PKzhilong)

---

Top Contributors

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

### Embed Badge

![Health badge](/badges/pkzhilong-oos/health.svg)

```
[![Health](https://phpackages.com/badges/pkzhilong-oos/health.svg)](https://phpackages.com/packages/pkzhilong-oos)
```

###  Alternatives

[knplabs/gaufrette

PHP library that provides a filesystem abstraction layer

2.5k39.8M123](/packages/knplabs-gaufrette)[google/cloud-storage

Cloud Storage Client for PHP

34390.8M123](/packages/google-cloud-storage)[illuminate/filesystem

The Illuminate Filesystem package.

15261.6M2.6k](/packages/illuminate-filesystem)[superbalist/flysystem-google-storage

Flysystem adapter for Google Cloud Storage

26320.6M30](/packages/superbalist-flysystem-google-storage)[creocoder/yii2-flysystem

The flysystem extension for the Yii framework

2931.7M61](/packages/creocoder-yii2-flysystem)[flowjs/flow-php-server

PHP library for handling chunk uploads. Works with flow.js html5 file uploads.

2451.6M15](/packages/flowjs-flow-php-server)

PHPackages © 2026

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