Atualizado arquivo README.txt com novos procedimentos para instalação e configuração da aplicação

Eriksen Costa Paixão
1 parent ea31a609
Showing 1 changed file with 212 additions and 13 deletions Show diff stats
ieducar/README.txt
@@ -13,10 +13,9 @@ CONTEÚDO
 REQUISITOS
 ----------
-O i-Educar requer um servidor web, PHP 5 (5.2 recomendado), PostgreSQL 8.2
-(a versão 8.2 é obrigatória) e a biblioteca PDFLib (versão Lite ou não). O
-servidor web Apache 2 é recomendado mas qualquer outro com suporte a PHP pode
-ser utilizado.
+O i-Educar requer um servidor web, PHP 5.2, PostgreSQL 8.2 e a biblioteca PDFLib
+(versão Lite ou Commercial). O servidor web Apache 2 é recomendado mas qualquer
+outro com suporte a PHP pode ser utilizado.
 A biblioteca PDFLib Lite tem algumas restrições em sua utilização. Consulte a
 licença da biblioteca para ver se o seu uso não cairá na necessidade de adquirir
@@ -27,17 +26,221 @@ http://www.pdflib.com/products/pdflib-family/pdflib-lite/pdflib-lite-licensing
 INSTALAÇÃO
 ----------
