wrolpi-help/docs/modules/files/index.md
Roland 217ff68098
Creating Tags, Configs, FileGroups, Downloads, and Upgrade docs.
Also: adding WROLPi Portable (Live USB) to Getting Started, syncing the
Home TOC with all existing pages, pointing eBooks/PDFs at the Docs
module, recommending Raspberry Pi Imager instead of Etcher, and fixing
typos.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-03 18:34:34 -06:00

72 lines
3.1 KiB
Markdown

# Files
The Files module allows you to view the files found in your media directory. No files outside the media directory
can be viewed.
The Files module is different from other modules in WROLPi (Videos/Archives/etc.) because the files displayed are not
fetched from the database, they are read from the media directory live. This is necessary to allow refreshing of files
that have recently been created, and are not yet in the database.
![Files Page](files-page.png)
## Refreshing
WROLPi can search any file in your media directory, this can only be accomplished after a full refresh of your files has
been completed.
> To refresh all your files, click the **Files** link in the top navigation bar, then click **Refresh** found at the
> bottom of the files table.
## Files Tools
The contents of the media directory can be manipulated in the Files module using the buttons on the bottom of the files
table.
**It is recommended to manipulate files using the provided tools. WROLPi can lose track of your files if you manipulate
them outside of these tools.**
The tool buttons are as displayed:
1. **Refresh** button
* This button will refresh all files in your media directory, or any files/directories you have selected.
2. **Delete** button
* This button will delete any files or directories selected.
3. **Rename** button
* Allows you to rename a single file or directory.
4. **Move** button
* Allows you to move files/directories into another directory.
5. **New Directory** button
* Allows you to create a new directory in the directory selected (or, the top directory if no directory is
selected.)
6. **Ignore** button
* Allows you to skip any directories (and their files) from indexing and searching. (Useful if you have a directory
with many thousands of small files, such as a git repo)
## Tags
See [Tags](../../system/tags.md) for everything about tagging.
WROLPi creates and manages a `tags` directory, this directory contains links to files you have tagged. This is the
[secondary](../../system/primary-secondary-tertiary.md) method to access your tags. **You should never manually add
files to this directory, they will be deleted.**
If a file is tagged with multiple tags, the file link will be placed in a directory containing the names of the tags,
separated by commas (alphabetically). For example, if you tagged a video at
`videos/WROLPi/WROLPi_20230909_0xfMLNVFq2Y_WROLPi v0.11 beta demo.mp4` with the tags "WROL" and "Computers",
then a link to the video will be created in
`tags/Computers, WROL/WROLPi_20230909_0xfMLNVFq2Y_WROLPi v0.11 beta demo.mp4`
All files in the [FileGroup](../../system/filegroups.md) will be linked in the same directory.
## File Preview
When clicking on any file, WROLPi will attempt to provide you with a preview of the file. If no previewer has been
created for the particular file type has been created, then the generic file preview will be used.
A preview of a 3D STL model file (which as been tagged with Tools):
![A preview of a 3D STL file](3d-benchy-preview.png)
A preview of a PDF file (which has been tagged with First Aid and Primitive):
![A preview of a PDF file](pdf-preview.png)