Member Junction
    Preparing search index...

    Interface InstallConfig

    interface InstallConfig {
        AnthropicKey?: string;
        APIPassword: string;
        APIPort: number;
        APIUser: string;
        AuthProvider: "entra" | "auth0" | "none";
        AuthProviderValues?: Record<string, string>;
        BaseEncryptionKey?: string;
        CodeGenPassword: string;
        CodeGenUser: string;
        CreateNewUser?: {
            Email: string;
            FirstName: string;
            LastName: string;
            Username: string;
        };
        DatabaseAdminPassword?: string;
        DatabaseAdminUser?: string;
        DatabaseHost: string;
        DatabaseName: string;
        DatabasePlatform: "sqlserver"
        | "postgresql";
        DatabasePort: number;
        DatabaseTrustCert: boolean;
        ExplorerPort: number;
        InstallMode: "distribution" | "monorepo";
        MistralKey?: string;
        OpenAIKey?: string;
        PackageManager: PackageManagerType;
    }
    Index

    Properties

    AnthropicKey? APIPassword APIPort APIUser AuthProvider AuthProviderValues? BaseEncryptionKey? CodeGenPassword CodeGenUser CreateNewUser? DatabaseAdminPassword? DatabaseAdminUser? DatabaseHost DatabaseName DatabasePlatform DatabasePort DatabaseTrustCert ExplorerPort InstallMode MistralKey? OpenAIKey? PackageManager

    Properties

    AnthropicKey?: string

    Anthropic API key for AI features. Leave blank to skip.

    APIPassword: string

    Password for the MJAPI SQL login.

    APIPort: number

    TCP port for the MJAPI GraphQL server (default: 4000).

    APIUser: string

    SQL login used by MJAPI at runtime for read/write data access. Typically granted db_datareader, db_datawriter, and EXECUTE (common value: "MJ_Connect"; no auto-applied default).

    AuthProvider: "entra" | "auth0" | "none"

    Authentication provider selection.

    • 'entra' — Microsoft Entra (MSAL) authentication.
    • 'auth0' — Auth0 authentication.
    • 'none' — skip authentication setup (default for fresh installs).
    AuthProviderValues?: Record<string, string>

    Provider-specific configuration values (e.g., TenantID, ClientID, Domain). Keys vary by AuthProvider:

    • Entra: TenantID, ClientID
    • Auth0: Domain, ClientID, ClientSecret
    BaseEncryptionKey?: string

    Base64-encoded 32-byte encryption key used for MJ field-level encryption. If omitted, the installer will generate one automatically.

    CodeGenPassword: string

    Password for the CodeGen SQL login.

    CodeGenUser: string

    SQL login used by mj codegen to read/write schema metadata. Typically granted db_owner role (common value: "MJ_CodeGen"; no auto-applied default).

    CreateNewUser?: {
        Email: string;
        FirstName: string;
        LastName: string;
        Username: string;
    }

    Optional new user to create in the MJ database during install. Populated interactively when the user opts in, or via --config.

    Type Declaration

    • Email: string

      Email address for the new user.

    • FirstName: string

      First name.

    • LastName: string

      Last name.

    • Username: string

      Login username (defaults to email if left blank).

    DatabaseAdminPassword?: string

    Password for DatabaseAdminUser. Never persisted.

    DatabaseAdminUser?: string

    A SQL login with rights to create databases and logins (for example sa). When the database and the two logins above are not set up yet, the database phase signs in with this login and runs mj-db-setup.sql itself. It is used only for that one step and is never written to .env, the install state, or the diagnostic report. Interactive installs ask for it when it is needed.

    DatabaseHost: string

    Database hostname or IP address (default: "localhost").

    DatabaseName: string

    Target database name (common value: "MemberJunction"; no auto-applied default).

    DatabasePlatform: "sqlserver" | "postgresql"

    Database platform (default: 'sqlserver'). Decides the default port, the setup script the database phase generates and runs, and — for 'postgresql' — the DB_PLATFORM / dbPlatform settings written to .env and mj.config.cjs. Set with MJ_INSTALL_DB_PLATFORM.

    DatabasePort: number

    Database TCP port (default: 1433 for SQL Server, 5432 for PostgreSQL).

    DatabaseTrustCert: boolean

    Whether to trust self-signed TLS certificates (SQL Server only; common for local dev instances).

    ExplorerPort: number

    TCP port for the MJExplorer Angular dev server (default: 4200 for distribution, 4201 for monorepo).

    InstallMode: "distribution" | "monorepo"

    Installation mode selection.

    • 'distribution' (default) — Downloads the lightweight bootstrap ZIP containing only MJAPI, MJExplorer, GeneratedEntities, and GeneratedActions as workspace packages. All @memberjunction/* packages come from npm.
    • 'monorepo' — Downloads the full MemberJunction source repository. Use this if you need to work on MJ framework code itself.
    MistralKey?: string

    Mistral API key for AI features. Leave blank to skip.

    OpenAIKey?: string

    OpenAI API key for AI features. Leave blank to skip.

    PackageManager: PackageManagerType

    Package manager used to install and build the workspace.

    • 'pnpm' (default) — matches the era-6 platform manifest.
    • 'npm' — explicit override for environments that cannot add pnpm.

    There is no silent fallback: preflight hard-fails when the configured package manager is not on PATH, so installs stay deterministic.

    Settings

    Member Visibility

    On This Page

    Properties