Como instalar uma pilha ERPNext no Ubuntu 18.04

O ERPNext é uma suíte de Planejamento de Recursos Empresariais (ERP) que aproveita o poder e a flexibilidade das tecnologias de código aberto. Ele se destaca no gerenciamento de processos de negócio fundamentais, como finanças, vendas, recursos humanos, fabricação, compras, serviços, necessidades de assistência técnica e muito mais. Entre os benefícios da implementação de um sistema como o ERPNext estão:

• Melhor produtividade, automatizando processos de negócio repetitivos
• Melhoria da eficiência de TI através do compartilhamento de um banco de dados para todos os departamentos dentro da empresa
• Melhor tomada de decisão graças a uma visão integral de como as unidades de negócios se relacionam entre si

O ERPNext é baseado no Frappe, um framework Web full-stack de aplicativos escrito em Python que aproveita ao máximo o ambiente de tempo de execução Node/JavaScript e usa o MariaDB como seu banco de dados de back-end. Uma das muitas vantagens dos aplicativos baseados no Frappe, como o ERPNext, é o utilitário de linha de comando bench. O CLI do bench economiza tempo dos administradores automatizando tarefas como instalar, atualizar, configurar e gerenciar vários sites do Frappe/ERPNext.

Neste tutorial, você irá instalar e configurar uma pilha ERPNext em um servidor executando o Ubuntu 18.04. Isso permitirá que você configure sua pilha para vários ambientes de desenvolvimento ou produção dependendo das suas necessidades. Além disso, isso irá prepará-lo para construir uma arquitetura mais complexa e tolerante a falhas.

• Um servidor Ubuntu 18.04 com pelo menos 4 GB de RAM e um usuário sudo não-root. Você pode configurar seu servidor e seu usuário seguindo nosso guia de configuração inicial do servidor com o Ubuntu 18.04.

• Um nome de domínio totalmente registrado com um registro A apontado para seu servidor. Se você estiver usando um Droplet da DigitalOcean, então você pode seguir este guia para configurar corretamente seu DNS. Este tutorial utilizará o your_domain durante todo o processo.

Embora configurar um firewall para o desenvolvimento seja opcional, para a produção, isso é uma prática de segurança obrigatória.

Você precisará abrir as seguintes portas em seu servidor ERPNext:

• 80/tcp e 443/tcp para o HTTP e HTTPS respectivamente
• 3306/tcp para a conexão do MariaDB (recomendado apenas se precisar de acesso remoto ao banco de dados)
• 143/tcp e 25/tcp para o IMAP e STMP respectivamente
• 22/tcp para o SSH (se você ainda não tiver ativado o OpenSSH)
• 8000/tcp para testes de desenvolvimento antes de implantar seu site

Para abrir várias portas ao mesmo tempo, utilize o seguinte comando:

sudo ufw allow 22,25,143,80,443,3306,8000/tcp

De maneira alternativa, você pode permitir conexões vindas de endereços IP específicos em portas específicas usando este comando:

sudo ufw allow from server_IP to any port port_number

Depois de abrir todas as portas necessárias,o ative o firewall:

sudo ufw enable

Depois de ativar o firewall, confirme o status de suas portas abertas:

sudo ufw status

Para mais informações sobre a configuração do firewall, leia nosso guia How To Set Up a Firewall with UFW on Ubuntu 18.04.

Configurar um firewall adequado é o primeiro dos dois passos preliminares. Agora, você irá configurar o mapeamento de teclado e a codificação de caracteres no seu servidor.

É altamente recomendado que você configure o mapeamento de teclado para o console, bem como a linguagem e a codificação de caracteres no seu host. Isso é necessário para evitar possíveis problemas durante o processo de instalação do ERPNext 12. Observe que essa configuração não tem nada a ver com a linguagem UI na sua plataforma ERPNext em si, mas com a configuração de localidades do sistema.

Primeiro, atualize seu servidor:

