Modify configuration structure. (#49)
This commit is contained in:
parent
cfede1d8f1
commit
5bb067be1a
16 changed files with 352 additions and 170 deletions
33
README.md
33
README.md
|
@ -1,10 +1,11 @@
|
|||
[![Releases][releases-shield]][releases-url]
|
||||
[![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]
|
||||
[![Coveralls][coveralls-shield]][coveralls-url]
|
||||
|
||||
[![Docker Image][docker-pulls-shield]][docker-pulls-url]
|
||||
<!-- PROJECT LOGO -->
|
||||
<br />
|
||||
<p align="center">
|
||||
|
@ -30,7 +31,7 @@
|
|||
- [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 _Expandable_ File Formats](#supported-expandable-file-formats)
|
||||
- [Supported](#supported)
|
||||
- [To Be Supported](#to-be-supported)
|
||||
- [Not Supported](#not-supported)
|
||||
|
@ -39,8 +40,6 @@
|
|||
- [Usage](#usage)
|
||||
- [Docker](#docker)
|
||||
- [Configuration File](#configuration-file)
|
||||
- [root](#root)
|
||||
- [mountpoints](#mountpoints)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
|
||||
|
@ -116,11 +115,11 @@ Docker run example:
|
|||
|
||||
```shell
|
||||
docker run \
|
||||
--rm -p 4444:4444 \
|
||||
--rm -p 4444:4444 -p 36911:36911 \
|
||||
--cap-add SYS_ADMIN \
|
||||
--device /dev/fuse \
|
||||
--security-opt apparmor:unconfined \
|
||||
-v /tmp/mountpoints:/distribyted-data/mountpoints:shared \
|
||||
-v /tmp/mount:/distribyted-data/mount:shared \
|
||||
-v /tmp/metadata:/distribyted-data/metadata \
|
||||
-v /tmp/config:/distribyted-data/config \
|
||||
distribyted/distribyted:latest
|
||||
|
@ -135,8 +134,9 @@ distribyted:
|
|||
restart: always
|
||||
ports:
|
||||
- "4444:4444/tcp"
|
||||
- "36911:36911/tcp"
|
||||
volumes:
|
||||
- /home/user/mountpoints:/distribyted-data/mountpoints:shared
|
||||
- /home/user/mount:/distribyted-data/mount:shared
|
||||
- /home/user/metadata:/distribyted-data/metadata
|
||||
- /home/user/config:/distribyted-data/config
|
||||
security_opt:
|
||||
|
@ -149,20 +149,7 @@ distribyted:
|
|||
|
||||
### 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. On Windows you can use a drive letter (`X:` per example) or a folder path that **does not exist**.|
|
||||
|torrents|List of `magnetUri`s or/and `torrentPath`s to be loaded on this fuse mount.|
|
||||
You can see the default configuration file with some explanation comments [here](templates/config_template.yaml).
|
||||
|
||||
## Contributing
|
||||
|
||||
|
@ -178,6 +165,10 @@ Contributions are what make the open-source community such an amazing place to l
|
|||
|
||||
Distributed under the GPL3 license. See `LICENSE` for more information.
|
||||
|
||||
[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
|
||||
[docker-pulls-url]:https://hub.docker.com/r/distribyted/distribyted
|
||||
[contributors-shield]: https://img.shields.io/github/contributors/distribyted/distribyted.svg?style=flat-square
|
||||
[contributors-url]: https://github.com/distribyted/distribyted/graphs/contributors
|
||||
[forks-shield]: https://img.shields.io/github/forks/distribyted/distribyted.svg?style=flat-square
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue