feat: comprehensive environment variable support

- Added support for 60+ environment variables covering all configuration options - Created detailed documentation in docs/ENVIRONMENT_VARIABLES.md with tables - Fixed missing skipStarredIssues field in GitHub config - Updated docker-compose files to reference environment variable documentation - Updated README to link to the new environment variables documentation - Environment variables now populate UI configuration automatically on Docker startup - Preserves manual UI changes when environment variables are not set - Includes support for mirror metadata, scheduling, cleanup, and authentication options Fixes #69 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-10 21:46:45 +03:00 · 2025-08-09 11:48:42 +05:30
parent afaac70bb8
commit df1738a44d
7 changed files with 554 additions and 60 deletions
--- a/src/lib/env-config-loader.ts
+++ b/src/lib/env-config-loader.ts
@@ -12,20 +12,34 @@ interface EnvConfig {
  github: {
    username?: string;
    token?: string;
+    type?: 'personal' | 'organization';
    privateRepositories?: boolean;
+    publicRepositories?: boolean;
    mirrorStarred?: boolean;
    skipForks?: boolean;
+    includeArchived?: boolean;
    mirrorOrganizations?: boolean;
    preserveOrgStructure?: boolean;
    onlyMirrorOrgs?: boolean;
    skipStarredIssues?: boolean;
+    starredReposOrg?: string;
+    mirrorStrategy?: 'preserve' | 'single-org' | 'flat-user' | 'mixed';
  };
  gitea: {
    url?: string;
    username?: string;
    token?: string;
    organization?: string;
-    visibility?: 'public' | 'private' | 'limited';
+    visibility?: 'public' | 'private' | 'limited' | 'default';
+    mirrorInterval?: string;
+    lfs?: boolean;
+    createOrg?: boolean;
+    templateOwner?: string;
+    templateRepo?: string;
+    addTopics?: boolean;
+    topicPrefix?: string;
+    preserveVisibility?: boolean;
+    forkStrategy?: 'skip' | 'reference' | 'full-copy';
  };
  mirror: {
    mirrorIssues?: boolean;
@@ -34,14 +48,38 @@ interface EnvConfig {
    mirrorPullRequests?: boolean;
    mirrorLabels?: boolean;
    mirrorMilestones?: boolean;
+    mirrorMetadata?: boolean;
  };
  schedule: {
-    delay?: number;
    enabled?: boolean;
+    interval?: string;
+    concurrent?: boolean;
+    batchSize?: number;
+    pauseBetweenBatches?: number;
+    retryAttempts?: number;
+    retryDelay?: number;
+    timeout?: number;
+    autoRetry?: boolean;
+    cleanupBeforeMirror?: boolean;
+    notifyOnFailure?: boolean;
+    notifyOnSuccess?: boolean;
+    logLevel?: 'error' | 'warn' | 'info' | 'debug';
+    timezone?: string;
+    onlyMirrorUpdated?: boolean;
+    updateInterval?: number;
+    skipRecentlyMirrored?: boolean;
+    recentThreshold?: number;
  };
  cleanup: {
    enabled?: boolean;
    retentionDays?: number;
+    deleteFromGitea?: boolean;
+    deleteIfNotInGitHub?: boolean;
+    protectedRepos?: string[];
+    dryRun?: boolean;
+    orphanedRepoAction?: 'skip' | 'archive' | 'delete';
+    batchSize?: number;
+    pauseBetweenDeletes?: number;
  };
 }

@@ -49,24 +87,43 @@ interface EnvConfig {
 * Parse environment variables into configuration object
 */
 function parseEnvConfig(): EnvConfig {
+  // Parse protected repos from comma-separated string
+  const protectedRepos = process.env.CLEANUP_PROTECTED_REPOS 
+    ? process.env.CLEANUP_PROTECTED_REPOS.split(',').map(r => r.trim()).filter(Boolean)
+    : undefined;
+
  return {
    github: {
      username: process.env.GITHUB_USERNAME,
      token: process.env.GITHUB_TOKEN,
+      type: process.env.GITHUB_TYPE as 'personal' | 'organization',
      privateRepositories: process.env.PRIVATE_REPOSITORIES === 'true',
+      publicRepositories: process.env.PUBLIC_REPOSITORIES === 'true',
      mirrorStarred: process.env.MIRROR_STARRED === 'true',
      skipForks: process.env.SKIP_FORKS === 'true',
+      includeArchived: process.env.INCLUDE_ARCHIVED === 'true',
      mirrorOrganizations: process.env.MIRROR_ORGANIZATIONS === 'true',
      preserveOrgStructure: process.env.PRESERVE_ORG_STRUCTURE === 'true',
      onlyMirrorOrgs: process.env.ONLY_MIRROR_ORGS === 'true',
      skipStarredIssues: process.env.SKIP_STARRED_ISSUES === 'true',
+      starredReposOrg: process.env.STARRED_REPOS_ORG,
+      mirrorStrategy: process.env.MIRROR_STRATEGY as 'preserve' | 'single-org' | 'flat-user' | 'mixed',
    },
    gitea: {
      url: process.env.GITEA_URL,
      username: process.env.GITEA_USERNAME,
      token: process.env.GITEA_TOKEN,
      organization: process.env.GITEA_ORGANIZATION,
-      visibility: process.env.GITEA_ORG_VISIBILITY as 'public' | 'private' | 'limited',
+      visibility: process.env.GITEA_ORG_VISIBILITY as 'public' | 'private' | 'limited' | 'default',
+      mirrorInterval: process.env.GITEA_MIRROR_INTERVAL,
+      lfs: process.env.GITEA_LFS === 'true',
+      createOrg: process.env.GITEA_CREATE_ORG === 'true',
+      templateOwner: process.env.GITEA_TEMPLATE_OWNER,
+      templateRepo: process.env.GITEA_TEMPLATE_REPO,
+      addTopics: process.env.GITEA_ADD_TOPICS === 'true',
+      topicPrefix: process.env.GITEA_TOPIC_PREFIX,
+      preserveVisibility: process.env.GITEA_PRESERVE_VISIBILITY === 'true',
+      forkStrategy: process.env.GITEA_FORK_STRATEGY as 'skip' | 'reference' | 'full-copy',
    },
    mirror: {
      mirrorIssues: process.env.MIRROR_ISSUES === 'true',
@@ -75,14 +132,38 @@ function parseEnvConfig(): EnvConfig {
      mirrorPullRequests: process.env.MIRROR_PULL_REQUESTS === 'true',
      mirrorLabels: process.env.MIRROR_LABELS === 'true',
      mirrorMilestones: process.env.MIRROR_MILESTONES === 'true',
+      mirrorMetadata: process.env.MIRROR_METADATA === 'true',
    },
    schedule: {
-      delay: process.env.DELAY ? parseInt(process.env.DELAY, 10) : undefined,
      enabled: process.env.SCHEDULE_ENABLED === 'true',
+      interval: process.env.SCHEDULE_INTERVAL || process.env.DELAY, // Support both old DELAY and new SCHEDULE_INTERVAL
+      concurrent: process.env.SCHEDULE_CONCURRENT === 'true',
+      batchSize: process.env.SCHEDULE_BATCH_SIZE ? parseInt(process.env.SCHEDULE_BATCH_SIZE, 10) : undefined,
+      pauseBetweenBatches: process.env.SCHEDULE_PAUSE_BETWEEN_BATCHES ? parseInt(process.env.SCHEDULE_PAUSE_BETWEEN_BATCHES, 10) : undefined,
+      retryAttempts: process.env.SCHEDULE_RETRY_ATTEMPTS ? parseInt(process.env.SCHEDULE_RETRY_ATTEMPTS, 10) : undefined,
+      retryDelay: process.env.SCHEDULE_RETRY_DELAY ? parseInt(process.env.SCHEDULE_RETRY_DELAY, 10) : undefined,
+      timeout: process.env.SCHEDULE_TIMEOUT ? parseInt(process.env.SCHEDULE_TIMEOUT, 10) : undefined,
+      autoRetry: process.env.SCHEDULE_AUTO_RETRY === 'true',
+      cleanupBeforeMirror: process.env.SCHEDULE_CLEANUP_BEFORE_MIRROR === 'true',
+      notifyOnFailure: process.env.SCHEDULE_NOTIFY_ON_FAILURE === 'true',
+      notifyOnSuccess: process.env.SCHEDULE_NOTIFY_ON_SUCCESS === 'true',
+      logLevel: process.env.SCHEDULE_LOG_LEVEL as 'error' | 'warn' | 'info' | 'debug',
+      timezone: process.env.SCHEDULE_TIMEZONE,
+      onlyMirrorUpdated: process.env.SCHEDULE_ONLY_MIRROR_UPDATED === 'true',
+      updateInterval: process.env.SCHEDULE_UPDATE_INTERVAL ? parseInt(process.env.SCHEDULE_UPDATE_INTERVAL, 10) : undefined,
+      skipRecentlyMirrored: process.env.SCHEDULE_SKIP_RECENTLY_MIRRORED === 'true',
+      recentThreshold: process.env.SCHEDULE_RECENT_THRESHOLD ? parseInt(process.env.SCHEDULE_RECENT_THRESHOLD, 10) : undefined,
    },
    cleanup: {
      enabled: process.env.CLEANUP_ENABLED === 'true',
      retentionDays: process.env.CLEANUP_RETENTION_DAYS ? parseInt(process.env.CLEANUP_RETENTION_DAYS, 10) : undefined,
+      deleteFromGitea: process.env.CLEANUP_DELETE_FROM_GITEA === 'true',
+      deleteIfNotInGitHub: process.env.CLEANUP_DELETE_IF_NOT_IN_GITHUB === 'true',
+      protectedRepos,
+      dryRun: process.env.CLEANUP_DRY_RUN === 'true',
+      orphanedRepoAction: process.env.CLEANUP_ORPHANED_REPO_ACTION as 'skip' | 'archive' | 'delete',
+      batchSize: process.env.CLEANUP_BATCH_SIZE ? parseInt(process.env.CLEANUP_BATCH_SIZE, 10) : undefined,
+      pauseBetweenDeletes: process.env.CLEANUP_PAUSE_BETWEEN_DELETES ? parseInt(process.env.CLEANUP_PAUSE_BETWEEN_DELETES, 10) : undefined,
    },
  };
 }
@@ -138,9 +219,11 @@ export async function initializeConfigFromEnv(): Promise<void> {
      .where(eq(configs.userId, userId))
      .limit(1);

-    // Determine mirror strategy based on environment variables
+    // Determine mirror strategy based on environment variables or use explicit value
    let mirrorStrategy: 'preserve' | 'single-org' | 'flat-user' | 'mixed' = 'preserve';
-    if (envConfig.github.preserveOrgStructure === false && envConfig.gitea.organization) {
+    if (envConfig.github.mirrorStrategy) {
+      mirrorStrategy = envConfig.github.mirrorStrategy;
+    } else if (envConfig.github.preserveOrgStructure === false && envConfig.gitea.organization) {
      mirrorStrategy = 'single-org';
    } else if (envConfig.github.preserveOrgStructure === true) {
      mirrorStrategy = 'preserve';
@@ -149,17 +232,17 @@ export async function initializeConfigFromEnv(): Promise<void> {
    // Build GitHub config
    const githubConfig = {
      owner: envConfig.github.username || existingConfig?.[0]?.githubConfig?.owner || '',
-      type: 'personal' as const,
+      type: envConfig.github.type || existingConfig?.[0]?.githubConfig?.type || 'personal',
      token: envConfig.github.token ? encrypt(envConfig.github.token) : existingConfig?.[0]?.githubConfig?.token || '',
      includeStarred: envConfig.github.mirrorStarred ?? existingConfig?.[0]?.githubConfig?.includeStarred ?? false,
      includeForks: !(envConfig.github.skipForks ?? false),
-      includeArchived: existingConfig?.[0]?.githubConfig?.includeArchived ?? false,
+      includeArchived: envConfig.github.includeArchived ?? existingConfig?.[0]?.githubConfig?.includeArchived ?? false,
      includePrivate: envConfig.github.privateRepositories ?? existingConfig?.[0]?.githubConfig?.includePrivate ?? false,
-      includePublic: existingConfig?.[0]?.githubConfig?.includePublic ?? true,
+      includePublic: envConfig.github.publicRepositories ?? existingConfig?.[0]?.githubConfig?.includePublic ?? true,
      includeOrganizations: envConfig.github.mirrorOrganizations ? [] : (existingConfig?.[0]?.githubConfig?.includeOrganizations ?? []),
-      starredReposOrg: 'starred',
+      starredReposOrg: envConfig.github.starredReposOrg || existingConfig?.[0]?.githubConfig?.starredReposOrg || 'starred',
      mirrorStrategy,
-      defaultOrg: envConfig.gitea.organization || 'github-mirrors',
+      defaultOrg: envConfig.gitea.organization || existingConfig?.[0]?.githubConfig?.defaultOrg || 'github-mirrors',
      skipStarredIssues: envConfig.github.skipStarredIssues ?? existingConfig?.[0]?.githubConfig?.skipStarredIssues ?? false,
    };

@@ -168,42 +251,47 @@ export async function initializeConfigFromEnv(): Promise<void> {
      url: envConfig.gitea.url || existingConfig?.[0]?.giteaConfig?.url || '',
      token: envConfig.gitea.token ? encrypt(envConfig.gitea.token) : existingConfig?.[0]?.giteaConfig?.token || '',
      defaultOwner: envConfig.gitea.username || existingConfig?.[0]?.giteaConfig?.defaultOwner || '',
-      mirrorInterval: existingConfig?.[0]?.giteaConfig?.mirrorInterval || '8h',
-      lfs: existingConfig?.[0]?.giteaConfig?.lfs ?? false,
+      mirrorInterval: envConfig.gitea.mirrorInterval || existingConfig?.[0]?.giteaConfig?.mirrorInterval || '8h',
+      lfs: envConfig.gitea.lfs ?? existingConfig?.[0]?.giteaConfig?.lfs ?? false,
      wiki: envConfig.mirror.mirrorWiki ?? existingConfig?.[0]?.giteaConfig?.wiki ?? false,
      visibility: envConfig.gitea.visibility || existingConfig?.[0]?.giteaConfig?.visibility || 'public',
-      createOrg: true,
-      addTopics: existingConfig?.[0]?.giteaConfig?.addTopics ?? true,
-      preserveVisibility: existingConfig?.[0]?.giteaConfig?.preserveVisibility ?? false,
-      forkStrategy: existingConfig?.[0]?.giteaConfig?.forkStrategy || 'reference',
+      createOrg: envConfig.gitea.createOrg ?? existingConfig?.[0]?.giteaConfig?.createOrg ?? true,
+      templateOwner: envConfig.gitea.templateOwner || existingConfig?.[0]?.giteaConfig?.templateOwner || undefined,
+      templateRepo: envConfig.gitea.templateRepo || existingConfig?.[0]?.giteaConfig?.templateRepo || undefined,
+      addTopics: envConfig.gitea.addTopics ?? existingConfig?.[0]?.giteaConfig?.addTopics ?? true,
+      topicPrefix: envConfig.gitea.topicPrefix || existingConfig?.[0]?.giteaConfig?.topicPrefix || undefined,
+      preserveVisibility: envConfig.gitea.preserveVisibility ?? existingConfig?.[0]?.giteaConfig?.preserveVisibility ?? false,
+      forkStrategy: envConfig.gitea.forkStrategy || existingConfig?.[0]?.giteaConfig?.forkStrategy || 'reference',
+      // Mirror metadata options
      mirrorReleases: envConfig.mirror.mirrorReleases ?? existingConfig?.[0]?.giteaConfig?.mirrorReleases ?? false,
-      mirrorMetadata: (envConfig.mirror.mirrorIssues || envConfig.mirror.mirrorPullRequests || envConfig.mirror.mirrorLabels || envConfig.mirror.mirrorMilestones) ?? existingConfig?.[0]?.giteaConfig?.mirrorMetadata ?? false,
+      mirrorMetadata: envConfig.mirror.mirrorMetadata ?? (envConfig.mirror.mirrorIssues || envConfig.mirror.mirrorPullRequests || envConfig.mirror.mirrorLabels || envConfig.mirror.mirrorMilestones) ?? existingConfig?.[0]?.giteaConfig?.mirrorMetadata ?? false,
      mirrorIssues: envConfig.mirror.mirrorIssues ?? existingConfig?.[0]?.giteaConfig?.mirrorIssues ?? false,
      mirrorPullRequests: envConfig.mirror.mirrorPullRequests ?? existingConfig?.[0]?.giteaConfig?.mirrorPullRequests ?? false,
      mirrorLabels: envConfig.mirror.mirrorLabels ?? existingConfig?.[0]?.giteaConfig?.mirrorLabels ?? false,
      mirrorMilestones: envConfig.mirror.mirrorMilestones ?? existingConfig?.[0]?.giteaConfig?.mirrorMilestones ?? false,
    };

-    // Build schedule config
+    // Build schedule config with support for interval as string or number
+    const scheduleInterval = envConfig.schedule.interval || (existingConfig?.[0]?.scheduleConfig?.interval ?? '3600');
    const scheduleConfig = {
      enabled: envConfig.schedule.enabled ?? existingConfig?.[0]?.scheduleConfig?.enabled ?? false,
-      interval: envConfig.schedule.delay ? String(envConfig.schedule.delay) : existingConfig?.[0]?.scheduleConfig?.interval || '3600',
-      concurrent: existingConfig?.[0]?.scheduleConfig?.concurrent ?? false,
-      batchSize: existingConfig?.[0]?.scheduleConfig?.batchSize ?? 10,
-      pauseBetweenBatches: existingConfig?.[0]?.scheduleConfig?.pauseBetweenBatches ?? 5000,
-      retryAttempts: existingConfig?.[0]?.scheduleConfig?.retryAttempts ?? 3,
-      retryDelay: existingConfig?.[0]?.scheduleConfig?.retryDelay ?? 60000,
-      timeout: existingConfig?.[0]?.scheduleConfig?.timeout ?? 3600000,
-      autoRetry: existingConfig?.[0]?.scheduleConfig?.autoRetry ?? true,
-      cleanupBeforeMirror: existingConfig?.[0]?.scheduleConfig?.cleanupBeforeMirror ?? false,
-      notifyOnFailure: existingConfig?.[0]?.scheduleConfig?.notifyOnFailure ?? true,
-      notifyOnSuccess: existingConfig?.[0]?.scheduleConfig?.notifyOnSuccess ?? false,
-      logLevel: existingConfig?.[0]?.scheduleConfig?.logLevel || 'info',
-      timezone: existingConfig?.[0]?.scheduleConfig?.timezone || 'UTC',
-      onlyMirrorUpdated: existingConfig?.[0]?.scheduleConfig?.onlyMirrorUpdated ?? false,
-      updateInterval: existingConfig?.[0]?.scheduleConfig?.updateInterval ?? 86400000,
-      skipRecentlyMirrored: existingConfig?.[0]?.scheduleConfig?.skipRecentlyMirrored ?? true,
-      recentThreshold: existingConfig?.[0]?.scheduleConfig?.recentThreshold ?? 3600000,
+      interval: scheduleInterval,
+      concurrent: envConfig.schedule.concurrent ?? existingConfig?.[0]?.scheduleConfig?.concurrent ?? false,
+      batchSize: envConfig.schedule.batchSize ?? existingConfig?.[0]?.scheduleConfig?.batchSize ?? 10,
+      pauseBetweenBatches: envConfig.schedule.pauseBetweenBatches ?? existingConfig?.[0]?.scheduleConfig?.pauseBetweenBatches ?? 5000,
+      retryAttempts: envConfig.schedule.retryAttempts ?? existingConfig?.[0]?.scheduleConfig?.retryAttempts ?? 3,
+      retryDelay: envConfig.schedule.retryDelay ?? existingConfig?.[0]?.scheduleConfig?.retryDelay ?? 60000,
+      timeout: envConfig.schedule.timeout ?? existingConfig?.[0]?.scheduleConfig?.timeout ?? 3600000,
+      autoRetry: envConfig.schedule.autoRetry ?? existingConfig?.[0]?.scheduleConfig?.autoRetry ?? true,
+      cleanupBeforeMirror: envConfig.schedule.cleanupBeforeMirror ?? existingConfig?.[0]?.scheduleConfig?.cleanupBeforeMirror ?? false,
+      notifyOnFailure: envConfig.schedule.notifyOnFailure ?? existingConfig?.[0]?.scheduleConfig?.notifyOnFailure ?? true,
+      notifyOnSuccess: envConfig.schedule.notifyOnSuccess ?? existingConfig?.[0]?.scheduleConfig?.notifyOnSuccess ?? false,
+      logLevel: envConfig.schedule.logLevel || existingConfig?.[0]?.scheduleConfig?.logLevel || 'info',
+      timezone: envConfig.schedule.timezone || existingConfig?.[0]?.scheduleConfig?.timezone || 'UTC',
+      onlyMirrorUpdated: envConfig.schedule.onlyMirrorUpdated ?? existingConfig?.[0]?.scheduleConfig?.onlyMirrorUpdated ?? false,
+      updateInterval: envConfig.schedule.updateInterval ?? existingConfig?.[0]?.scheduleConfig?.updateInterval ?? 86400000,
+      skipRecentlyMirrored: envConfig.schedule.skipRecentlyMirrored ?? existingConfig?.[0]?.scheduleConfig?.skipRecentlyMirrored ?? true,
+      recentThreshold: envConfig.schedule.recentThreshold ?? existingConfig?.[0]?.scheduleConfig?.recentThreshold ?? 3600000,
      lastRun: existingConfig?.[0]?.scheduleConfig?.lastRun || null,
      nextRun: existingConfig?.[0]?.scheduleConfig?.nextRun || null,
    };
@@ -212,13 +300,13 @@ export async function initializeConfigFromEnv(): Promise<void> {
    const cleanupConfig = {
      enabled: envConfig.cleanup.enabled ?? existingConfig?.[0]?.cleanupConfig?.enabled ?? false,
      retentionDays: envConfig.cleanup.retentionDays ? envConfig.cleanup.retentionDays * 86400 : existingConfig?.[0]?.cleanupConfig?.retentionDays ?? 604800, // Convert days to seconds
-      deleteFromGitea: existingConfig?.[0]?.cleanupConfig?.deleteFromGitea ?? false,
-      deleteIfNotInGitHub: existingConfig?.[0]?.cleanupConfig?.deleteIfNotInGitHub ?? true,
-      protectedRepos: existingConfig?.[0]?.cleanupConfig?.protectedRepos ?? [],
-      dryRun: existingConfig?.[0]?.cleanupConfig?.dryRun ?? true,
-      orphanedRepoAction: existingConfig?.[0]?.cleanupConfig?.orphanedRepoAction || 'archive',
-      batchSize: existingConfig?.[0]?.cleanupConfig?.batchSize ?? 10,
-      pauseBetweenDeletes: existingConfig?.[0]?.cleanupConfig?.pauseBetweenDeletes ?? 2000,
+      deleteFromGitea: envConfig.cleanup.deleteFromGitea ?? existingConfig?.[0]?.cleanupConfig?.deleteFromGitea ?? false,
+      deleteIfNotInGitHub: envConfig.cleanup.deleteIfNotInGitHub ?? existingConfig?.[0]?.cleanupConfig?.deleteIfNotInGitHub ?? true,
+      protectedRepos: envConfig.cleanup.protectedRepos ?? existingConfig?.[0]?.cleanupConfig?.protectedRepos ?? [],
+      dryRun: envConfig.cleanup.dryRun ?? existingConfig?.[0]?.cleanupConfig?.dryRun ?? true,
+      orphanedRepoAction: envConfig.cleanup.orphanedRepoAction || existingConfig?.[0]?.cleanupConfig?.orphanedRepoAction || 'archive',
+      batchSize: envConfig.cleanup.batchSize ?? existingConfig?.[0]?.cleanupConfig?.batchSize ?? 10,
+      pauseBetweenDeletes: envConfig.cleanup.pauseBetweenDeletes ?? existingConfig?.[0]?.cleanupConfig?.pauseBetweenDeletes ?? 2000,
      lastRun: existingConfig?.[0]?.cleanupConfig?.lastRun || null,
      nextRun: existingConfig?.[0]?.cleanupConfig?.nextRun || null,
    };