-Por favor, consulte nosso manual sobre os procedimentos de instalação em:
-http://svn.softwarepublico.gov.br/trac/ieducar/wiki/Documentacao/1.X/Instalacao
+1. DOWNLOAD DO SOFTWARE
+
+   Faça o download dos arquivos do sistema antes de prosseguir. A versão atual
+   pode ser encontrada em:
+   http://www.softwarepublico.gov.br/dotlrn/clubs/ieducar/file-storage/index?folder_id=10855442.
+   Descompacte o pacote de sua preferência no diretório raiz do seu servidor web
+   Apache.
+
+      $ cd /var/www
+      $ mkdir ieducar; cd ieducar
+      $ tar -xzvf /caminho/pacotes/ieducar-X.X.X.tar.gz
+
+
+2. CRIE O BANCO DE DADOS
+
+   Crie o banco de dados ao qual o i-Educar usará para armazenar todos os dados
+   digitados através da interface web. Os passos descritos nessa seção irão
+   criar:
+
+      * Um usuário ieducar no servidor PostgreSQL com a senha de acesso ieducar;
+      * Um banco de dados ieducar.
+
+   Observação: você pode usar o nome de usuário, banco de dados e senha que
+   desejar. Esses são apenas nomes padrões que a aplicação usa para conectar-se
+   ao banco.
+
+   Faça login no servidor de banco de dados PostgreSQL com o cliente psql:
+
+      $ su
+      # su - postgres
+      # psql
+
+   Alternativamente, com o sudo:
+
+      $ sudo -u postgres psql
+
+   Crie o usuário de banco de dados que será utilizado pelo i-Educar:
+
+      postgres=# CREATE ROLE ieducar;
+      postgres=# ALTER ROLE ieducar WITH SUPERUSER INHERIT NOCREATEROLE \
+         CREATEDB LOGIN PASSWORD 'ieducar';
+
+   Crie o banco de dados:
+
+      postgres=# CREATE DATABASE ieducar WITH TEMPLATE = template0 \
+         OWNER = ieducar ENCODING = 'LATIN1';
+      postgres=# \q
+
+   Execute o arquivo ieducar.sql que vem no i-Educar. O diretório em que esse 
+   arquivo reside é o misc/database.
+
+      $ psql -d ieducar -f misc/database/ieducar.sql
+
+   Atenção: em algumas plataformas, o restore do banco pode acabar em um erro
+   FATAL. Se isso acontecer, experimente fazer o restore no mesmo diretório em
+   que se encontra o arquivo ieducar.sql.
+
+   Novamente no psql, execute o seguinte comando para configurar o search_path:
+
+      $ psql ieducar
+      postgres=# ALTER DATABASE ieducar SET search_path TO "$user", public, \
+        portal, cadastro, acesso, alimentos, consistenciacao, historico, \
+        pmiacoes, pmicontrolesis, pmidrh, pmieducar, pmiotopic, urbano;
+      postgres=# \q;
+
+
+3. EDITE O ARQUIVO DE CONFIGURAÇÃO E CONCEDA PERMISSÕES DE ESCRITA
+
+   O i-Educar armazena algumas configurações necessárias para a aplicação em um
+   arquivo chamado ieducar.ini (em configuration/), que possui uma sintaxe bem
+   simples de entender. Caso tenha criado o banco de dados, nome de usuário ou
+   senha com um valor diferente de ieducar, basta editar esse arquivo para que
+   corresponda as suas escolhas:
+
+      [production]
+      ; Configurações de banco de dados
+      app.database.dbname   = ieducar
+      app.database.username = ieducar
+      app.database.hostname = localhost
+      app.database.password = ieducar
+      app.database.port     = 5432
+
+   Exemplo: caso tenha nomeado seu banco de dados com ieducar_db, o usuário com
+   ieducar_user e a senha com ieducar_pass, o ieducar.ini ficaria da seguinte
+   forma:
+
+      [production]
+      ; Configurações de banco de dados
+      app.database.dbname   = ieducar_db
+      app.database.username = ieducar_user
+      app.database.hostname = localhost
+      app.database.password = ieducar_pass
+      app.database.port     = 5432
+
+   Depois, conceda permissões de escrita nos diretórios intranet/tmp e
+   intranet/pdf. Uma forma prática é dar permissão de escrita para o usuário
+   dono do diretório e para usuários de um grupo. Nesse caso, mudaremos o grupo
+   desses diretórios para o grupo do usuário Apache.
+
+      # chmod 775 intranet/tmp intranet/pdf
+      # chgrp www-data intranet/tmp intranet/pdf
+
+   Observação: www-data é o nome do grupo Apache padrão em sistemas Debian.
+   Em outros sistemas, esse nome pode ser httpd, apache ou _www. Substitua de
+   acordo com o usado em seu sistema operacional.
+
+
+4. CONFIGURE O APACHE OU CRIE UM VIRTUAL HOST
+
+   A partir da versão 1.1.X, o i-Educar inclui, por padrão, um arquivo chamado
+   .htaccess no diretório raiz da aplicação. Esse arquivo contém diretivas de
+   configuração do servidor Apache que tornam o i-Educar mais seguro.
+   Além disso, esse arquivo configura o PHP corretamente para as necessidades
+   da aplicação.
+
+   Para que esse arquivo seja executado a cada requisição, é necessário
+   configurar o Apache para que este execute os arquivos .htaccess ou criar um
+   Virtual Host. A primeira opção requer a edição do arquivo
+   /etc/apache2/site-available/default. A única diretiva a ser alterada é
+   AllowOverride (linha 11) para All:
+
+        9         <Directory /var/www/>
+       10                 Options Indexes FollowSymLinks MultiViews
+       11                 AllowOverride All
+       12                 Order allow,deny
+       13                 allow from all
+       14         </Directory>
+
+   Reinicie o servidor Apache:
+
+      $ /etc/init.d/apache2 restart
+
+   A segunda opção requer a criação de um novo arquivo em
+   /etc/apache2/sites-available/. Crie um arquivo chamado ieducar.local com o
+   seguinte conteúdo:
+
+      <VirtualHost *:80>
+        ServerName ieducar.local
+        DocumentRoot /var/www/ieducar
+
+        <Directory /var/www/ieducar>
+          AllowOverride all
+          Order deny,allow
+          Allow from all
+        </Directory>
+      </VirtualHost>
+
+   Edite o arquivo /etc/hosts (no Windows esse arquivo fica em
+   C:\WINDOWS\system32\drivers\etc\hosts) e adicione a seguinte linha:
+
+      127.0.0.1      ieducar.local
+
+   Reinicie o servidor Apache:
+
+      $ /etc/init.d/apache2 restart
+
+   Pronto. Agora, acesse o endereço http://ieducar.local em seu navegador.
+
+   Atenção: configurar o seu servidor Apache (seguindo uma das opções
+   apresentadas) é importante para a segurança da aplicação. Assim, evita-se que
+   arquivos importantes como o configuration/ieducar.ini e os relatórios gerados
+   pela aplicação fiquem publicamente expostos para leitura através da Internet.
+
+
+5. ACESSE A APLICAÇÃO
+
+   Abra o navegador de sua preferência e acesse o endereço
+   http://localhost/ieducar ou http://ieducar.local (caso tenha configurado um
+   Virtual Host). Faça o login na aplicação utilizando o usuário administrador.
+   O login e senha para acesso são admin e admin, respectivamente.
+
+
+6. CONFIGURE O PHP
+
+   Esse passo é opcional caso tenha configurado o Apache (via AllowOverride ou
+   VirtualHost). Edite o arquivo php.ini da seguinte forma:
+
+   * memory_limit: altere para, no mínimo, 32M (devido a geração de relatórios
+   consumir bastante memória, pode ser necessário aumentar para uma quantidade
+   maior em plataformas 64 bits);
+      memory_limit = 32M
+
+   * error_reporting: altere para E_ALL & ~E_NOTICE para evitar que avisos do
+   nível E_NOTICE (comuns na versão atual), apareçam nas telas quebrando o
+   layout do sistema. E_ERROR é o recomendado para ambientes de produção.
+      error_reporting = E_ALL & ~E_NOTICE
+
+   * display_errors: altere para Off em produção:
+      display_errors = Off
+
+   * short_open_tag: altere para On.
+      short_open_tag = On
+
+   Observação: a localização do arquivo php.ini é diferente entre os sistemas
+   operacionais. No Debian/Ubuntu, o padrão é /etc/php5/apache2/php.ini. Para
+   descobrir onde o arquivo fica em seu sistema operacional, acesse o endereço
+   http://localhost/ieducar/info.php e procure por Loaded Configuration File.
+
+   Após qualquer alteração no arquivo php.ini, reinicie seu servidor web:
+
+      # /etc/init.d/apache2 restart
+
+
+7. FONTE
+
+   * https://svn.softwarepublico.gov.br/trac/ieducar/wiki/Documentacao/1.1.X/Instalacao
 DOCUMENTAÇÃO
 ------------
-A documentação oficial do i-Educar está disponível em:
+A documentação oficial do i-Educar está disponível em wiki:
 http://svn.softwarepublico.gov.br/trac/ieducar/wiki
-Problemas comuns de instalação podem ser encontrados no FAQ (perguntas 
+Problemas comuns de instalação podem ser encontrados no FAQ (perguntas
 frequentes):
 http://svn.softwarepublico.gov.br/trac/ieducar/wiki/Documentacao/FAQ/1.X
@@ -55,8 +258,4 @@ LICENÇA
 O i-Educar é um Software Público Brasileiro (SPB), livre e licenciado pela
 Creative Commons Licença Pública Geral versão 2 traduzida (CC GNU/GPL 2). Uma
-cópia da licença está incluida nesta distribuição no arquivo LICENSE-pt_BR.txt.
-
-
-
-Obrigado por usar o i-Educar!
 \ No newline at end of file
+cópia da licença está incluida nesta distribuição no arquivo LICENSE-pt_BR.txt.
 \ No newline at end of file
	@@ -13,10 +13,9 @@ CONTEÚDO		@@ -13,10 +13,9 @@ CONTEÚDO
13	REQUISITOS	13	REQUISITOS
14	----------	14	----------
15		15
16	-O i-Educar requer um servidor web, PHP 5 (5.2 recomendado), PostgreSQL 8.2
17	-(a versão 8.2 é obrigatória) e a biblioteca PDFLib (versão Lite ou não). O
18	-servidor web Apache 2 é recomendado mas qualquer outro com suporte a PHP pode
19	-ser utilizado.	16	+O i-Educar requer um servidor web, PHP 5.2, PostgreSQL 8.2 e a biblioteca PDFLib
		17	+(versão Lite ou Commercial). O servidor web Apache 2 é recomendado mas qualquer
		18	+outro com suporte a PHP pode ser utilizado.
20		19
21	A biblioteca PDFLib Lite tem algumas restrições em sua utilização. Consulte a	20	A biblioteca PDFLib Lite tem algumas restrições em sua utilização. Consulte a
22	licença da biblioteca para ver se o seu uso não cairá na necessidade de adquirir	21	licença da biblioteca para ver se o seu uso não cairá na necessidade de adquirir
	@@ -27,17 +26,221 @@ http://www.pdflib.com/products/pdflib-family/pdflib-lite/pdflib-lite-licensing		@@ -27,17 +26,221 @@ http://www.pdflib.com/products/pdflib-family/pdflib-lite/pdflib-lite-licensing
27	INSTALAÇÃO	26	INSTALAÇÃO
28	----------	27	----------
29		28
30	-Por favor, consulte nosso manual sobre os procedimentos de instalação em:
31	-http://svn.softwarepublico.gov.br/trac/ieducar/wiki/Documentacao/1.X/Instalacao	29	+1. DOWNLOAD DO SOFTWARE
		30	+
		31	+ Faça o download dos arquivos do sistema antes de prosseguir. A versão atual
		32	+ pode ser encontrada em:
		33	+ http://www.softwarepublico.gov.br/dotlrn/clubs/ieducar/file-storage/index?folder_id=10855442.
		34	+ Descompacte o pacote de sua preferência no diretório raiz do seu servidor web
		35	+ Apache.
		36	+
		37	+ $ cd /var/www
		38	+ $ mkdir ieducar; cd ieducar
		39	+ $ tar -xzvf /caminho/pacotes/ieducar-X.X.X.tar.gz
		40	+
		41	+
		42	+2. CRIE O BANCO DE DADOS
		43	+
		44	+ Crie o banco de dados ao qual o i-Educar usará para armazenar todos os dados
		45	+ digitados através da interface web. Os passos descritos nessa seção irão
		46	+ criar:
		47	+
		48	+ * Um usuário ieducar no servidor PostgreSQL com a senha de acesso ieducar;
		49	+ * Um banco de dados ieducar.
		50	+
		51	+ Observação: você pode usar o nome de usuário, banco de dados e senha que
		52	+ desejar. Esses são apenas nomes padrões que a aplicação usa para conectar-se
		53	+ ao banco.
		54	+
		55	+ Faça login no servidor de banco de dados PostgreSQL com o cliente psql:
		56	+
		57	+ $ su
		58	+ # su - postgres
		59	+ # psql
		60	+
		61	+ Alternativamente, com o sudo:
		62	+
		63	+ $ sudo -u postgres psql
		64	+
		65	+ Crie o usuário de banco de dados que será utilizado pelo i-Educar:
		66	+
		67	+ postgres=# CREATE ROLE ieducar;
		68	+ postgres=# ALTER ROLE ieducar WITH SUPERUSER INHERIT NOCREATEROLE \
		69	+ CREATEDB LOGIN PASSWORD 'ieducar';
		70	+
		71	+ Crie o banco de dados:
		72	+
		73	+ postgres=# CREATE DATABASE ieducar WITH TEMPLATE = template0 \
		74	+ OWNER = ieducar ENCODING = 'LATIN1';
		75	+ postgres=# \q
		76	+
		77	+ Execute o arquivo ieducar.sql que vem no i-Educar. O diretório em que esse
		78	+ arquivo reside é o misc/database.
		79	+
		80	+ $ psql -d ieducar -f misc/database/ieducar.sql
		81	+
		82	+ Atenção: em algumas plataformas, o restore do banco pode acabar em um erro
		83	+ FATAL. Se isso acontecer, experimente fazer o restore no mesmo diretório em
		84	+ que se encontra o arquivo ieducar.sql.
		85	+
		86	+ Novamente no psql, execute o seguinte comando para configurar o search_path:
		87	+
		88	+ $ psql ieducar
		89	+ postgres=# ALTER DATABASE ieducar SET search_path TO "$user", public, \
		90	+ portal, cadastro, acesso, alimentos, consistenciacao, historico, \
		91	+ pmiacoes, pmicontrolesis, pmidrh, pmieducar, pmiotopic, urbano;
		92	+ postgres=# \q;
		93	+
		94	+
		95	+3. EDITE O ARQUIVO DE CONFIGURAÇÃO E CONCEDA PERMISSÕES DE ESCRITA
		96	+
		97	+ O i-Educar armazena algumas configurações necessárias para a aplicação em um
		98	+ arquivo chamado ieducar.ini (em configuration/), que possui uma sintaxe bem
		99	+ simples de entender. Caso tenha criado o banco de dados, nome de usuário ou
		100	+ senha com um valor diferente de ieducar, basta editar esse arquivo para que
		101	+ corresponda as suas escolhas:
		102	+
		103	+ [production]
		104	+ ; Configurações de banco de dados
		105	+ app.database.dbname = ieducar
		106	+ app.database.username = ieducar
		107	+ app.database.hostname = localhost
		108	+ app.database.password = ieducar
		109	+ app.database.port = 5432
		110	+
		111	+ Exemplo: caso tenha nomeado seu banco de dados com ieducar_db, o usuário com
		112	+ ieducar_user e a senha com ieducar_pass, o ieducar.ini ficaria da seguinte
		113	+ forma:
		114	+
		115	+ [production]
		116	+ ; Configurações de banco de dados
		117	+ app.database.dbname = ieducar_db
		118	+ app.database.username = ieducar_user
		119	+ app.database.hostname = localhost
		120	+ app.database.password = ieducar_pass
		121	+ app.database.port = 5432
		122	+
		123	+ Depois, conceda permissões de escrita nos diretórios intranet/tmp e
		124	+ intranet/pdf. Uma forma prática é dar permissão de escrita para o usuário
		125	+ dono do diretório e para usuários de um grupo. Nesse caso, mudaremos o grupo
		126	+ desses diretórios para o grupo do usuário Apache.
		127	+
		128	+ # chmod 775 intranet/tmp intranet/pdf
		129	+ # chgrp www-data intranet/tmp intranet/pdf
		130	+
		131	+ Observação: www-data é o nome do grupo Apache padrão em sistemas Debian.
		132	+ Em outros sistemas, esse nome pode ser httpd, apache ou _www. Substitua de
		133	+ acordo com o usado em seu sistema operacional.
		134	+
		135	+
		136	+4. CONFIGURE O APACHE OU CRIE UM VIRTUAL HOST
		137	+
		138	+ A partir da versão 1.1.X, o i-Educar inclui, por padrão, um arquivo chamado
		139	+ .htaccess no diretório raiz da aplicação. Esse arquivo contém diretivas de
		140	+ configuração do servidor Apache que tornam o i-Educar mais seguro.
		141	+ Além disso, esse arquivo configura o PHP corretamente para as necessidades
		142	+ da aplicação.
		143	+
		144	+ Para que esse arquivo seja executado a cada requisição, é necessário
		145	+ configurar o Apache para que este execute os arquivos .htaccess ou criar um
		146	+ Virtual Host. A primeira opção requer a edição do arquivo
		147	+ /etc/apache2/site-available/default. A única diretiva a ser alterada é
		148	+ AllowOverride (linha 11) para All:
		149	+
		150	+ 9 <Directory /var/www/>
		151	+ 10 Options Indexes FollowSymLinks MultiViews
		152	+ 11 AllowOverride All
		153	+ 12 Order allow,deny
		154	+ 13 allow from all
		155	+ 14 </Directory>
		156	+
		157	+ Reinicie o servidor Apache:
		158	+
		159	+ $ /etc/init.d/apache2 restart
		160	+
		161	+ A segunda opção requer a criação de um novo arquivo em
		162	+ /etc/apache2/sites-available/. Crie um arquivo chamado ieducar.local com o
		163	+ seguinte conteúdo:
		164	+
		165	+ <VirtualHost *:80>
		166	+ ServerName ieducar.local
		167	+ DocumentRoot /var/www/ieducar
		168	+
		169	+ <Directory /var/www/ieducar>
		170	+ AllowOverride all
		171	+ Order deny,allow
		172	+ Allow from all
		173	+ </Directory>
		174	+ </VirtualHost>
		175	+
		176	+ Edite o arquivo /etc/hosts (no Windows esse arquivo fica em
		177	+ C:\WINDOWS\system32\drivers\etc\hosts) e adicione a seguinte linha:
		178	+
		179	+ 127.0.0.1 ieducar.local
		180	+
		181	+ Reinicie o servidor Apache:
		182	+
		183	+ $ /etc/init.d/apache2 restart
		184	+
		185	+ Pronto. Agora, acesse o endereço http://ieducar.local em seu navegador.
		186	+
		187	+ Atenção: configurar o seu servidor Apache (seguindo uma das opções
		188	+ apresentadas) é importante para a segurança da aplicação. Assim, evita-se que
		189	+ arquivos importantes como o configuration/ieducar.ini e os relatórios gerados
		190	+ pela aplicação fiquem publicamente expostos para leitura através da Internet.
		191	+
		192	+
		193	+5. ACESSE A APLICAÇÃO
		194	+
		195	+ Abra o navegador de sua preferência e acesse o endereço
		196	+ http://localhost/ieducar ou http://ieducar.local (caso tenha configurado um
		197	+ Virtual Host). Faça o login na aplicação utilizando o usuário administrador.
		198	+ O login e senha para acesso são admin e admin, respectivamente.
		199	+
		200	+
		201	+6. CONFIGURE O PHP
		202	+
		203	+ Esse passo é opcional caso tenha configurado o Apache (via AllowOverride ou
		204	+ VirtualHost). Edite o arquivo php.ini da seguinte forma:
		205	+
		206	+ * memory_limit: altere para, no mínimo, 32M (devido a geração de relatórios
		207	+ consumir bastante memória, pode ser necessário aumentar para uma quantidade
		208	+ maior em plataformas 64 bits);
		209	+ memory_limit = 32M
		210	+
		211	+ * error_reporting: altere para E_ALL & ~E_NOTICE para evitar que avisos do
		212	+ nível E_NOTICE (comuns na versão atual), apareçam nas telas quebrando o
		213	+ layout do sistema. E_ERROR é o recomendado para ambientes de produção.
		214	+ error_reporting = E_ALL & ~E_NOTICE
		215	+
		216	+ * display_errors: altere para Off em produção:
		217	+ display_errors = Off
		218	+
		219	+ * short_open_tag: altere para On.
		220	+ short_open_tag = On
		221	+
		222	+ Observação: a localização do arquivo php.ini é diferente entre os sistemas
		223	+ operacionais. No Debian/Ubuntu, o padrão é /etc/php5/apache2/php.ini. Para
		224	+ descobrir onde o arquivo fica em seu sistema operacional, acesse o endereço
		225	+ http://localhost/ieducar/info.php e procure por Loaded Configuration File.
		226	+
		227	+ Após qualquer alteração no arquivo php.ini, reinicie seu servidor web:
		228	+
		229	+ # /etc/init.d/apache2 restart
		230	+
		231	+
		232	+7. FONTE
		233	+
		234	+ * https://svn.softwarepublico.gov.br/trac/ieducar/wiki/Documentacao/1.1.X/Instalacao
