Skip to content

Releases: GearDuckDev/FlockSync

FlockSync 0.7.1

Choose a tag to compare

@JohnMartincic JohnMartincic released this 22 Oct 04:25

FlockSync 0.7.1

Gear sync reliability

  • Fixed the addon capturing unavailable inventory during logout/reload and replacing valid gear with an empty snapshot. Logout now preserves captured equipment while preparing the character record for WoW's SavedVariables write.
  • Equipment changes are captured immediately instead of waiting for the delayed broadcast, so a quick logout does not lose the slot change. Main and alt equipment remains attached to each character's own profile.
  • Incomplete item-cache results retain the previous valid gear. Explicit equipment-removal events still remove the affected slot, including the final item. Multiple local changes within one server second are preserved in the saved record.
  • WoW itself writes SavedVariables on /reload and logout; addons cannot force arbitrary disk writes. The running, signed-in desktop app already watches changed/replaced saves automatically. New integration coverage verifies reload, logout, and character-switch saves upload both characters and write AppHelper without a manual Sync click.
  • Includes desktop 0.5.0 from the previous release: explicitly indexed Lua gear tables parse correctly, and missing/malformed lists fail validation rather than silently clearing equipment.
  • Genuine equipment removals still replace older gear snapshots. Refreshing the roster does not delete stored equipment, and older or equal-timestamp syncs cannot overwrite newer gear.
  • Gear already overwritten by an older desktop sync needs a fresh in-game scan; installing the fix or refreshing the browser alone cannot reconstruct that equipment.

Release channel and scope

This is a normal Release-channel build with no alpha/beta suffix. FlockSync remains pre-1.0; this is not a declaration of 1.0 completeness.

The overall release advances from 0.7.0 to 0.7.1, and the main addon advances from 0.5.0 to 0.5.1 for this fix. Desktop, API/web, shared types, and AppHelper are unchanged. Unchanged components are rebuilt/repackaged for a complete download set and do not need reinstalling if already current.

Upgrade instructions

  1. Exit WoW completely and update FlockSync to 0.5.1. Members install FlockSync-Raider-Only.zip or update through CurseForge once published. Collectors install FlockSync-Addon-Bundle.zip, or update only FlockSync if AppHelper 0.2.2 is already installed. Preserve SavedVariables and avoid an extra nested AddOns directory.
  2. Keep desktop 0.5.0, API/web 0.4.1, and AppHelper 0.2.2 if already current. No server deployment, migration/reset, or reinstall of unchanged components is required. Desktop versions older than 0.5.0 still need the earlier parser fix: quit completely through the tray, then install FlockSync-Setup-0.5.0-x64.exe or use FlockSync-Portable-0.5.0-x64.exe. Preserve settings, select the correct WoW folder, and use the full server URL without /api.
  3. To restore gear previously cleared by an older sync, log in on each affected character and use Force Scan & Broadcast in the addon settings. An authorized guild catcher must be online to collect other members' broadcasts. Log out to save the catcher's data, wait for successful desktop sync, then refresh the dashboard.
  4. To load server-returned information, use the logout -> desktop sync -> login sequence. Each WoW account folder needs its own sync. Website-linked collection applies only within the authorized guild and realm; unrelated guilds, realms, and guildless characters do not inherit it.
  5. If your server is older than 0.4.1, preserve .env and data, obtain the deployment source, and run sh deploy/update-server.sh. It verifies a backup before rebuilding/restarting API/web. Do not bypass the backup guard or use docker compose down -v. Check container logs, public login, and sync.
  6. For older addon installations, exit WoW before replacing files. Extract directly into Interface\AddOns, without an extra ZIP-named directory, and preserve SavedVariables. If upgrading from before 0.4.0-beta, deploy the API before the desktop app for newer sync-field compatibility.

No settings, SavedVariables, or database reset is required. Do not delete saved data to troubleshoot missing equipment.

Download choices

  • FlockSync-Setup-0.5.0-x64.exe: Windows installer for officers/admins collecting guild data. Unchanged from 0.7.0; no reinstall needed if current. Includes the previous desktop gear parser fix.
  • FlockSync-Portable-0.5.0-x64.exe: unchanged portable Windows alternative; choose this or the installer, not both.
  • FlockSync-Raider-Only.zip: updated main addon 0.5.1 for all guild members, with logout/character-switch gear protection. Regular members do not need AppHelper, desktop, or a server account to share addon data.
  • FlockSync-Addon-Bundle.zip: updated main addon 0.5.1 plus unchanged AppHelper 0.2.2 for collectors. Collectors additionally need the desktop app and an authorized OFFICER or ADMIN website account.
  • FlockSync_Pi_Deploy.zip: complete 0.4.1 API/web source, shared contracts, theme assets, existing database migrations, and Docker deployment tooling. Server behavior/version unchanged; redeployment is not required for this desktop fix.
  • flocksync-release.json: generated component-version manifest required for update checking alongside the other five downloads.

Publish all six assets on one GitHub release. Collection only happens while a catcher is logged in; it cannot retrieve guild messages sent while offline. Installing AppHelper alone does not grant collection permissions.

Component versions

  • Desktop: 0.5.0 - unchanged; no reinstall needed if current.
  • Server/API/web: 0.4.1 - unchanged; API/web remain aligned, no redeployment required if current.
  • Shared types: 0.4.1 - unchanged.
  • Main addon: 0.5.1 - updated from 0.5.0; reload/logout and character-switch gear protection.
  • AppHelper: 0.2.2 - unchanged; no reinstall needed if current.
  • Root workspace package: 0.2.2 - unchanged.

New installations

Members extract the main addon into Interface\AddOns, enable it, and complete the walkthrough. Collectors additionally install AppHelper and one desktop download, select the WoW folder containing Interface and WTF, and connect to their guild's server using an authorized login.

For first-time server hosting, follow DEPLOYMENT.md. Configure .env with unique credentials, prepare a writable backup destination, and keep SQLite on local storage rather than a NAS. The server is guild-hosted, not automatically a shared public service. Background emblems default to None, and UI/background colors remain optional.

FlockSync 0.7.0

Choose a tag to compare

@JohnMartincic JohnMartincic released this 22 Oct 04:24

FlockSync 0.7.0

Gear sync reliability

  • Fixed desktop sync treating equipment saved with explicit Lua indexes as empty gear. These records now retain their items when uploaded and displayed after a web refresh.
  • Missing or malformed equipment lists now fail sync validation instead of silently uploading an empty list.
  • Genuine equipment removals still replace older gear snapshots. Refreshing the roster does not delete stored equipment, and older or equal-timestamp syncs cannot overwrite newer gear.
  • Gear already overwritten by an older desktop sync needs a fresh in-game scan; installing the fix or refreshing the browser alone cannot reconstruct that equipment.

Release channel and scope