sudo apt update

Agora, configure o keymap, a linguagem e a codificação de caracteres:

sudo localectl set-keymap us && sudo localectl set-locale LANG=en_US.utf8

O utilitário localectl é usado pelo Ubuntu 18.04 e outras distribuições Linux para controlar e alterar as configurações de localidade e de layout de teclado em todo o sistema antes do usuário fazer login, que é exatamente o que o ERPNext 12 necessita.

Você também precisará adicionar as seguintes linhas ao seu arquivo /etc/environment. Use o nano ou seu editor de texto preferido para abrir o arquivo:

sudo nano /etc/environment

Agora, adicione o conteúdo a seguir:

LC_ALL=en_US.UTF-8
LC_CTYPE=en_US.UTF-8
LANG=en_US.UTF-8

Salve e feche o arquivo.

Reinicialize seu servidor para aplicar todas as alterações:

sudo reboot

Dê ao seu servidor alguns minutos para reinicializar e então fazer um ssh nele. Agora, você está pronto para instalar seu banco de dados.

Agora, você irá adicionar o MariaDB à sua pilha de servidor. O ERPNext 12 requer o MariaDB 10.2+, mas a versão incluída no repositório oficial do Ubuntu 18.04 é a 10.1, o que significa que você precisará instalar uma versão superior. Para os propósitos deste guia, você irá usar a versão mais recente do MariaDB, que no momento da escrita deste artigo é a versão 10.4.

Para instalar o MariaDB 10.4 no Ubuntu 18.04, você precisará adicionar a chave de assinatura e o repositório apropriados. Você pode encontrar essas informações no assistente do repositório da Fundação MariaDB. Visite esta URL em seu navegador Web. Agora, sob 1. Choose a Distro, clique em Ubuntu. Uma segunda coluna intitulada 2. Choose a Release irá aparecer. Abaixo deste título, clique em 18.04 LTS “bionic”. Uma terceira coluna intitulada 3.Choose a Version então aparecerá. Abaixo deste clique em 10.4 stable. Uma terceira coluna intitulada 4.Choose a Mirror então aparecerá. Escolha um espelho baseado em sua localização e então o MariaDB irá preencher os comandos adequados para sua instalação personalizada.

Execute os três comandos preenchidos, que adicionarão corretamente o repositório e a chave do MariaDB. Seus próprios comandos serão parecidos com este:

sudo apt-get install software-properties-common && sudo apt-key adv --fetch-keys 'https://mariadb.org/mariadb_release_signing_key.asc' && sudo add-apt-repository 'deb [arch=amd64,arm64,ppc64el] http://mirror.klaus-uwe.me/mariadb/repo/10.4/ubuntu bionic main'

Depois de terminar de adicionar o repositório, instale o MariaDB:

sudo apt install mariadb-server

Depois de instalar o mariadb-server, instale os seguintes pacotes:

sudo apt install libmysqlclient-dev python3-mysqldb

O ERPNext 12 é uma aplicação Python e, portanto, ele requer a biblioteca python3-mysqldb para o gerenciamento do banco de dados. Quanto ao libmysqlclient-dev, mariadb-client, e libmariadbclient18: esses pacotes permitem aos usuários se comunicar com o serviço MariaDB. O ntpdate e o libdate-manip-perl são usados pelo ERPNext para a sincronização de tempo do servidor.

Em seguida, adicione uma camada básica de segurança ao servidor MariaDB executando o script mysql_secure_installation:

sudo mysql_secure_installation

O script mysql_secure_installation solicitará que você responda a várias perguntas:

• O primeiro prompt irá perguntar-lhe sobre a senha do root. Como ainda não existe nenhuma senha configurada, pressione ENTER.
• Em seguida, você terá que decidir usar a autenticação do Unix ou não. Responda Y para aceitar este método de autenticação.
• Quando perguntado sobre a alteração da senha do root do MariaDB, responda N. Usar a senha padrão juntamente com a autenticação do Unix é a configuração recomendada para sistemas baseados no Ubuntu, pois a conta root está intimamente relacionada com tarefas de manutenção automatizadas do sistema.
• As perguntas restantes têm a ver com remover o usuário anônimo do banco de dados, restringir a conta root para fazer login remotamente no localhost, remover o banco de dados de teste e recarregar as tabelas de privilégio. É seguro responder Y a todas essas perguntas.

Depois de completar o script mysql_secure_installation, o MariaDB será iniciado usando sua configuração padrão. A instalação padrão do ERPNext usa o usuário root do MariaDB’s para todas as operações de banco de dados. Embora essa abordagem possa ser conveniente em configurações com um único servidor, ela não é considerada uma boa prática de segurança. Dessa forma,na próxima seção, você irá aprender como evitar este problema criando um novo usuário com privilégios especiais.

sudo mysql

CREATE DATABASE sammy;

SHOW DATABASES;

Output
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
| sammy             |
+--------------------+

GRANT ALL PRIVILEGES ON *.* TO 'sammy'@'%' IDENTIFIED BY 'mariadb_password' WITH GRANT OPTION;

SELECT host, user, Super_priv FROM mysql.user;

Output
+-----------+-------+------------+
| Host      | User  | Super_priv |
+-----------+-------+------------+
| localhost | root  | Y          |
| localhost | mysql | Y          |
| %         | sammy | Y          |
+-----------+-------+------------+
3 rows in set (0.001 sec)

FLUSH PRIVILEGES;

exit

Com o MariaDB instalado e protegido, é hora de ajustá-lo para as conexões do ERPNext.

Primeiro, interrompa o mariadb.service:

sudo systemctl stop mariadb

Agora, use o nano ou seu editor de texto favorito para criar um arquivo de configuração do MariaDB chamado settings.cnf:

sudo nano /etc/mysql/conf.d/settings.cnf

Agora, adicione o modelo de configuração do ERPNext:

[mysqld]

# GENERAL #
user                           = mysql
default-storage-engine         = InnoDB
socket                         = /var/lib/mysql/mysql.sock
pid-file                       = /var/lib/mysql/mysql.pid

# MyISAM #
key-buffer-size                = 32M
myisam-recover                 = FORCE,BACKUP

# SAFETY #
max-allowed-packet             = 256M
max-connect-errors             = 1000000
innodb                         = FORCE

# DATA STORAGE #
datadir                        = /var/lib/mysql/

# BINARY LOGGING #
log-bin                        = /var/lib/mysql/mysql-bin
expire-logs-days               = 14
sync-binlog                    = 1

# REPLICATION #
server-id                      = 1

# CACHES AND LIMITS #
tmp-table-size                 = 32M
max-heap-table-size            = 32M
query-cache-type               = 0
query-cache-size               = 0
max-connections                = 500
thread-cache-size              = 50
open-files-limit               = 65535
table-definition-cache         = 4096
table-open-cache               = 10240

# INNODB #
innodb-flush-method            = O_DIRECT
innodb-log-files-in-group      = 2
innodb-log-file-size           = 512M
innodb-flush-log-at-trx-commit = 1
innodb-file-per-table          = 1
innodb-buffer-pool-size        = 5462M
innodb-file-format             = barracuda
innodb-large-prefix            = 1
collation-server               = utf8mb4_unicode_ci
character-set-server           = utf8mb4
character-set-client-handshake = FALSE
max_allowed_packet             = 256M

# LOGGING #
log-error                      = /var/lib/mysql/mysql-error.log
log-queries-not-using-indexes  = 0
slow-query-log                 = 1
slow-query-log-file            = /var/lib/mysql/mysql-slow.log

[mysql]
default-character-set = utf8mb4

[mysqldump]
max_allowed_packet=256M

!includedir /etc/mysql/mariadb.conf.d/

