GitHub - s-d-adams/muxfs: A mirroring, checksumming, and self-healing filesystem layer for OpenBSD.

s-d-adams / muxfs Public

Notifications You must be signed in to change notification settings
Fork 3
Star 50

A mirroring, checksumming, and self-healing filesystem layer for OpenBSD.

sdadams.org/muxfs/

ISC license

50 stars 3 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 6 Commits
CHANGES		CHANGES
GLOSSARY		GLOSSARY
LICENSE		LICENSE
Makefile		Makefile
README		README
SHA512SUMS		SHA512SUMS
chk.c		chk.c
chk.h		chk.h
conf.c		conf.c
desc.c		desc.c
dev.c		dev.c
ds.c		ds.c
ds.h		ds.h
ds_malloc.c		ds_malloc.c
format.c		format.c
gen.c		gen.c
lfile.c		lfile.c
mount.c		mount.c
mount.h		mount.h
muxfs.1		muxfs.1
muxfs.c		muxfs.c
muxfs.h		muxfs.h
ops.c		ops.c
ops.h		ops.h
scan.c		scan.c
state.c		state.c
sync.c		sync.c
test.conf.dist		test.conf.dist
test.sh		test.sh
unity.c		unity.c
util.c		util.c
version.c		version.c

Repository files navigation

The Multiplexed File System  
===========================

IMPORTANT
---------
DO NOT USE MUXFS TO STORE IMPORTANT DATA YET.  MUXFS IS CURRENTLY IN
DEVELOPMENT AND IS NOT READY FOR PRODUCTION USE.  IF AND WHEN MUXFS BECOMES
STABLE IT WILL BE INTENDED FOR LONG-TERM DATA STORAGE, HOWEVER USING MUXFS IN
ITS CURRENT FORM WILL LIKELY LEAD TO LOSS OF DATA.

Introduction
------------
muxfs is a mirroring, checksumming, and self-healing filesystem layer for
OpenBSD.  It mirrors a filesystem tree across a series of directories, and
employs checksum databases to validate and restore files automatically.

Installation
------------
	# make
	# make install

Usage
-----
muxfs has the following commands:

	muxfs format [-a checksum_algorithm] directory ...
	muxfs mount [-f] mount_point directory ...
	muxfs audit directory ...
	muxfs heal directory ...
	muxfs sync destination source ...
	muxfs version

Refer to the muxfs manual page for details.

Contributing
------------
Bug, usability, and performance reports may be sent to <[email protected]>.
Patches are welcome provided that their copyrights are assigned
to Stephen D. Adams.

If you want to read the code then I advise that you first look at GLOSSARY,
then muxfs.h before progressing to the rest of the code.

If you want to test a patch then I advise that you edit Makefile commenting out
the 'unity' target and uncommenting the 'incremental' target.  This should
produce clearer compiler error messages.

In addition to 'incremental' to run 'muxfs mount' under a debugger you will
need to edit the makefile commenting out the '-O2' CFLAGS line and uncommenting
the '-g' CFLAGS line, then pass the '-f' flag to 'muxfs mount' (see
'-f' from fuse_parse_cmdline(3) for more information).

Author
------
Stephen D. Adams <[email protected]>