Add chinese readme and set it by default.

This commit is contained in:
2017-09-25 15:59:35 +08:00
parent 2f40100ed2
commit 22a43434d0
4 changed files with 102 additions and 27 deletions
+59
View File
@@ -0,0 +1,59 @@
Aria2 + AriaNg
English | [简体中文](https://github.com/wahyd4/aria2-ariang-docker/raw/master/README.md)
<!-- TOC -->
- [Features](#features)
- [How to run](#how-to-run)
- [Simple Usage](#simple-usage)
- [Full Usage](#full-usage)
- [Supported Environment Variables](#supported-environment-variables)
- [Supported Volumes](#supported-volumes)
- [Usage it in Docker compose](#usage-it-in-docker-compose)
<!-- /TOC -->
Aria2
![Screenshot](https://github.com/wahyd4/aria2-ariang-x-docker-compose/raw/master/images/ariang.png)
File Manager
![Filemanager](https://github.com/wahyd4/aria2-ariang-docker/raw/master/filemanager.png)
## Features
* Aria2 (SSL support)
* AriaNg
* Auto HTTPS Let's Encrypt
* Basic Auth
* File indexing and video playing ([File Manager](https://henriquedias.com/filemanager/))
## How to run
### Simple Usage
```shell
docker run -d --name ariang -p 80:80 -p 6800:6800 wahyd4/aria2-ariang
```
### Full Usage
```shell
docker run -d --name ariang -p 80:80 -p 6800:6800 -p 443:443 -e ENABLE_AUTH=true -e RPC_SECRET=Hello -e DOMAIN=example.com -e ARIA2_USER=user -e ARIA2_PWD=pwd -v /yourdata:/data -v /yoursslkeys/:/root/conf/key wahyd4/aria2-ariang
```
### Supported Environment Variables
* ENABLE_AUTH enable Basic auth
* ARIA2_USER Basic Auth username
* ARIA2_PWD Basic Auth
* RPC_SECRET The Aria2 RPC secret token
* DOMAIN The domain you'd like to bind
### Supported Volumes
* `/data` The folder of all Aria2 downloaded files.
* `/root/conf/key` The folder which stored Aria2 SSL `certificate` and `key` file. `Notice`: The certificate file should be named `aria2.crt` and the key file should be named `aria2.key`
## Usage it in Docker compose
Please refer <https://github.com/wahyd4/aria2-ariang-x-docker-compose>
+34 -27
View File
@@ -1,54 +1,61 @@
Aria2 + AriaNg Aria2 + AriaNg
[English]((https://github.com/wahyd4/aria2-ariang-docker/raw/master/README.EN.md)) | 简体中文
本镜像包含 Aria2、AriaNg 和File Manager,主要方便那些用户期望只运行一个镜像就能实现图形化下载文件和在线播放文件。(类似离线下载的功能),只使用一个 Docker 镜像也方便用户在群晖NAS 中运行本程序。
<!-- TOC --> <!-- TOC -->
- [Features](#features) - [功能特性](#功能特性)
- [How to run](#how-to-run) - [安装于运行](#安装于运行)
- [Simple Usage](#simple-usage) - [快速运行](#快速运行)
- [Full Usage](#full-usage) - [开启所有功能](#开启所有功能)
- [Supported Environment Variables](#supported-environment-variables) - [支持的 Docker 环境变量](#支持的-docker-环境变量)
- [Supported Volumes](#supported-volumes) - [支持的 Docker volume 属性](#支持的-docker-volume-属性)
- [Usage it in Docker compose](#usage-it-in-docker-compose) - [使用 Docker compose 来运行](#使用-docker-compose-来运行)
<!-- /TOC --> <!-- /TOC -->
Aria2
![Screenshot](https://github.com/wahyd4/aria2-ariang-x-docker-compose/raw/master/images/ariang.png) ![Screenshot](https://github.com/wahyd4/aria2-ariang-x-docker-compose/raw/master/images/ariang.png)
## Features File Manager
![Filemanager](https://github.com/wahyd4/aria2-ariang-docker/raw/master/filemanager.png)
## 功能特性
* Aria2 (SSL support) * Aria2 (SSL 支持)
* AriaNg * AriaNg 通过 UI 来操作,下载文件
* Auto HTTPS Let's Encrypt * 自动 HTTPS Let's Encrypt
* Basic Auth * Basic Auth 用户认真
* 文件管理和视频播放 ([File Manager](https://henriquedias.com/filemanager/),注意默认情况下,只能访问和管理 `/data` 目录下的文件)
## How to run ## 安装于运行
### Simple Usage ### 快速运行
```shell ```shell
docker run -d --name ariang -p 80:80 -p 6800:6800 wahyd4/aria2-ariang docker run -d --name ariang -p 80:80 -p 6800:6800 wahyd4/aria2-ariang
``` ```
### Full Usage ### 开启所有功能
```shell ```shell
docker run -d --name ariang -p 80:80 -p 6800:6800 -p 443:443 -e ENABLE_AUTH=true -e RPC_SECRET=Hello -e DOMAIN=example.com -e ARIA2_USER=user -e ARIA2_PWD=pwd -v /yourdata:/data -v /yoursslkeys/:/root/conf/key wahyd4/aria2-ariang docker run -d --name ariang -p 80:80 -p 6800:6800 -p 443:443 -e ENABLE_AUTH=true -e RPC_SECRET=Hello -e DOMAIN=example.com -e ARIA2_USER=user -e ARIA2_PWD=pwd -v /yourdata:/data -v /yoursslkeys/:/root/conf/key wahyd4/aria2-ariang
``` ```
### Supported Environment Variables ### 支持的 Docker 环境变量
* ENABLE_AUTH enable Basic auth * ENABLE_AUTH 启用 Basic auth 用户认证
* ARIA2_USER Basic Auth username * ARIA2_USER Basic Auth 用户认证用户名
* ARIA2_PWD Basic Auth * ARIA2_PWD Basic Auth 密码
* RPC_SECRET The Aria2 RPC secret token * RPC_SECRET Aria2 RPC 密匙
* DOMAIN The domain you'd like to bind * DOMAIN 绑定的域名
### Supported Volumes ### 支持的 Docker volume 属性
* `/data` The folder of all Aria2 downloaded files. * `/data` 用来放置所有下载的文件的目录
* `/root/conf/key` The folder which stored Aria2 SSL `certificate` and `key` file. `Notice`: The certificate file should be named `aria2.crt` and the key file should be named `aria2.key` * `/root/conf/key` 用户来放置 Aria2 SSL `certificate`证书和 `key` 文件. `注意`: 证书的名字必须是 `aria2.crt` Key 文件的名字必须是 `aria2.key`
## Usage it in Docker compose ## 使用 Docker compose 来运行
Please refer <https://github.com/wahyd4/aria2-ariang-x-docker-compose> 请参考 <https://github.com/wahyd4/aria2-ariang-x-docker-compose>
+9
View File
@@ -8,3 +8,12 @@
basicauth / {$ARIA2_USER} {$ARIA2_PWD} basicauth / {$ARIA2_USER} {$ARIA2_PWD}
} }
{$DOMAIN}/files {
gzip
log stdout
errors stdout
filemanager / /data
basicauth / {$ARIA2_USER} {$ARIA2_PWD}
}
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB