Instalação do plug-in¶

Existem algumas maneiras de instalar um plugin:

Usando e variável de ambiente¶

Este método pressupõe que você já tenha os serviços de composição do Docker Climweb em execução.

Você pode usar as variáveis env CLIMWEB_PLUGIN_GIT_REPOS ao usar as imagens docker Climweb para instalar plug-ins na inicialização.

O CLIMWEB_PLUGIN_GIT_REPOS deve ser uma lista separada por vírgulas de URLs https git repo que serão usadas para baixar e instalar plug-ins na inicialização.

Depois de definir a variável de ambiente, você pode iniciar o contêiner docker usando o seguinte comando:

docker compose up 

Essas variáveis só serão acionadas e instaladas quando encontradas na inicialização do contêiner. Para desinstalar um plugin você ainda deve seguir manualmente as instruções abaixo.

Advertências ao instalar em um contêiner existente¶

Se você excluir o contêiner no qual instalou os plug-ins em tempo de execução e recriá-lo, o novo contêiner será criado a partir da imagem base do docker climweb que não possui nenhum plug-in instalado.

No entanto, quando um plugin é instalado em tempo de execução ou construção, ele é armazenado no CLIMWEB_PLUGIN_DIR que por padrão é a pasta do contêiner /climweb/plugins que deve ser montada dentro de um volume docker. Na inicialização, se um plugin for encontrado neste diretório que ainda não tenha sido instalado no contêiner atual, ele será reinstalado.

Contanto que você reutilize o mesmo volume de dados, você não deverá perder nenhum dado do plug-in, mesmo se remover e recriar os contêineres. O único efeito é na inicialização inicial do contêiner. Você poderá ver os plug-ins se reinstalando se você recriar o contêiner do zero.

Desinstalando um plugin instalado usando uma variável de ambiente¶

É altamente recomendável que você faça backup de seus dados antes de desinstalar um plugin.
Para desinstalar um plugin que você instalou usando um dos CLIMWEB_PLUGIN_GIT_REPOS você precisa ter certeza de excluir e recriar o contêiner com o plugin removido da variável de ambiente correspondente. Se você não fizer isso e apenas desinstalar o plugin usando exec e reiniciar, o plugin será reinstalado após a reinicialização, pois a variável de ambiente ainda conterá o plugin antigo

Verificando quais plugins já estão instalados¶

Use o comando list-plugins ou o script /climweb/plugins/list_plugins.sh integrado para verificar quais plug-ins estão instalados no momento.