Skip to content

CHANGELOG.md

Latest commit

 

History

History
168 lines (133 loc) · 10.5 KB

CHANGELOG.md

File metadata and controls

168 lines (133 loc) · 10.5 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog.

[0.8.0] - 2026-06-19

Added

  • install.sh --dev flag — installs from main on GitLab instead of the latest GitHub release, enabling a pre-release smoke test of the official install path
  • CI smoke-test jobs — run the real install.sh against the current checkout under each supported package manager (uv, pipx, pip) and then start the CLI (deepfellow version / deepfellow --help); gate the release stage so a broken install, dispatch regression, or startup crash blocks the GitHub push
  • infra restart and server restart commands — restart the whole Docker Compose stack for their scope in one step (stop then start), instead of running stop and start manually
  • deepfellow otel logs command — tails the local OpenTelemetry collector (installed via server install --otel-local) with -f/--follow and -n/--tail, consistent with server logs; reports clear errors when the collector is not installed or not running
  • infra env set and server env set now prompt to restart the stack after updating the .env file, so the new value takes effect immediately without a manual restart
  • server install and server update now automatically select the newest semver-tagged image from the registry (e.g. v1.2.3) instead of :latest, matching the existing behaviour of infra install and infra update; falls back to :latest if the registry is unreachable
  • Unit tests for infra disconnect covering directory checks, service-running guard, confirmation flow, env variable handling, and disconnect execution paths
  • Unit test coverage for infra install raised to 100%
  • Unit test coverage for infra start raised to 100%
  • Unit tests for server create-admin command
  • Added http(s) to ws(s) converter which allows connecting Infra even with http(s) URL provided.
  • deepfellow uninstall command — uninstalls the CLI using the detected package manager (uv tool, pipx, or pip); falls back to the DF_UNINSTALL_COMMAND value stored in config for custom setups
  • server install and server reconfigure now prompt to choose between dense and sparse embedding type; selecting sparse automatically uses the BGE-M3 model
  • DF_MONGO_PORT — configurable host port for the local MongoDB instance (default 27017); server install now publishes MongoDB on the specified port instead of only exposing it within the Docker network

Changed

  • server install now frames the MongoDB and vector database prompts as a local install by default ("Install a local MongoDB for DeepFellow Server?" / "Install a local vector database for DeepFellow Server?", default Yes), so accepting the defaults produces a working local stack; connecting an existing/external instance now requires answering No and providing its connection details
  • server create-admin now prints the password requirements up front and re-prompts in a loop on an invalid password instead of exiting, matching the existing behaviour of the name and email prompts; --non-interactive still exits with code 1 on a missing or invalid password
  • Increased timeout when connecting Infras to 60 seconds.

[0.7.0] - 2026-06-11

Added

  • deepfellow infra service list command — calls GET /admin/services and displays the installed service backends
  • just deptry command — runs deptry to detect imports used in source but not declared as explicit dependencies in pyproject.toml; integrated into just check and the CI/CD pipeline

Changed

  • Removed unused symbols from common modules: merge_services(), ConfigValidationError, check_directory_exist(), validate_config(), Infras dataclass, and legacy constants DF_INFRA_REPO, DF_SERVER_REPO, API_ENDPOINTS; corresponding tests deleted
  • server install and server opentelemetry now use DF_OTEL_EXPORTER_OTLP_ENDPOINT as the default OTel URL instead of None

Fixed

  • server uninstall and infra uninstall no longer crash with PermissionError on Docker-owned directories; they now warn the user, ask to retry with sudo rm -rf (auto-confirmed with --yes), and print a clear manual-removal message if sudo is declined or unavailable
  • Server compose.yaml now forwards DF_PLUGINS_SETUP and DF_LOG_LEVEL to the server container, so server env set PLUGINS_SETUP ... actually reaches the server (previously plugins like DFAnonymizePlugin never saw their configuration); server install writes defaults ({} / INFO), preserves existing values on reinstall and validates both before writing
  • server install --otel-local installs a local debug-only OpenTelemetry collector non-interactively (mutually exclusive with --otel-url); previously the local collector could only be enabled through interactive prompts

[0.6.0] - 2026-06-10

Added

  • server install and server reconfigure now offer a debug-only OTel collector mode: when the user opts to run OTel locally, a new prompt asks whether to export to Elasticsearch (default: No); answering No starts the otel-collector without any Elasticsearch dependency

Changed

  • CLI runtime flags now come from an internal AppState singleton instead of the Click context, so the CLI runs on Typer 0.26.x (previously pinned to 0.16.x to avoid a startup crash)

Fixed

  • server env info now displays variable names with the DF_ prefix (e.g. DF_SERVER_PORT) to match the names Docker/shell require, while server info keeps showing runtime values without the prefix

[0.5.0] - 2026-06-03

Added

  • Added --api-key option to infra service install to support remote services requiring an API key (e.g. claude)
  • Added per-service spec building for known cloud services (claude, google, openai, sindri); required fields with defaults (e.g. anthropic_version) are applied automatically

Fixed

  • deepfellow cli update command — upgrades the CLI using the detected package manager (uv tool, pipx, or pip)
  • df infra connect now verifies the WebSocket mesh connection is live before reporting success, with multi-stage polling of /admin/mesh/topology, detection of outdated images (HTML response) and legacy parent API (Docker log fallback), and a warning when a localhost URL is used
  • Increased maximum password length from 19 to 128 characters

[0.4.0] - 2026-05-28

Fixed

  • pin typer~=0.16.0 to prevent crash on startup caused by Typer 0.26+ vendoring its own Click fork with a separate context stack, breaking click.get_current_context() calls

Fixed

  • server reconfigure now preserves existing MongoDB admin credentials instead of regenerating them

Added

  • infra info and server info now display styled output: DF_ prefix stripped, sensitive values masked by default (--secret to reveal), undefined variables shown as undefined, and --doc flag for per-variable descriptions
  • Added unit tests for infra stop command
  • Added unit tests for infra update command
  • Added unit tests for infra ssl-on command (100% branch coverage)
  • Added unit tests for infra install command

[0.3.1] - 2026-05-21

  • fix: infra install — docker compose pull failure now shows error message
  • fix: server login — fix KeyError crash when server response lacks refresh_token

[0.3.0] - 2026-05-20

  • deepfellow infra prune — removes all infra containers, volumes, and files
  • deepfellow server prune — removes all server containers, volumes, and files

[0.2.2] - 2026-05-19

  • fix release process

[0.2.1] - 2026-05-19

  • styling for the echo.choice
  • echo.choice now handles from_args
  • install --directory sets storage path automatically
  • vector database selection text styling consistency
  • create random credentials for
    • metrics endpoint
    • default mongo
    • default milvus
  • fix for non interactive:
    • server
    • infra civitai key
    • infra hugging face key
  • server install now persists OTEL data between runs
  • fix: mongo compatibility on some systems
  • fix: password minimum length enforced to 10 characters
  • refresh token automatically on server login
  • bind docker ports to localhost only (do not expose publicly)
  • recommend rootless Docker mode for infra installs
  • add healthcheck for Qdrant container
  • fix: too wide permissions on mongo database
  • fix: outdated Docker Compose service names

[0.2.0]

  • Qdrant as a default vector database
  • deepfellow infra status / deepfelow server status - displays container status and resource usage
  • Added non-interactive mode support with --non-interactive flag for all commands

[0.1.0] - 2026-01-16

Added

  • Initial release of DeepFellow CLI
  • Server management commands:
    • deepfellow server install - Install DeepFellow Server with docker
    • deepfellow server start - Start DeepFellow Server
    • deepfellow server stop - Stop DeepFellow Server
    • deepfellow server update - Update DeepFellow Server
    • deepfellow server login - Login user and store the token in the secrets file
    • deepfellow server create-admin - Create admin
    • deepfellow server password-reset - Password reset
    • deepfellow server opentelemetry - Connect to Open Telemetry
    • deepfellow server project - Manage Projects
    • deepfellow server organization - Manage Organizations
    • deepfellow server env - Manage DeepFellow Server environment variables
    • deepfellow server info - Display environment configuration
  • Infra management commands:
    • deepfellow infra install - Install infra with docker
    • deepfellow infra start - Start DeepFellow Infra
    • deepfellow infra stop - Stop DeepFellow Infra
    • deepfellow infra update - Update DeepFellow Infra
    • deepfellow infra ssl-on - Switch on the SSL
    • deepfellow infra connect - Connect two Infras together
    • deepfellow infra disconnect - Disconnect infra
    • deepfellow infra service - Manage DeepFellow Infra services
    • deepfellow infra model - Manage DeepFellow Infra models
    • deepfellow infra env - Manage Infra environment variables
    • deepfellow infra info - Display environment configuration
  • Support for Docker Compose features
  • Environment variable management for both server and infra
  • OpenTelemetry integration support for server installations
  • Project and organization management capabilities
  • Password reset functionality
  • Admin creation support
  • Service and model management for infra
  • SSL configuration support
  • Environment configuration and management
  • deepfellow service uninstall get --purge option to clear its files
  • deepfellow model uninstall get --purge option to clear its files