Improve readme file
Signed-off-by: Antonio Navarro Perez <antnavper@gmail.com>
This commit is contained in:
parent
f6d7a5fff2
commit
9538285e0a
1 changed files with 59 additions and 7 deletions
66
README.md
66
README.md
|
@ -27,6 +27,11 @@
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
* [About the Project](#about-the-project)
|
* [About the Project](#about-the-project)
|
||||||
|
* [Use Cases](#use-cases)
|
||||||
|
* [Supported _Expandable_ File Formats](#supported-expandable-file-formats)
|
||||||
|
* [Getting Started](#getting-started)
|
||||||
|
* [Usage](#usage)
|
||||||
|
* [Configuration File](#configuration-file)
|
||||||
* [Contributing](#contributing)
|
* [Contributing](#contributing)
|
||||||
* [License](#license)
|
* [License](#license)
|
||||||
|
|
||||||
|
@ -37,19 +42,68 @@
|
||||||
|
|
||||||
Distribyted tries to make easier integrations with other applications among torrent files, presenting them as a standard filesystem.
|
Distribyted tries to make easier integrations with other applications among torrent files, presenting them as a standard filesystem.
|
||||||
|
|
||||||
We aim to use some compressed files characteristics to avoid download it entirely, just the parts that we'll need.
|
We aim to use some compressed file characteristics to avoid download it entirely, just the parts that we'll need.
|
||||||
|
|
||||||
Also, if the file format is not supported, distribyted can stream and seek through the file if needed.
|
Also, if the file format is not supported, distribyted can stream and seek through the file if needed.
|
||||||
|
|
||||||
**Note that distribyted is in alpha version, it is a proof of concept with a lot of bugs.**
|
**Note that distribyted is in alpha version, it is a proof of concept with a lot of bugs.**
|
||||||
|
|
||||||
|
### Use Cases
|
||||||
|
|
||||||
|
- Reproduce **multimedia files** on your favorite video or audio player. These files will be downloaded on demand and only the needed parts.
|
||||||
|
- Explore TBs of data from public **datasets** only downloading the parts you need. Use **Jupyter Notebooks** directly to process or analyze this data.
|
||||||
|
- Play your **ROM backups** directly from the torrent file. You can have virtually GBs in games and only downloaded the needed ones.
|
||||||
|
|
||||||
|
### Supported _Expandable_ File Formats
|
||||||
|
Distribyted 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.
|
||||||
|
|
||||||
|
#### Supported
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
#### To Be Supported
|
||||||
|
- tar: Seek to any file and inside that files using a [modified standard library](https://github.com/ajnavarro/go-tar). Not useful on `.tar.gz` files.
|
||||||
|
- 7zip: Similar to Zip. Need for a library similar to [zip](https://github.com/saracen/go7z).
|
||||||
|
- 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).
|
||||||
|
|
||||||
|
#### Not Supported
|
||||||
|
- gzip: As far as I know, it doesn't support random access.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Get the latest release from [releases](releases-url) page or download the source code and execute `make build`.
|
||||||
|
|
||||||
|
Use the [example config file](example-config) and modify it as needed.
|
||||||
|
|
||||||
|
Run the program: `distribyted-binary path/to/config/file.yaml`
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
After executing and load all torrent or magnet files, a web interface will be available with information about the mounted routes and torrent files like download/upload speed, leechers, seeders...
|
||||||
|
|
||||||
|
### Configuration File
|
||||||
|
|
||||||
|
#### root
|
||||||
|
|
||||||
|
|Config key|Description|
|
||||||
|
|-|-|
|
||||||
|
|max-cache-size| Size in MB for the cache. This is the maximum space used by distribyted to store torrent data. Less used torrent data will be discarded if this value is reached.|
|
||||||
|
|metadata-folder-name| Folder where distribyted metadata will be stored.|
|
||||||
|
|mountPoints|List of folders where torrents will be mounted as a filesystem. Possible configuration keys described [here](#mountpoints).|
|
||||||
|
|
||||||
|
#### mountpoints
|
||||||
|
|
||||||
|
|Config key|Description|
|
||||||
|
|-|-|
|
||||||
|
|path|Path where a new fuse mount will be initialized.|
|
||||||
|
|torrents|List of `magnetUri`s or/and `torrentPath`s to be loaded on this fuse mount.|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
||||||
|
|
||||||
1. Fork the Project
|
1. Fork the Project
|
||||||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
||||||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
|
||||||
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||||
5. Open a Pull Request
|
5. Open a Pull Request
|
||||||
|
|
||||||
|
@ -57,8 +111,6 @@ Contributions are what make the open source community such an amazing place to b
|
||||||
|
|
||||||
Distributed under the GPL3 license. See `LICENSE` for more information.
|
Distributed under the GPL3 license. See `LICENSE` for more information.
|
||||||
|
|
||||||
<!-- MARKDOWN LINKS & IMAGES -->
|
|
||||||
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
|
||||||
[contributors-shield]: https://img.shields.io/github/contributors/distribyted/distribyted.svg?style=flat-square
|
[contributors-shield]: https://img.shields.io/github/contributors/distribyted/distribyted.svg?style=flat-square
|
||||||
[contributors-url]: https://github.com/distribyted/distribyted/graphs/contributors
|
[contributors-url]: https://github.com/distribyted/distribyted/graphs/contributors
|
||||||
[forks-shield]: https://img.shields.io/github/forks/distribyted/distribyted.svg?style=flat-square
|
[forks-shield]: https://img.shields.io/github/forks/distribyted/distribyted.svg?style=flat-square
|
||||||
|
@ -67,8 +119,8 @@ Distributed under the GPL3 license. See `LICENSE` for more information.
|
||||||
[stars-url]: https://github.com/distribyted/distribyted/stargazers
|
[stars-url]: https://github.com/distribyted/distribyted/stargazers
|
||||||
[issues-shield]: https://img.shields.io/github/issues/distribyted/distribyted.svg?style=flat-square
|
[issues-shield]: https://img.shields.io/github/issues/distribyted/distribyted.svg?style=flat-square
|
||||||
[issues-url]: https://github.com/distribyted/distribyted/issues
|
[issues-url]: https://github.com/distribyted/distribyted/issues
|
||||||
|
[releases-url]: https://github.com/distribyted/distribyted/releases
|
||||||
[license-shield]: https://img.shields.io/github/license/distribyted/distribyted.svg?style=flat-square
|
[license-shield]: https://img.shields.io/github/license/distribyted/distribyted.svg?style=flat-square
|
||||||
[license-url]: https://github.com/distribyted/distribyted/blob/master/LICENSE
|
[license-url]: https://github.com/distribyted/distribyted/blob/master/LICENSE
|
||||||
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
|
|
||||||
[linkedin-url]: https://linkedin.com/in/distribyted
|
|
||||||
[product-screenshot]: docs/images/routes_screenshot.png
|
[product-screenshot]: docs/images/routes_screenshot.png
|
||||||
|
[example-config]: https://github.com/distribyted/distribyted/blob/master/examples/conf_example.yaml
|
Loading…
Reference in a new issue