nas-tools/README.md
2023-02-13 17:18:10 +08:00

53 lines
1.9 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

![logo-blue](https://user-images.githubusercontent.com/51039935/197520391-f35db354-6071-4c12-86ea-fc450f04bc85.png)
# NAS媒体库管理工具
[![GitHub stars](https://img.shields.io/github/stars/NAStool/nas-tools?style=plastic)](https://github.com/NAStool/nas-tools/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/NAStool/nas-tools?style=plastic)](https://github.com/NAStool/nas-tools/network/members)
[![GitHub issues](https://img.shields.io/github/issues/NAStool/nas-tools?style=plastic)](https://github.com/NAStool/nas-tools/issues)
[![GitHub license](https://img.shields.io/github/license/NAStool/nas-tools?style=plastic)](https://github.com/NAStool/nas-tools/blob/master/LICENSE.md)
[![Docker pulls](https://img.shields.io/docker/pulls/jxxghp/nas-tools?style=plastic)](https://hub.docker.com/r/jxxghp/nas-tools)
[![Platform](https://img.shields.io/badge/platform-amd64/arm64-pink?style=plastic)](https://hub.docker.com/r/jxxghp/nas-tools)
Dockerhttps://hub.docker.com/repository/docker/jxxghp/nas-tools
TG频道https://t.me/nastool
API: http://localhost:3000/api/v1/
## 功能:
NAS媒体库管理工具。
## 安装
### 1、Docker
```
docker pull jxxghp/nas-tools:latest
```
教程见 [这里](docker/readme.md) 。
如无法连接Github注意不要开启自动更新开关(NASTOOL_AUTO_UPDATE=false)将NASTOOL_CN_UPDATE设置为true可使用国内源加速安装依赖。
### 2、本地运行
python3.10版本需要预安装cython如发现缺少依赖包需额外安装
```
git clone -b master https://github.com/NAStool/nas-tools --recurse-submodule
python3 -m pip install -r requirements.txt
export NASTOOL_CONFIG="/xxx/config/config.yaml"
nohup python3 run.py &
```
### 3、Windows
下载exe文件双击运行即可会自动生成配置文件目录
https://github.com/NAStool/nas-tools/releases
### 4、群晖套件
添加矿神群晖SPK套件源直接安装
https://spk.imnks.com/
https://spk7.imnks.com/