Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brendoncarroll/webfs
A Filesystem Built On Top of the Web.
https://github.com/brendoncarroll/webfs
cryptography dropbox filesharing filesystem ipfs
Last synced: about 9 hours ago
JSON representation
A Filesystem Built On Top of the Web.
- Host: GitHub
- URL: https://github.com/brendoncarroll/webfs
- Owner: brendoncarroll
- License: gpl-3.0
- Created: 2019-08-18T22:31:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T02:14:21.000Z (almost 2 years ago)
- Last Synced: 2025-01-15T08:29:01.374Z (7 days ago)
- Topics: cryptography, dropbox, filesharing, filesystem, ipfs
- Language: Go
- Size: 355 KB
- Stars: 336
- Watchers: 13
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# WebFS
WebFS is a filesystem built on top of the web.
WebFS started after looking for a way to use IPFS as a Dropbox replacement,
and not finding any really solid solutions. I also wanted to be able to fluidly move
my data between traditional storage providers like Dropbox, MEGA, or Google Drive while testing the waters of new p2p storage systems, like Swarm or Filecoin.
If you have ever thought "x can probably be used as a file system", but didn't want to actually write the file system part, WebFS might be of benefit to you.
You can probably turn x into a file system with WebFS by writing a new `Store` or `Cell` implementation.
## Quick Links
[CLI Docs](./doc/10_CLI.md)
[Volume Specs Docs](./doc/11_Volume_Specs.md)
[ARCHITECTURE.md](./ARCHITECTURE.md)
## Installation
Installs to `$GOPATH/bin` with `make install`
## Getting Started
A simple volume spec using the filesystem for storage
```json
{
"cell": {
"file": "CELL_DATA",
},
"store": {
"fs": "BLOBS",
}
}
```
This configuration will create and write to a file `./CELL_DATA` and a directory `./BLOBS`, so plan accordingly.
To serve the files over http
```shell
$ webfs http --root myvolume.webfs
serving at http://127.0.0.1:7007
```
## Examples
There are examples in the `/examples` directory.
The examples assume you have the `webfs` executable on your `$PATH`.
You can also use
```go run ../../cmd/webfs``` instead of ```webfs``` if you don't want to set that up.
## Community
Questions and Discussion happening on Matrix.
