meanTorrent

by raphaeljorge

GitHub Readme.md

meanTorrent - A Private BitTorrent Tracker CMS based on meanjs/mean, and here is the DEMO Site

meanTorrent is A Private BitTorrent Tracker CMS with Multilingual support and a full-stack JavaScript open-source solution, which provides a solid starting point for MongoDB, Node.js, Express, and AngularJS based applications. The idea is to solve the common issues with connecting those frameworks, build a robust framework to support daily development needs, and help developers use better practices while working with popular JavaScript components.

Feature, Function, Screenshots First

  • Home page view home
  • Torrents list page view list
  • Torrent detail page view item
    • subtitle panel subtitle
    • users list panel ulist
    • other torrents panel other
    • admin panel adminpanel
  • Upload page view upload
  • Chat page view chat
  • User status page view status
  • User score page view score
  • Invitation detail page view invitation
  • MessageBox page view message
  • Message replies list page view reply
  • Forums list page view forum-list
  • Forum topics list page view topic-list
  • Forum topic replies list page view reply-list
  • Torrents maker group page maker
  • Movie collection list page collections
  • Movie collection detail page collectionitem
  • VIP Donate payment page donate

meanTorrent some feature:

  1. Multilingual support, now English & Chinese, you can Copy a string file modules/core/client/app/trans-string-en.js to translate it.
  2. When you want to upload a torrent, Only need to select a source torrent file, and input the movie ID origin TMDB, the movie detaill info will be autoload.
  3. One torrent can boundle many attrs tag, It's the key to search filtering.
  4. Torrent comment with full markdown style support.
  5. Oper/Admin can manager users(edit/delete etc), forbidden user(banned).
  6. OPer/Admin can manager torrents, can reviewed new torrents, set torrent sale type, set torrent recommend level, and delete torrent.
  7. Global sale set support, It provides convenience for site preferential sales setting.
  8. Client Black List support, user can not use the client list inside clientBlackList connect to the tracker server.
  9. When user to change profile picture, meanTorrent use ui-cropper to crop the image.
  10. The first sign up user auto be admin role.
  11. User signed ip / leeched ip all in db, admin can forbid user if user`s ip too many.
  12. Detailed user stats info, include account status, uploaded torrents list, seeding list, downloading list.
  13. Complete user score system, user can use score exchange an invitation to invite friend register join.
  14. Invitations manager, user can keep track of invited friends registration progress.
  15. Admin/Oper can manual management the user`s uploaded/downloaded/score data.
  16. Complete messageBox, include message list, read status, keys search, reply detail and markdown style support.
  17. Complete forum function, admin can configure each forum section and section moderators, the content support markdown style.
  18. Forum topics and replies can attach picture files and other type files, The picture file will be displayed automatically, Others file can only be downloaded.
  19. Forum replies support real edit, What you see is what you get (bootstrap-markdown), and drag & drop attach file upload.
  20. Complete thumbs-up system(thanks system), topic poster or torrent uploader will received score donate from clicker.
  21. IRC Announce support Node-irc, when user upload new torrent file, and oper/admin reviewed it, then announce the torrent info to IRC channel.
  22. Scrape torrents status from owner tracker server, design for public CMS mode, support HTTP/HTTPS/UDP tracker protocol.
  23. Complete HnR(hit and run) system support.
  24. Oper/admin can send official invitation, but all the invitation has the expired time setting.
  25. Complete music torrents support, include CD and MTV sub type.
  26. Sports and variety type torrents support NOW!
  27. Software, game, picture, ebook type torrents support NOW!
  28. Admin can update or set users Vip attribute data manual in manage page.
  29. Admin or oper can set torrent 'VIP' attribute, all these torrents only VIP user can list and download.
  30. Complete torrents maker group support, Admin can create a group and set a founder, and the founder can add or remove member users.
  31. Complete movie collections support, Admin can create a collection and insert any movie into it, user can view collection and download all torrents of the collection.
  32. Sort on torrent Vote, seeders, leechers, finished data on torrent list table head clicked events.
  33. Simple vip donate payment function, support Paypal me, Alipay Qrcode and Weixin QRcode.
  34. meanTorrent can backup mongo database into to a .tar files automatic at midnight everyday, and Admin can manage or download these files.
  35. OrderBy torrent imdb vote or site vote in torrent list table header click.
  36. User downloading progress bar or seeding status bar (ngProgress) in torrent list and home page.
  37. User email verify and account active support, inactive account can not login and announce torrent data.

