Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ehsannarmani/gradle-mirror-php

A mirror that has been developed to download gradle dependencies without network interference and sanctions
https://github.com/ehsannarmani/gradle-mirror-php

android android-dependency android-studio dependency-mirror gradle gradle-dependency gradle-mirror mirror mirrored-repository

Last synced: 12 days ago
JSON representation

A mirror that has been developed to download gradle dependencies without network interference and sanctions

Host: GitHub
URL: https://github.com/ehsannarmani/gradle-mirror-php
Owner: ehsannarmani
Created: 2024-12-22T17:09:11.000Z (about 1 month ago)
Default Branch: master
Last Pushed: 2024-12-24T05:43:00.000Z (about 1 month ago)
Last Synced: 2024-12-24T06:28:47.032Z (about 1 month ago)
Topics: android, android-dependency, android-studio, dependency-mirror, gradle, gradle-dependency, gradle-mirror, mirror, mirrored-repository
Language: PHP
Homepage: https://en-mirror.ir
Size: 12.7 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

## Gradle Mirror By PHP

#### This mirror developed to download gradle dependencies without network interference and sanctions

### Usage:

Simply add the mirror url as a maven repository in the `settings.gradle` file and re-sync project:

```kotlin
pluginManagement {
repositories {
maven("https://en-mirror.ir")
}
}
dependencyResolutionManagement {
...
repositories {
maven("https://en-mirror.ir")
}
}
```
> [!NOTE]
> Clone of mirror is launched at `en-mirror.ir` and ready to use. this mirror contains `google`,`central` and `jitpack` mavens.
### Repository Filtering
By default, all repositories are mirrored. To mirror only a specific repository, include its key in the mirror URL, like this:
```kotlin
maven("https://en-mirror.ir/jitpack")
```

### Code Document:
Configure your mirror `config.php`:
```php
$config = [
'cache_folder'=>'cache',
'cache_dependencies'=>true,
'repositories'=> [
"google"=>"https://dl.google.com/dl/android/maven2",
"central"=>"https://repo.maven.apache.org/maven2",
"jitpack"=>"https://jitpack.io"
]
]
```
`cache_dependencies`: This mirror have a feature to cache dependencies in server, so if you want to enable/disable that you need to change `cache_dependencies` property in config array.

`cache_folder`: You can specify the cache folder name with this property.

`repositories`: You can put or remove repositories which you want to get mirrored here (keys are optional and will be used for repository filtering in mirror url)

### Code Usage:
To self-host the mirror on your own server, start the PHP server, and the source path in public_html will serve as your mirror URL.
> [!NOTE]
> The mirror URL will be the address of the source root on your server. For example, if you clone the source in the `x` folder, the URL will be: `https://your-domain.com/x`

> [!NOTE]
> You can set up mirror with cloudflare worker tho, [see](https://github.com/ehsannarmani/gradle-mirror-cloudflare-worker).

#### این میرور جهت دانلود دیپندنسی ها و وابستگی های گریدل بدون تداخلات اینترنتی و تحریم ها توسعه داده شده است.

### نحوه استفاده:

به سادگی تنها آدرس میرور خودتان را در فایل `settings.gradle` به عنوان maven اضافه کنید:

```kotlin
pluginManagement {
repositories {
maven("https://en-mirror.ir")
}
}
dependencyResolutionManagement {
...
repositories {
maven("https://en-mirror.ir")
}
}
```

### فیلترکردن مخزن ها
این میرور بصورت پیشفرض تمامی مخزن های قرارداده شده در فایل کانفیگ را شامل خواهد شد، برای میرور کردن فقط یک مخزن خاص کافی است کلید آن را در انتهای آدرس میرور قرار دهید و پروژه خود را سینک کنید:
```kotlin
maven("https://en-mirror.ir/jitpack")
```

### توضیحات کد:
جهت کانفیگ میرور از طریق فایل `config.php` اقدام کنید:
```php
$config = [
'cache_folder'=>'cache',
'cache_dependencies'=>true,
'repositories'=> [
"google"=>"https://dl.google.com/dl/android/maven2",
"central"=>"https://repo.maven.apache.org/maven2",
"jitpack"=>"https://jitpack.io"
]
]
```
`cache_dependencies`: این میرور امکان کش کردن دیپندنسی هارا دارد، برای تعیین آن این مقدار را تغییر دهید.

`cache_folder`: با این مقدار میتوانید پوشه کش دیپدنسی هارا تعیین کنید

`repositories`: در این پراپرتی مخازنی که میخواهید میرور شوند را بگذارید یا اگر قصد میرور مخزنی رو ندارید از اینجا حذف کنید. (کلید ها دلخواه هستند و در فیلتر کردن میرور مخزن ها استفاده میشوند)

### استفاده از سورس کد:
برای اجرای این میرور در سرور شخصی خودتان یک php server استارت کنید و سورس کد را داخل مسیر public_html قرار دهید، آیپی سرور یا دامنه متصل شده به آن، آدرس میرور شما خواهد بود.
> [!NOTE]
> آدرس میرور، آدرس مسیر روت سورس کد در سرور شما خواهد بود، برای مثال اگر سورس کد را داخل پوشه x قرار دهید، آدرس میرور `https://your-domain.com/x` خواهد بود.

> [!NOTE]
> همچنین میتوانید با استفاده از ورکر های کلادفلر میرور خود را راه اندازی کنید، [اینجا](https://github.com/ehsannarmani/gradle-mirror-cloudflare-worker) را ببینید.