Mirror/gitea-mirror
1
0
Fork 0
mirror of https://github.com/RayLabsHQ/gitea-mirror.git synced 2025-12-17 03:43:46 +03:00
Code Issues Packages Projects Releases Wiki Activity

✨ Update README and docker-compose.dev.yml to use modern 'docker compose' syntax

Browse Source
This commit is contained in:
Arunavo Ray
2025-05-19 09:26:49 +05:30
parent e1faea72d5
commit 4c134c1302
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -75,15 +75,17 @@ Gitea Mirror provides multi-architecture Docker images that work on both ARM64 (
```bash
# Start the application using Docker Compose
docker-compose --profile production up -d
docker compose --profile production up -d
# For development mode (requires configuration)
# Ensure you have run pnpm setup first
docker-compose -f docker-compose.dev.yml up -d
docker compose -f docker-compose.dev.yml up -d
```
> **Important**: Docker Compose is the recommended method for running Gitea Mirror as it automatically sets up the required Redis sidecar service that the application depends on.
> **Note**: The examples above use the modern `docker compose` syntax (without hyphen) which is the recommended approach for Docker Compose V2. If you're using an older version of Docker Compose (V1), you may need to use `docker-compose` (with hyphen) instead.
##### Using Pre-built Images from GitHub Container Registry
If you want to run the container directly without Docker Compose, you'll need to set up a Redis instance separately:
@@ -119,7 +121,7 @@ cp .env.example .env
./scripts/build-docker.sh --push
# Then run with Docker Compose
docker-compose --profile production up -d
docker compose --profile production up -d
```
See [Docker build documentation](./scripts/README-docker.md) for more details.
@@ -340,7 +342,7 @@ For convenience, a dedicated development docker-compose file is provided that se
```bash
# Start with development environment and local Gitea instance
docker-compose -f docker-compose.dev.yml up -d
docker compose -f docker-compose.dev.yml up -d
```
You can also create a `.env` file with your GitHub and Gitea credentials:

4
docker-compose.dev.yml
View File

@@ -1,7 +1,5 @@
version: '3.8'
# Development environment with local Gitea instance for testing
# Run with: docker-compose -f docker-compose.dev.yml up -d
# Run with: docker compose -f docker-compose.dev.yml up -d
services:
# Local Gitea instance for testing