32		235
33		236
34	DOCUMENTAÇÃO	237	DOCUMENTAÇÃO
35	------------	238	------------
36		239
37	-A documentação oficial do i-Educar está disponível em:	240	+A documentação oficial do i-Educar está disponível em wiki:
38	http://svn.softwarepublico.gov.br/trac/ieducar/wiki	241	http://svn.softwarepublico.gov.br/trac/ieducar/wiki
39		242
40	-Problemas comuns de instalação podem ser encontrados no FAQ (perguntas	243	+Problemas comuns de instalação podem ser encontrados no FAQ (perguntas
41	frequentes):	244	frequentes):
42	http://svn.softwarepublico.gov.br/trac/ieducar/wiki/Documentacao/FAQ/1.X	245	http://svn.softwarepublico.gov.br/trac/ieducar/wiki/Documentacao/FAQ/1.X
43		246
	@@ -55,8 +258,4 @@ LICENÇA		@@ -55,8 +258,4 @@ LICENÇA
55		258
56	O i-Educar é um Software Público Brasileiro (SPB), livre e licenciado pela	259	O i-Educar é um Software Público Brasileiro (SPB), livre e licenciado pela
57	Creative Commons Licença Pública Geral versão 2 traduzida (CC GNU/GPL 2). Uma	260	Creative Commons Licença Pública Geral versão 2 traduzida (CC GNU/GPL 2). Uma
58	-cópia da licença está incluida nesta distribuição no arquivo LICENSE-pt_BR.txt.
59	-
60	-
61	-
62	-Obrigado por usar o i-Educar!
63	\ No newline at end of file	261	\ No newline at end of file
		262	+cópia da licença está incluida nesta distribuição no arquivo LICENSE-pt_BR.txt.
64	\ No newline at end of file	263	\ No newline at end of file