Skip to content

Latest commit

 

History

History
134 lines (94 loc) · 6.74 KB

README.md

File metadata and controls

134 lines (94 loc) · 6.74 KB
Raw

Alita_Robot

CI Release

Forks Stars Issues LICENSE Contributors Repo Size Views

DeepSource

Alita is a Telegram Group managment bot made using Gotgbot and Go, which makes it modern and faster than most of the exisitng Telegram Chat Managers.

Alita's features over other bots:

  • Modern
  • Fast
  • Fully asynchronous
  • Fully open-source
  • Frequently updated
  • Multi Language Support

Can be found on Telegram as @Alita_Robot

Alita is currently available in 1 Language as of now:

  • US English

More languages can be managed in the locales folder. Although we have added support for languages in bot, we still need contributors to translate the bot to other languages.

More langauges have been added to locales folder but need some configuration.

Help us bring more languages to the bot by contributing to the project on Crowdin

Requirements

  • You need to have a Mongo Database (Cluster Preferred)
  • You also need a Redis Database for caching (Required): Get a free redis database from here
  • Linux/Windows machine (Ubuntu/Debain-based OS Preferred or Windows 10/Server2016 and later)

or

  • Docker (Easiest way to setup the bot)

How to setup

First Step!

  • Star ⭐ the repository!!
  • Fork 🔱 the repository before deploying and make changes in the fork.

It really motivates me to continue this project further.

Deploy to Heroku

  • Get your API_ID and API_HASH from here
  • Get your Bot Token from @BotFather

Note: As it is banned with an unknown reason in heroku, follow the below steps carefully!

  • First Fork this repo :)
  • secondly, create an empty app in the Heroku, with a custom app name; and select Europe region for faster speed.
  • Now go to the deploy tab of your app and under deployment method select GitHub and connect it.
  • after that, type the forked repo name and select it now select main branch and enable auto deploy, at last click on deploy now button!

  • Lastly, you must fill up all the vars in heroku (if using heroku) as directed in app.json file and now turn on the worker dyno to run it :)

Must Add in heroku config :

  • DB_URI : Get one from mongodb
  • OWNER_ID : your telegram id
  • MESSAGE_DUMP : must be start with -100 or your bot added in as admin

Traditional

  • Download a binary from releases page specific to your PC.
  • Set the required env variables and run the binary

Note: Not a lot of people may be able to run using this because the instructions aren't clear but I'll try to make it clear in future.

Docker

We currently publish a ghcr.io/divideprojects/alita_robot Docker image based on alpine.

Set the Environmental vars using the -e flag in while running the container.

If all works well, bot should send message to the MESSAGE_DUMP Group!

Other

You can download all binaries and release artifacts from the Releases page. Binaries are built for macOS, Linux, Windows, for amd64 and arm64 architectures.

If a binary does not yet exist for the OS/architecture you use, please open a GitHub Issue.

Verify Signature

You can verify the integrity and authenticity of any released artifact using a public GPG key. All release artifacts are signed and have a corresponding signature file. Release artifacts are available on the Releases page.

fetch GPG signing key

gpg --keyserver keyserver.ubuntu.com --recv 9CAFFF2AC5F94C7C

example: verify a release package

gpg --verify alita_robot_2.0.1_darwin_amd64.tar.gz.sig alita_robot_2.0.1_darwin_amd64.tar.gz || echo "Verification failed!"

Contributing to the project

  • Make sure your PR works and doesn't break anything.
  • You must join the support group here.
  • Make sure the CI passes.

Special Thanks to

  • Paul Larsen for his Original Marie Source Code and the amazing Gotgbot library.
  • ÁÑÑÍHÌLÅTØR SPÄRK always motivating me to make this project better.
  • jayantkageri for motivating me as well.
  • Anony for helping me with bugs and issues in the project.
  • Everyone else who inspired me to make this project, more names can be seen on commits!

Copyright & License