This is a normal Release-channel build with no alpha/beta suffix. FlockSync remains pre-1.0; this is not a declaration of 1.0 completeness.

Using the requested minor increment, the overall release advances from 0.6.1 to 0.7.0, and desktop advances from 0.4.0 to 0.5.0. API/web, shared types, and both addons are unchanged. Unchanged components are rebuilt/repackaged for a complete download set and do not need reinstalling if already current.

Upgrade instructions

  1. Quit the desktop app completely using Quit FlockSync in its system tray. Install FlockSync-Setup-0.5.0-x64.exe, or replace your portable executable with FlockSync-Portable-0.5.0-x64.exe. Choose one, not both. Preserve existing settings and configure the full guild server URL without an /api suffix.
  2. Keep API/web 0.4.1, main addon 0.5.0, and AppHelper 0.2.2 if already current. No server deployment, database migration/reset, or addon reinstall is required for this fix.
  3. To restore gear previously cleared by an older sync, log in on each affected character and use Force Scan & Broadcast in the addon settings. An authorized guild catcher must be online to collect other members' broadcasts. Log out to save the catcher's data, wait for successful desktop sync, then refresh the dashboard.
  4. To load server-returned information, use the logout -> desktop sync -> login sequence. Each WoW account folder needs its own sync. Website-linked collection applies only within the authorized guild and realm; unrelated guilds, realms, and guildless characters do not inherit it.
  5. If your server is older than 0.4.1, preserve .env and data, obtain the deployment source, and run sh deploy/update-server.sh. It verifies a backup before rebuilding/restarting API/web. Do not bypass the backup guard or use docker compose down -v. Check container logs, public login, and sync.
  6. For older addon installations, exit WoW before replacing files. Extract directly into Interface\AddOns, without an extra ZIP-named directory, and preserve SavedVariables. If upgrading from before 0.4.0-beta, deploy the API before the desktop app for newer sync-field compatibility.

No settings, SavedVariables, or database reset is required. Do not delete saved data to troubleshoot missing equipment.

Download choices

  • FlockSync-Setup-0.5.0-x64.exe: updated Windows installer for officers/admins collecting guild data; includes the gear parser fix.
  • FlockSync-Portable-0.5.0-x64.exe: updated portable Windows alternative with the same fix; choose this or the installer.
  • FlockSync-Raider-Only.zip: main addon 0.5.0 for all guild members. Unchanged; no reinstall needed if current. Regular members do not need AppHelper, desktop, or a server account to share addon data.
  • FlockSync-Addon-Bundle.zip: the same main addon plus AppHelper 0.2.2 for collectors. Both unchanged; no reinstall needed if current. Collectors additionally need the desktop app and an authorized OFFICER or ADMIN website account.
  • FlockSync_Pi_Deploy.zip: complete 0.4.1 API/web source, shared contracts, theme assets, existing database migrations, and Docker deployment tooling. Server behavior/version unchanged; redeployment is not required for this desktop fix.
  • flocksync-release.json: generated component-version manifest required for update checking alongside the other five downloads.

Publish all six assets on one GitHub release. Collection only happens while a catcher is logged in; it cannot retrieve guild messages sent while offline. Installing AppHelper alone does not grant collection permissions.

Component versions

  • Desktop: 0.5.0 - updated from 0.4.0; equipment parsing and invalid-list validation fix.
  • Server/API/web: 0.4.1 - unchanged; API/web remain aligned, no redeployment required if current.
  • Shared types: 0.4.1 - unchanged.
  • Main addon: 0.5.0 - unchanged; no reinstall needed if current.
  • AppHelper: 0.2.2 - unchanged; no reinstall needed if current.
  • Root workspace package: 0.2.2 - unchanged.

New installations

Members extract the main addon into Interface\AddOns, enable it, and complete the walkthrough. Collectors additionally install AppHelper and one desktop download, select the WoW folder containing Interface and WTF, and connect to their guild's server using an authorized login.

For first-time server hosting, follow DEPLOYMENT.md. Configure .env with unique credentials, prepare a writable backup destination, and keep SQLite on local storage rather than a NAS. The server is guild-hosted, not automatically a shared public service. Background emblems default to None, and UI/background colors remain optional.

FlockSync 0.6.1

Choose a tag to compare

@JohnMartincic JohnMartincic released this 22 Oct 03:48

FlockSync 0.6.1

Web dashboard improvements

  • Added custom UI and background colors in Theme Settings, for both personal themes and administrator-managed server defaults.
  • Colors are linked by default: one color picker controls the dashboard surfaces and the page behind the background emblem. Enable Separate UI and background colors to choose them independently. Disable it again to use the UI color for both.
  • Panel, table, and control shades follow the UI color. Neutral text adjusts for light or dark surfaces; action buttons, class colors, and status indicators retain their recognizable colors.
  • The live preview shows the page color behind the selected emblem together with a sample panel and control before saving.
  • Color choices persist with the website account and follow users across browsers, just like background emblems. Administrator defaults apply only to users without a personal override; Use server default removes that override.
  • Existing themes retain their original appearance until customized. Changing the emblem preserves color choices, and existing custom-image uploads and opacity settings continue working.
  • PNG/JPEG uploads remain limited to 5 MB, resized to at most 1024 pixels per side, and checked against the encoded storage limit. Emblem opacity remains adjustable from 0% to 40%. SVG and external image URLs are not accepted.

Release channel and scope

This is a normal Release-channel build, with no alpha/beta suffix. FlockSync remains pre-1.0: version 0.6.1 does not mean every planned feature is complete or that the software has reached 1.0 maturity.

The overall release advances from 0.6.0 to 0.6.1, and API/web and shared types advance from 0.4.0 to 0.4.1, using the requested 0.0.1 increment. Desktop, main addon, and AppHelper are unchanged and rebuilt/repackaged only to provide complete downloads. Current installations of unchanged components do not need reinstalling.

Updating the server, desktop app, and addons

  1. Preserve the server's existing .env and data directory. Obtain the new source or extract FlockSync_Pi_Deploy.zip while preserving those files, then run sh deploy/update-server.sh from the deployed project directory. It verifies a database backup before rebuilding/restarting. Do not bypass the backup guard or use docker compose down -v.
  2. Deploy API and web together at 0.4.1. No new database migration or reset is required for color settings; they use the existing theme storage. Upgrades from before theme support still apply the additive theme-table migration automatically. Check docker compose ps and docker compose logs --tail 100 api web cloudflared, then verify public login and sync.
  3. Open Theme Settings. Choose a linked UI and background color, or enable Separate UI and background colors and select each independently. Check the preview and click Save theme. Administrators can also save a server default. Default changes appear on browser focus or within a minute for users following that default.
  4. Keep desktop 0.4.0 installed if already current; it does not need reinstalling. For older desktop installations, quit completely through Quit FlockSync in the tray, then install FlockSync-Setup-0.4.0-x64.exe or replace the portable executable with FlockSync-Portable-0.4.0-x64.exe. Preserve settings and use the full server URL without an /api suffix.
  5. Keep main addon 0.5.0 and AppHelper 0.2.2 installed if already current; neither addon changed. For older installations, exit WoW before replacing files. Members install FlockSync-Raider-Only.zip; collectors install FlockSync-Addon-Bundle.zip. Extract directly into Interface\AddOns, without an extra nested directory, and preserve SavedVariables.
  6. After an older addon/desktop upgrade, log in, complete the addon walkthrough if necessary, and /reload or log out to save current data. Wait for desktop sync success, then /reload to load helper return data. Refresh the dashboard to check synced records.
  7. If upgrading from before 0.4.0-beta, deploy the API before the desktop app because newer sync fields require the updated API. To enable website-linked collection, sync a character in the intended guild and reload after success; each WoW account folder needs its own grant. Same-guild/realm low-ranked alts can collect, but unrelated guilds, realms, and guildless characters do not inherit it.

No settings, SavedVariables, or database reset is required. Color settings are included in normal database backups with existing theme/account data.

Download choices

  • FlockSync-Raider-Only.zip: main WoW addon 0.5.0 for all guild members. Regular members do not need the desktop app, AppHelper, or a server account. Unchanged; no reinstall needed if current.
  • FlockSync-Addon-Bundle.zip: the same main addon plus AppHelper 0.2.2 for officers/admins collecting guild data. Both addons are unchanged.
  • FlockSync-Setup-0.4.0-x64.exe: Windows desktop installer for collectors. Desktop behavior/version are unchanged.
  • FlockSync-Portable-0.4.0-x64.exe: portable desktop alternative; choose this or the installer, not both. Unchanged version.
  • FlockSync_Pi_Deploy.zip: updated 0.4.1 API/web source, shared theme contracts, bundled theme images, existing database migrations, and Docker deployment tooling for server administrators.
  • flocksync-release.json: generated component-version manifest, required alongside the downloads for update checking.

Publish all six files on one GitHub release. Collectors need the main addon, AppHelper, and desktop app; installing AppHelper alone does not grant website permissions. Collection only occurs while logged in and cannot retrieve guild messages sent while offline.

Component versions

  • Main addon: 0.5.0 - unchanged; no reinstall needed if already current.
  • AppHelper: 0.2.2 - unchanged; no reinstall needed if already current.
  • Desktop: 0.4.0 - unchanged; rebuilt for the complete download set, no reinstall needed if current.
  • Server/API/web: 0.4.1 - updated from 0.4.0; custom linked/independent UI and background colors. API/web remain aligned.
  • Shared types: 0.4.1 - updated from 0.4.0; backward-compatible color fields and hex-color validation.
  • Root workspace package: 0.2.2 - unchanged; no root runtime change.

New installations

Extract the appropriate addon ZIP into Interface\AddOns, enable the addon(s), and complete the in-game walkthrough. Collectors additionally install the desktop app, select their WoW client folder, configure their server URL, and sign in with an ADMIN or OFFICER website account.

For server hosting, follow DEPLOYMENT.md. Copy .env.example to .env, configure unique credentials and your Cloudflare tunnel token, and prepare an existing writable backup directory. Keep the live SQLite database on local storage, not the NAS. New dashboard themes start with no emblem and the original dark palette; custom colors are optional.

FlockSync 0.6.0

Choose a tag to compare

@JohnMartincic JohnMartincic released this 22 Oct 01:49

FlockSync 0.6.0

Desktop improvements

  • Added Start minimized to system tray, available in App Settings and the tray menu. It applies on the next launch and defaults off.
  • Startup visibility is independent of Start on Windows boot and Minimize to tray on close. Windows startup no longer unconditionally hides the app; an explicit --hidden argument still hides it.
  • If the tray icon cannot be created, the window opens even when start-minimized is enabled.
  • Updated the desktop window, tray, installer, and portable-app icons using the FlockSync artwork.

Web dashboard improvements

  • Attunements now group linked alts under their main instead of placing each alt in a separate step section. Sections and completion totals count mains, not individual characters.
  • Alt lists start collapsed. Expand a main to see indented alts with their own completed/total counts, including alts on the same step as their main.
  • Missing main progress remains explicitly unknown, rather than being inferred from an alt. Inactive mains can remain as anchors for active alts; task creation still targets the chosen character's actual step.
  • Added Theme Settings with bundled Alliance, Horde, and World of Warcraft backgrounds, plus custom PNG/JPEG uploads. The example guild image is not bundled.
  • The initial theme is None, with no background emblem. Administrators can set a server-wide default; each user can save a personal override or choose Use server default.
  • Backgrounds stay faded behind content and do not intercept clicks. Opacity sliders range from 0% to 40%, with a 12% starting value for a chosen image.
  • Theme settings and uploaded images persist with the website account in SQLite and are included in normal database backups. Admin-default changes appear on browser focus or within a minute for users following that default.
  • Custom uploads accept PNG/JPEG files up to 5 MB, resize to at most 1024 pixels per side, and must fit the encoded storage limit after conversion. SVG and external image URLs are not accepted.
  • Updated the browser favicon using the FlockSync artwork.

Release channel and scope

This is a normal Release-channel publication, with no alpha/beta suffix. FlockSync remains pre-1.0: version 0.6.0 does not mean every planned feature is complete or that the software has reached 1.0 maturity.

Desktop, API/web, and shared types are updated. The main addon and AppHelper are unchanged from 0.5.0 and 0.2.2 respectively and are included for complete downloads. Existing addon installations on those versions do not need reinstalling.

Updating the server, desktop app, and addons

  1. Preserve the server's existing .env and data directory. Obtain the new source or extract FlockSync_Pi_Deploy.zip while preserving those files, then run sh deploy/update-server.sh from the deployed project directory. It verifies a database backup before rebuilding/restarting. Do not bypass the backup guard or use docker compose down -v.
  2. Deploy API and web together. The API automatically applies the additive theme-table migration at startup; no database reset is required. Check docker compose ps and docker compose logs --tail 100 api web cloudflared, then verify public login and sync.
  3. Quit the desktop app completely through Quit FlockSync in its tray menu. Install FlockSync-Setup-0.4.0-x64.exe, or replace your portable executable with FlockSync-Portable-0.4.0-x64.exe. Keep existing settings and use the full server URL without an /api suffix.
  4. To start quietly, enable Start minimized to system tray in desktop App Settings or the tray menu, then quit and relaunch. Leave it disabled to open the window normally. Older Windows startup entries containing --hidden are rewritten without that argument when the updated app runs.
  5. Open Theme Settings on the website. Administrators can save a server default; users can save their own theme or return to the default. New installations start with None. Attunement alts start collapsed and expand with the chevron beside their main.
  6. If already using main addon 0.5.0 and AppHelper 0.2.2, keep them installed: neither addon changed. For older installations, exit WoW before replacing files. Members install FlockSync-Raider-Only.zip; collectors install FlockSync-Addon-Bundle.zip. Extract directly into Interface\AddOns, without an extra nested directory, and preserve SavedVariables.
  7. Log in, complete the addon walkthrough if necessary, and /reload or log out to save current data. Wait for desktop sync success, then /reload to load helper return data. Refresh the dashboard to check synced records.
  8. If upgrading from before 0.4.0-beta, deploy the API before the desktop app because newer sync fields require the updated API. To enable website-linked collection, sync a character in the intended guild and reload after success; each WoW account folder needs its own grant. Same-guild/realm low-ranked alts can collect, but unrelated guilds, realms, and guildless characters do not inherit it.

No settings, SavedVariables, or database reset is required. The new theme tables are added without replacing existing roster or account data.

Download choices

  • FlockSync-Raider-Only.zip: main WoW addon 0.5.0 for all guild members. Regular members do not need the desktop app, AppHelper, or a server account. Unchanged from the previous release.
  • FlockSync-Addon-Bundle.zip: the same main addon plus AppHelper 0.2.2 for officers/admins collecting guild data. Both addons are unchanged.
  • FlockSync-Setup-0.4.0-x64.exe: updated Windows desktop installer for collectors.
  • FlockSync-Portable-0.4.0-x64.exe: updated portable desktop alternative; choose this or the installer, not both.
  • FlockSync_Pi_Deploy.zip: updated API/web source, bundled theme images, database migration, and Docker deployment tooling for server administrators.
  • flocksync-release.json: generated component-version manifest, required alongside the downloads for update checking.

Publish all six files on one GitHub release. Collectors need the main addon, AppHelper, and desktop app; installing AppHelper alone does not grant website permissions. Collection only occurs while logged in and cannot retrieve guild messages sent while offline.

Component versions

  • Main addon: 0.5.0 - unchanged; no reinstall needed if already current.
  • AppHelper: 0.2.2 - unchanged; no reinstall needed if already current.
  • Desktop: 0.4.0 - updated from 0.3.1; start-minimized preference and branding.
  • Server/API/web: 0.4.0 - updated from 0.3.1; themes, persistence, attunement presentation, and favicon. API/web remain aligned.
  • Shared types: 0.4.0 - updated from 0.3.1; shared theme validation and contracts.
  • Root workspace package: 0.2.2 - unchanged; no root runtime change.

New installations

Extract the appropriate addon ZIP into Interface\AddOns, enable the addon(s), and complete the in-game walkthrough. Collectors additionally install the desktop app, select their WoW client folder, configure their server URL, and sign in with an ADMIN or OFFICER website account.

For server hosting, follow DEPLOYMENT.md. Copy .env.example to .env, configure unique credentials and your Cloudflare tunnel token, and prepare an existing writable backup directory. Keep the live SQLite database on local storage, not the NAS.

FlockSync 0.5.0

Choose a tag to compare

@JohnMartincic JohnMartincic released this 21 Oct 02:55

FlockSync 0.5.0

Addon improvements and fixes

  • Reduced redundant guild broadcasts: rapid character edits coalesce before transmission, and unchanged event-triggered scans avoid rebroadcasting within a ten-minute window. This is event-driven suppression, not a periodic background heartbeat.
  • Guild information arriving late no longer permanently blocks character broadcasts after retries expire. Leaving a guild during retries also clears the pending attempt; later scans can retry. Skipped broadcasts report a chat message.
  • Snapshot requests and responses now coordinate better with other officers already transferring data, reducing duplicate guild traffic.
  • Unrelated quest turn-ins no longer trigger full attunement scans.
  • Profession scans avoid broadcasting unchanged data, remove dropped professions when the client supplies the learned-profession list, and include a Reset button for clearing captured profession data.
  • Profession cleanup now advances the export timestamp even when triggered by the profession summary, allowing newer data to replace stale server records.
  • Item search refreshes use a bounded recency queue, keeping personal items searchable without accumulating duplicate bookkeeping entries.
  • Crafter search and recipe output resolution cache repeated lookups; enchant names take precedence over colliding numeric item IDs when recognized.
  • Tooltip annotations avoid duplicate FlockSync lines on repeated refreshes.
  • Raid invitations refresh the local guild roster cache and attempt to convert an existing party when more than five places are needed.
  • Loot recording ignores roll/crafting messages, preserves two-part player names, and improves duplicate detection for nearby officer observations.
  • Removing a registered account character clears references to that character as a main across locally collected records.

Release channel and scope

This is a normal Release-channel publication, with no alpha/beta suffix. FlockSync remains pre-1.0: version 0.5.0 does not mean every planned feature is complete or that the software has reached 1.0 maturity.

All component versions were advanced for this publication. New runtime changes are concentrated in the main addon; desktop, API/web, shared types, and AppHelper retain their previous runtime behavior and receive version/channel updates.

Existing website ADMIN/OFFICER same-guild collector support and independent AppHelper update notices remain included.

Updating the server, desktop app, and addons

  1. Preserve the server's existing .env and data directory. Obtain the new source or extract the Pi deployment package while preserving those files, then run sh deploy/update-server.sh from the deployed project directory. It verifies a database backup before rebuilding/restarting. Do not bypass the backup guard or use docker compose down -v.
  2. Check docker compose ps and docker compose logs --tail 100 api web cloudflared. For users upgrading from before 0.4.0-beta, deploy the API before the desktop app because newer desktop sync fields require the updated API.
  3. Quit the desktop app completely through Quit FlockSync in its tray menu. Install FlockSync-Setup-0.3.1-x64.exe, or replace your portable executable with FlockSync-Portable-0.3.1-x64.exe. Keep existing settings and use the full server URL without an /api suffix.
  4. Exit WoW before replacing addon files. Members install FlockSync-Raider-Only.zip; collectors install FlockSync-Addon-Bundle.zip, containing FlockSync 0.5.0 and AppHelper 0.2.2. Extract directly into Interface\AddOns, with no extra nested directory. Preserve SavedVariables, settings, and collected data.
  5. CurseForge users select main addon 0.5.0, file type Release, when available. CurseForge updates only the main addon; obtain AppHelper 0.2.2 from the GitHub officer bundle.
  6. Log in, complete the addon walkthrough if necessary, and /reload or log out to save current data. Wait for desktop sync success, then /reload to load the helper return data. Refresh the web dashboard to see newly synced records.
  7. If enabling website-linked collection for the first time, perform that sync on a character in the intended guild. The returned grant allows low-ranked alts sharing that WoW account's SavedVariables to collect in the same guild and realm. Each WoW account folder needs its own sync; a later sync replaces the guild grant, and a guildless sync clears it.

