Skip to content

Latest commit

 

History

History
180 lines (123 loc) · 4.91 KB

INSTALL.md

File metadata and controls

180 lines (123 loc) · 4.91 KB

Guia de instalação

Você pode instalar o i-Educar utilizando Docker ou diretamente no seu servidor web, caso você deseje atualizar sua instalação siga os passos do guia de atualização.

Dependências

Para executar o projeto é necessário a utilização de alguns softwares.

Servidor

Docker

Instalação utilizando Docker

Para instalar o projeto execute todos os passos abaixo:

ATENÇÃO: Essa forma de instação tem o objetivo de facilitar demonstrações e desenvolvimento. Não é recomendado para ambientes de produção!

Clone o repositório:

git clone [email protected]:portabilis/i-educar.git && cd i-educar

Faça o build das imagens Docker utilizadas no projeto e inicie os containers da aplicação (pode levar alguns minutos):

docker-compose up -d --build

Execute o comando para fazer uma nova instalação:

docker-compose exec php composer new-install
docker-compose exec php php artisan db:seed

Personalizando a instalação

Você pode criar o arquivo docker-compose.override.yml para personalizar sua instalação do i-Educar, mudando as portas dos serviços ou o mapeamento dos volumes.

Xdebug

A ferramenta Xdebug está incluída no projeto com o intuito de facilitar o processo de debug durante o desenvolvimento. Para configurá-la, modifique os valores das variáveis XDEBUG_* no arquivo docker-compose.override.yml conforme orientações da sua IDE de desenvolvimento.

Testes automatizados

Para executar os testes automatizados, é necessário ter o i-Educar rodando com uma base limpa, apenas a estrutura inicial e suas migrations, crie o arquivo de configuração:

cp .env.example .env.testing

Execute o comando:

docker-compose exec php vendor/bin/pest

Instalação em servidor web

Para instalar o projeto execute todos os passos abaixo conectado em seu servidor web:

Este passo a passo serve para um servidor Ubuntu 22.04 LTS e não tem configurações mínimas de segurança

Gere uma chave SSH no seu servidor, copie e adicione ao seu GitHub https://github.com/settings/keys.

ssh-keygen -t ed25519
cat ~/.ssh/id_ed25519.pub # copie e adicione ao seu GitHub

Adicione os repositórios de dependências e sincronize a lista de diretórios:

add-apt-repository ppa:openjdk-r/ppa -y
add-apt-repository ppa:ondrej/php -y
apt update

Instale as dependências:

apt install -y nginx redis postgresql postgresql-contrib openjdk-8-jdk openssl unzip php8.3-common php8.3-cli php8.3-fpm php8.3-bcmath php8.3-curl php8.3-mbstring php8.3-pgsql php8.3-xml php8.3-zip php8.3-gd

Inicie o serviço de banco de dados:

systemctl start postgresql.service
sudo -i -u postgres

Crie o usuário do banco de dados, quando solicitado uma senha, utilize ieducar:

createuser ieducar --superuser --createdb --pwprompt

Crie o banco de dados e volte ao usuário root:

createdb ieducar
exit

Configure o Composer:

php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php composer-setup.php --install-dir=/usr/bin --filename=composer
php -r "unlink('composer-setup.php');"
export COMPOSER_ALLOW_SUPERUSER=1

Clone o repositório do i-Educar e copie o arquivo .env:

git clone https://github.com/portabilis/i-educar.git /var/www/ieducar
cd /var/www/ieducar/
cp /var/www/ieducar/.env.example /var/www/ieducar/.env

Copie os arquivos de configuração do Nginx:

cp /var/www/ieducar/docker/nginx/default.conf /etc/nginx/conf.d/default.conf
cp /var/www/ieducar/docker/nginx/upstream.conf /etc/nginx/conf.d/upstream.conf
sed -i 's/php:9000/unix:\/run\/php\/php-fpm.sock/g' /etc/nginx/conf.d/upstream.conf
rm /etc/nginx/sites-enabled/default
nginx -s reload

Faça a instalação do i-Educar:

composer new-install

Popule o banco de dados com os dados iniciais necessários para o funcionamento:

php artisan db:seed

Este passo é opcional, mas caso você desejar, você pode popular o banco de dados com alguns dados iniciais utilizando o comando abaixo:

php artisan db:seed --class=DemoSeeder

Primeiro acesso

Acesse http://localhost ou o IP do seu servidor para fazer o seu primeiro acesso.

O usuário padrão é: admin / A senha padrão é: 123456789.

Assim que realizar seu primeiro acesso não se esqueça de alterar a senha padrão.