ports/filesystems/zfsnap/pkg-message
Robert Clausecker 6e2da9672f filesystems: add new category for file systems and related utilities
The filesystems category houses file systems and file system utilities.
It is added mainly to turn the sysutils/fusefs-* pseudo-category into
a proper one, but is also useful for the sundry of other file systems
related ports found in the tree.

Ports that seem like they belong there are moved to the new category.
Two ports, sysutils/fusefs-funionfs and sysutils/fusefs-fusepak are
not moved as they currently don't fetch and don't have TIMESTAMP set
in their distinfo, but that is required to be able to push a rename
of the port by the pre-receive hook.

Approved by:	portmgr (rene)
Reviewed by:	mat
Pull Request:	https://github.com/freebsd/freebsd-ports/pull/302
PR:		281988
2024-11-06 16:17:35 +01:00

55 lines
2 KiB
Text

[
{ type: install
message: <<EOM
To run zfSnap periodically you can add these options to your
/etc/periodic.conf
xPERIODICx_zfsnap_enable - Enable xPERIODICx snapshots
(values: YES | NO)
xPERIODICx_zfsnap_fs - Space separated zfs filesystems
to create non-recursive snapshots
xPERIODICx_zfsnap_recursive_fs - Space separated zfs filesystems
to create recursive snapshots
xPERIODICx_zfsnap_ttl - Set Time To Live
xPERIODICx_zfsnap_verbose - Verbose output (values: YES | NO)
xPERIODICx_zfsnap_flags - zfSnap generic flags
(except -v and -d)
xPERIODICx_zfsnap_enable_prefix - Create snapshots with prefix
(Default = YES)
xPERIODICx_zfsnap_prefix - Set prefix to use for new snapshots
(Default = "xPERIODICx-")
(where xPERIODICx is any of hourly, daily, weekly, monthly, reboot)
xPERIODICx_zfsnap_delete_enable - Delete old snapshots periodically
(values: YES | NO)
xPERIODICx_zfsnap_delete_flags - zfSnap generic flags
(except -v and -d)
xPERIODICx_zfsnap_delete_verbose - Verbose output (values: YES | NO)
xPERIODICx_zfsnap_delete_prefixes - Space separated list of prefixes
of old zfSnap snapshots to delete
'hourly-', 'daily-', 'weekly-',
'monthly-' and 'reboot-' prefixes
are hard-coded
(where xPERIODICx is any of daily, weekly, monthly)
Add these lines to your /etc/crontab
4 * * * * root periodic hourly
@reboot root periodic reboot
NOTE: it is not recommended to delete zfSnap snapshots every hour.
Deleting zfs snapshots takes more time than creating them.
There for it's better to delete snapshots once per day...
Periodic scripts provide very limited feature set. If you want to use
more advanced setup, you need to call zfSnap from crontab directly.
This way you can combine all sort of parameter combinations.
Don't forget to check https://github.com/graudeejs/zfSnap/wiki for more
info.
Feedback welcomed: graudeejs@gmail.com
EOM
}
]