Users already on the previous beta can keep using its desktop/server/AppHelper runtime for the addon fixes alone, but should install the newly versioned components to move fully onto this Release-channel set. No component version is unchanged in this publication; no settings/database reset is required.

Download choices

  • FlockSync-Raider-Only.zip: main WoW addon for all guild members. Regular members do not need the desktop app, AppHelper, or a server account.
  • FlockSync-Addon-Bundle.zip: the same main addon plus AppHelper for officers/admins collecting guild data.
  • FlockSync-Setup-0.3.1-x64.exe: Windows desktop installer for collectors.
  • FlockSync-Portable-0.3.1-x64.exe: portable desktop alternative; choose this or the installer, not both.
  • FlockSync_Pi_Deploy.zip: API/web source and Docker deployment tooling for server administrators.
  • flocksync-release.json: generated component-version manifest, required alongside the downloads for update checking.

Publish all six files on one GitHub release. Collectors need the main addon, AppHelper, and desktop app; installing AppHelper alone does not grant website permissions. Collection only occurs while logged in and cannot retrieve guild messages sent while offline.

Component versions

  • Main addon: 0.5.0 - updated from 0.4.0-beta; addon improvements and fixes.
  • AppHelper: 0.2.2 - updated from 0.2.1-beta; version/channel update only.
  • Desktop: 0.3.1 - updated from 0.3.0-beta; version/channel update only.
  • Server/API/web: 0.3.1 - updated from 0.3.0-beta; version/channel update only, API/web remain aligned.
  • Shared types: 0.3.1 - updated from 0.3.0-beta; bundled contract package, version/channel update only.
  • Root workspace package: 0.2.2 - updated from 0.2.1-beta; workspace metadata only.

New installations

Extract the appropriate addon ZIP into Interface\AddOns, enable the addon(s), and complete the in-game walkthrough. Collectors additionally install the desktop app, select their WoW client folder, configure their server URL, and log in with an ADMIN or OFFICER website account.

For server hosting, follow DEPLOYMENT.md. Copy .env.example to .env, configure unique credentials and your Cloudflare tunnel token, and prepare an existing writable backup directory. Keep the live SQLite database on local storage, not the NAS.

Publishing and update notices

Publish one GitHub release tagged v0.5.0, titled FlockSync 0.5.0, with Set as a pre-release unchecked. Do not use a literal -release suffix. The tag and manifest releaseVersion must match exactly.

The CurseForge workflow automatically packages and publishes the main addon to project 1756960 as Release when this GitHub release is published, provided the tag includes the updated workflow and the repository has its CF_API_TOKEN secret configured. Check the workflow result and CurseForge moderation status; publication here is not a claim of server-policy approval. Do not manually re-upload a successful automated upload.

Release-channel updates are eligible for desktop/server users on Release, Beta, or Alpha. Checkers compare each component's own version, not the overall release tag. Stable addon/helper versions ignore future preview builds; preview installations can still discover eligible stable updates.

WoW cannot fetch GitHub directly. Addon notices rely on metadata from desktop sync and, for main-addon notices, guild snapshots. Cold metadata caches may require another sync. Notices appear once at initial character login, not on reloads or zone changes.

FlockSync 0.4.0-beta

FlockSync 0.4.0-beta Pre-release
Pre-release

Choose a tag to compare

@JohnMartincic JohnMartincic released this 21 Oct 01:38

FlockSync 0.4.0-beta

Guild collection on officer and admin alts

  • Website ADMIN and OFFICER accounts can now act as guild data collectors on low-ranked alts, without first logging in on an in-game officer-ranked character.
  • A successful desktop sync links collection access to the synced character's guild and realm. Other characters sharing that WoW account's SavedVariables can collect in that same guild, regardless of their in-game rank.
  • Characters in unrelated guilds, on other realms, or without a guild do not inherit this website-linked collection access.
  • Existing native guild officer detection continues to work. Uploads still require an authorized website account; installing AppHelper alone does not grant website permissions.
  • The related guild comes from the synced character, not a new website user-management setting. Each later sync replaces the linked guild; a guildless sync clears the website-linked grant. Each WoW account folder must sync separately.

Independent AppHelper update notices

  • Officers can now see a separate chat notice when their installed FlockSync AppHelper needs an update.
  • AppHelper is compared against its own component version, independently of the main addon, desktop app, and overall release tag.
  • The notice shows installed and available versions and points to github.com/GearDuckDev/FlockSync/releases for the officer bundle.
  • The GitHub address is plain chat text, not a clickable external hyperlink.
  • Notices appear once at initial character login, not repeatedly during play, reloads, or zone changes. Members without AppHelper receive no helper notice.
  • This release adds the checking support; AppHelper itself remains at 0.2.1-beta, so an existing copy at that version does not need replacing.

Updating the server, desktop app, and addons

  1. Update the API/web server first. Preserve your existing .env and data directory. From the deployed project directory, run sh deploy/update-server.sh after obtaining the new source, or apply the updated Pi deployment package while preserving those files. The update script verifies a database backup before rebuilding/restarting. Do not bypass the backup guard or use docker compose down -v.
  2. Confirm docker compose ps shows the API and web healthy, and check docker compose logs --tail 100 api web cloudflared for errors. The new desktop sync fields require this updated API; an older API can reject them.
  3. Quit the desktop app completely using Quit FlockSync in its system tray menu. Install FlockSync-Setup-0.3.0-beta-x64.exe, or replace your portable executable with FlockSync-Portable-0.3.0-beta-x64.exe. Keep your settings, enter the full server URL without an /api suffix, and log in with an ADMIN or OFFICER account.
  4. Exit WoW before replacing addon files. Install FlockSync-Raider-Only.zip, or FlockSync-Addon-Bundle.zip if you need AppHelper. Extract into Interface\AddOns without an extra nested folder. Keep existing SavedVariables, settings, and collected data.
  5. If updating the main addon through CurseForge, select FlockSync 0.4.0-beta when available and allow Beta files. Officers can keep AppHelper 0.2.1-beta; new officers obtain its folder from the GitHub officer bundle. CurseForge updates only the main addon.
  6. To activate website-linked collection, log into a character in the intended guild and complete the addon walkthrough if needed. Use /reload or log out so WoW writes the guild information to SavedVariables. Wait for the desktop app to report a successful sync, then /reload again to load the server's guild grant.
  7. Same-guild, same-realm alts on that WoW account can now collect broadcasts without an officer rank. Keep the desktop app running and logged in for uploads. Collection occurs only while logged in and does not retrieve messages sent while offline.

Older desktop clients can continue syncing against the updated server without receiving the new optional helper metadata. To enable both new features, update the server, desktop app, and main addon together in the order above.

