mirror of
https://github.com/RayLabsHQ/gitea-mirror.git
synced 2026-01-31 23:01:11 +03:00
docs: document docker-compose.alt.yml for quick start
This commit is contained in:
73
README.md
73
README.md
@@ -13,13 +13,13 @@
|
|||||||
## 🚀 Quick Start
|
## 🚀 Quick Start
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Using Docker (recommended)
|
# Fastest way - using the simplified Docker setup
|
||||||
docker compose up -d
|
docker compose -f docker-compose.alt.yml up -d
|
||||||
|
|
||||||
# Access at http://localhost:4321
|
# Access at http://localhost:4321
|
||||||
```
|
```
|
||||||
|
|
||||||
First user signup becomes admin. No configuration needed to get started!
|
First user signup becomes admin. Configure GitHub and Gitea through the web interface!
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src=".github/assets/dashboard.png" alt="Dashboard" width="full"/>
|
<img src=".github/assets/dashboard.png" alt="Dashboard" width="full"/>
|
||||||
@@ -46,18 +46,57 @@ First user signup becomes admin. No configuration needed to get started!
|
|||||||
|
|
||||||
### Docker (Recommended)
|
### Docker (Recommended)
|
||||||
|
|
||||||
|
We provide two Docker Compose options:
|
||||||
|
|
||||||
|
#### Option 1: Quick Start (docker-compose.alt.yml)
|
||||||
|
Perfect for trying out Gitea Mirror or simple deployments:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone repository
|
# Clone repository
|
||||||
git clone https://github.com/RayLabsHQ/gitea-mirror.git
|
git clone https://github.com/RayLabsHQ/gitea-mirror.git
|
||||||
cd gitea-mirror
|
cd gitea-mirror
|
||||||
|
|
||||||
# Start with Docker Compose
|
# Start with simplified setup
|
||||||
docker compose up -d
|
docker compose -f docker-compose.alt.yml up -d
|
||||||
|
|
||||||
# Access at http://localhost:4321
|
# Access at http://localhost:4321
|
||||||
```
|
```
|
||||||
|
|
||||||
Or use the pre-built image:
|
**Features:**
|
||||||
|
- ✅ Pre-built image - no building required
|
||||||
|
- ✅ Minimal configuration needed
|
||||||
|
- ✅ Data stored in `./data` directory
|
||||||
|
- ✅ Configure everything through web UI
|
||||||
|
- ✅ Automatic user/group ID mapping
|
||||||
|
|
||||||
|
**Best for:**
|
||||||
|
- First-time users
|
||||||
|
- Testing and evaluation
|
||||||
|
- Simple deployments
|
||||||
|
- When you prefer web-based configuration
|
||||||
|
|
||||||
|
#### Option 2: Full Setup (docker-compose.yml)
|
||||||
|
For production deployments with environment-based configuration:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Start with full configuration options
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
**Features:**
|
||||||
|
- ✅ Build from source or use pre-built image
|
||||||
|
- ✅ Complete environment variable configuration
|
||||||
|
- ✅ Support for custom CA certificates
|
||||||
|
- ✅ Advanced mirror settings (forks, wiki, issues)
|
||||||
|
- ✅ Multi-registry support
|
||||||
|
|
||||||
|
**Best for:**
|
||||||
|
- Production deployments
|
||||||
|
- Automated/scripted setups
|
||||||
|
- Advanced mirror configurations
|
||||||
|
- When using self-signed certificates
|
||||||
|
|
||||||
|
#### Using Pre-built Image Directly
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker pull ghcr.io/raylabshq/gitea-mirror:v2.20.1
|
docker pull ghcr.io/raylabshq/gitea-mirror:v2.20.1
|
||||||
@@ -65,16 +104,28 @@ docker pull ghcr.io/raylabshq/gitea-mirror:v2.20.1
|
|||||||
|
|
||||||
### Configuration Options
|
### Configuration Options
|
||||||
|
|
||||||
Create a `.env` file for custom settings (optional):
|
#### Quick Start Configuration (docker-compose.alt.yml)
|
||||||
|
|
||||||
|
Minimal `.env` file (optional - has sensible defaults):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# JWT secret for authentication (auto-generated if blank or default below)
|
# Custom port (default: 4321)
|
||||||
JWT_SECRET=your-secret-key-change-this-in-production
|
|
||||||
|
|
||||||
# Port configuration
|
|
||||||
PORT=4321
|
PORT=4321
|
||||||
|
|
||||||
|
# User/Group IDs for file permissions (default: 1000)
|
||||||
|
PUID=1000
|
||||||
|
PGID=1000
|
||||||
|
|
||||||
|
# JWT secret (auto-generated if not set)
|
||||||
|
JWT_SECRET=your-secret-key-change-this-in-production
|
||||||
```
|
```
|
||||||
|
|
||||||
|
All other settings are configured through the web interface after starting.
|
||||||
|
|
||||||
|
#### Full Setup Configuration (docker-compose.yml)
|
||||||
|
|
||||||
|
Supports extensive environment variables for automated deployment. See the full [docker-compose.yml](docker-compose.yml) for all available options including GitHub tokens, Gitea URLs, mirror settings, and more.
|
||||||
|
|
||||||
### LXC Container (Proxmox)
|
### LXC Container (Proxmox)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
Reference in New Issue
Block a user