Home server companion
stream torrent files from hosted web servers remotely!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
About The Project
There are lot of times when you want to access the specific content of a torrent file but don't want to waste bandwidth on downloading the entire file, this can be solved by downloading the file on a remote server and then browsing through the files.
- With remote file browsing / download support
- Optimized for both web and mobile views, responsive layout
- Built using React and Flask
⚡
A mobile first UI design so that you can enjoy the content seamlessly, Inspired by trending designs on Dribble.
List of commonly used resources that I find helpful are listed in the acknowledgements.
Built With
The application is containarized so that you don't need to go through the hassle of installing dependencies, tech stack used to built this application is listed below.
Getting Started
This project is focused to run on server environment hence docker containers are used to deploy the application.
Prerequisites
Installation
- Clone the repo
git clone https://github.com/imneonizer/autolycus.git
- Create
.env
file inside the project root folder, add the following to it (referexample.env
)POSTGRES_DB=autolycus # Postgresql database name POSTGRES_USER=admin # Postgresql username POSTGRES_PASSWORD=admin # Postgresql password API_URL=http://localhost:5000/api # Endpoint at which the api will be serving
- Run the containers
sudo docker-compose up
Usage
-
When you run the application for the very first time It will ask you to login, you can signup for a new account and login with the credentials.
-
Once logged in you can paste any valid torrent magnet link into the
Add Magnet
input field and it will start downloading the torrent file.
Roadmap
See the open issues for a list of proposed features (and known issues).
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the GNU General Public License v3.0. See LICENSE for more information.
Contact
Nitin Rai - @imneonizer - mneonizer@gmail.com
Project Link: https://github.com/imneonizer/autolycus