Difference between revisions of "APITestPage"

From FriendlyELEC WiKi
Jump to: navigation, search
(updated by API)
(updated by API)
 
(32 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Getting Started with OpenMediaVault|English]]
 
==OpenMediaVault版本信息==
 
* OS: Debian 12<br />
 
* OpenMediaVault: 7.0.5-1 (Sandworm)<br />
 
* Docker: 26.0.1<br />
 
* Others: 已安装OMV-Extras软件包<br />
 
==旧版本的OpenMediaVault文档==
 
Link to → [[Getting Started with OpenMediaVault6/zh|Getting Started with OpenMediaVault6]]
 
==OpenMediaVault运行界面==
 
[[File:Openmediavault7-zh.png|600px]]
 
==支持的平台==
 
* RK3328<br />
 
* RK3399<br />
 
* RK3568<br />
 
* RK3588<br />
 
==查看IP地址==
 
由于主机名默认为开发板的型号, 所以可以使用ping命令来获得IP地址,例如CM3588,可以用命令:
 
<syntaxhighlight lang="bash">
 
ping CM3588
 
</syntaxhighlight>
 
==登录OpenMediaVault网页后台==
 
在网页浏览器输入开发板的IP地址, 网页登录帐号默认为:
 
<syntaxhighlight lang="bash">
 
用户名: admin
 
密码: openmediavault
 
</syntaxhighlight>
 
==设置网页登录密码==
 
网页上点击右上角的头像,选择 “更改密码”
 
==默认的Linux帐号与密码==
 
普通用户:<br/>
 
&nbsp;&nbsp;&nbsp;&nbsp;用户名: pi<br/>
 
&nbsp;&nbsp;&nbsp;&nbsp;密码: pi<br/>
 
<br/>
 
Root用户:<br/>
 
&nbsp;&nbsp;&nbsp;&nbsp;用户名: root<br/>
 
&nbsp;&nbsp;&nbsp;&nbsp;密码: fa<br/>
 
==设置网页超时时间==
 
进入 '''系统 -> 工作台''',设置"自动登出"时间。
 
==通过ssh登录==
 
<syntaxhighlight lang="bash">
 
ssh pi@YourIPAddress
 
</syntaxhighlight>
 
pi用户的初始密码为 pi
 
==更新用户密码==
 
<syntaxhighlight lang="bash">
 
sudo passwd root
 
sudo passwd pi
 
</syntaxhighlight>
 
==配置网络与时区==
 
用root用户登录ssh:
 
<syntaxhighlight lang="bash">
 
ssh root@IPAddress
 
</syntaxhighlight>
 
执行如下命令:
 
<syntaxhighlight lang="bash">
 
omv-firstaid
 
</syntaxhighlight>
 
界面如下:<br />
 
[[File:Omv-firstaid.png|400px]]
 
==切换国内软件源==
 
<syntaxhighlight lang="bash">
 
sudo sed -i 's/deb.debian.org/mirrors.aliyun.com/g' /etc/apt/sources.list
 
sudo apt update
 
</syntaxhighlight>
 
==配置硬盘==
 
(注:如果硬盘之前已经初始化,无需重新擦除,RAID可以得到保留,直接挂载即可)<br />
 
