Files on v6 boot drive

From unRAID
Revision as of 20:25, 26 May 2016 by RobJ (talk | contribs) (adding notes)
Jump to: navigation, search

Files on v6 boot drive

Here are the files and folders on a v6 flash drive, what they are or do, whether they come from the distro or not, and possibly whether they can be restored, and/or are recreated.
All files and folders are listed as in the root of the flash drive (e.g. /bzimage, /config/super.dat). On the unRAID server, they are actually at /boot (e.g. /boot/bzimage, /boot/config/super.dat). Some files and folders may not exist in your installation, that's OK. Current and future unRAID v6 releases may add additional files and folders that may not be listed below.
bzroot - from distro; unRAID OS
bzimage - from distro; unRAID OS startup
bzroot-gui - from distro; optional; unRAID boot and management GUI; only v6.2
license.txt - from distro; the license text
make_bootable.bat - from distro; preps flash drive from DOS or Windows
make_bootable_mac - from distro; preps flash drive from Mac
memtest - from distro; Memtest86 5.01, open source version
install.txt - from distro; installation instructions for preparing the flash drive; only v6.1.2 through v6.1.9
changes.txt - from distro; release notes for current version, possibly for previous versions too; only v6.1.2 on
readme.txt - from older distros; installation and release notes for older versions; only through v6.1.1, not since
readvz - from Preclear plugin; optional; a tool for faster post-reading

/extra - optional; any packages here will be automatically installed at boot
/packages - optional; packages here will not be automatically installed, but may be installed by certain plugins
/logs - contains syslogs and diagnostics zip files; user may wish to archive old logs
/plugins - not used currently
/previous - contains the previous unRAID version, if user wishes to revert back from current upgrade
/unmenu - contains UnMENU files and folders; optional; only if user installs UnMENU
/syslinux and all files within - from distro
      syslinux.cfg - from distro, but may be edited by user (user may wish to restore their customized version)
/preclear_reports - contains reports from Preclear scripts and plugins; optional
/config - contains all user configuration and plugin information; some parts are from distro; if you don't backup entire flash, then backup this folder
     /plugins - contains all plugin files and folders, including Dynamix; a few are from distro
     /plugins-removed - contains plugin files for plugins that have been removed
     /shares - contains all files (*.cfg) that contain the share settings for each User Share; if removed, settings will be recreated with defaults
     /ssh - contains all generated SSH keys

     go - from distro, but may be edited by user (user may wish to restore their customized version)
     disk.cfg - contains various drive settings; if missing, recreated with defaults
     super.dat - contains the drive models and serials and their array assignments; recreated empty if missing
     ident.cfg - originally from distro, contains basic network identity settings, including NTP
     network.cfg - originally from distro, contains basic network settings
     share.cfg - contains global share settings; if missing, recreated with defaults
     smb-extra.conf - optional; contains special smb settings, such as recycle bin settings
     domain.cfg - originally from distro, contains basic domain settings
     domains.cfg - obsolete; only in certain v6.2 installations
     docker.cfg - originally from distro, contains basic docker settings
     *.key - your purchased license key file or files, tied to flash drive GUID
     parity-checks.log - optional; history of parity checks
     smart-one.cfg - contains SMART settings
     smart-all.cfg - contains SMART settings
     passwd - contains user and password info
     smbpasswd - contains user and password info
     shadow - contains user and password info
     secrets - contains user and password info; may be obsolete from older versions???

Important Notes and Warnings

Backups and super.dat - Backups are always a good thing, and certainly your unRAID flash drive should be backed up, or at least the /config folder should be backed up. But there's a couple of gotcha's to be aware of. One is that config/super.dat contains a flag whether the array is currently started or not. Why is that important to know? Because when you shut down normally, the flag indicates the array is stopped, and your backup can be restored without issue. But if you backup while the array is running, and then restore that backed up super.dat, unRAID will see that flag (showing the array still up) and assume you didn't shut down cleanly last time, and start a parity check. It's not a big problem, because you can just cancel the parity check, and the only harm is really minor - the parity check history may be messed up a little!
Backups and super.dat, part 2 - There's another danger to be aware of (much more serious!) - since super.dat contains the drive assignments for your array, you need to be careful if you make changes to the assignments that you don't ever restore an incompatible super.dat. MOST OF ALL, if you add a new parity drive, and reuse your old parity drive as a data drive! What would happen? If you restore that old super.dat, it assumes the *old* parity drive is your current parity drive and begins writing parity info to it, overwriting what is currently a data drive! Never restore a super.dat that is inconsistent with the current array configuration! It MUST have exactly the same set of drives and assignments!
Starting Over - Be aware that if your flash drive is lost or broken (completely unusable), you have not lost anything important! Your data is still safe, and parity is still valid! All you have lost is your settings, all of them (if you don't have a backup)! There's a section below to help you start over, but it doesn't mean starting over with your data, just starting over with all of the configuration and installed apps and tools.

Starting Over