Skip to content

Latest commit

 

History

History
200 lines (119 loc) · 4.84 KB

INSTALLATION.md

File metadata and controls

200 lines (119 loc) · 4.84 KB

Essa documentação de instalação é um PREVIEW

🇺🇸 English version

How to Install

The bot has 2 possible installation methods:

Running inside a container

This is a very straightforward method. In order to be able to run the bot inside a container you need to have the following requirements:

Fill out the .env.example variables and rename it to .env

Now run docker-compose up to start the bot.

Development on your local machine

Use this method only if you intend to help developing this project.

Pre-requirements

This method will require that you previously install the MariaDB development driver dependencies on your system.

Debian based systems

If you are using a Debian system, you can install it by running the following command:

apt-get install libmariadb-dev

This may require superuser privileges.

Fedora

If you are running Fedora, you can install it by running the following command:

dnf install mariadb-devel

Development build

Please, consider reading the pre-requirements section before proceeding.

Simply run:

sh scripts/install.sh

This should install the python venv, the bot components and the bot CLI divulgador on you local system.

Building custom images

When you are developing the bot, you can build a custom image by running the following command:

First, set a custom tag release:

export TAG_RELEASE=<your-tag-id>

And then run the following command:

sh scripts/container_build.sh

This will build 2 docker images. You can check your custom built images by running the following command:

docker image ls

This should return the images you have built:

  • An app image with the bot components called divulgador_app:<your-tag-id>
  • A Database image with the MariaDB database divulgador_db:<your-tag-id>

You can also customize the installation scripts with your credentials and tag release.

Running the bot locally

Execute the following command to run the bot:

divulgador run
🇧🇷 Versão em português

Como instalar

O bot possui dois métodos de instalação:

Rodando em um conteiner

O método de instalação é bem simples. Para conseguir rodar o bot em um container você precisa ter as seguintes dependências:

Preencha as variáveis de .env.example e renomeie o arquivo para .env

Execute docker-compose up para iniciar o bot.

Desenvolvendo na sua máquina local

Use este método apenas se você tiver interesse em ajudar a desenvolver este projeto.

Pré-requisitos

Esse método necessita que você previamente instale o driver de desenvolvimento do MariaDB no seu sistema.

Debian based systems

Se você estiver usando um sistema Debian, você pode instalá-lo executando o seguinte comando:

apt-get install libmariadb-dev

Talvez precise de privilégios de superusuário.

Fedora

Se estiver rodando Fedora, você pode instalá-lo executando o seguinte comando:

dnf install mariadb-devel

Build de desenvolvedor

Considere ler os pré-requisitos antes de prosseguir.

Execute:

sh scripts/install.sh

Isso instalará o venv, os componentes do bot e o CLI divulgador no seu sistema.

Construindo imagens customizadas

Quando você estiver desenvolvendo o bot, você pode construir uma imagem customizada executando o seguinte comando:

Primeiramente, defina um tag de release:

export TAG_RELEASE=<your-tag-id>

E então execute o seguinte comando:

sh scripts/container_build.sh

Isso deve construir 2 imagens. Você pode ver as imagens customizadas construídas executando o seguinte comando:

docker image ls

Isso deve retornar as imagens que você construiu:

  • Uma appimage com os componentes do bot chamada divulgador_app:<your-tag-id>
  • A base de dados MariaDB chamada divulgador_db:<your-tag-id>

Você poderá também customizar os scripts de instalação com as suas credenciais e tag release.

Rodando o bot localmente

Execute o seguinte comando para rodar o bot:

divulgador run