Files
nas-media-player/README.md
2026-04-19 05:07:07 +08:00

113 lines
5.0 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.
# NAS Media Player
轻量级NAS媒体播放器专为多架构Linux系统设计armhf/arm64/x86_64完美兼容嵌入式设备如hi3798mv100和常规Ubuntu/Debian发行版提供视频文件浏览、播放、上传、目录管理、私密目录保护等核心功能开箱即用。
## 🌟 功能特性
- **多架构适配**自动识别armv7l(armhf)、aarch64(arm64)、x86_64架构无需手动选择二进制文件
- **核心功能**:视频文件浏览/播放、大文件上传、目录创建/删除、私密目录密码保护
- **轻量化部署**单脚本一键安装自动配置systemd服务开机自启
- **日志可视化**:运行日志固定存储在程序目录,便于问题排查
- **兼容性强**适配嵌入式设备如hi3798mv100和普通Linux服务器
## 🚀 快速开始
## 一、海纳思系统安装方法
> [!TIP]
> 海纳思系统,直接如下安装即可
> apt update && apt install -y nas-media-player
> 忽略下面一切
## 二、其他ubuntu/debian系统
> [!TIP]
> 非海纳思系统,则推荐用以下命令快速运行容器,无需手动配置:
```
docker run -d \
--name nas-media-player \
-p 8800:8800 \
-v ~/nas-media:/mnt \
--restart always \
slitazcn/nas-media-player:latest
```
## 三、进阶者脚本安装
### 1. 环境要求
- 系统LinuxUbuntu/Debian/嵌入式Linux支持systemd最佳
- 权限需root权限sudo
- 网络:克隆仓库需网络连通(部署后无网络也可使用)
### 2. 克隆仓库
```bash
git clone https://github.com/teasiu/nas-media-player.git
cd nas-media-player
```
### 3. 一键安装 & 启动
安装脚本会自动完成「架构检测→文件部署→服务配置→启动运行」全流程:
```bash
sudo ./install.sh install
```
### 4. 访问服务
安装完成后,在浏览器中访问以下地址即可使用:
```plaintext
http://[你的设备IP]:8800
```
示例:`http://192.168.101.141:8800`
## ⚙️ 常用命令
| 功能 | 执行命令 | 说明 |
|--------------|---------------------------------------------------|-----------------------------------------|
| 启动服务 | `sudo ./install.sh start` | 启动NAS Media Player服务 |
| 停止服务 | `sudo ./install.sh stop` | 停止运行中的服务 |
| 重启服务 | `sudo ./install.sh restart` | 重启服务(配置修改后生效) |
| 查看状态 | `sudo ./install.sh status` | 查看服务运行状态、端口监听、目录状态 |
| 查看日志 | `tail -f /opt/nas-media-player/nas-media-player.log` | 实时查看运行日志 |
| 卸载服务 | `sudo ./install.sh uninstall` | 卸载程序(保留/mnt媒体目录文件 |
| 查看帮助 | `sudo ./install.sh help` | 查看所有可用命令 |
## 🛠️ 配置说明
核心配置可在`install.sh`脚本头部修改,无需改动代码:
| 配置项 | 默认值 | 说明 |
|--------------|-------------------------|---------------------------------------|
| `APP_DIR` | `/opt/nas-media-player` | 程序安装目录 |
| `PORT` | `8800` | 服务监听端口 |
| `VIDEO_DIR` | `/mnt` | 媒体文件存储根目录 |
| `LOG_FILE` | `${APP_DIR}/nas-media-player.log` | 运行日志文件路径 |
## ❓ 常见问题
### Q1安装后端口8800未监听
- 嵌入式设备启动可能有延迟等待1分钟后重试
- 执行`sudo ./install.sh status`查看服务状态;
- 查看日志排查:`tail -f /opt/nas-media-player/nas-media-player.log`
### Q2上传文件失败/目录创建报错?
- 检查`/mnt`目录权限:`sudo chmod 777 /mnt`
- 确认磁盘空间充足,大文件上传建议使用有线网络。
### Q3不支持的架构报错
- 仅支持armhf/arm64/x86_64架构执行`uname -m`查看系统架构。
### Q4卸载后重新安装失败
- 先执行`sudo ./install.sh uninstall`清理残留,再重新安装。
## 📂 目录结构
```plaintext
nas-media-player/
├── install.sh # 一键安装/管理脚本
├── nas-media-player.py # 主程序源码
├── index.html # 前端页面
├── zhinan.html # 帮助页面
├── releases/ # 多架构二进制文件目录
│ ├── nas-media-player-armhf
│ ├── nas-media-player-arm64
│ └── nas-media-player-x86_64
└── README.md # 说明文档
```
## 📄 许可证
本项目采用 MIT 许可证 - 详见 `LICENSE` 文件。
## 🤝 贡献
欢迎提交Issue反馈问题或PR优化功能提交前请确保脚本在多架构环境下测试通过。