Download choices

  • FlockSync-Raider-Only.zip: main WoW addon for all guild members. Regular members do not need the desktop app, AppHelper, or a server account.
  • FlockSync-Addon-Bundle.zip: the same main addon plus FlockSync AppHelper for officers/admins collecting guild data.
  • FlockSync-Setup-0.3.0-beta-x64.exe: Windows desktop installer for collectors.
  • FlockSync-Portable-0.3.0-beta-x64.exe: portable desktop alternative without installation; choose this or the installer, not both.
  • FlockSync_Pi_Deploy.zip: API/web source and Docker deployment tooling for server administrators.
  • flocksync-release.json: generated component-version manifest; publish alongside all downloads so update checkers can identify each component correctly.

Officers/admins collecting data need the main addon, AppHelper, and desktop app. All six files belong to this one GitHub release.

Component versions

  • Main addon: 0.4.0-beta - updated from 0.3.2-beta.
  • Desktop: 0.3.0-beta - updated from 0.2.2-beta.
  • Server/API/web: 0.3.0-beta - updated from 0.2.2-beta; API and web remain aligned.
  • Shared types: 0.3.0-beta - updated from 0.2.1-beta; bundled with the applications, no separate download needed.
  • AppHelper: 0.2.1-beta - unchanged; existing installations at this version do not need reinstalling.
  • Root workspace package: 0.2.1-beta - unchanged; not an end-user application version.

Feature-bearing components receive minor version increments. AppHelper's unchanged version is intentional: independent checking support lives in the main addon, API, and desktop app.

New installations

Extract the appropriate addon ZIP into Interface\AddOns, enable the addon(s), and complete the in-game setup walkthrough.

Collectors additionally install the Windows desktop app, configure their full server URL without an /api suffix, select their WoW client folder, and log in with an authorized website account. Follow the activation steps above to link their guild.

For server hosting, follow DEPLOYMENT.md. Copy .env.example to .env, configure unique credentials and your Cloudflare tunnel token, and prepare an existing writable backup directory. Keep the live SQLite database on local storage, not the NAS. Preserve .env and data during future upgrades.

Update notices and channels

This is a Beta release. Publish the single GitHub release as v0.4.0-beta and mark it pre-release. Use Beta for the CurseForge main addon upload.

Desktop and server users should select the Beta update channel to discover these builds. Release accepts stable versions only; Beta accepts beta and stable; Alpha accepts alpha, beta, and stable.

Update checkers compare each component's own version, not the overall tag. Main-addon and AppHelper notices independently follow their installed version's channel: stable installations ignore previews, beta installations accept beta/stable, and alpha installations accept all channels.

WoW cannot query GitHub directly. Release metadata arrives through desktop sync; main-addon metadata can also reach members through guild snapshots. A cold server release cache may require another sync. Fresh metadata may require a subsequent sync and initial character login before a notice appears; /reload alone does not trigger the initial-login notice.

FlockSync 0.3.5-beta

FlockSync 0.3.5-beta Pre-release
Pre-release

Choose a tag to compare

@JohnMartincic JohnMartincic released this 21 Oct 01:10

FlockSync 0.3.5-beta

Addon fixes

  • Fixed stale gear and last-seen information when officer detection was unavailable.
  • The addon now saves the logged-in character's own scan regardless of officer catcher status.
  • Equipment is captured again at logout or reload, preventing pending scans from leaving removed items in the exported data.
  • Collecting other players' guild broadcasts remains restricted to officers.
  • Older character updates cannot restore removed equipment or move last-seen timestamps backwards.

Updating the addon

  1. Download FlockSync-Raider-Only.zip, or FlockSync-Addon-Bundle.zip if you also need the officer helper.
  2. Exit WoW before replacing addon files.
  3. Extract into your WoW client's Interface/AddOns directory. FlockSync/FlockSync.toc must sit directly inside the FlockSync addon folder, not an extra nested directory.
  4. Keep your existing SavedVariables files; do not delete your settings or collected data.
  5. Log in and allow the addon to load. After changing equipment, use /reload or log out so WoW writes SavedVariables.
  6. Officers: wait for the desktop app to report a successful sync.
  7. Click Refresh on the web dashboard to load the latest gear and last-seen information.

If using CurseForge, install main addon version 0.3.2-beta when available. You may need to allow Beta files in the client. Officers using CurseForge for the main addon can obtain the separate FlockSync_AppHelper folder from the GitHub officer bundle.

Last seen represents the character's in-game scan time, not the desktop upload time. Re-uploading an unchanged file does not make an offline character appear recently seen. The web roster currently requires a manual Refresh to show new server data.

Download choices

  • FlockSync-Raider-Only.zip: main WoW addon for all guild members. Regular members do not need the desktop app, AppHelper, or a server account.
  • FlockSync-Addon-Bundle.zip: the same main addon plus FlockSync AppHelper for officers collecting guild data.
  • FlockSync-Setup-0.2.2-beta-x64.exe: Windows desktop installer for officers.
  • FlockSync-Portable-0.2.2-beta-x64.exe: portable desktop alternative without installation.
  • FlockSync_Pi_Deploy.zip: API/web server source and Docker deployment tooling.
  • flocksync-release.json: component versions used by update checkers; published alongside the downloads.

Officers collecting data need the main addon, AppHelper, and the desktop app. Installing AppHelper does not itself grant officer permissions.

Component versions

  • Main addon: 0.3.2-beta — updated
  • AppHelper: 0.2.1-beta — unchanged
  • Desktop: 0.2.2-beta — unchanged
  • Server/API/web: 0.2.2-beta — unchanged

Existing desktop, server, and AppHelper installations at these versions do not need reinstalling for this addon fix. All downloads remain included for convenient first-time installation.

New installations

Extract the appropriate addon ZIP into Interface/AddOns, enable the addons, and complete the in-game setup walkthrough.

Officers additionally install the Windows desktop app, configure their full server URL without an /api suffix, select their WoW client folder, and log in with an authorized account.

For server hosting, follow DEPLOYMENT.md in the repository. Copy .env.example to .env, configure unique credentials and your Cloudflare tunnel token, and prepare an existing writable backup directory. Keep the live SQLite database on local storage, not the NAS.

For future server upgrades, preserve .env and data and use sh deploy/update-server.sh. It verifies a database backup before rebuilding or restarting the application. Do not bypass the backup guard or use docker compose down -v.

Update notices

This is a Beta release. Desktop and server update checks compare each component's version, so the new overall tag does not prompt users already running the unchanged desktop/server versions.

Addon notices use release metadata received through desktop sync and guild relay. Beta addon installations can receive beta or stable notices; alpha installations can receive all channels; stable installations ignore previews. Notices appear only at initial character login, so fresh metadata may require a subsequent sync and login.

FlockSync v0.3.3-beta

