]> git.hungrycats.org Git - bees/commitdiff
docs: update running.md to reflect native hash table creation/resize
authorZygo Blaxell <bees@furryterror.org>
Sat, 2 May 2026 02:20:11 +0000 (22:20 -0400)
committerZygo Blaxell <bees@furryterror.org>
Tue, 6 Oct 2026 05:51:40 +0000 (01:51 -0400)
Update manual setup instructions to clarify that bees can now
auto-create and resize its hash table natively if state.create = yes
(the default) is used.

Assisted-by: Gemini:gemini-3.5-flash
Signed-off-by: Zygo Blaxell <bees@furryterror.org>
docs/running.md

index 1b5a94061aa36a1d1af1ad32371da817d0ccc7a3..2d466feb89ab3e80afccfbfb7e09c70242fae75e 100644 (file)
@@ -7,13 +7,15 @@ Setup
 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"
@@ -29,7 +31,8 @@ Use a separate mount point, and let only bees access it:
         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
@@ -37,7 +40,7 @@ to the root subvol of the filesystem.  For example:
 
 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
@@ -50,7 +53,7 @@ Configuration
 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.