https://github.com/nezorflame/opengapps-mirror-bot

Telegram bot, which provides OpenGApps package mirrors
https://github.com/nezorflame/opengapps-mirror-bot

android bot go modules opengapps telegram

Last synced: 6 months ago
JSON representation

Telegram bot, which provides OpenGApps package mirrors

• Host: GitHub
• URL: https://github.com/nezorflame/opengapps-mirror-bot
• Owner: nezorflame
• License: mit
• Archived: true
• Created: 2018-11-23T16:10:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-07-11T19:15:32.000Z (almost 5 years ago)
• Last Synced: 2025-10-25T12:59:20.640Z (8 months ago)
• Topics: android, bot, go, modules, opengapps, telegram
• Language: Go
• Homepage: https://t.me/opengappsmirrorbot
• Size: 122 KB
• Stars: 0
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# opengapps-mirror-bot [![CircleCI](https://circleci.com/gh/nezorflame/opengapps-mirror-bot/tree/master.svg?style=svg)](https://circleci.com/gh/nezorflame/opengapps-mirror-bot/tree/master) [![Go Report Card](https://goreportcard.com/badge/github.com/nezorflame/opengapps-mirror-bot)](https://goreportcard.com/report/github.com/nezorflame/opengapps-mirror-bot) [![GolangCI](https://golangci.com/badges/github.com/nezorflame/opengapps-mirror-bot.svg)](https://golangci.com/r/github.com/nezorflame/opengapps-mirror-bot) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fnezorflame%2Fopengapps-mirror-bot.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fnezorflame%2Fopengapps-mirror-bot?ref=badge_shield)

This is a Telegram bot which allows you to create a locally and remotely hosted mirrors for any existing OpenGApps package.

Requires Go 1.10+ for [Go modules](https://github.com/golang/go/wiki/Modules) support.

Based on a great [tgbotapi](https://github.com/go-telegram-bot-api/telegram-bot-api) package with the help of [go-github](https://github.com/google/go-github) package to browse Github repos.

## Install

This project uses Go modules.

To install it, starting with Go 1.12 you can just use `go get`:

`go get opengapps-mirror-bot`

or

`go install opengapps-mirror-bot`

Also you can just clone this repo and use the build/install targets from `Makefile`.

## Usage

### Flags

| Flag | Type | Description | Default |

|--------|--------|-------------------------------------|-----------|

| config | `string` | Config file name (without extension) | `config` |

### Config

Example configuration can be found in `config.example.toml`

Local and remote mirroring can be switched on/off by entering/removing the parameters `gapps.local_url`/`gapps.remote_url` from config.

Local hosting also requires parameter `gapps.local_path`

### Available commands

| Command | Description |

|--------|------------------------------------------------------------|

| mirror | Searches for a OpenGApps package and creates a mirror for it |

| help | Prints the help message |

### /mirror command format

Targets should be put after the `/mirror` command with space character between them.

- platform: `arm`|`arm64`|`x86`|`x86_64`

- Android version: `4.4`...`9.0`

- package variant: `pico`|`nano`|`micro`|`mini`|`full`|`stock`|`super`|`aroma`|`tvstock`

- (optional) date of the release: `YYYYMMDD`

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fnezorflame%2Fopengapps-mirror-bot.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fnezorflame%2Fopengapps-mirror-bot?ref=badge_large)