https://github.com/redsuperbat/node-torrent
https://github.com/redsuperbat/node-torrent
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/redsuperbat/node-torrent
- Owner: redsuperbat
- License: mit
- Created: 2020-12-06T16:12:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-07T21:19:45.000Z (over 5 years ago)
- Last Synced: 2025-06-03T02:12:06.477Z (about 1 year ago)
- Language: Vue
- Size: 1.56 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NodeTorrent
## Project setup
```
npm install
```
### Compiles and hot-reloads for development
```
npm run start:dev
```
This starts the vue-cli build command with the watch flag as well as the express server that serves all the files.
## Description
This project is ment to run alongside plex in a docker container. Preferrably using docker compose. In the root of this project there is an example [docker compose](docker-compose.yml) that features an example setup with plex and NodeTorrent.
The docker image is available on dockerhub as maxrsb/node-torrent. Link to dockerhub is [here](https://hub.docker.com/repository/docker/maxrsb/node-torrent).
### Running it without docker
Running the project without docker is also fine. This will require Node to be installed on your system.
#### Setup
- Clone the repo
- Navigate into the root dir
- run `npm i` to install dependecies
- run `npm run build` to build the project
- run `npm run start` to start NodeTorrent
#### Specifying download directories
To specify which directories that NodeTorrent will download into you have to set specific env variables when running the project.
Specifying `/downloads` as your download directory:
Linux:
`DOWNLOAD_DIR=/downloads npm run start`
Windows:
`DOWNLOAD_DIR=/downloads && npm run start`
## Screenshots