tstor/mkdocs/docs/index.md

37 lines
1.8 KiB
Markdown
Raw Normal View History

2023-10-08 16:46:03 +00:00
tstor is an alternative torrent client.
It can expose torrent files as a standard FUSE mount or webDAV endpoint and download them on demand, allowing random reads using a fixed amount of disk space.
2023-10-08 16:46:03 +00:00
![tstor Screen Shot][product-screenshot]
2023-10-08 16:46:03 +00:00
[product-screenshot]: images/tstor.gif
2021-10-08 09:52:37 +00:00
## Features
2021-10-08 09:52:37 +00:00
### User Interfaces
2023-10-08 16:46:03 +00:00
tstor supports several ways to expose the files to the user or external applications:
2021-10-08 09:52:37 +00:00
#### Supported
2021-10-08 09:52:37 +00:00
- FUSE: Other applications can access to torrent files directly as a filesystem.
2023-10-08 16:46:03 +00:00
- WebDAV: Applications that supports WebDAV can access torrent files using this protocol. It is recommended when tstor is running in a remote machine or using docker.
2021-11-29 10:53:37 +00:00
- HTTP: A simple HTTP interface for all the available routes. You can acces it from `http://[HOST]:[PORT]/fs`
2021-10-08 09:52:37 +00:00
### _Expandable_ File Formats
2023-10-08 16:46:03 +00:00
tstor can show some kind of files directly as folders, making it possible for applications read only the parts that they need. Here is a list of supported, to be supported and not supported formats.
2021-10-08 09:52:37 +00:00
#### Supported
2023-10-08 16:46:03 +00:00
2021-10-08 09:52:37 +00:00
- zip: Able to uncompress just one file. The file is decompressed to a temporal file sequentially to make possible seek over it. The decompression stops if no one is reading it.
2021-11-29 10:53:37 +00:00
- rar: Thanks to [rardecode](https://github.com/nwaples/rardecode/tree/experimental) experimental branch library, it is possible to seek through rar files.
- 7zip: Thanks to [sevenzip](https://github.com/bodgit/sevenzip) library, it is possible to read `7z` files in a similar way that is done using the `zip` implementation.
2021-10-08 09:52:37 +00:00
#### To Be Supported
2023-10-08 16:46:03 +00:00
2021-10-08 09:52:37 +00:00
- xz: Only worth it when the file is created using blocks. Possible library [here](https://github.com/ulikunitz/xz) and [here](https://github.com/frrad/bxzf).
2021-10-08 09:52:37 +00:00
#### Not Supported
2023-10-08 16:46:03 +00:00
2021-10-08 09:52:37 +00:00
- gzip: As far as I know, it doesn't support random access.