Difference between revisions of "APITestPage"
(updated by API) |
(updated by API) |
||
| Line 28: | Line 28: | ||
Click on the profile picture in the upper-right corner of the web page, then select "Change Password" | Click on the profile picture in the upper-right corner of the web page, then select "Change Password" | ||
==Configure the web page timeout duration== | ==Configure the web page timeout duration== | ||
| − | + | Go to "System" -> "Workbench" and adjust the "Auto Logout" time setting. | |
==Logging in via SSH== | ==Logging in via SSH== | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
| Line 45: | Line 45: | ||
ssh root@IPAddress | ssh root@IPAddress | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | == | + | ==Set up your drives and shared folders== |
The Raid Profiles: | The Raid Profiles: | ||
* MD RAID: has better performance, because it does a better job of parallelizing writes and striping reads.<br /> | * MD RAID: has better performance, because it does a better job of parallelizing writes and striping reads.<br /> | ||
| Line 51: | Line 51: | ||
===Optional 1: MD RAID=== | ===Optional 1: MD RAID=== | ||
===Step 1: Initialize the storage device=== | ===Step 1: Initialize the storage device=== | ||
| − | + | Go to '''Storage -> Disks''', select your storage device, and click the "Wipe" icon to perform disk erasure (please ensure your data is backed up). Typically, you can choose "Quick" erase.<br /> | |
If the disk can't be wiped, you need to remove the shared folder in this disk and umount it first. | If the disk can't be wiped, you need to remove the shared folder in this disk and umount it first. | ||
| − | ===Step 2: | + | ===Step 2: Configure your RAID=== |
(Note: USB interface hard drives are not supported, and OpenMediaVault will not list USB storage devices on the RAID creation page.)<br /> | (Note: USB interface hard drives are not supported, and OpenMediaVault will not list USB storage devices on the RAID creation page.)<br /> | ||
| − | Go to | + | Go to '''Storage -> Multiple Device''' click the "+" icon, choose the RAID level, and apply the settings. |
| − | ===Step 3: | + | ===Step 3: Setup file systems=== |
| − | Go to | + | Go to '''Storage" -> "File Systems''', click on the "+" icon, and for the type, it's recommended to choose "BTRFS", Select "Single" and check the storage device. <br /> |
| − | If you created a RAID in the previous step, choose a device starting with /dev/md. If it's a USB hard drive, choose /dev/sda.<br /> | + | If you created a RAID in the previous step, choose a device starting with '''/dev/md"'''. If it's a USB hard drive, choose "/dev/sda".<br /> |
After formatting is complete, openmediavault will let you choose which file system to mount, and choose the device you want to mount. | After formatting is complete, openmediavault will let you choose which file system to mount, and choose the device you want to mount. | ||
| − | ===Step 4: | + | ===Step 4: Create shared folders=== |
| − | Go to | + | 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.<br /> |
(Note: If there were previously created shared folders on the hard drive, you can recreate them with the same names, and the data will be preserved.) | (Note: If there were previously created shared folders on the hard drive, you can recreate them with the same names, and the data will be preserved.) | ||
===Optional 2: Btrfs RAID=== | ===Optional 2: Btrfs RAID=== | ||
(Note: If the hard drive has already been initialized and RAID has been preserved, you can proceed directly to step four for mounting.) | (Note: If the hard drive has already been initialized and RAID has been preserved, you can proceed directly to step four for mounting.) | ||
====Step 1: Initialize the storage device==== | ====Step 1: Initialize the storage device==== | ||
| − | + | Go to '''Storage -> Disks''', select your storage device, and click the '''Wipe''' icon to perform disk erasure (please ensure your data is backed up). Typically, you can choose "Quick" erase.<br /> | |
If the disk can't be wiped, you need to remove the shared folder on this disk and umount it first. | If the disk can't be wiped, you need to remove the shared folder on this disk and umount it first. | ||
| − | ====Step 2: Format, | + | ====Step 2: Format, Configure your RAID and Mount file system==== |
(Note: USB interface hard drives are not supported, and OpenMediaVault will not list USB storage devices on the RAID creation page.)<br /> | (Note: USB interface hard drives are not supported, and OpenMediaVault will not list USB storage devices on the RAID creation page.)<br /> | ||
| − | Go to | + | Go to '''Storage -> File Systems''' click the '''"+"''' icon, choose the '''"BTRFS"''', choose the RAID level, select your disks, and then save the settings.<br /> |
After formatting is complete, openmediavault will let you choose which file system to mount, it doesn't list all the disks, so you should choose a drive that starts with /dev/nvme. | After formatting is complete, openmediavault will let you choose which file system to mount, it doesn't list all the disks, so you should choose a drive that starts with /dev/nvme. | ||
| − | ====Step 3: | + | ====Step 3: Create shared folders==== |
| − | Go to | + | 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.<br /> |
(Note: If there were previously created shared folders on the hard drive, you can recreate them with the same names, and the data will be preserved.) | (Note: If there were previously created shared folders on the hard drive, you can recreate them with the same names, and the data will be preserved.) | ||
==Create NAS users== | ==Create NAS users== | ||
| Line 81: | Line 81: | ||
Click on "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. | Click on "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. | ||
==Create a Samba share== | ==Create a Samba share== | ||
| − | Go to | + | 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"<br /> |
<br /> | <br /> | ||
| − | Go to | + | 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<br /> |
<br /> | <br /> | ||
Testing: <br /> | Testing: <br /> | ||
| − | On Mac system, right-click Finder, select "Connect to Server | + | On Mac system, right-click Finder, select '''"Connect to Server"''', and enter "smb://YourIPAddress" (replace with the actual IP address). A authentication dialog will appear; enter the username "nasuser" and the password to access the share. |
==Create an NFS share== | ==Create an NFS share== | ||
| − | Go to | + | 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.<br /> |
<br /> | <br /> | ||
| − | Go to | + | 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: |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
rw,async,insecure,no_subtree_check,all_squash,anonuid=0,anongid=0 | rw,async,insecure,no_subtree_check,all_squash,anonuid=0,anongid=0 | ||
| Line 126: | Line 126: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==Transferring Docker Data to a Hard Drive== | ==Transferring Docker Data to a Hard Drive== | ||
| − | + | Go to '''Storage -> Shared Folders''', and click the "+" icon to create three folders, namely: | |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
docker -> The Docker data directory, defined in /etc/docker/daemon.json | docker -> The Docker data directory, defined in /etc/docker/daemon.json | ||
| Line 133: | Line 133: | ||
docker-app -> For personal use, storing Dockerfiles and data | docker-app -> For personal use, storing Dockerfiles and data | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | Go to '''Services -> Compose''' enter the "Settings" interface, and configure the "Shared folder" for "Compose Files" and "Data"，<br /> | |
<br /> | <br /> | ||
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： | 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： | ||
Revision as of 08:48, 18 April 2024
Contents
- 1 OpenMediaVault version
- 2 Earlier version OpenMediaVault
- 3 First Look
- 4 Supported platforms
- 5 Find IP Address
- 6 Access the OpenMediaVault web page
- 7 Change the web login password
- 8 Configure the web page timeout duration
- 9 Logging in via SSH
- 10 Create the root user
- 11 Set up your drives and shared folders
- 12 Create NAS users
- 13 Create a Samba share
- 14 Create an NFS share
- 15 Transferring Docker Data to a Hard Drive
- 16 Install Nextcloud with Docker
- 17 Install Filebrowser with Docker
- 18 Install Jellyfin with Docker
- 19 Install Portainer with Docker
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
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 CM35886 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 the web login password
Click on the profile picture 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 Logging in via SSH
ssh pi@YourIPAddress
The default password is "pi".
10 Create the root user
Create the root user and add user to the root and ssh groups:
sudo passwd root sudo gpasswd -a root root sudo gpasswd -a root _ssh
You can now use the root user to log in via SSH:
ssh root@IPAddress
The 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.
11.1 Optional 1: MD RAID
11.2 Step 1: Initialize the storage device
Go to Storage -> Disks, select your storage device, and click the "Wipe" icon to perform disk erasure (please ensure your data is backed up). Typically, you can choose "Quick" erase.
If the disk can't be wiped, you need to remove the shared folder in this disk and umount it first.
11.3 Step 2: Configure your RAID
(Note: USB interface hard drives are not supported, and OpenMediaVault will not list USB storage devices on the RAID creation page.)
Go to Storage -> Multiple Device click the "+" icon, choose the RAID level, and apply the settings.
11.4 Step 3: Setup file systems
Go to Storage" -> "File Systems, click on the "+" icon, and for the type, it's recommended to choose "BTRFS", Select "Single" and check the storage device.
If you created a RAID in the previous step, choose a device starting with /dev/md". If it's a USB hard drive, choose "/dev/sda".
After formatting is complete, openmediavault will let you choose which file system to mount, and choose the device you want to mount.
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 hard drive, you can recreate them with the same names, and the data will be preserved.)
11.6 Optional 2: Btrfs RAID
(Note: If the hard drive has already been initialized and RAID has been preserved, you can proceed directly to step four for mounting.)
11.6.1 Step 1: Initialize the storage device
Go to Storage -> Disks, select your storage device, and click the Wipe icon to perform disk erasure (please ensure your data is backed up). Typically, you can choose "Quick" erase.
If the disk can't be wiped, you need to remove the shared folder on this disk and umount it first.
11.6.2 Step 2: Format, Configure your RAID and Mount file system
(Note: USB interface hard drives are not supported, and OpenMediaVault will not list USB storage devices on the RAID creation page.)
Go to Storage -> File Systems click the "+" icon, choose the "BTRFS", choose the RAID level, select your disks, and then save the settings.
After formatting is complete, openmediavault will let you choose which file system to mount, it doesn't list all the disks, so you should choose a drive that starts with /dev/nvme.
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 hard drive, you can recreate them with the same names, and the data will be preserved.)
12 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":
Click on "Users" -> "Groups" and then click the "+" icon to create a user group named "nasuser".
Click on "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.
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 Mac system, right-click Finder, select "Connect to Server", and enter "smb://YourIPAddress" (replace with the actual IP address). A authentication dialog will appear; enter the username "nasuser" and the password to access the 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.
14.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 in the address bar, input:
nfs://YourIPAddress/export/nfs
14.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 set up automatic mounting at boot time, add the following line to the /etc/fstab file:
YourIPAddress:/export/nfs /mnt/nfs nfs defaults 0 0
15 Transferring Docker Data to a Hard Drive
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.
16 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 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".
18 Install Jellyfin with Docker
Access "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.
19 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".
