From 2d607ff8a0005b17629358bbdd1f4c707cf9620d Mon Sep 17 00:00:00 2001
From: Abhishek Shroff <shroff@kudosoft.net>
Date: Fri, 2 May 2025 03:50:21 +0530
Subject: [PATCH] [server] Readme

---
 README.md        | 65 ++++++++++++++++++++++++++++++++++++++++++++++++
 server/README.md | 37 ---------------------------
 2 files changed, 65 insertions(+), 37 deletions(-)
 create mode 100644 README.md
 delete mode 100644 server/README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..b5fc6769
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+Phylum
+======
+
+Phylum is a self-hosted cloud file storage with native clients on all platforms(*), meant as a replacement for Google Drive, Dropbox, etc.
+
+It is in very early stages of testing, so bugs are to be expected. While the backend is quite robust and its data model fairly fixed, don't even think about putting the only copy of any data that you care about.
+
+
+### Features
+
+ - Offline-first native clients on all platforms (*)
+ - Public shares
+ - Users and permissions
+ - WebDAV-compatible server
+ - Jailed users
+
+* Not yet built/tested on MacOS, iOS, and Windows. 
+
+### Roadmap
+
+In no particular order, here are some things that are planned
+
+ - App links
+ - In-app user management
+ - Email notifications
+ - Storage backends like S3, B2, Minio, etc. (partially implemented)
+ - Thumbnails and grid view
+ - Links / Shortcuts
+ - Directory quota 
+ - User Groups
+ - Auth backends (LDAP, OAuth)
+ - Keep files synced offline
+ - Sync directory tree metadata
+ - 2-way folder sync
+
+
+### Development / Testing
+
+The easiest way to get up and running is to use docker (or podman) compose go to `http://localhost:2448`.
+
+
+#### Server
+
+The server is written in Go, and requires a postgres server to be running.
+
+```
+$ podman run -it -e POSTGRES_USER=phylum -e POSTGRES_PASSWORD=phylum -v ./data/db:/var/lib/postgresql/data docker.io/postgres:17
+$ PHYLUM_DB_PASSWORD=phylum go run -C server cmd/phylum.go -W .. serve
+```
+
+`-W ..` will ensure that all paths are relative to the root directory of this repo, so the default storage won't end up inside the server source.
+
+#### Client
+
+The client is written using Flutter, and building requires no special configuration as long as your toolchian is [set up properly](https://docs.flutter.dev/get-started/). Of course, you will need a running server to connect to.
+
+It is usually easiest to work on the desktop app, and only test on devices/web if needed for platform integration.
+
+##### Web
+
+If you want to work on the web app using `flutter run`, then you will need to enable CORS on the server. This can be done by either passing in the `--cors-enabled` flag or by setting `PHYLUM_SERVER_CORS_ENABLED=1`. This is not required for mobile/desktop clients.
+```
+.../phylum $ PHYLUM_DB_PASSWORD=phylum go run -C server cmd/phylum.go -W .. --web-app-dir client/build/web serve --cors-enabled
+```
+
diff --git a/server/README.md b/server/README.md
deleted file mode 100644
index b4a7e722..00000000
--- a/server/README.md
+++ /dev/null
@@ -1,37 +0,0 @@
-Self-hosted cloud file storage
-
-[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
-    [x] Download folder as zip
-    [ ] Thumbnails
-[x] Bookmarks / Favorites
-[x] Internal sharing 
-    [x] List shared resources
-[x] Public sharing
-    [x] Create
-    [x] Access
-        [x] Password protection (Basic auth)
-        [x] Expiration time
-        [x] Max Accesses
-        [x] View directory listing
-        [x] Download files
-    [ ] Get Info
-        [x] Per-resource
-        [ ] By-creator
-        [ ] All (user permissions)
-[ ] Sync
-    [ ] Keep track of incremental sync state per token
-[ ] User admin
-    [ ] Permissions
-[ ] Storage backends
-[ ] Trash
-[ ] Login backends
-    [ ] LDAP
-    [ ] OIDC