Mirror/gitea-mirror
1
0
Fork 0
mirror of https://github.com/RayLabsHQ/gitea-mirror.git synced 2026-01-27 04:40:52 +03:00
Code Issues Packages Projects Releases Wiki Activity

✨ Update README.md to include additional badges and enhance quick start instructions

Browse Source
This commit is contained in:
Arunavo Ray
2025-05-19 19:21:53 +05:30
parent 645006afe3
commit 38206e7d3d
1 changed files with 26 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -1,11 +1,26 @@
# Gitea Mirror <!-- Badges -->
<p align="center">
<a href="https://github.com/arunavo4/gitea-mirror/releases/latest"><img src="https://img.shields.io/github/v/tag/arunavo4/gitea-mirror?label=release"/></a>
<a href="https://github.com/arunavo4/gitea-mirror/actions/workflows/astro-build-test.yml"><img src="https://img.shields.io/github/actions/workflow/status/arunavo4/gitea-mirror/astro-build-test.yml?branch=main"/></a>
<a href="https://github.com/arunavo4/gitea-mirror/pkgs/container/gitea-mirror"><img src="https://img.shields.io/badge/ghcr.io-container-blue?logo=github"/></a>
<a href="https://github.com/arunavo4/gitea-mirror/blob/main/LICENSE"><img src="https://img.shields.io/github/license/arunavo4/gitea-mirror"/></a>
</p>
# Gitea Mirror
<p align="center"> <p align="center">
<i>A modern web application for automatically mirroring repositories from GitHub to your self-hosted Gitea instance.</i><br> <i>A modern web application for automatically mirroring repositories from GitHub to your self-hosted Gitea instance.</i><br>
<sub>Designed for developers, teams, and organizations who want to retain full control of their code while still collaborating on GitHub.</sub> <sub>Designed for developers, teams, and organizations who want to retain full control of their code while still collaborating on GitHub.</sub>
</p> </p>
## 🚀 Quick Start
```bash
docker compose --profile production up -d
# or
pnpm setup && pnpm dev
```
<p align="center"> <p align="center">
<img src=".github/assets/dashboard.png" alt="Dashboard" width="80%"/> <img src=".github/assets/dashboard.png" alt="Dashboard" width="80%"/>
</p> </p>
@@ -330,12 +345,12 @@ docker compose -f docker-compose.dev.yml up -d
> [!TIP] > [!TIP]
> You can also create a `.env` file with your GitHub and Gitea credentials: > You can also create a `.env` file with your GitHub and Gitea credentials:
> >
> ```env > ```env
> # GitHub credentials > # GitHub credentials
> GITHUB_TOKEN=your-github-token > GITHUB_TOKEN=your-github-token
> GITHUB_USERNAME=your-github-username > GITHUB_USERNAME=your-github-username
> >
> # Gitea credentials (will be set up after you create a user in the local Gitea instance) > # Gitea credentials (will be set up after you create a user in the local Gitea instance)
> GITEA_TOKEN=your-local-gitea-token > GITEA_TOKEN=your-local-gitea-token
> GITEA_USERNAME=your-local-gitea-username > GITEA_USERNAME=your-local-gitea-username
@@ -385,14 +400,14 @@ This project is now complete and ready for production use with version 1.0.0. Al
> [!WARNING] > [!WARNING]
> If you encounter network-related warnings or errors when running Docker Compose, such as: > If you encounter network-related warnings or errors when running Docker Compose, such as:
> >
> ``` > ```
> WARN[0095] a network with name gitea-network exists but was not created by compose. > WARN[0095] a network with name gitea-network exists but was not created by compose.
> Set `external: true` to use an existing network > Set `external: true` to use an existing network
> ``` > ```
> >
> or > or
> >
> ``` > ```
> network gitea-network was found but has incorrect label com.docker.compose.network set to "" (expected: "gitea-network") > network gitea-network was found but has incorrect label com.docker.compose.network set to "" (expected: "gitea-network")
> ``` > ```
@@ -416,7 +431,7 @@ Try the following steps:
> [!TIP] > [!TIP]
> If you need to share the network with other Docker Compose projects, you can modify the `docker-compose.dev.yml` file to mark the network as external: > If you need to share the network with other Docker Compose projects, you can modify the `docker-compose.dev.yml` file to mark the network as external:
> >
> ```yaml > ```yaml
> networks: > networks:
> gitea-network: > gitea-network:
@@ -428,7 +443,7 @@ Try the following steps:
> [!CAUTION] > [!CAUTION]
> If the application fails to connect to Redis with errors like `ECONNREFUSED 127.0.0.1:6379`, ensure: > If the application fails to connect to Redis with errors like `ECONNREFUSED 127.0.0.1:6379`, ensure:
> >
> 1. The Redis container is running: > 1. The Redis container is running:
> ```bash > ```bash
> docker ps | grep redis > docker ps | grep redis
@@ -494,13 +509,13 @@ redis.on('error', (err) => console.error('Redis client error:', err));
> [!TIP] > [!TIP]
> If containers are not starting properly, check their health status: > If containers are not starting properly, check their health status:
> >
> ```bash > ```bash
> docker ps --format "{{.Names}}: {{.Status}}" > docker ps --format "{{.Names}}: {{.Status}}"
> ``` > ```
> >
> For more detailed logs: > For more detailed logs:
> >
> ```bash > ```bash
> docker logs gitea-mirror-dev > docker logs gitea-mirror-dev
> ``` > ```