2021-04-04 17:24:58 +00:00
[![Releases][releases-shield]][releases-url]
2020-07-31 08:57:51 +00:00
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GPL3 License][license-shield]][license-url]
2020-11-14 13:00:56 +00:00
[![Coveralls][coveralls-shield]][coveralls-url]
2021-04-04 17:24:58 +00:00
[![Docker Image][docker-pulls-shield]][docker-pulls-url]
2023-10-08 16:46:03 +00:00
2020-07-31 08:57:51 +00:00
<!-- PROJECT LOGO -->
< br / >
< p align = "center" >
2023-10-08 16:46:03 +00:00
< a href = "https://git.kmsign.ru/royalcat/tstor" >
< img src = "mkdocs/docs/images/tstor_icon.png" alt = "Logo" width = "100" >
2020-07-31 08:57:51 +00:00
< / a >
2023-10-08 16:46:03 +00:00
< h3 align = "center" > tstor< / h3 >
2020-07-31 08:57:51 +00:00
< p align = "center" >
Torrent client with on-demand file downloading as a filesystem.
< br / >
< br / >
2023-10-08 16:46:03 +00:00
< a href = "https://git.kmsign.ru/royalcat/tstor/issues" > Report a Bug< / a >
2020-07-31 08:57:51 +00:00
·
2023-10-08 16:46:03 +00:00
< a href = "https://git.kmsign.ru/royalcat/tstor/issues" > Request Feature< / a >
2020-07-31 08:57:51 +00:00
< / p >
< / p >
## About The Project
2023-10-08 16:46:03 +00:00
![tstor Screen Shot][product-screenshot]
2020-07-31 08:57:51 +00:00
2023-10-08 16:46:03 +00:00
tstor is an alternative torrent client.
It can expose torrent files as a standard FUSE, webDAV or HTTP endpoint and download them on demand, allowing random reads using a fixed amount of disk space.
2020-07-31 08:57:51 +00:00
2023-10-08 16:46:03 +00:00
tstor tries to make easier integrations with other applications using torrent files, presenting them as a standard filesystem.
2020-07-31 08:57:51 +00:00
2023-10-08 16:46:03 +00:00
**Note that tstor is in beta version, it is a proof of concept with a lot of bugs.**
2020-07-31 08:57:51 +00:00
2021-10-08 09:52:37 +00:00
## Use Cases
2020-08-03 09:21:12 +00:00
2020-08-03 09:26:39 +00:00
- Play **multimedia files** on your favorite video or audio player. These files will be downloaded on demand and only the needed parts.
2020-08-03 09:21:12 +00:00
- Explore TBs of data from public **datasets** only downloading the parts you need. Use **Jupyter Notebooks** directly to process or analyze this data.
2021-11-29 10:55:34 +00:00
- Give access to your latest dataset creation just by sharing a magnet link. People will start using your data in seconds.
2020-08-03 09:21:12 +00:00
- Play your **ROM backups** directly from the torrent file. You can have virtually GBs in games and only downloaded the needed ones.
2021-10-08 09:52:37 +00:00
## Documentation
2021-11-29 10:53:37 +00:00
Check [here][main-url] for further documentation.
2020-08-03 09:21:12 +00:00
2021-10-08 09:52:37 +00:00
## Contributing
2020-08-03 09:21:12 +00:00
2021-10-08 09:52:37 +00:00
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated** .
2020-08-03 09:21:12 +00:00
2021-11-29 10:53:37 +00:00
Some areas need more care than others:
2023-10-08 16:46:03 +00:00
- Windows and macOS tests and compatibility. I don't have any easy way to test tstor on these operating systems.
2021-11-29 10:53:37 +00:00
- Web interface. Web development is not my _forte_ .
- Tutorials. Share with the community your use case!
2020-08-03 09:21:12 +00:00
2021-11-29 17:09:53 +00:00
## Special thanks
2021-11-29 17:10:43 +00:00
- [Anacrolix BitTorrent client package and utilities][torrent-repo-url]. An amazing torrent library with file seek support.
- [Nwaples rardecode library, experimental branch][rardecode-repo-url]. The only go library that is able to seek over rar files and avoid to use `io.Discard` .
- [Bodgit 7zip library][sevenzip-repo-url]. Amazing library to decode 7zip files.
2021-11-29 17:09:53 +00:00
2021-10-08 09:52:37 +00:00
## License
2020-08-03 09:21:12 +00:00
2021-10-08 09:52:37 +00:00
Distributed under the GPL3 license. See `LICENSE` for more information.
2020-07-31 08:57:51 +00:00
2021-11-29 17:09:53 +00:00
[sevenzip-repo-url]: https://github.com/bodgit/sevenzip
[rardecode-repo-url]: https://github.com/nwaples/rardecode/tree/experimental
[torrent-repo-url]: https://github.com/anacrolix/torrent
2023-10-08 16:46:03 +00:00
[main-url]: https://tstor.com
[releases-shield]: https://img.shields.io/github/v/release/tstor/tstor.svg?style=flat-square
[releases-url]: https://git.kmsign.ru/royalcat/tstor/releases
[docker-pulls-shield]: https://img.shields.io/docker/pulls/tstor/tstor.svg?style=flat-square
[docker-pulls-url]: https://hub.docker.com/r/tstor/tstor
[contributors-shield]: https://img.shields.io/github/contributors/tstor/tstor.svg?style=flat-square
[contributors-url]: https://git.kmsign.ru/royalcat/tstor/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/tstor/tstor.svg?style=flat-square
[forks-url]: https://git.kmsign.ru/royalcat/tstor/network/members
[stars-shield]: https://img.shields.io/github/stars/tstor/tstor.svg?style=flat-square
[stars-url]: https://git.kmsign.ru/royalcat/tstor/stargazers
[issues-shield]: https://img.shields.io/github/issues/tstor/tstor.svg?style=flat-square
[issues-url]: https://git.kmsign.ru/royalcat/tstor/issues
[releases-url]: https://git.kmsign.ru/royalcat/tstor/releases
[license-shield]: https://img.shields.io/github/license/tstor/tstor.svg?style=flat-square
[license-url]: https://git.kmsign.ru/royalcat/tstor/blob/master/LICENSE
[product-screenshot]: mkdocs/docs/images/tstor.gif
[example-config]: https://git.kmsign.ru/royalcat/tstor/blob/master/examples/conf_example.yaml
[coveralls-shield]: https://img.shields.io/coveralls/github/tstor/tstor?style=flat-square
[coveralls-url]: https://coveralls.io/github/tstor/tstor
