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;
        };
        DatabaseHost: string;
        DatabaseName: string;
        DatabasePort: number;
        DatabaseTrustCert: boolean;
        ExplorerPort: number;
        InstallMode: "distribution"
        | "monorepo";
        MistralKey?: string;
        OpenAIKey?: string;
    }
    Index

    Properties

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

    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).

    DatabaseHost: string

    SQL Server hostname or IP address (default: "localhost").

    DatabaseName: string

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

    DatabasePort: number

    SQL Server TCP port (default: 1433).

    DatabaseTrustCert: boolean

    Whether to trust self-signed TLS certificates (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.

    Settings

    Member Visibility

    On This Page

    Properties