FlockSync v0.3.3-beta Pre-release
Pre-release

Choose a tag to compare

@JohnMartincic JohnMartincic released this 21 Oct 00:45

FlockSync 0.3.3-beta

Desktop fixes

  • Fixed the app clearing the previously documented server URL, causing “Failed to parse URL from /api/sync”.
  • Invalid server URLs now display an actionable settings error.
  • Excluded unrelated addon saves and temporary files from file watching, preventing errors involving files such as Auctionator.lua.tmp.
  • FlockSync.lua creation and replacement remain monitored for sync.

Updating the desktop app

  1. Quit FlockSync completely, including its system-tray icon.
  2. Run FlockSync-Setup-0.2.2-beta-x64.exe, or replace your portable executable with FlockSync-Portable-0.2.2-beta-x64.exe.
  3. Open the app and verify the API URL in settings. Use your full server origin, such as https://flocksync.gearduckdev.com, without an /api suffix.
  4. Save settings and run a manual sync. An already-cleared URL must be entered again.

Download choices

  • Setup EXE: Windows desktop installer for officers.
  • Portable EXE: Windows desktop app without installation.
  • FlockSync-Raider-Only.zip: main WoW addon for guild members.
  • FlockSync-Addon-Bundle.zip: main addon plus AppHelper for officers.
  • FlockSync_Pi_Deploy.zip: API/web Docker deployment source.
  • flocksync-release.json: component versions used by update checkers.

Component versions

  • Desktop: 0.2.2-beta — updated
  • Server/API/web: 0.2.2-beta — unchanged
  • Main addon: 0.3.1-beta — unchanged
  • AppHelper: 0.2.1-beta — unchanged

Existing server and addon installations do not need updating for these desktop fixes. Choose Beta or Alpha in desktop update settings to receive this beta notice; Release-only settings exclude it.

For new installations, follow the repository’s DEPLOYMENT.md. Guild members need only the main addon; officers collecting data also need AppHelper and the desktop app.

FlockSync 0.3.2-beta

FlockSync 0.3.2-beta Pre-release
Pre-release

Choose a tag to compare

@JohnMartincic JohnMartincic released this 21 Oct 00:05

FlockSync 0.3.2-beta

This beta fixes server deployment and update reliability. Desktop and addon versions are unchanged and remain included for convenient installation.

Fixed

  • Fixed pre-update backups failing after the API was stopped.
  • Server updates now start missing or stopped Cloudflare tunnel containers.
  • Fixed passing the configured tunnel token to Cloudflare.
  • Simplified deployment to use .env, allowing normal docker compose commands without an extra environment-file flag.
  • Added automated update and deployment regression tests.

Downloads

  • FlockSync_Pi_Deploy.zip: API/web server source and Docker deployment tooling.
  • FlockSync-Setup-0.2.1-beta-x64.exe: Windows desktop installer for officers collecting guild data.
  • FlockSync-Portable-0.2.1-beta-x64.exe: Portable alternative to the installer.
  • FlockSync-Raider-Only.zip: Main WoW addon for guild members.
  • FlockSync-Addon-Bundle.zip: Main addon plus AppHelper for officers using desktop sync.
  • flocksync-release.json: Component versions used by update checkers; upload alongside all downloads.

Existing server installations

  1. Preserve your environment configuration and the entire data directory when extracting the updated server ZIP. Do not move the live SQLite database to the NAS.

  2. If your configuration is still named .env.production, rename it to .env. Do not overwrite an existing .env; merge settings if both exist.

  3. Remove any old COMPOSE_ENV_FILES=.env.production override. Keep your existing credentials, tunnel token, and NAS path.

  4. Ensure the configured backup destination is mounted and writable.

  5. From the deployed FlockSync directory, run:

    sh deploy/update-server.sh

  6. Check:

    docker compose ps
    docker compose logs --tail 100 api web cloudflared db-backup

  7. Verify public website login and desktop sync.

The update script verifies a database backup before rebuilding/restarting the application. Backup failure aborts the update. Do not bypass this guard or use docker compose down -v.

New installations

Extract FlockSync_Pi_Deploy.zip, copy .env.example to .env, and configure unique credentials, your Cloudflare tunnel token, and an existing backup directory. Follow DEPLOYMENT.md in the repository for NAS mounting, database-directory ownership, and tunnel setup before starting with docker compose up -d --build.

For WoW, extract the appropriate addon ZIP directly into Interface/AddOns. Officers also run the desktop app, configure the server URL and WoW folder, and log in. Other guild members need only the member addon. Complete the in-game setup walkthrough.

Versions and update notices

  • Server/API/web: 0.2.2-beta
  • Desktop: 0.2.1-beta (unchanged)
  • Main addon: 0.3.1-beta (unchanged)
  • AppHelper: 0.2.1-beta (unchanged)

Choose Beta or Alpha in update settings to see this beta server update. Release-only settings exclude beta releases. Update checks compare each component's own version, so unchanged desktop and addon installations do not show a new update merely because the overall release tag changed.

FlockSync 0.3.1-beta

FlockSync 0.3.1-beta Pre-release
Pre-release

Choose a tag to compare

@JohnMartincic JohnMartincic released this 20 Oct 02:46

FlockSync 0.3.1-beta

FlockSync connects your WoW Forever guild's in-game data to a guild management dashboard. This beta includes the in-game addons, Windows desktop sync app, and self-hosted web/API deployment package.

Supported game interface: WoW Forever, Interface 16001.

This is testing software, not a stable general-availability release. Back up your data before upgrading and report problems without including credentials or private account data.

What's new

  • Choose Release, Beta, or Alpha update channels in the desktop app and web admin settings.
  • See a small, non-blocking web/API update banner when a newer eligible server version is available.
  • Receive addon update reminders once at initial character login—not repeatedly during play, UI reloads, or zone changes.
  • Publish and download everything from one combined release. Each update checker compares its own component version, so unchanged components do not trigger false update notifications.
  • Automatically create and verify a SQLite backup before server upgrades performed through the new guarded update script. Backup failure stops the upgrade.
  • Added a repeatable packaging and release guide.

Included versions

Component Version
Overall release 0.3.1-beta
FlockSync main addon 0.3.1-beta
FlockSync AppHelper 0.2.1-beta
Windows desktop app 0.2.1-beta
Web dashboard and API 0.2.1-beta

Different component versions are intentional. The overall release is a bundle, not a requirement that every component share a version.

Which download do I need?

Download What it is / who needs it
FlockSync-Raider-Only.zip Main in-game addon. This is all ordinary guild members need.
FlockSync-Addon-Bundle.zip Main addon plus AppHelper. Intended for officers running desktop synchronization. Install this instead of the member ZIP, not in addition to it.
FlockSync-Setup-0.2.1-beta-x64.exe Windows desktop installer for officers who upload guild data.
FlockSync-Portable-0.2.1-beta-x64.exe Alternative Windows desktop build that runs without an installer. Choose this OR Setup.
FlockSync_Pi_Deploy.zip Source and Docker configuration for administrators hosting the web dashboard and API. Not needed by ordinary players.
flocksync-release.json Component-version manifest used by update checkers. Leave it attached to this release; players do not need to install or edit it.

