diff --git a/README.md b/README.md index 3509561..0f1bca2 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ It can be an alternative to `python -m pyftpdlib`, even though it does not cover ## Install ~~`cargo install intray`~~ -(Not published yet because some upstream denpendencies are still unstable.) +(Not published yet because some upstream dependencies are still unstable.) Visit https://github.com/Gowee/intray/releases . @@ -47,22 +47,32 @@ ARGS: ![A screenshot of Web UI](Screenshot.png) ## Notes + +### Listen on By default, intray listens on `[::]:8080`. For Linux-based system with `net.ipv6.bindv6only` be `0` (false), which is the default, it can be reached over either IPv4 -(e.g. [`http://127.0.0.1:8080`](http://127.0.0.1:8080)) or IPv6 (e.g. [`http://[::1]:8080`](http://[::1]:8080)). See also [`IPV6(7)`](http://man7.org/linux/man-pages/man7/ipv6.7.html). +(e.g. [`http://127.0.0.1:8080`](http://127.0.0.1:8080)) or IPv6 (e.g. [`http://[::1]:8080`](http://[::1]:8080)). See also +[`IPV6(7)`](http://man7.org/linux/man-pages/man7/ipv6.7.html). For Windows and Linux other than the above, it can only be reached over IPv6. In case IPv4 is preferred, specify address manually. +Intray is not serving locally by default. Keeping service exposed on the public Internet may lead to suffering from flooding. + +### Compatibility +Due to the usage of modern Web features here and there and the lack of skills of the author to set up a Babel pipeline, +Intray has poor compatibility with old-fashioned browsers, which unfortunately includes some of major browsers such as +IE and some (even slightly) old versions of Chrome and Firefox. + ## TODO - [x] Rewrite with tide (deprecating the original actix-web version). - [x] Rewrite Web UI (#1). +- [x] No chunking for small files. +- [x] Better reverse proxy support. - [ ] Authentication. -- [ ] Support HTTPS without the need to setup Web server separatedly. +- [ ] Support HTTPS without the need to set up Web server separately. - [ ] Support to limit space usage. - [ ] Upgrade tokio{,-fs} to 0.2 (still in alpha). - [ ] Fallback Web-page to support IE11 and so on. -- [ ] Support retrying failed tasks and pausing/resuming progressing tasks. -- [ ] No chunking for small file. -- [ ] Better reverse proxy support. \ No newline at end of file +- [ ] Support retrying failed tasks and pausing/resuming progressing tasks. \ No newline at end of file