https://github.com/binarybirds/liquid-local-driver
A local driver implementation for the LiquidKit file storage solution.
https://github.com/binarybirds/liquid-local-driver
file-storage liquid-kit swift-nio
Last synced: 11 months ago
JSON representation
A local driver implementation for the LiquidKit file storage solution.
- Host: GitHub
- URL: https://github.com/binarybirds/liquid-local-driver
- Owner: BinaryBirds
- License: mit
- Archived: true
- Created: 2020-04-28T06:38:25.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-04-11T07:59:03.000Z (about 3 years ago)
- Last Synced: 2025-07-18T21:04:22.244Z (11 months ago)
- Topics: file-storage, liquid-kit, swift-nio
- Language: Swift
- Homepage: https://feathercms.com/
- Size: 52.7 KB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LiquidLocalDriver
A local driver implementation for the [LiquidKit](https://github.com/BinaryBirds/liquid-kit) file storage solution.
The local driver uses a local directory on the server and the FileManager object from the Foundation framework to store files. If you are planning to setup a distributed system with multiple application servers, please consider using the [AWS S3](https://github.com/BinaryBirds/liquid-aws-s3-driver) driver instead.
LiquidKit and the local driver is also compatible with Vapor 4 through the [Liquid](https://github.com/BinaryBirds/liquid) repository, that contains Vapor specific extensions.
## Key resolution for local objects
Keys are being resolved using a public base URL component, the name of the working directory and the key itself.
- url = [public base URL] + [working directory name] + [key]
e.g.
- publicUrl = "http://localhost/"
- workDirectory = "assets"
- key = "test.txt"
- resolvedUrl = "http://localhost/assets/test.txt"
## Usage with SwiftNIO
Add the required dependencies using SPM:
```swift
// swift-tools-version:5.3
import PackageDescription
let package = Package(
name: "myProject",
platforms: [
.macOS(.v10_15)
],
dependencies: [
.package(url: "https://github.com/binarybirds/liquid", from: "1.3.0"),
.package(url: "https://github.com/binarybirds/liquid-local-driver", from: "1.3.0"),
],
targets: [
.target(name: "App", dependencies: [
.product(name: "Liquid", package: "liquid"),
.product(name: "LiquidLocalDriver", package: "liquid-local-driver"),
]),
]
)
```
A basic usage example with SwiftNIO:
```swift
/// setup thread pool
let elg = MultiThreadedEventLoopGroup(numberOfThreads: 1)
let pool = NIOThreadPool(numberOfThreads: 1)
pool.start()
/// create fs
let fileio = NonBlockingFileIO(threadPool: pool)
let storages = FileStorages(fileio: fileio)
storages.use(.local(publicUrl: "http://localhost/",
publicPath: "/var/www/localhost/public",
workDirectory: "assets"), as: .local)
let fs = storages.fileStorage(.local, logger: .init(label: "[test-logger]"), on: elg.next())!
/// test file upload
let key = "test.txt"
let data = Data("file storage test".utf8)
let res = try await fs.upload(key: key, data: data)
/// http://localhost/assets/test.txt
let url = req.fs.resolve(key: key)
/// delete key
try await req.fs.delete(key: key)
```