Skip to content

Open-source gym & body-weight tracker, now in the App Store (iPhone + Apple Watch) and as an Android APK. Plan routines, log workouts, see which muscles are trained, import from Strong/Hevy/FitNotes. Self-host it or use it on the phone alone.

docs: .env.example says where the data lives

Boris 'B' Kurktchievaf992ead27f4
diff --git a/.env.example b/.env.example
index a7a63a993..d7098c377 100644
--- a/.env.example
+++ b/.env.example
@@ -121,6 +121,25 @@ RP_NAME=openGym
#
# BASE_PATH=/gym
+# ── Where the data lives (optional) ────────────────────────────────────────
+# DATA_DIR is the one directory the API stores anything in: db.json (accounts,
+# passkey credentials, push subscriptions, invites), state-<uid>.json per
+# profile, `secret` (the key every session cookie is signed with), vapid.json,
+# audit.log, and the Coach's coach.json and coach/ when it is on. Back up that
+# directory and you have backed up the instance; lose `secret` and everyone is
+# signed out. Default /data.
+#
+# Under docker compose it is pinned to /data in docker-compose.yml and the host
+# side of the volume is ./data — so to keep the data somewhere else, change the
+# volume line rather than this variable, which the compose file overrides. The
+# variable is what you set when the API runs outside that file: `node server.js`
+# on a host, or a stack of your own.
+#
+# It has to be writable by the API: every save goes through it, and a read-only
+# mount or a full disk is a write that cannot land.
+#
+# DATA_DIR=/data
+
# ── Notifications (optional) ───────────────────────────────────────────────
# Push works out of the box — nothing to set. VAPID keys are generated on first
# run and saved to ./data/vapid.json. Each user's browser reports its own