aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorXavier Del Campo Romero <xavi92@disroot.org>2025-10-06 23:02:51 +0200
committerXavier Del Campo Romero <xavi92@disroot.org>2025-10-08 02:03:05 +0200
commit00dd37604d50cbf3fb27ec0631b4d4b6d2ee893a (patch)
tree81f9546b168078aa9bf54d4298aa76e99bb229af /README.md
parent4ab3ee681607f0cc75cf56e4fcbeae85594bb630 (diff)
downloadslcl-00dd37604d50cbf3fb27ec0631b4d4b6d2ee893a.tar.gz
Implement directory download as ZIP
Thanks to the fdzipstream library [1] and zlib [2], it is possible to generate ZIP files on-the-fly, therefore requiring no extra disk space usage and only a small amount of memory. Unfortunately, as of the time of this writing fdzipstream is not packaged by any distributions yet [3], so it had to be imported as a git submodule as a workaround. While libarchive [4] could be an interesting alternative, writing ZIP files is only supported by very recent versions (>= 3.8.0), which are still not packaged by many distributions [5], either. Moreover, libarchive is a package with several dependencies other than zlib and is significantly larger compared to fdzipstreams, so fdzipstreams was ultimately considered a better fit for this purpose. [1]: https://github.com/CTrabant/fdzipstream.git [2]: http://zlib.net/ [3]: https://repology.org/projects/?search=fdzipstream [4]: https://www.libarchive.org/ [5]: https://repology.org/project/libarchive/versions
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index e34d401..80e850f 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@ portability, minimalism, simplicity and efficiency.
- Private access directory with file uploading, with configurable quota.
- Read-only public file sharing.
+- Download directories as `.zip` files.
- Uses [`libweb`](https://gitea.privatedns.org/xavi/libweb), a tiny web framework.
- A simple JSON file as the credentials database.
- No JavaScript.
@@ -50,10 +51,13 @@ to `slcl`. If required, encryption should be done before uploading e.g.: using
- A POSIX environment.
- OpenSSL >= 2.0.
- cJSON >= 1.7.15.
+- ZLIB.
- [`dynstr`](https://gitea.privatedns.org/xavi/dynstr)
(provided as a `git` submodule by `libweb`).
- [`libweb`](https://gitea.privatedns.org/xavi/libweb)
(provided as a `git` submodule).
+- [`fdzipstream`](https://github.com/CTrabant/fdzipstream.git)
+(provided as a `git` submodule).
- `jq` (for [`usergen`](usergen) only).
- CMake (optional).
@@ -62,7 +66,7 @@ to `slcl`. If required, encryption should be done before uploading e.g.: using
#### Mandatory packages
```sh
-sudo apt install build-essential libcjson-dev libssl-dev m4 jq
+sudo apt install build-essential libcjson-dev libssl-dev m4 jq zlib1g
```
#### Optional packages