Update README & Add contributor's guide
This commit is contained in:
Pratik Borsadiya
parent
fa8af23289
commit
54c56d57ae
25
CONTRIBUTING.md
Normal file
25
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
## Contributor's Guide
|
||||
|
||||
First off, thanks for taking the time to contribute! :tada::+1:
|
||||
|
||||
WebUI-Aria2 is an Angular JS 1.x application bundled with webpack. Follow the [Get Started Guide](#get-started) to setup the development environment. You'll need `Node > 6` and latest version of `npm` to build the source files.
|
||||
|
||||
## Get Started
|
||||
|
||||
To start developing an awesome feature or to fix a bug [fork and clone the repo](https://help.github.com/articles/fork-a-repo/) and then install Node.js > 6 and npm.
|
||||
|
||||
Next, install this package's dependencies with npm using `npm install` command.
|
||||
|
||||
Then run `npm run dev` command to start an HTTP development server on http://localhost:8888 and to watch and compile the source files.
|
||||
|
||||
Use `npm run build` to create a production ready build from source files.
|
||||
|
||||
### Useful commands
|
||||
|
||||
| Command | Purpose |
|
||||
| ------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `npm install` | will install required dependencies |
|
||||
| `npm run dev` | will start an HTTP dev server on http://localhost:8888 and will watch and compile the source files |
|
||||
| `npm run build` | will create a production build from source files |
|
||||
| `npm run analyze` | will open a bundle analyzer on port http://localhost:9999. Useful for visualizing contents of your bundle |
|
||||
| `npm run format --silent` | will format your code for consistency using Prettier |
|
||||
69
README.md
69
README.md
|
|
@ -1,43 +1,43 @@
|
|||
webui-aria2
|
||||
===========
|
||||
# WebUI-Aria2
|
||||
|
||||
|
||||
|
||||
The aim for this project is to create the worlds best and hottest interface to interact with aria2. aria2 is the worlds best file downloader, but sometimes the command line brings more power than necessary. The project was initially created as part of the GSOC scheme, however it has rapidly grown and changed with tremendous support and feedback from the aria2 community.
|
||||
|
||||
Very simple to use, no build scripts, no installation scripts. First start aria2 in the background either in your local machine or in a remote one. You can do that as follows:
|
||||
````bash
|
||||
aria2c --enable-rpc --rpc-listen-all
|
||||
````
|
||||
|
||||
```bash
|
||||
aria2c --enable-rpc --rpc-listen-all
|
||||
```
|
||||
|
||||
If aria2 is not installed in your local machine then head on to https://aria2.github.io/ and follow the instructions there.
|
||||
|
||||
Then download the webui, you can either do that by downloading this repository and running index.html in the browser. Or you could just head on to https://ziahamza.github.io/webui-aria2/ and just start downloading files! After that you can also save it for offline use by saving from the browser save page as option. You can also use node js to create simple server by using the following command from the download folder.
|
||||
````bash
|
||||
node node-server.js
|
||||
````
|
||||
Then download the webui, you can either do that by downloading this repository and running index.html from build folder in the browser. Or you could just head on to https://ziahamza.github.io/webui-aria2/ and just start downloading files! After that you can also save it for offline use by saving from the browser save page as option. You can also use node js to create simple server by using the following command from the download folder.
|
||||
|
||||
```bash
|
||||
node node-server.js
|
||||
```
|
||||
|
||||
# Tips
|
||||
|
||||
Tips
|
||||
====
|
||||
1. You can always select which files to download in case of torrents or metalinks. Just pause a download and a list icon should appear next to the settings button. To select which files to download before starting the download, give the flag --pause-metadata to aria2. See [link](https://aria2.github.io/manual/en/html/aria2c.html#cmdoption--pause-metadata)
|
||||
|
||||
Configuration
|
||||
=============
|
||||
Read and edit [configuration.js](configuration.js).
|
||||
# Configuration
|
||||
|
||||
DirectURL
|
||||
---------
|
||||
This feature allows users to download files that they download from aria2 directly from the webui dashboard. If you are familiar with how webservers work, setup a http server that points at the configured aria2 download directory, check permissions. Then Specify a full url: ```http://server:port/``` in the webui directURL configuration.
|
||||
Read and edit [configuration.js](src/js/services/configuration.js).
|
||||
|
||||
## DirectURL
|
||||
|
||||
This feature allows users to download files that they download from aria2 directly from the webui dashboard. If you are familiar with how webservers work, setup a http server that points at the configured aria2 download directory, check permissions. Then Specify a full url: `http://server:port/` in the webui directURL configuration.
|
||||
|
||||
If the above is not obvious, keep reading what this is about in [directurl.md](directurl.md)
|
||||
|
||||
Dependencies
|
||||
============
|
||||
# Dependencies
|
||||
|
||||
Well, you need aria2. And a web browser (if that even counts!)
|
||||
|
||||
Docker support
|
||||
==============
|
||||
# Docker support
|
||||
|
||||
There is two Dockerfile in this project, one is a common Dockerfile, which can be use for **testing purpose**.<br>
|
||||
The second is a **production ready** Dockerfile for arm32v7 plateforms (which includes raspberry).
|
||||
|
||||
|
|
@ -47,15 +47,15 @@ You can also try or use webui-aria2 in your LAN inside a Docker sandbox.
|
|||
|
||||
Build the image
|
||||
|
||||
````bash
|
||||
```bash
|
||||
sudo docker build -t yourname/webui-aria2 .
|
||||
````
|
||||
```
|
||||
|
||||
..and run it! It will be available at: `http://localhost:9100`
|
||||
|
||||
````bash
|
||||
```bash
|
||||
sudo docker run -v /Downloads:/data -p 6800:6800 -p 9100:8080 --name="webui-aria2" yourname/webui-aria2
|
||||
````
|
||||
```
|
||||
|
||||
`/Downloads` is the directory in the host where you want to keep the downloaded files
|
||||
|
||||
|
|
@ -64,11 +64,13 @@ sudo docker run -v /Downloads:/data -p 6800:6800 -p 9100:8080 --name="webui-aria
|
|||
This image contains both aria2 and webui-aria2.
|
||||
|
||||
Build it (may take several hours due to the aria2 compilation process. Don't panic and grab a coffee).
|
||||
|
||||
```
|
||||
docker build -f Dockerfile.arm32v7 -t yourname/webui-aria2 .
|
||||
```
|
||||
|
||||
This command will ends up building three images:
|
||||
|
||||
- The first one is just about compiling aria2 and goreman binaries. It MUST be deleted each time the `ARIA2_VERSION` is changed in the Dockerfile, otherwise you won't benefit from the update.
|
||||
- The second is about building and downloading some go dependencies (goreman and gosu).
|
||||
- The second one is the acutal aria2 container, the one you must use.
|
||||
|
|
@ -84,6 +86,7 @@ This image required few file to be mounted in the container.
|
|||
```
|
||||
|
||||
Run it
|
||||
|
||||
```
|
||||
docker run --restart=always \
|
||||
-v /home/<USER>/data/aria2/downloads:/data/downloads \
|
||||
|
|
@ -93,14 +96,18 @@ docker run --restart=always \
|
|||
-d yourname/webui-aria2
|
||||
```
|
||||
|
||||
Deploy to Heroku
|
||||
==============
|
||||
# Contributing
|
||||
|
||||
Checkout [contributor's guide](CONTRIBUTING.md) to know more about how to contribute to this project.
|
||||
|
||||
# Deploy to Heroku
|
||||
|
||||
[](https://heroku.com/deploy)
|
||||
|
||||
Support
|
||||
=======
|
||||
# Support
|
||||
|
||||
For any support, feature request and bug report add an issue in the github project. [link](https://github.com/ziahamza/webui-aria2/issues)
|
||||
|
||||
License
|
||||
=======
|
||||
# License
|
||||
|
||||
Refer to the LICENSE file (MIT License). If the more liberal license is needed then add it as an issue
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user