Configuration/browse: Difference between revisions

From Snakeoil OS Reference
Jump to navigation Jump to search
No edit summary
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{abox|This page is available in activated editions only.}}
{{abox|This page is available in activated editions only.}}
{{DISPLAYTITLE: File Manager}}{{TopicConfiguration|float:right;}}A web based file browser is introduced in Blind Testing U8 (1.1.8).
{{DISPLAYTITLE: Browse}}{{TopicConfiguration|float:right;}}A web based file browser was introduced in Blind Testing U8 (1.1.8).


This feature gives you another option to manage your music and playlists, compared to the more traditional way of [[Configuration/music-library#Copying Files Over Network|file sharing]]. Here is the look and layout of the File Manager:
This feature gives you another option to manage your music and playlists, compared to the more traditional way of [[Configuration/music-library#Copying Files Over Network|file sharing]].
[[File:FileBrowser.png|center|thumb|810x810px|File Browser]]Created initially as a simple way to copy music files to your RAM disk, it has slowly expanded into a full file management module. The File manager is split into 3 logical components: ''[[Configuration/browse#Summary|Summary]], [[Configuration/browse#Contents|Contents]]'' and ''[[Configuration/browse#Command Panel|Command Panel]]''. Read on to find learn the functionalities of each panel.  
 
Click on the "Browse" item on the right to access this module. This is the look and layout of Browse:
[[File:Browse top.jpg|alt=|center|thumb|800x800px|File Browser]]
Created initially as a simple way to copy music files to your RAM disk, it has slowly expanded into a full file management module. Browse is split into 3 logical components: ''[[Configuration/browse#Summary|Summary]], [[Configuration/browse#Contents|Contents]]'' and ''[[Configuration/browse#Command Panel|Command Panel]]''. Read on to find learn the functionalities of each panel.  


==System Limitations==
==System Limitations==
Line 36: Line 39:
==Summary==
==Summary==
The summary panel contains all the information associated in the files currently viewed under the Contents panel.
The summary panel contains all the information associated in the files currently viewed under the Contents panel.
[[File:Summary.png|center|thumb|831x831px|File Manager Summary]]
[[File:Browse no Ram.jpg|center|thumb|831x831px|File Manager Summary]]


====RAM Disk Status====
====RAM Disk Status====
This shows whether RAM Disk is working properly or not. The commands [[Configuration/browse#Add To RAM|Add To RAM]] and [[Configuration/browse#Replace RAM|Replace RAM]] will be available if this is ticked (✓). This is a sign that your RAM disk is configured and working normally.[[File:RAM Disk Status.png|center|thumb|831x831px|Ram Disk Status]]A cross <big>(✗) indicates one of the following:</big>
This shows whether RAM Disk is working properly or not. The commands [[Configuration/browse#Add To RAM|Add To RAM]] and [[Configuration/browse#Replace RAM|Replace RAM]] will be available if this is ticked (✓). This is a sign that your RAM disk is configured and working normally.
[[File:Browse with Ram highlight.jpg|center|thumb|831x831px|Ram Disk Status]]
A cross <big>(✗) indicates one of the following:</big>


#RAM Disk is disabled
#RAM Disk is disabled
Line 47: Line 52:


====Refresh File Contents====
====Refresh File Contents====
Click on this button to refresh the file contents.[[File:Refresh File Contents.png|center|thumb|831x831px|Refresh File Contents]]Useful if you have managed files from another interface and want the contents to be updated here. Or you want to reset your selections.
Click on this button to refresh the file contents.
[[File:BrowseRefresh.jpg|center|thumb|831x831px|Refresh File Contents]]
Useful if you have managed files from another interface and want the contents to be updated here. Or you want to reset your selections.


====Switch Views====
====Switch Views====
You can switch between ''Music'' and ''Playlists'' to manage your media library.
You can switch between ''Music'' and ''Playlists'' to manage your media library.
[[File:Switch Media View.png|center|thumb|831x831px|Switch Media View]]
[[File:Browse first line.jpg|center|thumb|831x831px|Switch Media View]]
MusicPD (MPD) and Logitech Media Server (LMS) are configured to look under the ''Music'' share for music content (wav, flac, dsd, dsf, etc) and the ''Playlists'' share for playlists (.m3u). Other players do not necessary follow this convention. You are free to manage your media library any way you see fit. The file locations are as follows:
The most popular music players, Music Player Daemon (MPD) and Logitech Media Server (LMS), are configured to look under the ''Music'' share for music content (wav, flac, dsd, dsf, etc) and the ''Playlists'' share for playlists (.m3u). Other players do not necessary follow this convention. You are free to manage your media library any way you see fit. The file locations are as follows:
{| class="wikitable"
{| class="wikitable"
!View Name
!View Name
Line 63: Line 70:
|/media/playlists
|/media/playlists
|}
|}
Playlists are useful for copying music to RAM disk.  While you can use playlists to manage files, it is easier, and faster, to manage them directly.


====Path====
====Path====
This shows you file path you're currently in (i.e. how "deep" you are from the root).
This shows you file path you're currently in (i.e. how "deep" you are from the root).
[[File:Summary Panel Path.png|center|thumb|831x831px|Summary Panel Path]]
[[File:Browse path.jpg|center|thumb|831x831px|Summary Panel Path]]
You can move around the directory structure easily by double clicking on any path here. In the example above you double click on ''two'' to switch to /media/music/two, and so on. To return to the root, click the Home (🏠) button.
You can move around the directory structure easily by double clicking on any path here. In the example above you double click on ''pa'' to switch to /media/music/pa, and so on. To return to the root, click the Home (🏠) button.


==Contents==
==Contents==
This panel display the files under the path. The items here scrollable remember to scroll down or up if the file you are looking for is not in view.
This panel display the files under the path. The items here scrollable remember to scroll down or up if the file you are looking for is not in view.
[[File:File-Contents.png|center|thumb|810x810px|File Listing]]
[[File:Adele list.jpg|center|thumb|810x810px|File Listing]]


===Navigating The File System===
===Navigating The File System===
Sub-directories have a folder icon (🗀) prefixed to the name. You can double-click the folder to go in, or single-click to select all the contents in this folder. You can quickly move around the directory structure by clicking on any path in the [[Configuration/browse#Summary|Summary]] panel. You can also click on the up arrow (🠙) to return to the parent folder.
Sub-directories have a folder icon (🗀) prefixed to the name. You can double-click the folder to go in, or single-click to select all the contents in this folder. You can quickly move around the directory structure by clicking on any path in the [[Configuration/browse#Summary|Summary]] panel. You can also click on the up arrow (🠙) to return to the parent folder.
[[File:File-Contents-Return-To-Parent.png|center|thumb|830x830px|Double click here to return to the parent folder]]
[[File:Adele parent.jpg|center|thumb|830x830px|Double click here to return to the parent folder]]
Everything else are files, and they can only be toggled on or off. The [[Configuration/browse#Command Panel|Command Panel]] will change accordingly. Refer to the next section for more details.
Everything else are files, and they can only be toggled on or off. The [[Configuration/browse#Command Panel|Command Panel]] will change accordingly. Refer to the next section for more details.
[[File:File-Contents-Selection.png|center|thumb|810x810px|Command Panel changes according to file selections]]
[[File:Adele select.jpg|center|thumb|810x810px|Command Panel changes according to file selections]]
You can always reset your selection by clicking the [[Configuration/browse#Refresh File Contents|refresh]] button in the [[Configuration/browse#Summary|Summary panel]].
You can always reset your selection by clicking the [[Configuration/browse#Refresh File Contents|refresh]] button in the [[Configuration/browse#Summary|Summary panel]].


You can only select files in the current view. For example, in the above example where 06.dsd, 07.dsd and 10.dsd are selected. If I proceed to enter any of the child folders (abc, ad, one or test), the current selection will be lost. So remember to perform your file operations before switching views or change your directory.
You can only select files in the current view. For example, in the above example where Adele 25 folder and 01 Hometown Glory.flac, 05 Set Fire to the Rain.flac are selected. If I proceed to enter any of the child folders (Adele 25), the current selection will be lost. So remember to perform your file operations before switching views or change your directory.
 
===Add File(s)===
You can now add files easily to your Snakeoil PC by clicking on the Add button in the Command Panel to upload the file.
[[File:Browse add file.jpg|center|thumb|818x818px|Add file]]
<br />
[[File:Upload files.jpg|center|thumb|300x300px|Uploading files]]
You will see a progress screen while uploading files to your folders. Please wait patiently for the operation to complete.
 
New to 1.2.6 is a useful tool to monitor progress and may help diagnose problems. With a computer browser, use F12 to bring up a Console screen similar to this.
[[File:Browse F12.jpg|center|thumb|800x800px|Monitor progress with F12]]
F12 is not available on mobile devices.
 


===Drag And Drop To Add File(s)===
You can now add files easily to your Snakeoil PC. Simply drag and drop any file into the contents window to add the file to the current location. Note this yellow box is shown in this wiki for <u>illustrative purposes</u> only. You will not see this yellow box in the Snakeoil WebApp. You can also click on the Add button in the Command Panel to upload the file.[[File:File-Contents-Add-File.png|center|thumb|818x818px|Drop any file into the yellow box to upload.]]
You should see this when adding files, please wait patiently for the operation to complete.
[[File:File-Contents-Uploading.png|center|thumb|812x812px|Progress Bar]]
The file will be shown automatically once the upload is complete.
The file will be shown automatically once the upload is complete.
[[File:File-Contents-Uploaded.png|center|thumb|807x807px|Upload completed]]
[[File:Browse upload done.jpg|center|thumb|807x807px|Upload completed]]
If you have more files to add, drop them one after another now.
<br />
 
Multiple uploads will hopefully be supported in a future update.


==Command Panel==
==Command Panel==
Here you can perform basic file system operations on your media files. Some functions are only active if  
Here you can perform basic file system operations on your media files. Some functions are only active if  
[[File:FileCommandPanel.png|center|thumb|686x686px|File Browser Command Panel]]
[[File:Browse command panel.jpg|center|thumb|686x686px|File Browser Command Panel]]


===New Folder===
===New Folder===
Line 100: Line 114:


Click on this button to create a new sub-folder. Do now use any of the following disallowed characters:
Click on this button to create a new sub-folder. Do now use any of the following disallowed characters:
  \ / : * ? | " ' &
  \ /<span> </span>: * ? | " ' &
The ''Confirm'' will be activated when you enter a valid name. Click this button to create the folder. Or ''Cancel'' to return.[[File:File-Command-Create-Folder.png|center|thumb|809x809px|Create A new Sub-folder]]You will be placed automatically inside this child-folder on creation.  
The ''Confirm'' will be activated when you enter a valid name. Click this button to create the folder. Or ''Cancel'' to return.
[[File:Browse add folder.jpg|center|thumb|809x809px|Create A new Sub-folder]]
You will be placed automatically inside this child-folder on creation.  


===Add===
===Add File(s)===
This command is only available when no folders/files are selected.
This command is only available when no folders/files are selected.


Line 109: Line 125:


===Delete===
===Delete===
Select the files you want to delete, then click this button to delete them permanently. You will be prompted a list of files (and it's children if present) to be deleted. Click ''Confirm'' to bein the delete operation, or ''Cancel'' to return.
Select the files you want to delete, then click this button to delete them permanently. You will be prompted a list of files (and it's children if present) to be deleted. Click ''Confirm'' to begin the delete operation, or ''Cancel'' to return. <blockquote>WARNING: Please pause before confirming.  There is no undo</blockquote>
[[File:FileCommandConfirmDelete.png|center|thumb|822x822px|Confirm Delete]]
[[File:Browse delete.jpg|center|thumb|822x822px|Confirm Delete]]
Note that the delete operation cannot be undone.
<br />


===Add To RAM===
===Copy RAM===
Snakeoil Blind Testing U7 and onwards allows you to create your own RAM disk. You can use this command to copy music files to this low latency, non-persistent storage.
Snakeoil Blind Testing U7 and onwards allows you to create your own RAM disk. You can use this command to copy music files to this low latency, non-persistent storage.


Select the files in your current view and click this button to add to he RAM disk.  
Select the files in your current view and click this button to add to the RAM disk.  
[[File:FileCommandCopyToRam.png|center|thumb|803x803px|These files will be copied to your RAM disk]]
[[File:Browse copy ram.jpg|center|thumb|802x802px|These files will be copied to your RAM disk]]
There is minimal file checking in place. So make sure you allocate a big enough RAM disk for this to work. The file manager will start copying the files one by one and stop when the RAM disk storage is full.
There is minimal file checking in place. So make sure you allocate a big enough RAM disk for this to work. The file manager will start copying the files one by one and stop when the RAM disk storage is full. Copy to RAM is now done in it's own thread.
 
 
New to 1.2.6 is a useful tool to monitor progress and may help diagnose problems. With a computer browser, use F12 to bring up a Console screen similar to this.
[[File:Browse F12.jpg|center|thumb|800x800px]]
 
 
New to 1.2.6 is the ability to view and manage files in Ram disk.
[[File:Browse ram.jpg|center|thumb|800x800px|Browse RAM disk]]
You can delete the files in RAM disk.  You can use Add File within RAM Disk as an alternative to Copy Ram.  Adding a Folder is also possible.
 


This command works differently when you're in the ''Playlists'' view. When you add a playlist, the music files themselves are copied over to the RAM disk. Adding playlist makes it more convenient to copy files from across sub-directories.
This command works differently when you're in the ''Playlists'' view. When you add a playlist, the music files themselves are copied over to the RAM disk.  
[[File:Browse add playlist.jpg|center|thumb|800x800px|Add music to RAM disk using playlists]]
Adding playlist makes it more convenient to copy files from across sub-directories. You will get a warning message if a file is missing in the playlist.


Depending on your player, the music will either show up automatically or not (do a database rescan or equivalent refresh).
Depending on your player, the music will either show up automatically or not (do a database rescan or equivalent refresh).
Line 127: Line 155:


Use this to quickly replace your music on your RAM disk.
Use this to quickly replace your music on your RAM disk.
[[File:FileCommandReplaceRam.png|center|thumb|812x812px|Replace your RAM music with these]]
[[File:Browse replace ram.jpg|center|thumb|812x812px|Replace your RAM music with these]]
RAM storage and playlist function works the same way as ''Add To RAM''.{{ManualNavigation|[[Configuration]]
RAM storage and playlist function works the same way as ''Add To RAM''.{{ManualNavigation|[[Configuration]]
|[[configuration/system|System]]
|[[configuration/system|System]]
|[[configuration/snakeoil|Snakeoil]]
|[[configuration/snakeoil|Snakeoil]]
}}
}}
[[Category:Configuration]]

Latest revision as of 12:20, 30 August 2022

!icon.png This page is available in activated editions only.

A web based file browser was introduced in Blind Testing U8 (1.1.8).

This feature gives you another option to manage your music and playlists, compared to the more traditional way of file sharing.

Click on the "Browse" item on the right to access this module. This is the look and layout of Browse:

File Browser

Created initially as a simple way to copy music files to your RAM disk, it has slowly expanded into a full file management module. Browse is split into 3 logical components: Summary, Contents and Command Panel. Read on to find learn the functionalities of each panel.

System Limitations

A HTML5 based application has limitations, here is a non-exhaustive list:

Limitation Description
Modern Browser This is a HTML5 application, and thus require a modern HTML5 browser. Internet Explorer or Safari will be hit and miss. Please use modern browsers as recommended here.
File Permissions File operations are performed by the root user (UID=0). The root user need to have full access to the music and playlists folder. This means you need to grant READ/WRITE permissions to your share folder if you are mounting this from a NAS.
Single File Operation You can only drag and drop one file at a time. Only the first file is uploaded when you drag and drop multiple files.
Overwrite Existing Files Existing files with the same name will be overwritten. Overwritten files will be gone forever.
File Encodings This is tested only with UTF-8 filenames. Please file a bug if the manager has problem managing your files that's using a different encoding system.
No Recycle Bin There is no recycle bin. Any files deleted will not be recoverable.
Double Clicks You need to use a mouse to navigation the directory structure. Not sure if MacOS have double clicks?

You can always fallback to the traditional methods for file management duties if the above limitations are unacceptable,

Summary

The summary panel contains all the information associated in the files currently viewed under the Contents panel.

File Manager Summary

RAM Disk Status

This shows whether RAM Disk is working properly or not. The commands Add To RAM and Replace RAM will be available if this is ticked (✓). This is a sign that your RAM disk is configured and working normally.

Ram Disk Status

A cross (✗) indicates one of the following:

  1. RAM Disk is disabled
  2. RAM disk creation failure

Refer to the Snakeoil RAM configuration for details. Note that RAM disk is an experimental feature for now and only configurable if you're Snakeoil is activated. Refer to this wiki for more information about activation,

Refresh File Contents

Click on this button to refresh the file contents.

Refresh File Contents

Useful if you have managed files from another interface and want the contents to be updated here. Or you want to reset your selections.

Switch Views

You can switch between Music and Playlists to manage your media library.

Switch Media View

The most popular music players, Music Player Daemon (MPD) and Logitech Media Server (LMS), are configured to look under the Music share for music content (wav, flac, dsd, dsf, etc) and the Playlists share for playlists (.m3u). Other players do not necessary follow this convention. You are free to manage your media library any way you see fit. The file locations are as follows:

View Name File Path
Music /media/music
Playlists /media/playlists

Playlists are useful for copying music to RAM disk. While you can use playlists to manage files, it is easier, and faster, to manage them directly.

Path

This shows you file path you're currently in (i.e. how "deep" you are from the root).

Summary Panel Path

You can move around the directory structure easily by double clicking on any path here. In the example above you double click on pa to switch to /media/music/pa, and so on. To return to the root, click the Home (🏠) button.

Contents

This panel display the files under the path. The items here scrollable remember to scroll down or up if the file you are looking for is not in view.

File Listing

Navigating The File System

Sub-directories have a folder icon (🗀) prefixed to the name. You can double-click the folder to go in, or single-click to select all the contents in this folder. You can quickly move around the directory structure by clicking on any path in the Summary panel. You can also click on the up arrow (🠙) to return to the parent folder.

Double click here to return to the parent folder

Everything else are files, and they can only be toggled on or off. The Command Panel will change accordingly. Refer to the next section for more details.

Command Panel changes according to file selections

You can always reset your selection by clicking the refresh button in the Summary panel.

You can only select files in the current view. For example, in the above example where Adele 25 folder and 01 Hometown Glory.flac, 05 Set Fire to the Rain.flac are selected. If I proceed to enter any of the child folders (Adele 25), the current selection will be lost. So remember to perform your file operations before switching views or change your directory.

Add File(s)

You can now add files easily to your Snakeoil PC by clicking on the Add button in the Command Panel to upload the file.

Add file


Uploading files

You will see a progress screen while uploading files to your folders. Please wait patiently for the operation to complete.

New to 1.2.6 is a useful tool to monitor progress and may help diagnose problems. With a computer browser, use F12 to bring up a Console screen similar to this.

Monitor progress with F12

F12 is not available on mobile devices.


The file will be shown automatically once the upload is complete.

Upload completed


Command Panel

Here you can perform basic file system operations on your media files. Some functions are only active if

File Browser Command Panel

New Folder

This command is only available when no folders/files are selected.

Click on this button to create a new sub-folder. Do now use any of the following disallowed characters:

\ / : * ? | " ' &

The Confirm will be activated when you enter a valid name. Click this button to create the folder. Or Cancel to return.

Create A new Sub-folder

You will be placed automatically inside this child-folder on creation.

Add File(s)

This command is only available when no folders/files are selected.

Clicking this button will pop up a file selection picker. Select a single file to upload to the current path. This is a backup method where drag & drop upload is nog working.

Delete

Select the files you want to delete, then click this button to delete them permanently. You will be prompted a list of files (and it's children if present) to be deleted. Click Confirm to begin the delete operation, or Cancel to return.

WARNING: Please pause before confirming. There is no undo

Confirm Delete


Copy RAM

Snakeoil Blind Testing U7 and onwards allows you to create your own RAM disk. You can use this command to copy music files to this low latency, non-persistent storage.

Select the files in your current view and click this button to add to the RAM disk.

These files will be copied to your RAM disk

There is minimal file checking in place. So make sure you allocate a big enough RAM disk for this to work. The file manager will start copying the files one by one and stop when the RAM disk storage is full. Copy to RAM is now done in it's own thread.


New to 1.2.6 is a useful tool to monitor progress and may help diagnose problems. With a computer browser, use F12 to bring up a Console screen similar to this.

Browse F12.jpg


New to 1.2.6 is the ability to view and manage files in Ram disk.

Browse RAM disk

You can delete the files in RAM disk. You can use Add File within RAM Disk as an alternative to Copy Ram. Adding a Folder is also possible.


This command works differently when you're in the Playlists view. When you add a playlist, the music files themselves are copied over to the RAM disk.

Add music to RAM disk using playlists

Adding playlist makes it more convenient to copy files from across sub-directories. You will get a warning message if a file is missing in the playlist.

Depending on your player, the music will either show up automatically or not (do a database rescan or equivalent refresh).

Replace RAM

This will clear all files on your RAM disk first, before copy the selected files over.

Use this to quickly replace your music on your RAM disk.

Replace your RAM music with these

RAM storage and playlist function works the same way as Add To RAM.

 Main   Configuration    System   Snakeoil