Salve e feche o arquivo. Para obter informações mais detalhadas sobre essas configurações, revise este arquivo modelo no repositório Github do ERPNext. Ele é um ponto de partida útil para explorar essas opções.

Em seguida, crie outro arquivo chamado erpnext.cnf:

sudo nano /etc/mysql/mariadb.conf.d/erpnext.cnf

Adicione o conteúdo a seguir ao arquivo:

[mysqld]
pid-file        = /var/run/mysqld/mysqld.pid
socket          = /var/run/mysqld/mysqld.sock
bind-address    = 0.0.0.0

O primeiro arquivo, /etc/mysql/conf.d/settings.cnf complementa e também sobrepõe alguns valores incluídos na configuração padrão do MariaDB localizada em /etc/mysql/my.cnf. Este arquivo oferece um modelo curado que melhora muito o desempenho de banco de dados para o ERPNext. No entanto, tenha em mente que, embora esse modelo seja um ótimo ponto de partida, nada impede que você melhore o desempenho do MariaDB ainda mais ajustando esses parâmetros para atender às suas necessidades.

O segundo arquivo, o /etc/mysql/mariadb.conf.d/erpnext.cnf, também sobrepõe alguns valores introduzindo informações específicas sobre a sua conexão de banco de dados.

sudo systemctl start mariadb

mysql --user sammy --password mariadb_password --host=localhost --protocol=tcp --port=3306 test

Output
mysql  Ver 15.1 Distrib 10.4.13-MariaDB, for debian-linux-gnu (x86_64) using readline 5.2
Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.

Usage: mysql [OPTIONS] [database]

Default options are read from the following files in the given order:
/etc/my.cnf /etc/mysql/my.cnf ~/.my.cnf

...

  --ssl-verify-server-cert
                      Verify server's "Common Name" in its cert against
                      hostname used when connecting. This option is disabled by
                      default.
  -t, --table         Output in table format.
  --tee=name          Append everything into outfile. See interactive help (\h)
                      also. Does not work in batch mode. Disable with
                      --disable-tee. This option is disabled by default.
  -u, --user=name     User for login if not current user.
  -U, --safe-updates  Only allow UPDATE and DELETE that uses keys.
  -U, --i-am-a-dummy  Synonym for option --safe-updates, -U.
  -v, --verbose       Write more. (-v -v -v gives the table output format).

...

max-join-size                     1000000
secure-auth                       FALSE
show-warnings                     FALSE
plugin-dir                        (No default value)
default-auth                      (No default value)
binary-mode                       FALSE
connect-expired-password          FALSE

sudo systemctl restart mariadb

sudo systemctl enable mariadb

Agora que o banco de dados está pronto, continue configurando seu aplicativo Web ERPNext. Nesta seção, você irá aprender como instalar e configurar todos os componentes necessários pelo ERPNext 12 e então instalar o próprio aplicativo.

Comece preparando o servidor com todos os pacotes de sistema exigidos pelo ERPNext 12. Instale as dependências do sistema usando o seguinte comando:

 sudo DEBIAN_FRONTEND=noninteractive apt install -y curl build-essential mariadb-client python3-setuptools python3-dev libffi-dev python3-pip libcurl4 dnsmasq fontconfig git htop libcrypto++-dev libfreetype6-dev liblcms2-dev libwebp-dev libxext6 libxrender1 libxslt1-dev libxslt1.1 libffi-dev ntpdate postfix python3-dev python-tk screen vim xfonts-75dpi xfonts-base zlib1g-dev apt-transport-https libsasl2-dev libldap2-dev libcups2-dev pv libjpeg8-dev libtiff5-dev tcl8.6-dev tk8.6-dev libssl1.0-dev python3-mysqldb libdate-manip-perl logwatch

A variável DEBIAN_FRONTEND=noninteractive foi passada para o comando de instalação para evitar os prompts do Postfix. Para informações detalhadas sobre a configuração do Postfix, leia nosso guia How To Install and Configure Postfix on Ubuntu 18.04.

Em seguida, atualize o pip3 e então, instale as versões mais recentes de três módulos Python adicionais exigidos pelo ERPNext:

 sudo -H python3 -m pip install --upgrade setuptools cryptography psutil

Agora que você instalou todas as dependências globais necessárias, irá instalar todos os serviços e bibliotecas exigidos pelo ERPNext 12.

curl -sL https://deb.nodesource.com/setup_12.x -o nodesource_setup.sh

sudo nano nodesurce_setup.sh

sudo bash nodesource_setup.sh

sudo apt install nodejs

sudo npm install -g yarn

cd /tmp

wget https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/0.12.5/wkhtmltox_0.12.5-1.bionic_amd64.deb

sudo dpkg -i wkhtmltox_0.12.5-1.bionic_amd64.deb

sudo cp /usr/local/bin/wkhtmlto* /usr/bin/

sudo chmod a+x /usr/bin/wk*

sudo apt install redis-server

sudo systemctl enable redis-server

Agora que você instalou todos os requisitos de pilha do ERPNext, libere a flexibilidade do utilitário de linha de comando bench do Frappe. O bench CLI foi projetado com o propósito de ajudar os usuários no processo de instalar, configurar e gerenciar aplicativos como o ERPNext que são baseados no Frappe Framework. Nas próximas seções, você irá instalar o CLI bench e então usá-lo para completar o processo de configuração do ERPNext 12.

Certifique-se de que o usuário do Frappe (neste caso sammy) tenha os direitos adequados em seu diretório home:

sudo chown sammy -R /home/sammy

Agora, clone o repositório frappe/bench para seu diretório home. Lembre-se de substituir sammy pelo nome de usuário do seu sistema:

git clone https://github.com/frappe/bench /home/sammy/.bench --depth 1 --branch master

Instale o bench CLI:

sudo pip3 install -e /home/sammy/.bench

Este guia assume que você esteja instalando o ERPNext 12 para cenários de teste/produção e, consequentemente,que você esteja usando a ramificação master. Mas se a sua intenção for desenvolver aplicativos ou módulos do ERPNext personalizados, a ramificação develop pode ser uma opção mais adequada. Para ambos os casos, você está agora preparado para instalar o Frappe Framework. Esse será o passo final antes de instalar o próprio ERPNext.

echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

bench init /home/sammy/frappe-bench --frappe-path https://github.com/frappe/frappe --frappe-branch version-12 --python python3

Output
...
Done in 82.23s.
INFO:bench.utils:setting up backups
no crontab for sammy
SUCCESS: Bench /home/sammy/frappe-bench initialized

Nesta seção, você irá construir um site baseado no Frappe, e então instalar o aplicativo ERPNext 12 nele.

Vá para o diretório onde o Frappe foi inicializado.

cd /home/sammy/frappe-bench

Agora, faça o download do ERPNext 12 a partir do seu repositório usando o bench CLI:

bench get-app erpnext https://github.com/frappe/erpnext --branch version-12

Em seguida, crie o novo site, substituindo your_domain pelo domínio que você associou ao IP deste servidor:

bench new-site your_domain --admin-password 'erpnext_admin_password' --mariadb-root-username sammy --mariadb-root-password 'mariadb_password'

Vamos reservar um momento para revisar as opções usadas no comando acima:

• bench new-site cria um novo site baseado no Frappe Framework.
• your_domain é o nome para o novo site. Certifique-se de que o DNS do seu domínio tenha um registro A apontando para o IP do seu servidor.
• erpnext_admin_password é a senha desejada para o usuário Administrator do ERPNext. Mantenha essa senha em um lugar seguro — você precisará dela em breve.
• mariadb_password é a senha que você criou no início do guia para o usuário sammy do MariaDB.

Depois disso, instale o aplicativo ERPNext no site:

bench --site your_domain install-app erpnext

