Merge pull request #44 from RayLabsHQ/v3

V3

Author: arunavo4

.env.example

@@ -1,19 +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
-JWT_SECRET=change-this-to-a-secure-random-string-in-production
+# 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
+
+# ===========================================
+# DOCKER CONFIGURATION (Optional)
+# ===========================================
+
+# Docker Registry Configuration
+DOCKER_REGISTRY=ghcr.io
+DOCKER_IMAGE=arunavo4/gitea-mirror
+DOCKER_TAG=latest
 
-# 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.
+# ===========================================
+# 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
@@ -25,22 +46,36 @@ JWT_SECRET=change-this-to-a-secure-random-string-in-production
 # 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
+
+# ===========================================
+# AUTHENTICATION CONFIGURATION
+# ===========================================
+
+# Header Authentication (for Reverse Proxy SSO)
+# Enable automatic authentication via reverse proxy headers
+# HEADER_AUTH_ENABLED=false
+# HEADER_AUTH_USER_HEADER=X-Authentik-Username
+# HEADER_AUTH_EMAIL_HEADER=X-Authentik-Email
+# HEADER_AUTH_NAME_HEADER=X-Authentik-Name
+# HEADER_AUTH_AUTO_PROVISION=false
+# HEADER_AUTH_ALLOWED_DOMAINS=example.com,company.org
+

.gitignore

@@ -31,3 +31,4 @@ certs/*.crt
 certs/*.pem
 certs/*.cer
 !certs/README.md
+

CONTRIBUTING.md

@@ -0,0 +1,182 @@
+# Contributing to Gitea Mirror
+
+Thank you for your interest in contributing to Gitea Mirror! This document provides guidelines and instructions for contributing to the open-source version of the project.
+
+## 🎯 Project Overview
+
+Gitea Mirror is an open-source, self-hosted solution for mirroring GitHub repositories to Gitea instances. This guide provides everything you need to know about contributing to the project.
+
+## 🚀 Getting Started
+
+1. Fork the repository
+2. Clone your fork:
+   ```bash
+   git clone https://github.com/yourusername/gitea-mirror.git
+   cd gitea-mirror
+   ```
+
+3. Install dependencies:
+   ```bash
+   bun install
+   ```
+
+4. Set up your environment:
+   ```bash
+   cp .env.example .env
+   # Edit .env with your configuration
+   ```
+
+5. Start development:
+   ```bash
+   bun run dev
+   ```
+
+## 🛠 Development Workflow
+
+### Running the Application
+
+```bash
+# Development mode
+bun run dev
+
+# Build for production
+bun run build
+
+# Run tests
+bun test
+```
+
+### Database Management
+
+```bash
+# Initialize database
+bun run init-db
+
+# Reset database
+bun run cleanup-db && bun run init-db
+```
+
+## 📝 Code Guidelines
+
+### General Principles
+
+1. **Keep it Simple**: Gitea Mirror should remain easy to self-host
+2. **Focus on Core Features**: Prioritize repository mirroring and synchronization
+3. **Database**: Use SQLite for simplicity and portability
+4. **Dependencies**: Minimize external dependencies for easier deployment
+
+### Code Style
+
+- Use TypeScript for all new code
+- Follow the existing code formatting (Prettier is configured)
+- Write meaningful commit messages
+- Add tests for new features
+
+### Scope of Contributions
+
+This project focuses on personal/small team use cases. Please keep contributions aligned with:
+- Core mirroring functionality
+- Self-hosted simplicity
+- Minimal external dependencies
+- SQLite as the database
+- Single-instance deployments
+
+## 🐛 Reporting Issues
+
+1. Check existing issues first
+2. Use issue templates when available
+3. Provide clear reproduction steps
+4. Include relevant logs and screenshots
+
+## 🎯 Pull Request Process
+
+1. Create a feature branch:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. Make your changes following the code guidelines
+
+3. Test your changes:
+   ```bash
+   # Run tests
+   bun test
+   
+   # Build and check
+   bun run build:oss
+   ```
+
+4. Commit your changes:
+   ```bash
+   git commit -m "feat: add new feature"
+   ```
+
+5. Push to your fork and create a Pull Request
+
+### PR Requirements
+
+- Clear description of changes
+- Tests for new functionality
+- Documentation updates if needed
+- No breaking changes without discussion
+- Passes all CI checks
+
+## 🏗 Architecture Overview
+
+```
+src/
+├── components/     # React components
+├── lib/           # Core utilities
+│   ├── db/        # Database queries (SQLite only)
+│   ├── github/    # GitHub API integration
+│   ├── gitea/     # Gitea API integration
+│   └── utils/     # Helper functions
+├── pages/         # Astro pages
+│   └── api/       # API endpoints
+└── types/         # TypeScript types
+```
+
+## 🧪 Testing
+
+```bash
+# Run all tests
+bun test
+
+# Run tests in watch mode
+bun test:watch
+
+# Run with coverage
+bun test:coverage
+```
+
+## 📚 Documentation
+
+- Update README.md for user-facing changes
+- Add JSDoc comments for new functions
+- Update .env.example for new environment variables
+
+## 💡 Feature Requests
+
+We welcome feature requests! When proposing new features, please consider:
+- Does it enhance the core mirroring functionality?
+- Will it benefit self-hosted users?
+- Can it be implemented without complex external dependencies?
+- Does it maintain the project's simplicity?
+
+## 🤝 Community
+
+- Be respectful and constructive
+- Help others in issues and discussions
+- Share your use cases and feedback
+
+## 📄 License
+
+By contributing, you agree that your contributions will be licensed under the same license as the project (MIT).
+
+## Questions?
+
+Feel free to open an issue for any questions about contributing!
+
+---
+
+Thank you for helping make Gitea Mirror better! 🎉

Dockerfile

@@ -31,6 +31,7 @@ COPY --from=builder /app/dist ./dist
 COPY --from=builder /app/package.json ./package.json
 COPY --from=builder /app/docker-entrypoint.sh ./docker-entrypoint.sh
 COPY --from=builder /app/scripts ./scripts
+COPY --from=builder /app/drizzle ./drizzle
 
 ENV NODE_ENV=production
 ENV HOST=0.0.0.0