GitHub's automatically generated “Source code” archives are not the packaged member addon or Windows application. Use the downloads listed above.

How FlockSync works

  1. The main addon scans supported character data, including gear, roles, and guild-planning information.
  2. Characters share updates through hidden guild addon messages.
  3. Officer catchers aggregate guild data into their account's SavedVariables.
  4. The officer's desktop app watches those files and uploads changes to the configured guild API using an authenticated officer/admin account.
  5. The API stores the data, and the web dashboard provides guild roster and planning tools.
  6. Server return data is written through AppHelper and loaded in-game. Officers can relay guild snapshots to members who do not run the desktop app.

WoW normally writes SavedVariables on logout or /reload, not continuously. Uploads and return data are therefore not an instant, live connection to the running game.

Installation

Guild members: main addon only

  1. Exit WoW.

  2. Download and extract FlockSync-Raider-Only.zip.

  3. Copy the FlockSync folder directly into your game's Interface\AddOns directory.

  4. Confirm the resulting layout is:

    Interface\AddOns\FlockSync\FlockSync.toc

    Do not leave an extra ZIP-name or bundle folder between AddOns and FlockSync.

  5. Enable FlockSync in the character-selection AddOns list.

  6. Log in and finish the first-time walkthrough. Choose your features, role/off-spec, and main character. Scanning and broadcasting remain paused until you finish onboarding.

Daily controls:

  • /fs: daily-use features.
  • /fs options: settings.
  • Minimap left-click: features.
  • Minimap right-click: settings.

Members do not need the desktop app or AppHelper just to broadcast character data. A web account is only needed to sign in to the dashboard.

Officers: addons and Windows sync app

  1. Exit WoW.

  2. Download FlockSync-Addon-Bundle.zip and extract both folders directly into Interface\AddOns:

    Interface\AddOns\FlockSync\FlockSync.toc
    Interface\AddOns\FlockSync_AppHelper\FlockSync_AppHelper.toc

  3. Enable both addons in WoW.

  4. Download either the desktop Setup executable or the Portable executable.

  5. If upgrading, fully quit the old app using Quit FlockSync in its system tray menu first. Closing the window may only minimize it to the tray.

  6. Install/run the new app.

  7. Enter the API server URL provided by your guild administrator, such as https://guild.example.com. Do not add an /api suffix.

  8. Sign in with an account assigned OFFICER or ADMIN by your server administrator. Registering an account does not automatically grant officer access.

  9. Select your WoW installation directory and keep the desktop app running while playing.

  10. Complete addon onboarding and use /reload or log out to write data for synchronization. Confirm the desktop app reports a successful sync.

Officer alts

Log in with a character whose guild permissions/rank qualify as an officer so FlockSync can recognize that guild for the WoW account. Other characters on that same WoW account can then act as catchers while in the same recognized guild.

This does not grant catcher status in unrelated guilds. Local Test Officer Mode is off by default and normally should remain off.

Loading returned server data

For the clearest return-trip test: log out of WoW, let the desktop sync complete, then log back in. AppHelper reads the returned SavedVariables when the game loads them. A /reload writes the game's existing in-memory SavedVariables before reloading, so do not assume an external file edit immediately replaces data already loaded in-game.

Dashboard users

Open the guild dashboard URL provided by your administrator and sign in or create an account if registration is available. Ask an administrator for officer access if your responsibilities require it.

The dashboard provides roster and gear views, availability, team planning, crafting/gear-goal tools, and role-restricted management features. Available controls depend on your account role.

Self-hosting the server: first installation

The deployment package contains the web dashboard, API, shared contracts, Docker build files, reverse-proxy configuration, and backup tooling. It does not contain a prebuilt Docker image, real credentials, or an existing database.

Requirements:

  • A 64-bit Linux host, such as Raspberry Pi OS/Debian on a Raspberry Pi 5.
  • Docker Engine and the Docker Compose plugin.
  • Local storage for the live SQLite database. Do not place the live database on a NAS share.
  • A writable backup directory, optionally on a mounted NAS.
  • For the included public-access setup, a Cloudflare-managed hostname and Cloudflare Tunnel token.
  1. Download FlockSync_Pi_Deploy.zip and extract it on the server. Open a terminal in its top-level FlockSync directory.

  2. Create your production environment file:

    cp .env.production.example .env.production
    openssl rand -hex 32
  3. Edit .env.production:

    • Set JWT_SECRET to a newly generated random secret.
    • Set INITIAL_ADMIN_EMAIL and a unique INITIAL_ADMIN_PASSWORD of at least 16 characters.
    • Set CLOUDFLARE_TUNNEL_TOKEN to your tunnel token.
    • Set NAS_BACKUP_PATH to your chosen existing backup directory.
    • Set GITHUB_REPOSITORY if using a different public release repository.

    Keep this file private. The initial admin is created only when the users table is empty; changing the environment password later does not reset an existing account.

  4. Prepare database storage:

    mkdir -p data/sqlite
    sudo chown 1000:1000 data/sqlite
  5. Prepare backups:

    • NAS: mount the share first, verify it is actually mounted, and confirm the backup container will have write access.
    • Local trial: create data/backups and set NAS_BACKUP_PATH=./data/backups.

    The configured destination must already exist. A directory existing at a NAS mountpoint does not prove that the NAS is mounted.

  6. In Cloudflare Tunnel's public-hostname settings, route your chosen hostname to the HTTP service http://web:80.

  7. Build and start the stack:

    docker compose --env-file .env.production up -d --build
    docker compose --env-file .env.production ps
    docker compose --env-file .env.production logs --tail 100 api web db-backup cloudflared
  8. Open your own HTTPS hostname and sign in with the initial admin account. Verify /health at that hostname and test a desktop sync.

  9. Give guild officers your hostname as their desktop API server URL and assign their web/API accounts the appropriate role.

The supplied Compose configuration does not publish host ports. Access through the configured tunnel, or deliberately configure your own reverse proxy/network exposure. Browser-only Cloudflare Access challenges can prevent desktop API calls; the desktop app does not implement Cloudflare Access service-token authentication.

Upgrading an existing server

  1. Preserve your existing .env.production and data directory. Keep a separate secure copy of configuration.

  2. Extract/select the new deployment source without overwriting those files or deleting data.

  3. Confirm NAS_BACKUP_PATH points to an existing, writable destination. Verify the NAS is mounted if applicable.

  4. From the deployed project directory, run:

    sh...
Read more