Split README into client and server

This commit is contained in:
Abhishek Shroff
2024-10-24 20:44:43 +05:30
parent 84a8e8cd3f
commit 4c61cac059
3 changed files with 97 additions and 94 deletions

View File

@@ -1,69 +0,0 @@
Self-hosted cloud file storage
[x] WebDAV compatible
[x] Cross-platform (Mobile, Desktop, Web)
[x] Offline
[x] File Explorer
[x] Upload files
[x] Upload folders
[x] Create folders
[x] Rename
[x] Move (cut-paste)
[x] Copy (copy-paste)
[ ] Merge (move/copy)
[x] Download files
[ ] Notifications for completed/failed downloads
[ ] Download folders / multiple files as zip
[x] Preview files
[x] Images
[ ] Text
[ ] Audio
[ ] PDF
[ ] EPUB
[ ] Bookmark folders
[ ] Table View
[ ] Grid View
[ ] Thumbnails
[x] Sync Manager
[x] View List of pending actions
[x] View failed actions
[ ] Actions for failed actions
[x] Delete
[x] Retry
[ ] Edit
[ ] Rename
[ ] Overwrite
[x] View in-progress downloads
[ ] View transfer rate and ETA
[ ] View finished downloads (in current session)
[ ] Actions for completed downloads
[ ] Open
[ ] Open Folder
[ ] Actions for failed downloads
[ ] Delete
[ ] Retry
[ ] Edit
[ ] View all past downloads
[ ] Public access
[ ] Download files
[ ] View folders
[ ] Password-protected (Basic auth)
[ ] Max Duration
[ ] Max Accesses (single-file only?)
[ ] Sharing folders
[x] Server support for sharing permissions
[ ] View permissions
[ ] Edit permissions
[ ] Shared With Me
[ ] Sync
[ ] Sync directory tree
[ ] Keep files offline
[ ] Full 2-way sync
[ ] Storage backends
[ ] System Tray Integration
[ ] Edit files
[ ] Text
[ ] Images
[ ] Session management
[x] Support server-side logout
[ ] Trash

View File

@@ -1,16 +1,63 @@
# phylum
Self-hosted cloud file storage
Self-hosted file storage
## Getting Started
This project is a starting point for a Flutter application.
A few resources to get you started if this is your first Flutter project:
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
[x] Cross-platform
[ ] Not tested on iOS, macOS, Windows yet
[x] Fully offline
[x] File Explorer
[x] Upload files
[x] Upload folders
[x] Create folders
[x] Rename
[x] Move (cut-paste)
[x] Copy (copy-paste)
[ ] Merge (move/copy)
[x] Download files
[ ] Notifications for completed/failed downloads
[ ] Download folders / multiple files as zip
[x] Preview files
[x] Images
[ ] Text
[ ] Audio
[ ] PDF
[ ] EPUB
[x] List view
[ ] Table View (for web, desktop)
[ ] Grid View
[ ] Bookmarks / Favorites
[ ] Add
[ ] Remove
[ ] View
[x] Sync Manager
[x] View List of pending actions
[x] View failed actions
[ ] Actions for failed actions
[x] Delete
[x] Retry
[ ] Edit
[ ] Rename
[ ] Overwrite
[x] View in-progress downloads
[ ] View transfer rate and ETA
[ ] View finished downloads (in current session)
[ ] Actions for completed downloads
[ ] Open
[ ] Open Folder
[ ] Actions for failed downloads
[ ] Delete
[ ] Retry
[ ] Edit
[ ] View all past downloads
[ ] Public sharing
[ ] Create
[ ] View
[ ] per-resource
[ ] all
[ ] Sharing folders
[x] Server support for sharing permissions
[ ] View permissions
[ ] Edit permissions
[ ] Shared With Me
[ ] System Tray Integration
[ ] Edit files
[ ] Text
[ ] Images

View File

@@ -1,11 +1,36 @@
### Setting up the test databsae
Self-hosted cloud file storage
```
podman run -d \
--name phylum \
-e POSTGRES_USER=phylum \
-e POSTGRES_PASSWORD=phylum \
-e POSTGRES_DB=phylum \
-p 5432:5432 \
docker.io/postgres:latest
```
[x] WebDAV compatible
[x] File explorer functionality
[x] Upload files
[x] Upload folders
[x] Create folders
[x] Move (rename)
[x] Copy
[ ] Merge (move/copy)
[x] Download files
[ ] Download folders / multiple files as zip
[ ] Thumbnails
[x] Bookmarks / Favorites
[x] Internal sharing
[x] List shared resources
[ ] Public sharing
[ ] Create
[ ] Password protection (Basic auth)
[ ] Max Duration
[ ] Max Accesses (single-file only?)
[ ] Use
[ ] View directory listing
[ ] Download files
[ ] Get Info
[ ] Per-resource
[ ] All
[ ] Sync
[ ] Keep track of incremental sync state per token
[ ] User admin
[ ] Permissions
[ ] Storage backends
[ ] Trash
[ ] Login backends
[ ] LDAP
[ ] OIDC