Chat room feature:

  1. Users name list
  2. Oper/admin can kick(ban) user out of room
  3. Support chat message font style(Font color, Bold style, Italic style) setting online
  4. Banned user can not reconnect to chat server with an expires time(default one hour)
  5. User can not repetitive login from another location at one time
  6. Chat message bubble style

TODO

  • Add signature for forum.
  • torrent more images from TMDB
  • IRC chat
  • Business cooperation support(like play box? NAS? etc.)
  • ......more

Online support

Before You Begin

Before you begin we recommend you read about the basic building blocks that assemble a meanTorrent application:

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

$ npm install -g bower

Downloading meanTorrent

There are several ways you can get the meanTorrent boilerplate:

Cloning The GitHub Repository

The recommended way to get meanTorrent is to use git to directly clone the meanTorrent repository:

$ git clone https://github.com/taobataoma/meanTorrent.git

This will clone the latest version of the meanTorrent repository to a meanTorrent folder.

Downloading The Repository Zip File

Another way to use the MEAN.JS boilerplate is to download a zip copy from the master branch on GitHub. You can also do this using the wget command:

$ wget https://github.com/taobataoma/meanTorrent/archive/master.zip -O meanTorrent.zip; unzip meanTorrent.zip; rm meanTorrent.zip

Don't forget to rename meanTorrent-master after your project name.

Quick Install

Once you've downloaded the boilerplate and installed all the prerequisites, you're just a few steps away from starting to develop your meanTorrent application.

The boilerplate comes pre-bundled with a package.json and bower.json files that contain the list of modules you need to start your application.

To install the dependencies, run this in the application folder from the command-line:

$ npm install

This command does a few things:

  • First it will install the dependencies needed for the application to run.
  • If you're running in a development environment, it will then also install development dependencies needed for testing and running your application.
  • When the npm packages install process is over, npm will initiate a bower install command to install all the front-end modules needed for the application
  • To update these packages later on, just run npm update

If install process show error info below:

../node-icu-charset-detector.cpp:7:28: fatal error: unicode/ucsdet.h: No such file or directory

then run this command to install libicu manual

apt-get install libicu-dev OR yum install libicu-devel

Running Your Application

Run your application using npm:

$ npm start

Your application should run on port 3000 with the development environment configuration, so in your browser just go to http://localhost:3000

That's it! Your application should be running. To proceed with your development, check the other sections in this documentation. If you encounter any problems, try the Troubleshooting section.

Explore config/env/development.js for development environment configuration options.

Running in Production mode

To run your application with production environment configuration:

$ npm run start:prod

Explore config/env/production.js for production environment configuration options.

Running with TLS (SSL)

Application will start by default with secure configuration (SSL mode) turned on and listen on port 8443. To run your application in a secure manner you'll need to use OpenSSL and generate a set of self-signed certificates. Unix-based users can use the following command:

$ npm run generate-ssl-certs

Windows users can follow instructions found here. After you've generated the key and certificate, place them in the config/sslcerts folder.

Finally, execute prod task npm run start:prod

  • enable/disable SSL mode in production environment change the secure option in config/env/production.js

Getting Started With meanTorrent

Before you to start the meanTorrent application, Please explore config/env/torrent.js for many environment configuration options, you can change all configuration items of you Caring, such as:

    announce: {
      url: 'http://chd.im/announce',
      announcePrefix: '[CHD.im].',
      admin: 'admin@chd.im',
      baseUrl: 'http://chd.im',
      clientBlackListUrl: '/about/black',
      privateTorrentCmsMode: true
    },

meanTorrent tracker is private, please set the announce.url to your server url, then when user to upload torrent file, It will autocheck the torrent announce url whether matching as announce.url. But, meanTorrent support public tracker torrents CMS mode with privateTorrentCmsMode set to false, in public mode, user can upload and download public tracker torrent files, but these torrent files is can not used by meanTorrent tracker server.

    tmdbConfig: {
      //please change it to your api key from themoviedb.org
      key: '7888f0042a366f63289ff571b68b7ce0',
    },