Assim que a instalação for concluída, você terá uma aplicação ERPNext 12 funcionando. Agora, vamos testá-lo usando um comando bench:

bench start

O comando acima irá iniciar um console de monitoramento em tempo real mostrando várias mensagens sobre o servidor Web e outros serviços. Abra um navegador Web e vá até localhost:8000 (para instalações locais) ou your_domain:8000 (se você estiver usando um servidor remoto). Você verá a tela de login do ERPNext (abordaremos o login e a configuração em um passo posterior, assim que fizermos nosso site ficar pronto para a produção).

Depois de visitar sua implantação teste, retorne ao seu terminal e pressione CTRL+C. Isso irá parar o ERPNext e sair do console de monitoramento.

Se seu objetivo principal for criar módulos ou modificar o ERPNext 12, então pode parar aqui. Não há mais componentes necessários para fins de desenvolvimento. No entanto, se o que você precisa é um sistema pronto para a produção que não requer uma inicialização manual, então será necessário instalar e configurar alguns componentes adicionais. Esse é o seu próximo passo.

Embora a aplicação ERPNext 12 esteja pronta, o sistema como um todo ainda não está completamente preparado para a produção. Para garantir a confiabilidade e a segurança do ERPNext, será necessário habilitar alguns serviços adicionais:

• O Fail2ban fornece uma camada extra de proteção contra tentativas de força bruta de usuários e bots maliciosos.
• O Nginx será usado principalmente como um proxy Web, redirecionando todo o tráfego da porta 8000 para a porta 80 (HTTP) ou porta 443 (HTTPS)
• Supervisor este serviço garante que os processos chave do ERPNext estejam em funcionamento constante, reiniciando-os conforme necessário.

Até este ponto, você instalou e configurou o ERPNext 12 manualmente, o que lhe permitiu personalizar o processo para funcionar em qualquer caso de uso particular. No entanto, para o resto da configuração de produção, aproveite a conveniência do bench CLI e deixe-o automatizar a instalação e configuração desses serviços restantes.

Certifique-se de estar no diretório de trabalho do Frappe:

cd /home/sammy/frappe-bench

Agora, use o seguinte comando para terminar a configuração do ERPNext 12 para produção:

sudo bench setup production sammy --yes

O comando acima irá instalar e configurar o Nginx, Supervisor e Fail2Ban e definir sammy como proprietário do ambiente de produção.

Os arquivos de configuração criados pelo comando bench são:

• Dois arquivos de configuração do Nginx localizados em /etc/nginx/nginx.conf e /etc/nginx/conf.d/frappe-bench.conf
• Uma prisão de proxy do Fail2Ban localizada em /etc/fail2ban/jail.d/nginx-proxy.conf e um filtro localizado em /etc/fail2ban/filter.d/nginx-proxy.conf

Essas configurações padrão serão suficientes para este tutorial, mas é possível explorar e ajustar esses arquivos para atender às suas necessidades. Pare todos os serviços executando:

sudo supervisorctl stop all

Assim que tudo estiver pronto, reinicie seus serviços:

sudo supervisorctl start all

Agora, você está pronto para testar sua instalação.

systemctl list-unit-files | grep 'fail2ban\|nginx\|supervisor'

Output
fail2ban.service                       enabled
nginx.service                          enabled
supervisor.service                     enabled

Agora que você instalou corretamente seu aplicativo ERPNext 12, pode ser desejável iniciar a implementação do sistema para as necessidades do seu negócio. Um bom ponto de partida é clicando no botão Getting Started no painel do ERPNext. O ERPNext irá então ajudá-lo a configurar a plataforma para todas as suas necessidades de negócios e e-commerce.

Pode ser que você também queira aumentar a velocidade do ERPNext. Se for esse o caso, então você pode ler sobre Ajuste de Desempenho do ERPNext, que irá guiá-lo pelas práticas recomendadas e em como depurar problemas relacionados ao desempenho.