更多内容请参考:[https://docs.openmediavault.org/en/latest/administration/storage/raid.html|RAID]
 
===第一步:清除硬盘===
 
进入 '''存储器 -> 磁盘''',选中你的存储器,点击'''“擦除"'''图标进行擦除 (注意备份你的数据),一般选'''“快速”'''即可。<br />
 
如果硬盘无法擦除,你需要先移除此硬盘上的共享文件夹并取消挂载。
 
===第二步:创建文件系统===
 
(注: 不支持USB 接口的硬盘,OpenMediaVault创建RAID的页面上不会列出USB接口的存储设备)
 
本章节所介绍的两种Raid配置的区别:
 
* MD RAID:性能更好,因为它在并行写入和读取分块方面做得更好。
 
* Btrfs RAID:数据安全性更好,因为校验和使其能够确定块的哪个副本出错,当只有一个副本出错时,并且它能够判断两个副本是否都有问题。
 
====方案1: 配置MD RAID====
 
* 进入 '''存储器 -> 多重装置''',点击'''“+”'''图标,在'''"级别"'''一栏选择RAID级别,在'''"设备"'''一栏钩选存储设备,保存后,状态如下所示:
 
[[File:Omv-raid-resyncing.png|400px]]<br/>
 
你需要等待状态从 resyncing 转为 clean,完成后如下图所示:<br />
 
[[File:Omv-raid-clean.png|400px]]<br/>
 
* 进入 '''存储器 -> 文件系统''',点击'''“+”''',类型建议选择'''"BTRFS"''',选择'''"Single"'''并在"设备"栏中钩选你的存储设备,如果在上一步中创建了RAID,设备名是以"/dev/md"开头的,如果你的设备在'''"设备"'''栏中没法列出,可能是设备中已存在共享文件夹等数据,尝试点击 '''►''' 图标直接挂载,如果数据可以被丢弃,则可以考虑使用如下命令擦除硬盘数据:
 
<syntaxhighlight lang="bash">
 
# 注意:硬盘中的所有数据将会丢失
 
sudo wipefs --all /dev/mdX
 
</syntaxhighlight>
 
/dev/mdX需要换成真实的设备,通过"cat /proc/partitions"命令查看。
 
* 格式化完成后,OpenMediaVault 将提示您挂载该设备。
 
====方案2: 配置Btrfs RAID====
 
* 进入 '''存储 -> 文件系统''',点击 '''"+"''' 图标,选择 '''"BTRFS"''',选择 RAID 级别,选择您的硬盘,然后保存设置。<br />
 
* 格式化完成后,OpenMediaVault 将让您选择要挂载的文件系统,它不会列出所有硬盘,因此您应选择以 /dev/nvme 开头的驱动器。
 
====方案3: 不使用RAID阵列====
 
* 进入 '''存储 -> 文件系统''',点击 '''"+"''' 图标,选择 '''"BTRFS"''',选择 Single 级别,选择您的硬盘,然后保存设置。<br />
 
* 格式化完成后,OpenMediaVault 将提示您挂载该设备。
 
==创建共享文件夹==
 
进入'''存储器 -> 共享文件夹''',添加'''"+"'''图标创建2个文件夹,名称分别为'''nfs'''和'''samba''',我们接下来将用这些文件夹来测试nfs和samba共享。<br />
 
(注:如果硬盘中存在同名的共享文件夹,重新创建同名的文件夹,数据会得到保留)
 
==创建NAS用户==
 
Debian系统的用户或通过命令行创建的Linux会缺少诸如samba之类服务的访问权限,因此这里推荐使用OpenMediaVault界面创建一个用户用于访问samba和nfs共享,这里我会创建一个名为'''nasuser'''的用户和组:<br />
 
<br />
 
* 点击'''用户 -> 用户组''',点击 '''"+"''' 图标创建一个名为 '''nasuser''' 的用户组。
 
* 点击'''用户 -> 用户''',点击 '''"+"''' 图标后创建一个名为 '''nasuser''',Shell选择/usr/sbin/nologin, 用户组钩选'''nasuser'''和'''users'''的用户。
 
==创建Samba共享==
 
* 点击'''服务 -> SMB/CIFS -> 设置''', 钩选最上面的 "已启动", 最低协议版本选择 '''"SMB1"''',然后点 "保存";
 
* 点击'''服务 -> SMB/CIFS -> 共享''', 点击 '''"+"''' ,在 '''"Shared folder"''' 处选择要共享的文件夹,这里我选择samba文件夹。
 
测试访问: <br />
 
在Mac系统下右击Finder,选择连接服务器后输入 smb://YourIPAddress(换成真实IP),会弹出验证对话框,输入用户名nasuser以及密码即可以访问。
 
==创建NFS共享==
 
* 点击"服务" -> "NFS" -> "设置", 钩选最上面的 "已启动", 在"版本"一栏中,钩选所有版本包括'''“NFSv2”''',然后点 "保存"并应用设置;
 
* 点击"服务" -> "NFS" -> "共享", 点击 '''"+"''' ,在 '''"Shared folder"''' 处选择要共享的文件夹,这里我选择 nfs 文件夹。在客户端一栏中输入 192.168.1.0/24 (换成真实网段,或指定仅允许访问的IP),权限处选择 "读/写",在扩展选项中输入:
 
<syntaxhighlight lang="bash">
 
rw,async,insecure,no_subtree_check,all_squash,anonuid=0,anongid=0
 
</syntaxhighlight>
 
然后点 "保存"并应用设置;
 
===Mac下测试挂载NFS===
 
命令行查看OpenMediaVault的NFS共享信息
 
<syntaxhighlight lang="bash">
 
# showmount -e YourIPAddress
 
Exports list on YourIPAddress:
 
/export                             192.168.1.0/24
 
/export/nfs                         192.168.1.0/24
 
</syntaxhighlight>
 
在Mac上右击Finder,选择连接服务器,在地址栏输入
 
<syntaxhighlight lang="bash">
 
nfs://YourIPAddress/export/nfs
 
</syntaxhighlight>
 
===Linux下测试挂载NFS===
 
安装软件包
 
<syntaxhighlight lang="bash">
 
sudo apt install nfs-common
 
</syntaxhighlight>
 
挂载
 
<syntaxhighlight lang="bash">
 
sudo mount -t nfs YourIPAddress:/export/nfs /mnt/nfs
 
</syntaxhighlight>
 
查看状态
 
<syntaxhighlight lang="bash">
 
# df -h | grep nfs
 
YourIPAddress:/export/nfs  7.3G  3.5M  6.8G    1% /mnt/nfs
 
</syntaxhighlight>
 
设置开机自动挂载,添加如下内容到 /etc/fstab
 
<syntaxhighlight lang="bash">
 
YourIPAddress:/export/nfs /mnt/nfs nfs defaults 0 0
 
</syntaxhighlight>
 
==Docker的使用==
 
===将Docker数据移动至硬盘===
 
先安装openmediavault-compose插件, 通过SSH登录然后执行如下命令:
 
<syntaxhighlight lang="bash">
 
sudo apt update
 
sudo apt install -y openmediavault-compose
 
</syntaxhighlight>
 
刷新网页后,进入'''存储器 -> 共享文件夹''',添加 '''"+"''' 图标创建3个文件夹,分别为
 
<syntaxhighlight lang="bash">
 
docker            -> Docker数据目录,在/etc/docker/daemon.json中定义
 
docker-compose    -> Location of compose files
 
docker-data      -> Location of persistent container data
 
docker-app        -> 自用,存放Dockerfile和数据
 
</syntaxhighlight>
 
进入'''服务 -> Compose''',进入设置界面,设置"Compose 文件"的Shared folder为docker-compose, 设置"Data“的Shared folder为docker-data,<br />
 
<br />
 
进入ssh终端,输入以下命令,将docker数据移动到共享文件夹, 其中,'''/srv/dev-disk-by-uuid-XXYYZZ/docker''' 是共享文件夹的绝对路径,可以在网页 '''存储器 -> 共享文件夹''' 列表中得到:
 
<syntaxhighlight lang="bash">
 
su root
 
systemctl stop docker.socket docker.service
 
mv /var/lib/docker/* /srv/dev-disk-by-uuid-XXYYZZ/docker/
 
</syntaxhighlight>
 
在页面上设置 '''Docker存储''' 为该docker共享文件夹的绝对路径,保存并应用后, 重启开发板。
 
<br />GUI 上填写的最终数值:<br />
 
<syntaxhighlight lang="text">
 
Compose Files's Shared folder  -> on /dev/md0, docker-compose
 
Data's Shared folder          -> on /dev/md0, docker-data
 
Docker's Docker storage        -> on /srv/dev-disk-by-uuid-XXYYZZ/docker/
 
</syntaxhighlight>
 
===Docker安装nextcloud网盘===
 
命令行界面输入以下命令即可:
 
<syntaxhighlight lang="bash">
 
su root
 
cd $(readlink -f /srv/dev-disk-by-uuid-*/docker-app)
 
