OpenParable
Skip to content
← Back to skills

Steedos Builder6 Internals

Development
steedos-builder6-internals

Steedos Builder6 Internals is an Agent Skill for development published in the steedos/steedos-platform repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Builder6 Server architecture: NestJS 11 + Moleculer 0.14 hybrid monorepo. TRIGGER: @builder6/* packages, monorepo structure, module organization, bootstrap, middleware, guards; B6_* environment variables, dotenv-flow, STEEDOS_ compatibility aliases, ConfigService access. SKIP: use API → steedos-builder6-api; Steedos Server internals → steedos-server-internals; project env config → steedos-configuration.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/steedos/steedos-platform/blob/HEAD/skills/steedos-builder6-internals/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/steedos-builder6-internals, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Builder6 Server Architecture & Configuration

Overview | 概述

Builder6 Server is a NestJS + Moleculer hybrid monorepo powering the Steedos platform. It uses Nx + Lerna for workspace management with 20+ specialized @builder6/* packages.

Technology Stack | 技术栈

  • HTTP: NestJS 11 (Express adapter)
  • Microservices: Moleculer 0.14
  • Real-time: Socket.IO (HybridAdapter)
  • Database: MongoDB via MongodbService
  • Session/Cache: Redis (connect-redis + ioredis)
  • Auth: JWT + session tokens via @builder6/core
  • API Docs: Swagger at /api/v6
  • Build: Nx 22 + Lerna 9 + Yarn 3.8

Monorepo Structure | 结构

builder6-server/
├── package.json
├── nx.json / lerna.json
└── packages/
    ├── server/          # @builder6/server — main entry
    ├── core/            # @builder6/core — auth, config, mongodb, plugins, filters, websockets
    ├── tables/          # @builder6/tables — data table CRUD with DataLoader
    ├── files/           # @builder6/files — file upload (local + S3)
    ├── pages/           # @builder6/pages — micro page management
    ├── email/           # @builder6/email — SMTP + queue
    ├── rooms/           # @builder6/rooms — real-time collaboration
    ├── moleculer/       # @builder6/moleculer — NestJS-Moleculer bridge
    ├── microservices/   # @builder6/microservices — service management
    ├── steedos/         # @builder6/steedos — Steedos metadata + ObjectQL
    ├── oidc/            # @builder6/oidc — OIDC client
    ├── onlyoffice/      # @builder6/onlyoffice — document editing
    ├── query-mongodb/   # @builder6/query-mongodb — DevExtreme query adapter
    └── cli/             # @builder6/cli — CLI tool

NestJS Module Tree

AppModule.forRoot() imports:

ModulePackagePurpose
ConfigModule@nestjs/configGlobal config
MoleculerModule@builder6/moleculerMoleculer broker
AuthModule@builder6/coreJWT + session auth
MongodbModule@builder6/coreMongoDB pool
SteedosModule@builder6/steedosMetadata + ObjectQL
TablesModule@builder6/tablesData table CRUD
FilesModule@builder6/filesFile upload/download
PluginModule@builder6/coreDynamic plugin loading

Bootstrap & Middleware

bootstrap()
  1. NestFactory.create(AppModule.forRoot({}))
  2. Redis cluster transport
  3. Logger + AllExceptionsFilter
  4. HybridAdapter (Socket.IO)
  5. CORS (all origins)
  6. Redis session store
  7. Swagger at /api/v6
  8. Middleware: cookieParser → JSON(50mb) → urlencoded(100mb) → compression
  9. Start microservices → listen on B6_PORT

Guards

GuardUsage
AuthGuardTables, Files, Users endpoints
AdminGuardDirect MongoDB API (profile === 'admin')

Key Design Patterns

  • Controller → Service → MongodbService: Standard NestJS layered architecture
  • @InjectBroker(): Inject Moleculer broker into NestJS services
  • DataLoader: Batch loading for lookup field resolution
  • @builder6/query-mongodb: DevExtreme → MongoDB aggregation

Development Commands

yarn start:dev      # Hot reload
yarn start:debug    # Debug mode
yarn start:prod     # Production
yarn build          # Build all
yarn lint           # Lint

Configuration | 配置

Environment Variable Parsing | 环境变量解析

getEnvConfigs() in @builder6/core parses B6_* and STEEDOS_* env vars via dotenv-flow:

  • Underscores become nested keys: B6_MONGO_URL → configService.get('mongo.url')
  • "true"/"false" → boolean, numeric strings → numbers
  • B6_ takes precedence over STEEDOS_

Steedos Compatibility Aliases | 兼容别名

Legacy VariableMaps To
MONGO_URLB6_MONGO_URL
ROOT_URLB6_ROOT_URL
PORTB6_PORT
TRANSPORTERB6_TRANSPORTER
CACHERB6_CACHER
JWT_SECRETB6_JWT_SECRET

All B6_* Variables

Server Core

VariableDefaultDescription
B6_PORT5100Server port
B6_ROOT_URLhttp://127.0.0.1:5100Root URL
B6_HOMEprocess.cwd()Working directory
B6_LOG_LEVELwarnLog level

Database & Cache

VariableDefaultDescription
B6_MONGO_URLmongodb://127.0.0.1/steedosMongoDB
B6_TRANSPORTERredis://127.0.0.1:6379Moleculer transporter
B6_CACHERredis://127.0.0.1:6379/1Moleculer cacher
B6_NAMESPACEsteedosMoleculer namespace

Authentication

VariableDefaultDescription
B6_JWT_SECRETsteedosJWT secret
B6_SESSION_SECRETsteedos-session-secretSession secret
B6_SESSION_PREFIXsteedos-session:Redis session prefix

File Storage

VariableDefaultDescription
B6_STORAGE_DIR./steedos-storageLocal storage dir
B6_CFS_STORElocallocal or S3
B6_CFS_AWS_S3_*—S3 endpoint, key, secret, region, bucket
B6_CFS_DOWNLOAD_PUBLIC["avatars"]Public download collections

Plugin System

VariableDescription
B6_PLUGIN_MODULESNestJS module packages
B6_PLUGIN_PACKAGESMoleculer service packages
B6_PLUGIN_NPMRCCustom npm registry

ConfigService Access

@Injectable()
export class MyService {
  constructor(private configService: ConfigService) {}
  example() {
    const mongoUrl = this.configService.get('mongo.url');
    const port = this.configService.get('port');
  }
}