https://github.com/visuellverstehen/statamic-pixxio-flysystem
A Statamic addon which provides a Flysystem Adapter for the Pixxio API
https://github.com/visuellverstehen/statamic-pixxio-flysystem
filesystem laravel pixxio statamic
Last synced: 20 days ago
JSON representation
A Statamic addon which provides a Flysystem Adapter for the Pixxio API
- Host: GitHub
- URL: https://github.com/visuellverstehen/statamic-pixxio-flysystem
- Owner: visuellverstehen
- Created: 2023-04-27T07:29:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-21T14:25:59.000Z (3 months ago)
- Last Synced: 2025-02-13T19:51:12.633Z (2 months ago)
- Topics: filesystem, laravel, pixxio, statamic
- Language: PHP
- Homepage:
- Size: 67.4 KB
- Stars: 2
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Statamic Pixxio Flysystem
> Statamic Pixxio Flysystem is a Statamic addon that does something pretty neat.
## Features
- Provide a Flysystem Adapter for Pixxio
- Exclude specific directories from the asset-container.
---
## Licensing
Pixxio Flysystem is a commercial addon - you **must purchase a license** via the [Statamic Marketplace](https://statamic.com/addons/visuellverstehen/pixxio-flysystem) to use it in a production environment.
---
## How to Install
### Run the following command from your project root:
``` bash
composer require visuellverstehen/statamic-pixxio-flysystem
```
### Add your Pixxio credentials to config/filesystems.php
``` php
'disks' => [
'pixxio' => [
'driver' => 'pixxio',
'api_key' => env('PIXXIO_API_KEY'),
'refresh_token' => env('PIXXIO_REFRESH_TOKEN'),
'endpoint' => env('PIXXIO_ENDPOINT'),
],
],
```
### Run migrations
``` bash
php artisan migrate
```
### Edit blueprint
Add `alt`, `copyright` and `description` fields to the asset-container blueprint.
### Run synchronization script:
``` bash
php artisan pixxio:sync
```
If you wish to only import newly added files you can use the `--new` option.
``` bash
php artisan pixxio:sync --new
```
In order to keep the database updated schedule a task that runs synchronization script regularly.
---
## Configurations
``` bash
php artisan vendor:publish --provider="VV\PixxioFlysystem\ServiceProvider" --tag="flysystem-pixxio-config"
```
Exclude certain directories in config/flysystem-pixxio.php
``` php
'exclude' => [
'directories' => [
'/home',
],
],
```
---
## How to Use
- Simply create an Asset-Container with pixxio as your driver.