mirror of
https://github.com/mickael-kerjean/filestash
synced 2025-12-06 08:22:24 +01:00
documentation (README): update project README
This commit is contained in:
parent
ee1ceb7907
commit
e38fa58764
5 changed files with 15 additions and 21 deletions
Binary file not shown.
|
Before Width: | Height: | Size: 1.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 470 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 180 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.9 MiB |
34
README.md
34
README.md
|
|
@ -1,63 +1,57 @@
|
||||||

|

|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
A Dropbox-like file manager that let you manage your data anywhere it is located:<br>
|
A Dropbox-like file manager that let you manage your data anywhere it is located:<br>
|
||||||
FTP • SFTP • WebDAV • Git • S3 • Minio <br>
|
FTP • SFTP • WebDAV • Git • S3 • LDAP • Minio <br>
|
||||||
|
CardDAV • CalDAV • Backblaze B2 <br>
|
||||||
Dropbox • Google Drive
|
Dropbox • Google Drive
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="http://demo.filestash.app">
|
<a href="http://demo.filestash.app">
|
||||||
<img src="https://raw.githubusercontent.com/mickael-kerjean/filestash/master/.assets/img/button_demo.png" alt="demo button" />
|
<img src="https://raw.githubusercontent.com/mickael-kerjean/filestash_images/master/.assets/button_demo.png" alt="demo button" />
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
# Features
|
# Features
|
||||||
- Manage your files from a browser
|
- Manage your files from a browser
|
||||||
- Org mode friendly ([documentation](https://github.com/mickael-kerjean/filestash/wiki/Release-0.1:-Org-Mode-everywhere))
|
- Org mode friendly ([documentation](https://github.com/mickael-kerjean/filestash/wiki/Release-0.1:-Org-Mode-everywhere))
|
||||||
- Photo management ([documentation](https://github.com/mickael-kerjean/filestash/wiki/Release-0.2:-Photo-Management))
|
- Photo management
|
||||||
- Flexible Share mechanism
|
- Flexible Share mechanism
|
||||||
- User friendly
|
- User friendly
|
||||||
- Mobile friendly
|
- Mobile friendly
|
||||||
- Customisable ([documentation](https://github.com/mickael-kerjean/filestash/wiki/Customisation))
|
- Customisable
|
||||||
- Super fast
|
- Super fast
|
||||||
- Works offline
|
|
||||||
- Upload files and folders
|
- Upload files and folders
|
||||||
- Multiple cloud providers and protocols, easily extensible
|
- Multiple cloud providers and protocols, easily extensible
|
||||||
|
- Full Text Search
|
||||||
|
- Shared links as WebDAV server
|
||||||
- Audio player
|
- Audio player
|
||||||
- Video player
|
- Video player
|
||||||
- Image viewer
|
- Image viewer
|
||||||
- Quick access: frequently access folders are pin to the homepage
|
- Quick access: frequently access folders are pin to the homepage
|
||||||
- Stateless
|
|
||||||
- Emacs, VIM or Sublime keybindings `;)`
|
- Emacs, VIM or Sublime keybindings `;)`
|
||||||
|
|
||||||
# Screenshots
|
# Screenshots
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://demo.filestash.app">
|
<a href="https://demo.filestash.app">
|
||||||
<img src="https://raw.githubusercontent.com/mickael-kerjean/filestash/master/.assets/img/navigation.gif" alt="user experience on navigation" />
|
<img src="https://raw.githubusercontent.com/mickael-kerjean/filestash_images/master/.assets/navigation.gif" alt="user experience on navigation" />
|
||||||
</a>
|
</a>
|
||||||
<i>Navigating in Filestash</i>
|
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="http://demo.filestash.app">
|
<a href="http://demo.filestash.app">
|
||||||
<img src="https://raw.githubusercontent.com/mickael-kerjean/filestash/master/.assets/img/photo_management.gif" alt="user experience on medias" />
|
<img src="https://raw.githubusercontent.com/mickael-kerjean/filestash_images/master/.assets/photo_management.gif" alt="user experience on medias" />
|
||||||
</a>
|
</a>
|
||||||
<i>Works great with your medias</i>
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
# Getting started - Installation
|
# Documentation
|
||||||
Filestash can be used in different settings:
|
- [Getting started](https://www.filestash.app/docs)
|
||||||
- Selfhosting ([documentation](https://github.com/mickael-kerjean/filestash/wiki/Installation:-Selfhosting)): install it somewhere you have full control (with docker, without docker, on a server or even android)
|
- [Installation](https://www.filestash.app/docs/install-and-upgrade)
|
||||||
- Saas ([documentation](https://github.com/mickael-kerjean/filestash/wiki/Installation:-SaaS)): official instance or private instance fully managed
|
- [FAQ](https://www.filestash.app/docs/faq)
|
||||||
|
|
||||||
# Support the project
|
# Support the project
|
||||||
- Bitcoin: `3LX5KGmSmHDj5EuXrmUvcg77EJxCxmdsgW`
|
- Bitcoin: `3LX5KGmSmHDj5EuXrmUvcg77EJxCxmdsgW`
|
||||||
- [Patreon](https://www.patreon.com/mickaelk)
|
- [Patreon](https://www.patreon.com/mickaelk)
|
||||||
|
|
||||||
# Documentation
|
|
||||||
- [FAQ](https://github.com/mickael-kerjean/filestash/wiki)
|
|
||||||
- [Customisation](https://github.com/mickael-kerjean/filestash/wiki/Customisation)
|
|
||||||
- [Release Notes](https://github.com/mickael-kerjean/filestash/wiki/Releases)
|
|
||||||
|
|
||||||
# Credits
|
# Credits
|
||||||
- [Contributors](https://github.com/mickael-kerjean/filestash/graphs/contributors) and folks developing awesome libraries (libvips, libraw, ...)
|
- [Contributors](https://github.com/mickael-kerjean/filestash/graphs/contributors) and folks developing awesome libraries (libvips, libraw, ...)
|
||||||
- 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/), loader adapted from [Mr Alien](https://codepen.io/mr_alien/pen/FDLjg)
|
- 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/), loader adapted from [Mr Alien](https://codepen.io/mr_alien/pen/FDLjg)
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue