Difference between revisions of "APITestPage"

Revision as of 02:52, 20 April 2024

查看中文

1 OpenMediaVault version

• OS: Debian 12
  
• OpenMediaVault: 7.0.5-1 (Sandworm)
  
• Docker: 26.0.1
  
• Others: built-in OMV-Extras
  

2 Earlier version OpenMediaVault

Link to → Getting Started with OpenMediaVault6

3 First Look

4 Supported platforms

• RK3328
  
• RK3399
  
• RK3568
  
• RK3588
  

5 Find IP Address

Since the hostname is set by default to the model of the development board, you can use the "ping" command to obtain the IP address. For example, for CM3588, you can use the following command:

ping CM3588

6 Access the OpenMediaVault web page

Enter the IP address of the development board in your web browser; the default login account for the web interface is:

Username: admin
Password: openmediavault

7 Change admin password

Click on the profile icon in the upper-right corner of the web page, then select "Change Password".

8 Configure the web page timeout duration

Go to System -> Workbench and adjust the "Auto Logout" time setting.

9 Linux default passwords

Regular Account:
    User Name: pi
    Password: pi

Root:
    User Name: root
    Password: fa

10 Root Login via SSH

ssh pi@YourIPAddress

The default password is "pi".

11 Change the passwords

sudo passwd root
sudo passwd pi

12 Configuring the network and time zone

Login to your OMV via SSH as root user:

ssh root@IPAddress

Excute the following command:

omv-firstaid

Something like this should appear:

13 Set up your drives

Note: If the hard drive has already been initialized and RAID has been preserved, you should be able to mount it directly. Refre to: #How to recover files after reinstalling OpenMediaVault

13.1 Step 1: Wipe drives

Go to Storage -> Disks, choose your storage device, and click the "Wipe" icon to initiate disk erasure (please ensure your data is backed up). Typically, you can opt for a "Quick" erase option.
If wiping isn't effective, you should first remove the shared folder and unmount it.

13.2 Step 2: Setup file systems

The difference between the following two Raid Profiles:

• MD RAID: has better performance, because it does a better job of parallelizing writes and striping reads.
  
• Btrfs RAID: has better data safety, because the checksumming lets it ID which copy of a block is wrong when only one is wrong, and means it can tell if both copies are bad.
  

Note: OMV does not support RAID for USB-connected devices, for more details, please refer to the official guide: RAID

13.2.1 Optional 1: Configure MD RAID

• Go to Storage -> Multiple Device, click the "+" icon, select the desired RAID level and drives, after saving, the status is shown below:

You need to wait for the status to change from resyncing to clean, and when it's done it will look like this:

• Go to Storage -> File Systems, click on "+", it is recommended to choose "BTRFS" as the Type, select "Single" as the Profile, and select your storage device in the Device field. If you created RAID in the previous step, the device name starts with "/dev/md". If your device cannot be listed in the "Device" field, it may be because there are existing shared folders or other data on the device. Try clicking the ► icon to mount directly. If the data can be discarded, you can consider using the following command to erase the partition first:

# Note: All data on the drive will be lost
sudo wipefs --all /dev/mdX

Replace /dev/mdX with the actual device, which can be checked using the "cat /proc/partitions" command.

13.2.2 Optional 2: Configure Btrfs RAID

• Go to Storage -> File Systems click the "+" icon, choose the "BTRFS", choose the RAID level, select your drives, and then save the settings.

After formatting is complete, openmediavault will let you choose which file system to mount, it won't list all the hard drives in the RAID array; just select one of the hard drives within the array.

13.2.3 Optional 3: Not using RAID array

• Go to Storage -> File Systems, click on the "+" icon, select "BTRFS", choose the Single level, select your disk, and then save the settings.
  

After formatting is complete, OpenMediaVault will prompt you to mount the device.

13.3 Step 3: Create shared folders

• Go to Storage -> Shared Folders, click the "+" icon to create two folders named "nfs" and "samba." We will use these folders for testing NFS and Samba sharing in the following steps.
  

(Note: If there were previously created shared folders on the drive, you can recreate them with the same names, and the data will be preserved.)

14 Create NAS users

Debian system users or Linux users created via the command line may lack certain permissions required for services like Samba and NFS. Therefore, it is recommended to use the OpenMediaVault interface to create a user specifically for accessing Samba and NFS shares. Here, I will create a user and group named "nasuser":

• Go to Users -> Groups and then click the "+" icon to create a user group named "nasuser".
  
• Go to Users -> "Users then click the "+" icon to create a user named "nasuser", change user's shell to "/usr/sbin/nologin", and select the "nasuser" and "users" groups.

15 Create a Samba share

• Go to Services -> SMB/CIFS -> Settings, check the box at the top for "Enabled," select "SMB1" as the minimum protocol version, and then click "Save"
• Go to Services -> SMB/CIFS -> Shares, click the "+" button, and in the "Shared folder" field, select the folder you want to share. as an example, here i select the "samba" folder

Testing:
On a Mac system, right-click Finder, select "Connect to Server", and enter "smb://YourIPAddress" (replace with the actual IP address). An authentication dialog will appear; enter the username "nasuser" and the password to access the share.

16 Create an NFS share

• Go to Services -> NFS -> Settings, check the box at the top for "Enabled", and in the "Versions" section, select all versions, including "NFSv2", then click "Save" and apply the settings.
• Go to Services -> NFS -> Shares, click the "+" button, and in the "Shared folder" field, select the folder you want to share. here i select the "nfs" folder. In the "Client" section, enter the IP range or specific IPs that are allowed to access the share (e.g., 192.168.1.0/24). Set the permissions to "Read/Write", in the "Extra Options" field, Input:

rw,async,insecure,no_subtree_check,all_squash,anonuid=0,anongid=0

Then click "Save" and apply the settings.

16.1 Testing NFS mounting on a Mac

Viewing OpenMediaVault's NFS Share Information via Command Line:

# showmount -e YourIPAddress
Exports list on YourIPAddress:
/export                             192.168.1.0/24
/export/nfs                         192.168.1.0/24

Right-click Finder on your Mac, select "Connect to Server," and input the following in the address bar:

nfs://YourIPAddress/export/nfs

16.2 Testing NFS mounting on Linux

Installing the NFS client

sudo apt install nfs-common

Start to mount:

sudo mount -t nfs YourIPAddress:/export/nfs /mnt/nfs

Checking the Status

# df -h | grep nfs
YourIPAddress:/export/nfs  7.3G  3.5M  6.8G    1% /mnt/nfs

To configure automatic mounting at boot time, append the following line to the /etc/fstab file:

YourIPAddress:/export/nfs /mnt/nfs nfs defaults 0 0

17 Docker on OMV

17.1 Moving docker storage

First, install the openmediavault-compose plugin, login via SSH and excute the following command:

sudo apt update
sudo apt install -y openmediavault-compose

After refreshing the page，go to Storage -> Shared Folders, and click the "+" icon to create three folders, namely:

docker            -> The Docker data directory, defined in /etc/docker/daemon.json
docker-compose    -> Location of compose files
docker-data       -> Location of persistent container data
docker-app        -> For personal use, storing Dockerfiles and data

Go to Services -> Compose enter the "Settings" interface, and configure the "Shared folder" for "Compose Files" and "Data":
Access the SSH terminal and execute the following command to move Docker data to the shared folder, where "/srv/dev-disk-by-uuid-XXYYZZ/docker" represents the absolute path of the shared folder, which can be obtained from the "Storage" -> "Shared Folders" list on the web interface：

su root
systemctl stop docker.socket docker.service
mv /var/lib/docker/* /srv/dev-disk-by-uuid-XXYYZZ/docker/

On the web interface, set the "Docker storage" to the absolute path of the "docker" shared folder. save the settings and apply, and then reboot the system.

The final value filled on the Gui:

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/

17.2 Install Nextcloud with Docker

Run the following command in the terminal:

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 \
    -v $PWD/data:/var/www/html --restart=always \
    --privileged=true  arm64v8/nextcloud

you can access the Nextcloud web interface by opening a web browser and navigating to http://YourIPAddress:8888/ (replace YourIPAddress with the actual IP address of your device).

17.3 Install Filebrowser with Docker

Run the following command in the terminal:

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

After completing the setup, you can access the Filebrowser web interface by opening a web browser and navigating to http://YourIPAddress:8080/ (replace YourIPAddress with the actual IP address of your device). The default username and password for Filebrowser are both "admin".

17.4 Install Jellyfin with Docker

Go to Storage -> Shared Folders, click the "+" icon to create a "media" folder for storing multimedia resources. Then, in the command-line terminal, you can run the following command to install Jellyfin:

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

After completing the setup, you can access the Jellyfin web interface by opening a web browser and navigating to http://YourIPAddress:8096/ (replace YourIPAddress with the actual IP address of your device). This will allow you to access and manage your media content using Jellyfin.

17.5 Install Portainer with Docker

Run the following command in the terminal:

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

After completing the setup, you can access the Portainer web interface by opening a web browser and navigating to http://YourIPAddress:9000/ (replace YourIPAddress with the actual IP address of your device). The default administrator account username and password are both "admin".

18 System Backup and Restore

18.1 Backing up the System in eMMC

Use the tar command to back up the contents of the file system:

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 /

18.2 Restoring the System to eMMC

Boot from the SD card, start the Linux system (such as Debian or Ubuntu), and use the following command to query the root partition of the system on eMMC:

root@CM3588:~# sudo parted -s /dev/mmcblk2 unit MiB print | grep rootfs
 8      140MiB   59000MiB  58860MiB  ext4         rootfs

According to the mathematical index 8 mentioned above, the device name for the root partition is /dev/mmcblk2p8. Below, it will be reformatted, mounted, and then the rootfs.tar.gz will be decompressed here:

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

After shutting down, remove the SD card, and then power on again to boot the system from eMMC.

19 How to recover files after reinstalling OpenMediaVault

• Go to Storage -> File System, click on the ► icon, and select your device in the File System section, then click Save.
• Go to Storage -> Shared Folders, create shared folders with the same names, such as nfs, samba, docker, docker-app, docker-compose, and docker-data, as shown in this document.

20 Common problems and solutions

20.1 Problem: RAID array appears in the status: "Clean, Resyncing (PENDING)"

Execute following command to switch array to read-write state and begin resync process:

mdadm --readwrite /dev/md0

20.2 Problem: Can´t create Filesystem - Disk not showing

using the following command to erase the partition first:

# Note: All data on the disk will be lost
sudo wipefs --all /dev/mdX

21 OpenMediaVault packages

You can install OpenMediaVault packages using the apt command, for example:

apt install openmediavault-diskstats

Here is the list of each package with its functionality: openmediavault-diskclone: Tool for cloning disks.
openmediavault-diskstats: Tool for displaying disk usage statistics.
openmediavault-downloader: Download manager for managing download tasks.
openmediavault-fail2ban: Firewall software for preventing brute-force attacks.
openmediavault-filebrowser: File browser for browsing and managing files.
openmediavault-flashmemory: Tool for storing system logs and temporary files in memory to reduce disk writes.
openmediavault-forkeddaapd: DAAP server with iTunes support.
openmediavault-ftp: FTP server for file transfer.
openmediavault-kernel: Tool for kernel updates.
openmediavault-kvm: Virtualization solution for running virtual machines.
openmediavault-locate: Tool for file searching.
openmediavault-luksencryption: Provides disk encryption functionality.
openmediavault-lvm2: Logical Volume Manager.
openmediavault-mergerfs: Provides Union file system functionality to merge multiple file systems into one logical file system.
openmediavault-minidlna: DLNA server for sharing media files over the network.
openmediavault-nut: Network UPS Tools for monitoring UPS (Uninterruptible Power Supply) communication.
openmediavault-omvextrasorg: Provides additional plugins and packages.
openmediavault-onedrive: Integration with OneDrive cloud storage service.
openmediavault-owntone: Configuration tool for UPnP/DLNA media server.
openmediavault-photoprism: Photo management software.
openmediavault-remotemount: Remote mount manager.
openmediavault-resetperms: Tool for resetting file and folder permissions.
openmediavault-rsnapshot: Snapshot backup tool.
openmediavault-s3: S3 storage service plugin.
openmediavault-sftp: SFTP server.
openmediavault-shairport: AirPlay audio server.
openmediavault-sharerootfs: Tool to allow sharing of the root file system.
openmediavault-snapraid: SnapRAID data protection tool.
openmediavault-snmp: SNMP (Simple Network Management Protocol) plugin.
openmediavault-symlinks: Symbolic link management tool.
openmediavault-tftp: TFTP (Trivial File Transfer Protocol) server.
openmediavault-tgt: iSCSI target server.
openmediavault-usbbackup: USB backup plugin.
openmediavault-wakealarm: Tool for waking up the system at scheduled times.
openmediavault-webdav: WebDAV server.
openmediavault-wetty: Web terminal tool.
openmediavault-wireguard: WireGuard VPN plugin.
openmediavault-wol: Wake-on-LAN tool.
openmediavault-anacron: Task scheduling tool.
openmediavault-apttool: APT (Advanced Package Tool) management tool.
openmediavault-autoshutdown: Automatic shutdown tool.
openmediavault-backup: Backup tool.
openmediavault-borgbackup: BorgBackup tool.
openmediavault-clamav: Antivirus software using ClamAV to detect malware and viruses.
openmediavault-compose: Docker Compose tool.
openmediavault-cputemp: Tool for monitoring CPU temperature.
openmediavault-zfs: ZFS file system support plugin.