mkdir nextcloud
 
cd nextcloud
 
mkdir data
 
  
docker run -d -p 8888:80  --name nextcloud \
+
{{BurnLinuxToExtDrive-Rockchip/zh|NanoPC-T4}}
    -v $PWD/data:/var/www/html --restart=always \
+
{{BurnLinuxToExtDrive-Rockchip|NanoPC-T4}}
    --privileged=true  arm64v8/nextcloud
+
</syntaxhighlight>
+
完成后在网页浏览器访问http://YourIPAddress:8888/即可看到nextcloud网盘的页面,如果无法访问,建议重启一下设备。
+
===Docker安装Filebrowser===
+
命令行界面输入以下命令即可:
+
<syntaxhighlight lang="bash">
+
su root
+
cd $(readlink -f /srv/dev-disk-by-uuid-*/docker-app)
+
mkdir filebrowser
+
cd filebrowser
+
 
+
docker run -d -v $(readlink -f /srv/dev-disk-by-uuid-*):/srv \
+
    -v $PWD/filebrowserconfig.json:/etc/config.json \
+
    -v $PWD/database.db:/etc/database.db -p 8080:80 \
+
    --restart=always --name filebrowser \
+
    filebrowser/filebrowser
+
</syntaxhighlight>
+
完成后在网页浏览器访问http://YourIPAddress:8080/即可看到Filebrowser的页面,默认管理员的帐号与密码都是admin。
+
===Docker安装Jellyfin影音服务器===
+
进入 '''存储器 -> 共享文件夹''',添加 '''"+"''' 图标创建media文件夹用于存放影音资源,然后在命令行终端输入以下命令安装Jellyfin:
+
<syntaxhighlight lang="bash">
+
su root
+
cd $(readlink -f /srv/dev-disk-by-uuid-*/docker-app)
+
mkdir jellyfin
+
cd jellyfin
+
mkdir config cache
+
 
