Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Create and manage a case-sensitive disk-image on macOS (OS X).
#!/bin/bash
# ---------------------------------------------------------
# Customizable Settings
# ---------------------------------------------------------
MOUNT_POINT="${CASE_SAFE_MOUNT_POINT:-${HOME}/casesafe}"
VOLUME_PATH="${CASE_SAFE_VOLUME_PATH:-${HOME}/.casesafe.dmg.sparseimage}"
VOLUME_NAME="${CASE_SAFE_VOLUME_NAME:-casesafe}"
VOLUME_SIZE="${CASE_SAFE_VOLUME_SIZE:-60g}"
# ---------------------------------------------------------
# Functionality
# ---------------------------------------------------------
create() {
hdiutil create -type SPARSE -fs 'Case-sensitive Journaled HFS+' -size ${VOLUME_SIZE} -volname ${VOLUME_NAME} ${VOLUME_PATH}
}
automount() {
attach
cat << EOF > "/tmp/com.${VOLUME_NAME}.plist"
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>RunAtLoad</key>
<true/>
<key>Label</key>
<string>com.${VOLUME_NAME}</string>
<key>ProgramArguments</key>
<array>
<string>hdiutil</string>
<string>attach</string>
<string>-notremovable</string>
<string>-nobrowse</string>
<string>-mountpoint</string>
<string>${MOUNT_POINT}</string>
<string>${VOLUME_PATH}</string>
</array>
</dict>
</plist>
EOF
sudo cp "/tmp/com.${VOLUME_NAME}.plist" "/Library/LaunchDaemons/com.${VOLUME_NAME}.plist"
rm "/tmp/com.${VOLUME_NAME}.plist"
}
noautomount() {
detach
sudo rm -f "/Library/LaunchDaemons/com.${VOLUME_NAME}.plist"
}
detach() {
m=$(hdiutil info | grep "${MOUNT_POINT}" | cut -f1)
if [ ! -z "$m" ]; then
sudo hdiutil detach $m
fi
}
attach() {
sudo hdiutil attach -notremovable -nobrowse -mountpoint ${MOUNT_POINT} ${VOLUME_PATH}
}
resize() {
compact
detach
hdiutil resize -size ${VOLUME_SIZE} ${VOLUME_PATH}
attach
}
compact() {
detach
hdiutil compact ${VOLUME_PATH} -batteryallowed
attach
}
help() {
cat <<EOF
usage: casesafe <command>
Possible commands:
create Initialize case-sensitive volume (only needed first time)
automount Configure macOS to mount the volume automatically on restart
noautomount Stop macOS from mounting the volume automatically on restart
mount Attach the case-sensitive volume
unmount Detach the case-sensitive volume
resize Resize the case-sensitive volume
compact Remove any uneeded reserved space in the volume
config Show current configuration and instructions on changing
help Display this message
EOF
}
config() {
cat <<EOF
The behavior of the script may be modified by setting the following environment variables.
If not set the script will use sane defaults.
CASE_SAFE_MOUNT_POINT
Location where case-sensitive volume will be mounted
Current effective value: ${MOUNT_POINT}
CASE_SAFE_VOLUME_PATH
Location where image file should be stored
Current effective value: ${VOLUME_PATH}
CASE_SAFE_VOLUME_NAME
Name of case-sensitive workspace as visible in macOS Finder app
Current effective value: ${VOLUME_NAME}
CASE_SAFE_VOLUME_SIZE
Maximum size of volume (will auto-grow up to this)
Current effective value: ${VOLUME_SIZE}
EOF
}
invalid() {
printf "casesafe: '$1' is not a valid command.\n\n";
help
}
case "$1" in
create) create;;
automount) automount;;
noautomount) noautomount;;
mount) attach;;
unmount) detach;;
resize) resize;;
compact) compact;;
config) config;;
help) help;;
'') help;;
*) invalid $1;;
esac
@swinton

This comment has been minimized.

Copy link

@swinton swinton commented Sep 17, 2016

This is great, thank you for providing it 🙇

@jeiros

This comment has been minimized.

Copy link

@jeiros jeiros commented Oct 18, 2016

This saved my butt today!
🙏 God bless 🙏

@hoppinjohnz

This comment has been minimized.

Copy link

@hoppinjohnz hoppinjohnz commented Jan 11, 2017

Thanks for sharing this improved disk image script. It solved my problem of developing applications in Java with Mac OS X. Well done.

@joshka

This comment has been minimized.

Copy link

@joshka joshka commented Apr 28, 2017

Thanks for sharing this. For multiple mounts, it seems that you would need to update:
https://gist.github.com/scottsb/479bebe8b4b86bf17e2d#file-workspace-sh-L44 to include ${VOLUME_NAME}

@crdesai

This comment has been minimized.

Copy link

@crdesai crdesai commented Nov 15, 2017

Thanks for the script. It helped me resolve an issue I was facing with my package. I enabled automount while creating the volume at this time. However, I do not need the volume anymore. How can I make sure OS does not automount it when i restart my machine?

@scottsb

This comment has been minimized.

Copy link
Owner Author

@scottsb scottsb commented Nov 16, 2017

@joshka, this wasn't really intended to support multiple mounts, but I don't see any harm in that suggestion, so I'll update it.

@crdesai, I just updated this to include a "noautomount" subcommand as well.

@strogonoff

This comment has been minimized.

Copy link

@strogonoff strogonoff commented May 19, 2018

SPARSEBUNDLE might be a better choice than SPARSE. The bundle appears to split the image into chunks, and therefore works better with backup software which only needs to update the changed chunks after the first copy.

See also: https://discussions.apple.com/thread/2001162

@tpinne

This comment has been minimized.

Copy link

@tpinne tpinne commented Sep 27, 2018

I'm experiencing very very veeeeery bad IO performance since I updated to macOS Mojave. Anyone experiencing the same problem?

@djedi

This comment has been minimized.

Copy link

@djedi djedi commented Oct 31, 2018

I'm having a number of issues since installing Mojave. I can't seem to mount at all right now. The process just hangs.

@rajpra8

This comment has been minimized.

Copy link

@rajpra8 rajpra8 commented Feb 16, 2019

I had similar issue. Look at the original thread that has link to this. Solution was to move to APFS
https://gist.github.com/dixson3/8360571#file-workspace-sh-L7

@amaharana

This comment has been minimized.

Copy link

@amaharana amaharana commented Apr 7, 2020

Is there a way to resize the disk image created using this script? I have run out of space on the case sensitive image and changing the value of CASE_SAFE_VOLUME_SIZE while mounting doesn't help. Is my only option to create another image of larger size and transfer the contents? Or is there an easier, more obvious way that I am missing?

@scottsb

This comment has been minimized.

Copy link
Owner Author

@scottsb scottsb commented Apr 7, 2020

@amaharana, I just added a resize command that you should be able to use (along with setting CASE_SAFE_VOLUME_SIZE). Note that I have not tested this, as I am not currently using this script myself and don't have one to test with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.