Because meanTorrent autoload the movie info from TMDB, so please to register yourself key and replace it to tmdbConfig.key.

    language: [
      {name: 'en', index: 0, class: 'flag-icon-gb', title: 'English'},
      {name: 'zh', index: 1, class: 'flag-icon-cn', title: '中文'}
    ],

Multilingual support, if you add a new translate string file, please add configuration here. The name if value of ISO_639-1, The class is used origin flag-icon-css, you can find flag icon at /public/lib/flag-icon-css/flags.

    clientBlackList: [
      {name: 'Transmission/2.93'},
      {name: 'Mozilla'},
      {name: 'AppleWebKit'},
      {name: 'Safari'},
      {name: 'Chrome'}
    ],

This is a client Black List, all the list client can not connect to the tracker server, you can add more if you unlike some client to connect. And you can make a list page to tell users witch clients are unpopular.

    sign: {
      openSignup: true,
      allowSocialSignin: true
    },
    invite: {
      openInvite: true,
      scoreExchange: 10000,
      expires: 60 * 60 * 1000 * 24
    },

If your site do not accept user free register, please set openSignup to false, then user only can register through friend invitation or system(admin/oper) invitation. if you set openInvite to true, the normal user can invite friends to join, if false only oper/admin can invite users.

    ircAnnounce: {
      enable: true,
      debug: false,
      server: 'chd.im',
      port: 16667,
      nick: 'chdAnnounce',
      userName: 'meanTorrent',
      realName: 'IRC announce client',
      channel: '#chdAnnounce',
      showErrors: true,
      autoRejoin: true,
      autoConnect: true,
      retryCount: 86400,
      retryDelay: 5000,
      encoding: 'UTF-8'
    },

Now, IRC announce support Node-irc, this function can be used on rtorrent client, if match some words, the download client can add the torrent into download task list automatic.

    app: {
      showDemoWarningPopup: true
      showDebugLog: true
    },
    sign: {
      showDemoSignMessage: true
    },

If you started meanTorrent at production env, please set showDemoWarningPopup and showDemoSignMessage to false, this will not show demo message any where. and you can set showDebugLog to false, then the console.log info is not output.

    hitAndRun: {
      condition: {
        seedTime: 24 * 60 * 60 * 1000 * 7,
        ratio: 1.5
      },
      forbiddenDownloadMinWarningNumber: 3,
      scoreToRemoveWarning: 10000
    },

meanTorrent support complete HnR(hit and run) system, if user download a HnR torrent, then must seeding days of contition.seedTime or the upload ratio more than contition.ratio, otherwise, the user will get a HnR warning, if the warning numbers is more than forbiddenDownloadMinWarningNumber, then the user can not download any torrent. but can continue the warning torrent and seed it until the warning disappears, and the user can remove a warning by score number of scoreToRemoveWarning or donate a VIP qualifications.

    backup: {
      enable: true,
      dir: './modules/backup/client/backup/'

    }

meanTorrent can backup mongo database into to a .tar files automatic at midnight everyday, and Admin/Oper can manage or download these files. if you want to disabled this feature, please set enable to false, dir is the saved path.

mail sender configure

meanTorrent need send mail to user when restore password, send invitations etc. before send these mail, you need change the mail options in file env/development.js or env/production.js, meanTorrent used module nodemailer, if you have any config question you can find at nodemailer.

  mailer: {
    from: process.env.MAILER_FROM || 'admin@domain.com',
    options: {
      service: process.env.MAILER_SERVICE_PROVIDER || 'Gmail',
      auth: {
        user: process.env.MAILER_EMAIL_ID || 'username@gmail.com',
        pass: process.env.MAILER_PASSWORD || 'mailpassword'
      }
    }
  },

Deploying to PAAS

Deploying MEANJS To Heroku

By clicking the button below you can signup for Heroku and deploy a working copy of MEANJS to the cloud without having to do the steps above.

Deploy

Amazon S3 configuration

To save the profile images to S3, simply set those environment variables:

UPLOADS_STORAGE: s3
S3_BUCKET: the name of the bucket where the images will be saved
S3_ACCESS_KEY_ID: Your S3 access key
S3_SECRET_ACCESS_KEY: Your S3 access key password

License

The MIT License