+
docker run -d --name jellyfin \
+
-v $PWD/config:/config \
+
-v $PWD/cache:/cache \
+
-v $(readlink -f /srv/dev-disk-by-uuid-*/media):/media \
+
-p 8096:8096 \
+
--restart=always \
+
jellyfin/jellyfin
+
</syntaxhighlight>
+
完成后在网页浏览器访问http://YourIPAddress:8096/即可看到Jellyfin的页面。
+
===安装Docker可视化容器管理工具Portainer===
+
命令行界面输入以下命令即可:
+
<syntaxhighlight lang="bash">
+
su root
+
cd $(readlink -f /srv/dev-disk-by-uuid-*/docker-app)
+
mkdir portainer
+
cd portainer
+
mkdir data
+
 
+
docker run -d \
+
  --name portainer \
+
  --restart=always \
+
  -e TZ=Asia/Shanghai \
+
  -p 8000:8000 \
+
  -p 9000:9000 \
+
  -v /var/run/docker.sock:/var/run/docker.sock \
+
  -v $PWD/data:/data \
+
  portainer/portainer-ce:latest
+
</syntaxhighlight>
+
完成后在网页浏览器访问http://YourIPAddress:9000/即可看到Portainer的页面,默认管理员的帐号与密码都是admin。
+
==系统的备还与还原==
+
===备份eMMC中的系统===
+
使用tar命令备份文件系统的内容:
+
<syntaxhighlight lang="bash">
+
su root
+
cd /
+
tar --warning=no-file-changed -cvpzf /rootfs.tar.gz \
+
    --exclude=/rootfs.tar.gz --exclude=/var/lib/docker/runtimes \
+
    --exclude=/etc/firstuser --exclude=/etc/friendlyelec-release \
+
    --exclude=/usr/local/first_boot_flag --one-file-system /
+
</syntaxhighlight>
+
===还原系统到eMMC===
+
使用SD卡启动,启动Linux系统(例如Debian或Ubuntu均可),使用如下命令查询eMMC上的系统根分区:
+
<syntaxhighlight lang="bash">
+
root@CM3588:~# sudo parted -s /dev/mmcblk2 unit MiB print | grep rootfs
+
8      140MiB  59000MiB  58860MiB  ext4        rootfs
+
</syntaxhighlight>
+
根据上面的序号8可以得知根分区的设备名为/dev/mmcblk2p8,下面对它重新格式化并挂载,然后解压rootfs.tar.gz到此处:
+
<syntaxhighlight lang="bash">
+
sudo mkfs.ext4 /dev/mmcblk2p8
+
sudo mkdir /mnt/rootfs
+
sudo mount /dev/mmcblk2p8 /mnt/rootfs
+
sudo tar xvzfp /path/to/rootfs.tar.gz -C /mnt/rootfs --numeric-owner --same-owner
+
sudo poweroff
+
</syntaxhighlight>
+
关机后,拨出SD卡,重新上电从eMMC启动系统。
+
==系统重装后恢复硬盘数据==
+
* 进入 '''存储器 -> 文件系统''', 点击 '''►''' 图标,在 '''文件系统''' 一栏选择你的设备,点保存。
+
* 进入 '''存储器 -> 共享文件夹''', 创建同名共享文件名,例如本文示例中的nfs, samba, docker, docker-app, docker-compose和docker-data。
+
==常见问题与解决办法==
+
===问题: Raid阵列出现如下状态Clean, Resyncing (PENDING)===
+
Execute following command to switch array to read-write state and begin resync process:
+
<syntaxhighlight lang="bash">
+
mdadm --readwrite /dev/md0
+
</syntaxhighlight>
+
===问题: 挂载文件系统时,未列出存储设备===
+
先使用如下命令擦除硬盘数据:
+
<syntaxhighlight lang="bash">
+
# 注意:硬盘中的所有数据将会丢失
+
sudo wipefs --all /dev/mdX
+
</syntaxhighlight>
+
==OpenMediaVault软件包一览==
+
你可以使用apt命令安装OpenMediaVault的软件包,例如:
+
<syntaxhighlight lang="bash">
+
apt install openmediavault-diskstats
+
</syntaxhighlight>
+
这是每个软件包的功能列表:
+
openmediavault-diskclone: 用于克隆磁盘的工具。<br />
+
openmediavault-diskstats: 显示磁盘使用统计信息的工具。<br />
+
openmediavault-downloader: 下载管理器,用于管理下载任务。<br />
+
openmediavault-fail2ban: 防火墙软件,用于防范暴力攻击。<br />
+
openmediavault-filebrowser: 文件浏览器,用于浏览和管理文件。<br />
+
openmediavault-flashmemory: 用于将系统日志和临时文件存储在内存中以减少对磁盘的写入。<br />
+
openmediavault-forkeddaapd: 支持 iTunes 的 DAAP 服务器。<br />
+
openmediavault-ftp: FTP 服务器,用于文件传输。<br />
+
openmediavault-kernel: 内核更新工具。<br />
+
openmediavault-kvm: 虚拟化解决方案,用于运行虚拟机。<br />
+
openmediavault-locate: 文件搜索工具。<br />
+
openmediavault-luksencryption: 提供磁盘加密功能。<br />
+
openmediavault-lvm2: 逻辑卷管理器。<br />
+
openmediavault-mergerfs: 提供 Union 文件系统功能,将多个文件系统合并成一个逻辑文件系统。<br />
+
openmediavault-minidlna: DLNA 服务器,用于在网络上共享媒体文件。<br />
+
openmediavault-nut: 用于监控 UPS(不间断电源系统)的网络通信软件。<br />
+
openmediavault-omvextrasorg: 提供额外的插件和软件包。<br />
+
openmediavault-onedrive: 用于与 OneDrive 云存储服务进行集成。<br />
+
openmediavault-owntone: 用于配置 UPnP/DLNA 媒体服务器。<br />
+
openmediavault-photoprism: 相片管理软件。<br />
+
openmediavault-remotemount: 远程挂载管理器。<br />
+
openmediavault-resetperms: 重置文件和文件夹权限的工具。<br />
+
openmediavault-rsnapshot: 快照备份工具。<br />
+
openmediavault-s3: S3 存储服务插件。<br />
+
openmediavault-sftp: SFTP 服务器。<br />
+
openmediavault-shairport: AirPlay 音频服务器。<br />
+
openmediavault-sharerootfs: 允许共享根文件系统的工具。<br />
+
openmediavault-snapraid: SnapRAID 数据保护工具。<br />
+
openmediavault-snmp: SNMP(简单网络管理协议)插件。<br />
+
openmediavault-symlinks: 符号链接管理工具。<br />
+
openmediavault-tftp: TFTP(Trivial File Transfer Protocol)服务器。<br />
+
openmediavault-tgt: iSCSI 目标服务器。<br />
+
openmediavault-usbbackup: USB 备份插件。<br />
+
openmediavault-wakealarm: 用于通过计划的时间唤醒系统的工具。<br />
+
openmediavault-webdav: WebDAV 服务器。<br />
+
openmediavault-wetty: Web 终端工具。<br />
+
openmediavault-wireguard: WireGuard VPN 插件。<br />
+
openmediavault-wol: Wake-on-LAN 工具。<br />
+
openmediavault-anacron: 任务调度工具。<br />
+
openmediavault-apttool: APT(Advanced Package Tool)管理工具。<br />
+
openmediavault-autoshutdown: 自动关机工具。<br />
+
openmediavault-backup: 备份工具。<br />
+
openmediavault-borgbackup: BorgBackup 工具。<br />
+
openmediavault-clamav: ClamAV 来检测恶意软件和病毒的防病毒软件。<br />
+
openmediavault-compose: Docker Compose 工具。<br />
+
openmediavault-cputemp: 用于监控 CPU 温度的工具。<br />
+
openmediavault-zfs: ZFS 文件系统支持插件。<br />
+

