Updated some interfaces to be more future proof

Author: arunavo4

.env.example

@@ -1,21 +1,40 @@
-# Docker Registry Configuration
-DOCKER_REGISTRY=ghcr.io
-DOCKER_IMAGE=arunavo4/gitea-mirror
-DOCKER_TAG=latest
+# Gitea Mirror Configuration
+# Copy this to .env and update with your values
+
+# ===========================================
+# CORE CONFIGURATION
+# ===========================================
 
 # Application Configuration
 NODE_ENV=production
 HOST=0.0.0.0
 PORT=4321
+
+# Database Configuration
+# For self-hosted, SQLite is used by default
 DATABASE_URL=sqlite://data/gitea-mirror.db
 
 # Security
+# Generate with: openssl rand -base64 32
 BETTER_AUTH_SECRET=change-this-to-a-secure-random-string-in-production
 BETTER_AUTH_URL=http://localhost:4321
 # ENCRYPTION_SECRET=optional-encryption-key-for-token-encryption # Generate with: openssl rand -base64 48
 
-# Optional GitHub/Gitea Mirror Configuration (for docker-compose, can also be set via web UI)
-# Uncomment and set as needed. These are passed as environment variables to the container.
+# ===========================================
+# DOCKER CONFIGURATION (Optional)
+# ===========================================
+
+# Docker Registry Configuration
+DOCKER_REGISTRY=ghcr.io
+DOCKER_IMAGE=arunavo4/gitea-mirror
+DOCKER_TAG=latest
+
+# ===========================================
+# MIRROR CONFIGURATION (Optional)
+# Can also be configured via web UI
+# ===========================================
+
+# GitHub Configuration
 # GITHUB_USERNAME=your-github-username
 # GITHUB_TOKEN=your-github-personal-access-token
 # SKIP_FORKS=false
@@ -27,22 +46,23 @@ BETTER_AUTH_URL=http://localhost:4321
 # PRESERVE_ORG_STRUCTURE=false
 # ONLY_MIRROR_ORGS=false
 # SKIP_STARRED_ISSUES=false
+
+# Gitea Configuration
 # GITEA_URL=http://gitea:3000
 # GITEA_TOKEN=your-local-gitea-token
 # GITEA_USERNAME=your-local-gitea-username
 # GITEA_ORGANIZATION=github-mirrors
 # GITEA_ORG_VISIBILITY=public
 # DELAY=3600
 
-# Optional Database Cleanup Configuration (configured via web UI)
-# These environment variables are optional and only used as defaults
-# Users can configure cleanup settings through the web interface
+# ===========================================
+# OPTIONAL FEATURES
+# ===========================================
+
+# Database Cleanup Configuration
 # CLEANUP_ENABLED=false
 # CLEANUP_RETENTION_DAYS=7
 
-# Optional TLS/SSL Configuration
-# Option 1: Mount custom CA certificates in ./certs directory as .crt files
-#          The container will automatically combine them into a CA bundle
-# Option 2: Mount your system CA bundle at /etc/ssl/certs/ca-certificates.crt
-#          See docker-compose.yml for volume mount examples
-# GITEA_SKIP_TLS_VERIFY=false  # WARNING: Only use for testing, disables TLS verification
+# TLS/SSL Configuration
+# GITEA_SKIP_TLS_VERIFY=false  # WARNING: Only use for testing
+

.gitignore

@@ -32,5 +32,3 @@ certs/*.pem
 certs/*.cer
 !certs/README.md
 
-# Hosted version documentation (local only)
-docs/HOSTED_VERSION.md

docs/SPONSOR_INTEGRATION.md

@@ -0,0 +1,91 @@
+# GitHub Sponsors Integration
+
+This guide shows how GitHub Sponsors is integrated into the open-source version of Gitea Mirror.
+
+## Components
+
+### GitHubSponsors Card
+
+A card component that displays in the sidebar or dashboard:
+
+```tsx
+import { GitHubSponsors } from '@/components/sponsors/GitHubSponsors';
+
+// In your layout or dashboard
+<GitHubSponsors />
+```
+
+### SponsorButton
+
+A smaller button for headers or navigation:
+
+```tsx
+import { SponsorButton } from '@/components/sponsors/GitHubSponsors';
+
+// In your header
+<SponsorButton />
+```
+
+## Integration Points
+
+### 1. Dashboard Sidebar
+
+Add the sponsor card to the dashboard sidebar for visibility:
+
+```tsx
+// src/components/layout/DashboardLayout.tsx
+<aside>
+  {/* Other sidebar content */}
+  <GitHubSponsors />
+</aside>
+```
+
+### 2. Header Navigation
+
+Add the sponsor button to the main navigation:
+
+```tsx
+// src/components/layout/Header.tsx
+<nav>
+  {/* Other nav items */}
+  <SponsorButton />
+</nav>
+```
+
+### 3. Settings Page
+
+Add a support section in settings:
+
+```tsx
+// src/components/settings/SupportSection.tsx
+<Card>
+  <CardHeader>
+    <CardTitle>Support Development</CardTitle>
+  </CardHeader>
+  <CardContent>
+    <GitHubSponsors />
+  </CardContent>
+</Card>
+```
+
+## Behavior
+
+- **Only appears in self-hosted mode**: The components automatically hide in hosted mode
+- **Non-intrusive**: Designed to be helpful without being annoying
+- **Multiple options**: GitHub Sponsors, Buy Me a Coffee, and starring the repo
+
+## Customization
+
+You can customize the sponsor components by:
+
+1. Updating the GitHub Sponsors URL
+2. Adding/removing donation platforms
+3. Changing the styling to match your theme
+4. Adjusting the placement based on user feedback
+
+## Best Practices
+
+1. **Don't be pushy**: Show sponsor options tastefully
+2. **Provide value first**: Ensure the tool is useful before asking for support
+3. **Be transparent**: Explain how sponsorships help the project
+4. **Thank sponsors**: Acknowledge supporters in README or releases