royalcat/tstor
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages1 Wiki Activity Actions

First version of proper docs. ()

Browse source 
Signed-off-by: Antonio Navarro Perez <antnavper@gmail.com>
This commit is contained in:
Antonio Navarro Perez 2021-10-07 19:03:03 +02:00 • committed by GitHub
parent e20b48b972
commit 8e70ea1404
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 201 additions and 108 deletions

114
README.md
View file

@ -10,7 +10,7 @@
<br />
<p align="center">
<a href="https://github.com/distribyted/distribyted">
<img src="docs/images/distribyted_icon.png" alt="Logo" width="100">
<img src="mkdocs/docs/images/distribyted_icon.png" alt="Logo" width="100">
</a>
<h3 align="center">distribyted</h3>
@ -25,25 +25,6 @@
</p>
</p>
<!-- TABLE OF CONTENTS -->
## Table of Contents
- [Table of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Use Cases](#use-cases)
- [Supported _Expandable_ File Formats](#supported-expandable-file-formats)
- [Supported](#supported)
- [To Be Supported](#to-be-supported)
- [Not Supported](#not-supported)
- [Getting Started](#getting-started)
- [Prerequisites on windows](#prerequisites-on-windows)
- [Usage](#usage)
- [Docker](#docker)
- [Configuration File](#configuration-file)
- [Contributing](#contributing)
- [License](#license)
<!-- ABOUT THE PROJECT -->
## About The Project
![Distribyted Screen Shot][product-screenshot]
@ -76,95 +57,12 @@ Distribyted can show some kind of files directly as folders, making it possible
#### Not Supported
- gzip: As far as I know, it doesn't support random access.
## Getting Started
## Documentation
Get the latest release from [releases][releases-url] page or download the source code and execute `make build`.
Run the program: `./distribyted-[VERSION]-[OS]-[ARCH]`
Defaults are good enough for starters, but you can change them. Here is the output of `./distribyted -help`:
```text
NAME:
distribyted - Torrent client with on-demand file downloading as a filesystem.
USAGE:
distribyted [global options] [arguments...]
GLOBAL OPTIONS:
--config value YAML file containing distribyted configuration. (default: "./distribyted-data/config.yaml") [$DISTRIBYTED_CONFIG]
--http-port value HTTP port for web interface (default: 4444) [$DISTRIBYTED_HTTP_PORT]
--fuse-allow-other Allow other users to acces to all fuse mountpoints. You need to add user_allow_other flag to /etc/fuse.conf file. (default: false) [$DISTRIBYTED_FUSE_ALLOW_OTHER]
--help, -h show help (default: false)
```
### Prerequisites on windows
Download and install [WinFsp](http://www.secfs.net/winfsp/).
## Usage
After executing and load all torrent or magnet files, a web interface will be available here: `http://localhost:4444`
It contains information about the mounted routes and torrent files like download/upload speed, leechers, seeders...
You can also modify the configuration file and reload the server from here: `http://localhost:4444/config` .
### Docker
Docker run example:
```shell
docker run \
--rm -p 4444:4444 -p 36911:36911 \
--cap-add SYS_ADMIN \
--device /dev/fuse \
--security-opt apparmor:unconfined \
-v /tmp/mount:/distribyted-data/mount:shared \
-v /tmp/metadata:/distribyted-data/metadata \
-v /tmp/config:/distribyted-data/config \
distribyted/distribyted:latest
```
Docker compose example:
```yaml
distribyted:
container_name: distribyted
image: distribyted/distribyted:latest
restart: always
ports:
- "4444:4444/tcp"
- "36911:36911/tcp"
volumes:
- /home/user/mount:/distribyted-data/mount:shared
- /home/user/metadata:/distribyted-data/metadata
- /home/user/config:/distribyted-data/config
security_opt:
- apparmor:unconfined
devices:
- /dev/fuse
cap_add:
- SYS_ADMIN
```
### Configuration File
You can see the default configuration file with some explanation comments [here](templates/config_template.yaml).
## Contributing
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
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the GPL3 license. See `LICENSE` for more information.
Check [here][main-url] or [here][doc-folder-url] for further documentation.
[doc-folder-url]: https://github.com/distribyted/distribyted/mkdocs/docs
[main-url]: https://distribyted.com
[releases-shield]: https://img.shields.io/github/v/release/distribyted/distribyted.svg?style=flat-square
[releases-url]: https://github.com/distribyted/distribyted/releases
[docker-pulls-shield]:https://img.shields.io/docker/pulls/distribyted/distribyted.svg?style=flat-square
@ -180,7 +78,7 @@ Distributed under the GPL3 license. See `LICENSE` for more information.
[releases-url]: https://github.com/distribyted/distribyted/releases
[license-shield]: https://img.shields.io/github/license/distribyted/distribyted.svg?style=flat-square
[license-url]: https://github.com/distribyted/distribyted/blob/master/LICENSE
[product-screenshot]: docs/images/distribyted.gif
[product-screenshot]: mkdocs/docs/images/distribyted.gif
[example-config]: https://github.com/distribyted/distribyted/blob/master/examples/conf_example.yaml
[coveralls-shield]: https://img.shields.io/coveralls/github/distribyted/distribyted?style=flat-square
[coveralls-url]: https://coveralls.io/github/distribyted/distribyted