If you don't want to use the helper script `scripts/beesd` to setup and
configure bees, here's how you manually setup bees.
-Create a directory for bees state files:
+Create a directory for bees state files (optional, bees can create this
+if `state.create = yes` is configured):
export BEESHOME=/some/path
mkdir -p "$BEESHOME"
-Create an empty hash table ([your choice of size](config.md), but it
-must be a multiple of 128KB). This example creates a 1GB hash table:
+You can manually create an empty hash table if desired ([your choice of size](config.md),
+but it must be a multiple of 128KB). If `state.create = yes` is
+configured, bees will create this file for you on the first run.
truncate -s 1g "$BEESHOME/beeshash.dat"
chmod 700 "$BEESHOME/beeshash.dat"
mount /dev/disk/by-uuid/$UUID /var/lib/bees/$UUID -osubvol=/
If you don't set BEESHOME, the path "`.beeshome`" will be used relative
-to the root subvol of the filesystem. For example:
+to the root subvol of the filesystem. For example (again, the
+subvolume creation and truncate are optional if `state.create = yes`):
btrfs sub create /var/lib/bees/$UUID/.beeshome
truncate -s 1g /var/lib/bees/$UUID/.beeshome/beeshash.dat
You can use any relative path in `BEESHOME`. The path will be taken
relative to the root of the deduped filesystem (in other words it can
-be the name of a subvol):
+be the name of a subvol, and creation is optional):
export BEESHOME=@my-beeshome
btrfs sub create /var/lib/bees/$UUID/$BEESHOME
There are some runtime configurable options using environment variables:
* BEESHOME: Directory containing bees state files:
- * beeshash.dat | persistent hash table. Must be a multiple of 128KB, and must be created before bees starts.
+ * beeshash.dat | persistent hash table. Must be a multiple of 128KB; can be auto-created by bees if `state.create = yes`.
* beespoint.ini | state of extent and subvolume crawlers. ASCII text in INI format.
* beescrawl.dat | state of old-version crawlers (legacy). ASCII text. Migrated to beespoint.ini on first run.
* beesstats.txt | statistics and performance counters. ASCII text. bees will create this.