Latest revision as of 09:58, 29 October 2024

1 安装系统到M.2或USB硬盘

可以通过使用TF卡启动eFlasher系统,将引导和系统分别安装到不同存储设备,但是由于CPU不支持直接从M.2和USB设备引导,所以虽然系统可以安装到M.2和USB设备,但是引导仍然需要安装到eMMC或者TF卡。
操作步骤如下:

  • 准备一张32G或以上容量的TF卡;
  • 访问此处的下载地址下载文件名为XXXX-eflasher-multiple-os-YYYYMMDD-30g.img.gz的固件(位于"01_系统固件/02_SD卡刷机固件(SD-to-eMMC)"目录);
  • 将固件写入TF卡,在NanoPC-T4上连接好存储设备,插入TF卡上电开机,接下来要在界面上操作,如果没有显示设备,可以使用VNC代替,请参考使用VNC操作eFlasher;
  • 在eFlasher界面上,首先选择要安装的OS,然后选择引导安装的目的地 (通常选eMMC),以及选择系统安装的目的地(可以选eMMC,M.2硬盘,USB存储设备等),如下图所示:

Eflasher-select-boot-and-system-device.png

  • 没有eMMC时可使用TF卡作为引导,方法是将另一个TF卡通过USB读卡器插入USB端口,然后选择USB设备作为引导安装目的地,从而实现从TF卡引导,但系统存放在M.2或USB硬盘的目的;
  • 烧写完成后,从NanoPC-T4弹出SD卡,引导在eMMC的情况下,NanoPC-T4会自动重启至你刚刚烧写的系统,如果引导安装在TF卡,则需要拨掉电源,插入TF引导卡再上电开机;
  • 更详细的安装指南请参考此处;

2 Installing the System to M.2 or USB Drive

You can use a TF card to boot the eFlasher system, allowing the boot and system to be installed on different storage devices. However, since the CPU doesn’t support booting directly from M.2 and USB devices, the system can be installed on M.2 and USB devices, but the boot must still be installed on eMMC or a TF card.
Steps are as follows:

  • Prepare a TF card with a capacity of 32GB or larger.
  • Visit [the download link here](http://download.friendlyelec.com/APITestPage) to download the firmware file named XXXX-eflasher-multiple-os-YYYYMMDD-30g.img.gz (located in the “01_Official images/02_SD-to-eMMC images” directory).
  • Flash the firmware to the TF card, connect the storage device you intend to use on NanoPC-T4, insert the TF card and power on, we need to perform the operations in the eFlasher GUI. If your NanoPC-T4 does not have a display interface, you can use VNC; refer to Using VNC to Operate eFlasher.
  • In the eFlasher GUI, select the OS to install, and in the OS settings interface, choose the destination for boot installation (typically eMMC), then choose the destination for system installation (options include eMMC, M.2 hard drive, USB storage, etc.), as shown below:

Eflasher-select-boot-and-system-device.png

  • If no eMMC is available, the TF card can serve as the boot by inserting another TF card into the USB port via a USB card reader and selecting it as the boot destination, enabling booting from the TF card with the system stored on the M.2 or USB drive.
  • After flashing, eject the SD card from NanoPC-T4. If booting from eMMC, NanoPC-T4 will automatically restart into the newly flashed system. If boot installation is on a TF card, power off, insert the boot TF card, and power on again.
  • For a more detailed installation guide, please refer to this link.