progrium / httpfs

Create filesystems using your favorite HTTP framework.

httpfs

Create virtual filesystems using any HTTP framework.

$ tree ~/demo
/Users/progrium/demo
├── greet
│   ├── goodbye
│   └── hello
└── random

2 directories, 3 files

The file tree mounted at ~/demo is powered by this Flask app:

import os, random
from flask import Flask
from autodir import AutoDirMiddleware

app = Flask(__name__)
AutoDirMiddleware(app)

@app.get("/greet/hello")
def hello():
    return "Hello, world!\n"

@app.get("/greet/goodbye")
def goodbye():
    return "Goodbye, world!\n"

@app.get("/random")
def rnd():
    return ''.join(random.choice('abcdefghijklmnopqrstuvwyz') for _ in range(24))+"\n"

All it took was one command:

httpfs -mount ~/demo ./examples/flask-basic/app.py

Don't care for Flask? Use any web framework!

Install

Currently works on Linux and Mac (with MacFUSE). Download from latest release or you can run this installer:

bash -c "$(curl -sSL https://raw.githubusercontent.com/progrium/httpfs/main/install.sh)"

Alternatively you can install using Homebrew:

brew tap progrium/homebrew-taps
brew install httpfs

Build an HTTP filesystem

Check out the examples directory or read the PROTOCOL.md to see how it works.

Roadmap

Full read-write and more coming soon. See our roadmap.

License

MIT

httpfs's Issues

Add Auth support for HTTP API URL.

HTTP API will be protected with Auth (Basic / JWT / oAuth) - provide option to accept it during runtime.

Example not working on Mac M2 Max Sonoma 14.4.1

I tried the Flask example locally, and get:

$ httpfs -mount ~/demo ./examples/flask-basic/app.py
2024/04/19 09:03:27 unable to stat httpfs: Head "http://localhost:59353/": dial tcp 127.0.0.1:59353: connect: connection refused

I don't know much about Flask. It might be nice to bundle a Go example as well.

I'm running on a Mac M2 Max with Sonoma 14.4.1.