MSTECH wiki - Contribuições do usuário [pt-br]

Configurando OpenEDX devstack

2017-08-10T19:56:44Z

Alexandre.paravani: /* Rodando serviços */

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==
=== Hardware ===

CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

=== Software ===
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas de rede ===
Após a criação da VM, '''durante a instalação''', é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.
Talvez peça suas credenciais durante o processo.

=== Erros diversos ===
Ao reiniciar o processo de instalação do zero muitos deles não ocorreram, então é possível que haja '''um dependência alta da qualidade da internet e estabilidade durante a instalação'''

= Rodando serviços =
== Usuários ==
Para acessar o conteúdo utilize os usuários abaixo:
'''user / password'''
staff@example.com / edx
verified@example.com / edx
audit@example.com / edx
honor@example.com / edx
== Conectando na VM ==
Após a instalação será possível conectar na VM usando o comando:
vagrant ssh

Usaremos o usuário '''edxapp''' como root com o comando:
sudo su edxapp

== Iniciando LMS ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de LMS com o comando:
paver devstack lms ( use '''--fast''' para não atualizar o conteúdo do LMS )
Deve ser acessível no endereço [http://localhost:8000 localhost:8000].

== Iniciando Studio ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de '''Studio''' com o comando:
paver devstack studio ( use '''--fast''' para não atualizar o conteúdo do Studio )
Deve ser acessível no endereço [http://localhost:8000 localhost:8001].

== Iniciando Discussão ==

É preciso estar com o usuário '''forum''' para iniciar o serviço de '''Discussão''' com o comando:
sudo su forum
bundle install ( atualiza Ruby )
ruby app.rb -p 18080
Deve ser acessível no endereço [http://localhost:18080 localhost:18080].

== Problemas ==
=== Serviços não rodam novamente ===
Caso algum dos serviços acima já tenha sido executado e ao tentar rodar está apresentando o seguinte erro:
'''Build failed running pavelib.servers.devstack: Subprocess return code: 1'''
É possível que tenha dado erro ao se conectar no Mongo, para corrigir isso será preciso executar os comandos abaixo '''dentro da VM''':
sudo rm /edx/var/mongo/mongodb/mongod.lock
sudo mongod -repair --config /etc/mongod.conf
sudo chown -R mongodb:mongodb /edx/var/mongo/.
sudo service mongod start
Agora é só tentar executar o serviço novamente, conforme os exemplos acima.

= Customização =
== Acessibilidade ==
Dá suporte a acessibilidade com o [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/accessibility.html#use-wai-aria-to-create-accessible-widgets-or-enhance-native-elements WAI-ARIA].
== Desenvolvimento ==
Possui um sessão dedicada a desenvolvimento, [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/index.html#writing-good-code Writing Good Code].

Atualmente suporte para ES5 e está iniciando o suporte para ES6.

A plataforma permite a uso de frameworks e tecnologias como [http://facebook.github.io/react/ React] /
[http://backbonejs.org/ Backbone] /
[http://underscorejs.org Underscore] e
[http://webpack.github.io Webpack] /
[http://http://requirejs.org/ RequireJS]( XBlocks não dão suporte à RequireJS ),
bem como até o uso de [http://coffeescript.org CoffeeScript].

Também possui um [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/javascript_guidelines.html#edx-javascript-guidelines EdX JavaScript Style Guide]( Estilo de código, testes e documentação ) que orienta com desenvolver usando '''JavaScript na plataforma'''.

== Cursos ==
A customização ou criação de cursos pode ser feita através do '''Studio''', que possui um plataforma dedicada para isso.
== XBlock==
São arquitetura de components para cursos da edX.org. Cursos são construídos hierarquicamente com peças chamadas Xblocks, como tags HTML, <div> .

O XBlock provem a estrutura, dados e até a API se for necessário para construir o componente. [https://open.edx.org/xblocks Mais detalhes]

== Temas ==
A plataforma de edX permite uma customização completa de toda a plataforma.
Também disponibiliza padrões de User Interface e guidlines.

* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Exemplos achados no [https://github.com/search?utf8=%E2%9C%93&q=edx+themes&type= Github]
* [https://github.com/dadasoz/edx-bootstrap-theme edx-bootstrap-theme - LMS]
* [https://github.com/openfun/edx-theme OpenFun] - [https://www.fun-mooc.fr/ examplo]
* [https://github.com/Stanford-Online/edx-theme/ Stanford theme]
* [https://github.com/raccoongang/themes_for_themex.io Raccoongang] - [https://edx-marvel-blue.raccoongang.com/ exemplo]

= Remoção =
Deleter a pasta '''devstack''' e a imagem no virtualbox.

= Referências =
* [https://youtrack.mstech.com.br/issue/10030020-2#tab=Comments Youtrack]
* [https://open.edx.org/about-open-edx Dúvidas básicas sobre Open edX]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack Dev. on Devstack]
* [https://github.com/edx/XBlock XBlock]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Configurando OpenEDX devstack

2017-08-10T19:53:34Z

Alexandre.paravani:

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==
=== Hardware ===

CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

=== Software ===
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas de rede ===
Após a criação da VM, '''durante a instalação''', é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.
Talvez peça suas credenciais durante o processo.

=== Erros diversos ===
Ao reiniciar o processo de instalação do zero muitos deles não ocorreram, então é possível que haja '''um dependência alta da qualidade da internet e estabilidade durante a instalação'''

= Rodando serviços =
== Conectando na VM ==
Após a instalação será possível conectar na VM usando o comando:
vagrant ssh

Usaremos o usuário '''edxapp''' como root com o comando:
sudo su edxapp

== Iniciando LMS ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de LMS com o comando:
paver devstack lms ( use '''--fast''' para não atualizar o conteúdo do LMS )
Deve ser acessível no endereço [http://localhost:8000 localhost:8000].

== Iniciando Studio ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de '''Studio''' com o comando:
paver devstack studio ( use '''--fast''' para não atualizar o conteúdo do Studio )
Deve ser acessível no endereço [http://localhost:8000 localhost:8001].

== Iniciando Discussão ==

É preciso estar com o usuário '''forum''' para iniciar o serviço de '''Discussão''' com o comando:
sudo su forum
bundle install ( atualiza Ruby )
ruby app.rb -p 18080
Deve ser acessível no endereço [http://localhost:18080 localhost:18080].

== Problemas ==
=== Serviços não rodam novamente ===
Caso algum dos serviços acima já tenha sido executado e ao tentar rodar está apresentando o seguinte erro:
'''Build failed running pavelib.servers.devstack: Subprocess return code: 1'''
É possível que tenha dado erro ao se conectar no Mongo, para corrigir isso será preciso executar os comandos abaixo '''dentro da VM''':
sudo rm /edx/var/mongo/mongodb/mongod.lock
sudo mongod -repair --config /etc/mongod.conf
sudo chown -R mongodb:mongodb /edx/var/mongo/.
sudo service mongod start
Agora é só tentar executar o serviço novamente, conforme os exemplos acima.

= Customização =
== Acessibilidade ==
Dá suporte a acessibilidade com o [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/accessibility.html#use-wai-aria-to-create-accessible-widgets-or-enhance-native-elements WAI-ARIA].
== Desenvolvimento ==
Possui um sessão dedicada a desenvolvimento, [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/index.html#writing-good-code Writing Good Code].

Atualmente suporte para ES5 e está iniciando o suporte para ES6.

A plataforma permite a uso de frameworks e tecnologias como [http://facebook.github.io/react/ React] /
[http://backbonejs.org/ Backbone] /
[http://underscorejs.org Underscore] e
[http://webpack.github.io Webpack] /
[http://http://requirejs.org/ RequireJS]( XBlocks não dão suporte à RequireJS ),
bem como até o uso de [http://coffeescript.org CoffeeScript].

Também possui um [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/javascript_guidelines.html#edx-javascript-guidelines EdX JavaScript Style Guide]( Estilo de código, testes e documentação ) que orienta com desenvolver usando '''JavaScript na plataforma'''.

== Cursos ==
A customização ou criação de cursos pode ser feita através do '''Studio''', que possui um plataforma dedicada para isso.
== XBlock==
São arquitetura de components para cursos da edX.org. Cursos são construídos hierarquicamente com peças chamadas Xblocks, como tags HTML, <div> .

O XBlock provem a estrutura, dados e até a API se for necessário para construir o componente. [https://open.edx.org/xblocks Mais detalhes]

== Temas ==
A plataforma de edX permite uma customização completa de toda a plataforma.
Também disponibiliza padrões de User Interface e guidlines.

* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Exemplos achados no [https://github.com/search?utf8=%E2%9C%93&q=edx+themes&type= Github]
* [https://github.com/dadasoz/edx-bootstrap-theme edx-bootstrap-theme - LMS]
* [https://github.com/openfun/edx-theme OpenFun] - [https://www.fun-mooc.fr/ examplo]
* [https://github.com/Stanford-Online/edx-theme/ Stanford theme]
* [https://github.com/raccoongang/themes_for_themex.io Raccoongang] - [https://edx-marvel-blue.raccoongang.com/ exemplo]

= Remoção =
Deleter a pasta '''devstack''' e a imagem no virtualbox.

= Referências =
* [https://youtrack.mstech.com.br/issue/10030020-2#tab=Comments Youtrack]
* [https://open.edx.org/about-open-edx Dúvidas básicas sobre Open edX]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack Dev. on Devstack]
* [https://github.com/edx/XBlock XBlock]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Configurando OpenEDX devstack

2017-08-10T19:21:16Z

Alexandre.paravani: /* Iniciando Fórum */

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==
=== Hardware ===

CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

=== Software ===
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas de rede ===
Após a criação da VM, '''durante a instalação''', é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.
Talvez peça suas credenciais durante o processo.

=== Erros diversos ===
Ao reiniciar o processo de instalação do zero muitos deles não ocorreram, então é possível que haja '''um dependência alta da qualidade da internet e estabilidade durante a instalação'''

= Rodando serviços =
== Conectando na VM ==
Após a instalação será possível conectar na VM usando o comando:
vagrant ssh

Usaremos o usuário '''edxapp''' como root com o comando:
sudo su edxapp

== Iniciando LMS ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de LMS com o comando:
paver devstack lms ( use '''--fast''' para não atualizar o conteúdo do LMS )
Deve ser acessível no endereço [http://localhost:8000 localhost:8000].

== Iniciando Studio ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de '''Studio''' com o comando:
paver devstack studio ( use '''--fast''' para não atualizar o conteúdo do Studio )
Deve ser acessível no endereço [http://localhost:8000 localhost:8001].

== Iniciando Discussão ==

É preciso estar com o usuário '''forum''' para iniciar o serviço de '''Discussão''' com o comando:
sudo su forum
bundle install ( atualiza Ruby )
ruby app.rb -p 18080
Deve ser acessível no endereço [http://localhost:18080 localhost:18080].

== Problemas ==
=== Serviços não rodam novamente ===
Caso algum dos serviços acima já tenha sido executado e ao tentar rodar está apresentando o seguinte erro:
'''Build failed running pavelib.servers.devstack: Subprocess return code: 1'''
É possível que tenha dado erro ao se conectar no Mongo, para corrigir isso será preciso executar os comandos abaixo '''dentro da VM''':
sudo rm /edx/var/mongo/mongodb/mongod.lock
sudo mongod -repair --config /etc/mongod.conf
sudo chown -R mongodb:mongodb /edx/var/mongo/.
sudo service mongod start
Agora é só tentar executar o serviço novamente, conforme os exemplos acima.

= Customização =
== Acessibilidade ==
Dá suporte a acessibilidade com o [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/accessibility.html#use-wai-aria-to-create-accessible-widgets-or-enhance-native-elements WAI-ARIA].
== Desenvolvimento ==
Possui um sessão dedicada a desenvolvimento, [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/index.html#writing-good-code Writing Good Code].

Atualmente suporte para ES5 e está iniciando o suporte para ES6.

A plataforma permite a uso de frameworks e tecnologias como [http://facebook.github.io/react/ React] /
[http://backbonejs.org/ Backbone] /
[http://underscorejs.org Underscore] e
[http://webpack.github.io Webpack] /
[http://http://requirejs.org/ RequireJS]( XBlocks não dão suporte à RequireJS ),
bem como até o uso de [http://coffeescript.org CoffeeScript].

Também possui um [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/javascript_guidelines.html#edx-javascript-guidelines EdX JavaScript Style Guide]( Estilo de código, testes e documentação ) que orienta com desenvolver usando '''JavaScript na plataforma'''.

== Cursos ==
A customização ou criação de cursos pode ser feita através do '''Studio''', que possui um plataforma dedicada para isso.
== XBlock==
São arquitetura de components para cursos da edX.org. Cursos são construídos hierarquicamente com peças chamadas Xblocks, como tags HTML, <div> .

O XBlock provem a estrutura, dados e até a API se for necessário para construir o componente. [https://open.edx.org/xblocks Mais detalhes]

== Temas ==
A plataforma de edX permite uma customização completa de toda a plataforma.
Também disponibiliza padrões de User Interface e guidlines.

* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Exemplos achados no [https://github.com/search?utf8=%E2%9C%93&q=edx+themes&type= Github]
* [https://github.com/dadasoz/edx-bootstrap-theme edx-bootstrap-theme - LMS]
* [https://github.com/openfun/edx-theme OpenFun] - [https://www.fun-mooc.fr/ examplo]
* [https://github.com/Stanford-Online/edx-theme/ Stanford theme]
* [https://github.com/raccoongang/themes_for_themex.io Raccoongang] - [https://edx-marvel-blue.raccoongang.com/ exemplo]

= Remoção =
Deleter a pasta '''devstack''' e a imagem no virtualbox.

= Referências =
* [https://open.edx.org/about-open-edx Dúvidas básicas sobre Open edX]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack Dev. on Devstack]
* [https://github.com/edx/XBlock XBlock]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Configurando OpenEDX devstack

2017-08-10T19:19:04Z

Alexandre.paravani:

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==
=== Hardware ===

CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

=== Software ===
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas de rede ===
Após a criação da VM, '''durante a instalação''', é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.
Talvez peça suas credenciais durante o processo.

=== Erros diversos ===
Ao reiniciar o processo de instalação do zero muitos deles não ocorreram, então é possível que haja '''um dependência alta da qualidade da internet e estabilidade durante a instalação'''

= Rodando serviços =
== Conectando na VM ==
Após a instalação será possível conectar na VM usando o comando:
vagrant ssh

Usaremos o usuário '''edxapp''' como root com o comando:
sudo su edxapp

== Iniciando LMS ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de LMS com o comando:
paver devstack lms ( use '''--fast''' para não atualizar o conteúdo do LMS )
Deve ser acessível no endereço [http://localhost:8000 localhost:8000].

== Iniciando Studio ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de '''Studio''' com o comando:
paver devstack studio ( use '''--fast''' para não atualizar o conteúdo do Studio )
Deve ser acessível no endereço [http://localhost:8000 localhost:8001].

== Iniciando Fórum ==

É preciso estar com o usuário '''forum''' para iniciar o serviço de '''Fórum''' com o comando:
sudo su forum
bundle install ( atualiza Ruby )
ruby app.rb -p 18080
Deve ser acessível no endereço [http://localhost:18080 localhost:18080].

== Problemas ==
=== Serviços não rodam novamente ===
Caso algum dos serviços acima já tenha sido executado e ao tentar rodar está apresentando o seguinte erro:
'''Build failed running pavelib.servers.devstack: Subprocess return code: 1'''
É possível que tenha dado erro ao se conectar no Mongo, para corrigir isso será preciso executar os comandos abaixo '''dentro da VM''':
sudo rm /edx/var/mongo/mongodb/mongod.lock
sudo mongod -repair --config /etc/mongod.conf
sudo chown -R mongodb:mongodb /edx/var/mongo/.
sudo service mongod start
Agora é só tentar executar o serviço novamente, conforme os exemplos acima.

= Customização =
== Acessibilidade ==
Dá suporte a acessibilidade com o [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/accessibility.html#use-wai-aria-to-create-accessible-widgets-or-enhance-native-elements WAI-ARIA].
== Desenvolvimento ==
Possui um sessão dedicada a desenvolvimento, [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/index.html#writing-good-code Writing Good Code].

Atualmente suporte para ES5 e está iniciando o suporte para ES6.

A plataforma permite a uso de frameworks e tecnologias como [http://facebook.github.io/react/ React] /
[http://backbonejs.org/ Backbone] /
[http://underscorejs.org Underscore] e
[http://webpack.github.io Webpack] /
[http://http://requirejs.org/ RequireJS]( XBlocks não dão suporte à RequireJS ),
bem como até o uso de [http://coffeescript.org CoffeeScript].

Também possui um [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/javascript_guidelines.html#edx-javascript-guidelines EdX JavaScript Style Guide]( Estilo de código, testes e documentação ) que orienta com desenvolver usando '''JavaScript na plataforma'''.

== Cursos ==
A customização ou criação de cursos pode ser feita através do '''Studio''', que possui um plataforma dedicada para isso.
== XBlock==
São arquitetura de components para cursos da edX.org. Cursos são construídos hierarquicamente com peças chamadas Xblocks, como tags HTML, <div> .

O XBlock provem a estrutura, dados e até a API se for necessário para construir o componente. [https://open.edx.org/xblocks Mais detalhes]

== Temas ==
A plataforma de edX permite uma customização completa de toda a plataforma.
Também disponibiliza padrões de User Interface e guidlines.

* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Exemplos achados no [https://github.com/search?utf8=%E2%9C%93&q=edx+themes&type= Github]
* [https://github.com/dadasoz/edx-bootstrap-theme edx-bootstrap-theme - LMS]
* [https://github.com/openfun/edx-theme OpenFun] - [https://www.fun-mooc.fr/ examplo]
* [https://github.com/Stanford-Online/edx-theme/ Stanford theme]
* [https://github.com/raccoongang/themes_for_themex.io Raccoongang] - [https://edx-marvel-blue.raccoongang.com/ exemplo]

= Remoção =
Deleter a pasta '''devstack''' e a imagem no virtualbox.

= Referências =
* [https://open.edx.org/about-open-edx Dúvidas básicas sobre Open edX]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack Dev. on Devstack]
* [https://github.com/edx/XBlock XBlock]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Configurando OpenEDX devstack

2017-08-10T15:50:23Z

Alexandre.paravani: /* Temas */

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==
=== Hardware ===

CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

=== Software ===
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas de rede ===
Após a criação da VM, '''durante a instalação''', é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.
Talvez peça suas credenciais durante o processo.

=== Erros diversos ===
Ao reiniciar o processo de instalação do zero muitos deles não ocorreram, então é possível que haja '''um dependência alta da qualidade da internet e estabilidade durante a instalação'''

= Rodando serviços =
== Conectando na VM ==
Após a instalação será possível conectar na VM usando o comando:
vagrant ssh

Usaremos o usuário '''edxapp''' como root com o comando:
sudo su edxapp

== Iniciando LMS ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de LMS com o comando:
paver devstack lms ( use '''--fast''' para não atualizar o conteúdo do LMS )
Deve ser acessível no endereço [http://localhost:8000 localhost:8000].

== Iniciando Studio ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de '''Studio''' com o comando:
paver devstack studio ( use '''--fast''' para não atualizar o conteúdo do Studio )
Deve ser acessível no endereço [http://localhost:8000 localhost:8001].

== Iniciando Fórum ==

É preciso estar com o usuário '''forum''' para iniciar o serviço de '''Fórum''' com o comando:
sudo su forum
bundle install ( atualiza Ruby )
ruby app.rb -p 18080
Deve ser acessível no endereço [http://localhost:18080 localhost:18080].

== Problemas ==
=== Serviços não rodam novamente ===
Caso algum dos serviços acima já tenha sido executado e ao tentar rodar está apresentando o seguinte erro:
'''Build failed running pavelib.servers.devstack: Subprocess return code: 1'''
É possível que tenha dado erro ao se conectar no Mongo, para corrigir isso será preciso executar os comandos abaixo '''dentro da VM''':
sudo rm /edx/var/mongo/mongodb/mongod.lock
sudo mongod -repair --config /etc/mongod.conf
sudo chown -R mongodb:mongodb /edx/var/mongo/.
sudo service mongod start
Agora é só tentar executar o serviço novamente, conforme os exemplos acima.

= Customização =
== Acessibilidade ==
Dá suporte a acessibilidade com o [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/accessibility.html#use-wai-aria-to-create-accessible-widgets-or-enhance-native-elements WAI-ARIA].
== Desenvolvimento ==
Possui um sessão dedicada a desenvolvimento, [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/index.html#writing-good-code Writing Good Code].

Atualmente suporte para ES5 e está iniciando o suporte para ES6.

A plataforma permite a uso de frameworks e tecnologias como [http://facebook.github.io/react/ React] /
[http://backbonejs.org/ Backbone] /
[http://underscorejs.org Underscore] e
[http://webpack.github.io Webpack] /
[http://http://requirejs.org/ RequireJS]( XBlocks não dão suporte à RequireJS ),
bem como até o uso de [http://coffeescript.org CoffeeScript].

Também possui um [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/javascript_guidelines.html#edx-javascript-guidelines EdX JavaScript Style Guide]( Estilo de código, testes e documentação ) que orienta com desenvolver usando '''JavaScript na plataforma'''.

== Cursos ==
A customização ou criação de cursos pode ser feita através do '''Studio''', que possui um plataforma dedicada para isso.
== XBlock==
São arquitetura de components para cursos da edX.org. Cursos são construídos hierarquicamente com peças chamadas Xblocks, como tags HTML, <div> .

O XBlock provem a estrutura, dados e até a API se for necessário para construir o componente. [https://open.edx.org/xblocks Mais detalhes]

== Temas ==
A plataforma de edX permite uma customização completa de toda a plataforma.
Também disponibiliza padrões de User Interface e guidlines.

* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Exemplos achados no [https://github.com/search?utf8=%E2%9C%93&q=edx+themes&type= Github]
* [https://github.com/dadasoz/edx-bootstrap-theme edx-bootstrap-theme - LMS]
* [https://github.com/openfun/edx-theme OpenFun] - [https://www.fun-mooc.fr/ examplo]
* [https://github.com/Stanford-Online/edx-theme/ Stanford theme]
* [https://github.com/raccoongang/themes_for_themex.io Raccoongang] - [https://edx-marvel-blue.raccoongang.com/ exemplo]

= Remoção =
Deleter a pasta '''devstack''' e a imagem no virtualbox.

= Referências =
* [https://open.edx.org/about-open-edx Dúvidas básicas sobre Open edX]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack Dev. on Devstack]
* [https://github.com/edx/XBlock XBlock]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Configurando OpenEDX devstack

2017-08-10T15:41:19Z

Alexandre.paravani: /* Customização */

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==
=== Hardware ===

CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

=== Software ===
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas de rede ===
Após a criação da VM, '''durante a instalação''', é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.
Talvez peça suas credenciais durante o processo.

=== Erros diversos ===
Ao reiniciar o processo de instalação do zero muitos deles não ocorreram, então é possível que haja '''um dependência alta da qualidade da internet e estabilidade durante a instalação'''

= Rodando serviços =
== Conectando na VM ==
Após a instalação será possível conectar na VM usando o comando:
vagrant ssh

Usaremos o usuário '''edxapp''' como root com o comando:
sudo su edxapp

== Iniciando LMS ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de LMS com o comando:
paver devstack lms ( use '''--fast''' para não atualizar o conteúdo do LMS )
Deve ser acessível no endereço [http://localhost:8000 localhost:8000].

== Iniciando Studio ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de '''Studio''' com o comando:
paver devstack studio ( use '''--fast''' para não atualizar o conteúdo do Studio )
Deve ser acessível no endereço [http://localhost:8000 localhost:8001].

== Iniciando Fórum ==

É preciso estar com o usuário '''forum''' para iniciar o serviço de '''Fórum''' com o comando:
sudo su forum
bundle install ( atualiza Ruby )
ruby app.rb -p 18080
Deve ser acessível no endereço [http://localhost:18080 localhost:18080].

== Problemas ==
=== Serviços não rodam novamente ===
Caso algum dos serviços acima já tenha sido executado e ao tentar rodar está apresentando o seguinte erro:
'''Build failed running pavelib.servers.devstack: Subprocess return code: 1'''
É possível que tenha dado erro ao se conectar no Mongo, para corrigir isso será preciso executar os comandos abaixo '''dentro da VM''':
sudo rm /edx/var/mongo/mongodb/mongod.lock
sudo mongod -repair --config /etc/mongod.conf
sudo chown -R mongodb:mongodb /edx/var/mongo/.
sudo service mongod start
Agora é só tentar executar o serviço novamente, conforme os exemplos acima.

= Customização =
== Acessibilidade ==
Dá suporte a acessibilidade com o [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/accessibility.html#use-wai-aria-to-create-accessible-widgets-or-enhance-native-elements WAI-ARIA].
== Desenvolvimento ==
Possui um sessão dedicada a desenvolvimento, [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/index.html#writing-good-code Writing Good Code].

Atualmente suporte para ES5 e está iniciando o suporte para ES6.

A plataforma permite a uso de frameworks e tecnologias como [http://facebook.github.io/react/ React] /
[http://backbonejs.org/ Backbone] /
[http://underscorejs.org Underscore] e
[http://webpack.github.io Webpack] /
[http://http://requirejs.org/ RequireJS]( XBlocks não dão suporte à RequireJS ),
bem como até o uso de [http://coffeescript.org CoffeeScript].

Também possui um [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/javascript_guidelines.html#edx-javascript-guidelines EdX JavaScript Style Guide]( Estilo de código, testes e documentação ) que orienta com desenvolver usando '''JavaScript na plataforma'''.

== Cursos ==
A customização ou criação de cursos pode ser feita através do '''Studio''', que possui um plataforma dedicada para isso.
== XBlock==
São arquitetura de components para cursos da edX.org. Cursos são construídos hierarquicamente com peças chamadas Xblocks, como tags HTML, <div> .

O XBlock provem a estrutura, dados e até a API se for necessário para construir o componente. [https://open.edx.org/xblocks Mais detalhes]

== Temas ==
A plataforma de edX permite uma customização completa de toda a plataforma.
Também disponibiliza padrões de User Interface e guidlines.

* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

= Remoção =
Deleter a pasta '''devstack''' e a imagem no virtualbox.

= Referências =
* [https://open.edx.org/about-open-edx Dúvidas básicas sobre Open edX]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack Dev. on Devstack]
* [https://github.com/edx/XBlock XBlock]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Configurando OpenEDX devstack

2017-08-10T15:30:20Z

Alexandre.paravani: /* Javascript */

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==
=== Hardware ===

CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

=== Software ===
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas de rede ===
Após a criação da VM, '''durante a instalação''', é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.
Talvez peça suas credenciais durante o processo.

=== Erros diversos ===
Ao reiniciar o processo de instalação do zero muitos deles não ocorreram, então é possível que haja '''um dependência alta da qualidade da internet e estabilidade durante a instalação'''

= Rodando serviços =
== Conectando na VM ==
Após a instalação será possível conectar na VM usando o comando:
vagrant ssh

Usaremos o usuário '''edxapp''' como root com o comando:
sudo su edxapp

== Iniciando LMS ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de LMS com o comando:
paver devstack lms ( use '''--fast''' para não atualizar o conteúdo do LMS )
Deve ser acessível no endereço [http://localhost:8000 localhost:8000].

== Iniciando Studio ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de '''Studio''' com o comando:
paver devstack studio ( use '''--fast''' para não atualizar o conteúdo do Studio )
Deve ser acessível no endereço [http://localhost:8000 localhost:8001].

== Iniciando Fórum ==

É preciso estar com o usuário '''forum''' para iniciar o serviço de '''Fórum''' com o comando:
sudo su forum
bundle install ( atualiza Ruby )
ruby app.rb -p 18080
Deve ser acessível no endereço [http://localhost:18080 localhost:18080].

== Problemas ==
=== Serviços não rodam novamente ===
Caso algum dos serviços acima já tenha sido executado e ao tentar rodar está apresentando o seguinte erro:
'''Build failed running pavelib.servers.devstack: Subprocess return code: 1'''
É possível que tenha dado erro ao se conectar no Mongo, para corrigir isso será preciso executar os comandos abaixo '''dentro da VM''':
sudo rm /edx/var/mongo/mongodb/mongod.lock
sudo mongod -repair --config /etc/mongod.conf
sudo chown -R mongodb:mongodb /edx/var/mongo/.
sudo service mongod start
Agora é só tentar executar o serviço novamente, conforme os exemplos acima.

= Customização =
== Desenvolvimento ==

Possui um sessão dedicada a desenvolvimento, [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/index.html#writing-good-code Writing Good Code].

Atualmente suporte para ES5 e está iniciando o suporte para ES6.

A plataforma permite a uso de frameworks e tecnologias como [http://facebook.github.io/react/ React] /
[http://backbonejs.org/ Backbone] /
[http://underscorejs.org Underscore] e
[http://webpack.github.io Webpack] /
[http://http://requirejs.org/ RequireJS]( XBlocks não dão suporte à RequireJS ),
bem como até o uso de [http://coffeescript.org CoffeeScript].

Também possui um [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/javascript_guidelines.html#edx-javascript-guidelines EdX JavaScript Style Guide]( Estilo de código, testes e documentação ) que orienta com desenvolver usando '''JavaScript na plataforma'''.

== Cursos ==
A customização ou criação de cursos pode ser feita através do '''Studio''', que possui um plataforma dedicada para isso.
== XBlock==
São arquitetura de components para cursos da edX.org. Cursos são construídos hierarquicamente com peças chamadas Xblocks, como tags HTML, <div> .

O XBlock provem a estrutura, dados e até a API se for necessário para construir o componente. [https://open.edx.org/xblocks Mais detalhes]

== Temas ==
A plataforma de edX permite uma customização completa de toda a plataforma.
Também disponibiliza padrões de User Interface e guidlines.

* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

= Remoção =
Deleter a pasta '''devstack''' e a imagem no virtualbox.

= Referências =
* [https://open.edx.org/about-open-edx Dúvidas básicas sobre Open edX]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack Dev. on Devstack]
* [https://github.com/edx/XBlock XBlock]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Configurando OpenEDX devstack

2017-08-10T15:25:03Z

Alexandre.paravani: /* Javascript */

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==
=== Hardware ===

CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

=== Software ===
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas de rede ===
Após a criação da VM, '''durante a instalação''', é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.
Talvez peça suas credenciais durante o processo.

=== Erros diversos ===
Ao reiniciar o processo de instalação do zero muitos deles não ocorreram, então é possível que haja '''um dependência alta da qualidade da internet e estabilidade durante a instalação'''

= Rodando serviços =
== Conectando na VM ==
Após a instalação será possível conectar na VM usando o comando:
vagrant ssh

Usaremos o usuário '''edxapp''' como root com o comando:
sudo su edxapp

== Iniciando LMS ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de LMS com o comando:
paver devstack lms ( use '''--fast''' para não atualizar o conteúdo do LMS )
Deve ser acessível no endereço [http://localhost:8000 localhost:8000].

== Iniciando Studio ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de '''Studio''' com o comando:
paver devstack studio ( use '''--fast''' para não atualizar o conteúdo do Studio )
Deve ser acessível no endereço [http://localhost:8000 localhost:8001].

== Iniciando Fórum ==

É preciso estar com o usuário '''forum''' para iniciar o serviço de '''Fórum''' com o comando:
sudo su forum
bundle install ( atualiza Ruby )
ruby app.rb -p 18080
Deve ser acessível no endereço [http://localhost:18080 localhost:18080].

== Problemas ==
=== Serviços não rodam novamente ===
Caso algum dos serviços acima já tenha sido executado e ao tentar rodar está apresentando o seguinte erro:
'''Build failed running pavelib.servers.devstack: Subprocess return code: 1'''
É possível que tenha dado erro ao se conectar no Mongo, para corrigir isso será preciso executar os comandos abaixo '''dentro da VM''':
sudo rm /edx/var/mongo/mongodb/mongod.lock
sudo mongod -repair --config /etc/mongod.conf
sudo chown -R mongodb:mongodb /edx/var/mongo/.
sudo service mongod start
Agora é só tentar executar o serviço novamente, conforme os exemplos acima.

= Customização =
== Javascript ==
A plataforma permite a incorporação de frameworks e tecnologias como [http://facebook.github.io/react/ React] /
[http://backbonejs.org/ Backbone] /
[http://underscorejs.org Underscore] e
[http://webpack.github.io Webpack] /
[http://http://requirejs.org/ RequireJS]( XBlocks não dão suporte à RequireJS ),
bem como até o uso de [http://coffeescript.org CoffeeScript].

== Cursos ==
A customização ou criação de cursos pode ser feita através do '''Studio''', que possui um plataforma dedicada para isso.
== XBlock==
São arquitetura de components para cursos da edX.org. Cursos são construídos hierarquicamente com peças chamadas Xblocks, como tags HTML, <div> .

O XBlock provem a estrutura, dados e até a API se for necessário para construir o componente. [https://open.edx.org/xblocks Mais detalhes]

== Temas ==
A plataforma de edX permite uma customização completa de toda a plataforma.
Também disponibiliza padrões de User Interface e guidlines.

* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

= Remoção =
Deleter a pasta '''devstack''' e a imagem no virtualbox.

= Referências =
* [https://open.edx.org/about-open-edx Dúvidas básicas sobre Open edX]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack Dev. on Devstack]
* [https://github.com/edx/XBlock XBlock]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Configurando OpenEDX devstack

2017-08-10T15:21:38Z

Alexandre.paravani: /* Customização */

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==
=== Hardware ===

CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

=== Software ===
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas de rede ===
Após a criação da VM, '''durante a instalação''', é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.
Talvez peça suas credenciais durante o processo.

=== Erros diversos ===
Ao reiniciar o processo de instalação do zero muitos deles não ocorreram, então é possível que haja '''um dependência alta da qualidade da internet e estabilidade durante a instalação'''

= Rodando serviços =
== Conectando na VM ==
Após a instalação será possível conectar na VM usando o comando:
vagrant ssh

Usaremos o usuário '''edxapp''' como root com o comando:
sudo su edxapp

== Iniciando LMS ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de LMS com o comando:
paver devstack lms ( use '''--fast''' para não atualizar o conteúdo do LMS )
Deve ser acessível no endereço [http://localhost:8000 localhost:8000].

== Iniciando Studio ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de '''Studio''' com o comando:
paver devstack studio ( use '''--fast''' para não atualizar o conteúdo do Studio )
Deve ser acessível no endereço [http://localhost:8000 localhost:8001].

== Iniciando Fórum ==

É preciso estar com o usuário '''forum''' para iniciar o serviço de '''Fórum''' com o comando:
sudo su forum
bundle install ( atualiza Ruby )
ruby app.rb -p 18080
Deve ser acessível no endereço [http://localhost:18080 localhost:18080].

== Problemas ==
=== Serviços não rodam novamente ===
Caso algum dos serviços acima já tenha sido executado e ao tentar rodar está apresentando o seguinte erro:
'''Build failed running pavelib.servers.devstack: Subprocess return code: 1'''
É possível que tenha dado erro ao se conectar no Mongo, para corrigir isso será preciso executar os comandos abaixo '''dentro da VM''':
sudo rm /edx/var/mongo/mongodb/mongod.lock
sudo mongod -repair --config /etc/mongod.conf
sudo chown -R mongodb:mongodb /edx/var/mongo/.
sudo service mongod start
Agora é só tentar executar o serviço novamente, conforme os exemplos acima.

= Customização =
== Javascript ==
A plataforma permite a incorporação de frameworks e tecnologias como [http://facebook.github.io/react/ React]/[http://backbonejs.org/ Backbone]/[http://underscorejs.org Underscore] e [http://webpack.github.io Webpack], bem como até o uso de [http://coffeescript.org CoffeeScript].

== Cursos ==
A customização ou criação de cursos pode ser feita através do '''Studio''', que possui um plataforma dedicada para isso.
== XBlock==
São arquitetura de components para cursos da edX.org. Cursos são construídos hierarquicamente com peças chamadas Xblocks, como tags HTML, <div> .

O XBlock provem a estrutura, dados e até a API se for necessário para construir o componente. [https://open.edx.org/xblocks Mais detalhes]

== Temas ==
A plataforma de edX permite uma customização completa de toda a plataforma.
Também disponibiliza padrões de User Interface e guidlines.

* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

= Remoção =
Deleter a pasta '''devstack''' e a imagem no virtualbox.

= Referências =
* [https://open.edx.org/about-open-edx Dúvidas básicas sobre Open edX]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack Dev. on Devstack]
* [https://github.com/edx/XBlock XBlock]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Configurando OpenEDX devstack

2017-08-10T15:21:07Z

Alexandre.paravani:

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==
=== Hardware ===

CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

=== Software ===
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas de rede ===
Após a criação da VM, '''durante a instalação''', é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.
Talvez peça suas credenciais durante o processo.

=== Erros diversos ===
Ao reiniciar o processo de instalação do zero muitos deles não ocorreram, então é possível que haja '''um dependência alta da qualidade da internet e estabilidade durante a instalação'''

= Rodando serviços =
== Conectando na VM ==
Após a instalação será possível conectar na VM usando o comando:
vagrant ssh

Usaremos o usuário '''edxapp''' como root com o comando:
sudo su edxapp

== Iniciando LMS ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de LMS com o comando:
paver devstack lms ( use '''--fast''' para não atualizar o conteúdo do LMS )
Deve ser acessível no endereço [http://localhost:8000 localhost:8000].

== Iniciando Studio ==

Agora que estamos no sistem com o usuário '''edxapp''' vamos iniciar o serviço de '''Studio''' com o comando:
paver devstack studio ( use '''--fast''' para não atualizar o conteúdo do Studio )
Deve ser acessível no endereço [http://localhost:8000 localhost:8001].

== Iniciando Fórum ==

É preciso estar com o usuário '''forum''' para iniciar o serviço de '''Fórum''' com o comando:
sudo su forum
bundle install ( atualiza Ruby )
ruby app.rb -p 18080
Deve ser acessível no endereço [http://localhost:18080 localhost:18080].

== Problemas ==
=== Serviços não rodam novamente ===
Caso algum dos serviços acima já tenha sido executado e ao tentar rodar está apresentando o seguinte erro:
'''Build failed running pavelib.servers.devstack: Subprocess return code: 1'''
É possível que tenha dado erro ao se conectar no Mongo, para corrigir isso será preciso executar os comandos abaixo '''dentro da VM''':
sudo rm /edx/var/mongo/mongodb/mongod.lock
sudo mongod -repair --config /etc/mongod.conf
sudo chown -R mongodb:mongodb /edx/var/mongo/.
sudo service mongod start
Agora é só tentar executar o serviço novamente, conforme os exemplos acima.

= Customização =
== Javascript ==
A plataforma permite a incorporação de frameworks e tecnologias como [https://facebook.github.io/react/ React]/[https://backbonejs.org/ Backbone]/[https://underscorejs.org Underscore] e [https://webpack.github.io Webpack], bem como até o uso de [https://coffeescript.org CoffeeScript].

== Cursos ==
A customização ou criação de cursos pode ser feita através do '''Studio''', que possui um plataforma dedicada para isso.
== XBlock==
São arquitetura de components para cursos da edX.org. Cursos são construídos hierarquicamente com peças chamadas Xblocks, como tags HTML, <div> .

O XBlock provem a estrutura, dados e até a API se for necessário para construir o componente. [https://open.edx.org/xblocks Mais detalhes]

== Temas ==
A plataforma de edX permite uma customização completa de toda a plataforma.
Também disponibiliza padrões de User Interface e guidlines.

* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

= Remoção =
Deleter a pasta '''devstack''' e a imagem no virtualbox.

= Referências =
* [https://open.edx.org/about-open-edx Dúvidas básicas sobre Open edX]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack Dev. on Devstack]
* [https://github.com/edx/XBlock XBlock]
* [https://github.com/edx/edx-platform/wiki/Developing-on-the-edX-Developer-Stack#configuring-themes-in-devstack Configuring Themes in Devstack]
* [https://openedx.atlassian.net/wiki/spaces/FEDX Open edX Front End Development Guideline]
* [https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/user_interface_development.html Open edX UI Patterns]

Configurando OpenEDX devstack

2017-08-10T15:12:07Z

Alexandre.paravani: /* Referências */

Configurando OpenEDX devstack

2017-08-10T15:10:07Z

Alexandre.paravani:

Configurando OpenEDX devstack

2017-08-10T14:28:43Z

Alexandre.paravani: /* Rodando serviços */

Configurando OpenEDX devstack

2017-08-09T21:34:09Z

Alexandre.paravani: /* Referências */

Configurando OpenEDX devstack

2017-08-09T21:28:27Z

Alexandre.paravani:

Configurando OpenEDX devstack

2017-08-09T21:27:41Z

Alexandre.paravani:

Configurando OpenEDX devstack

2017-08-09T21:04:43Z

Alexandre.paravani: /* Problemas */

Configurando OpenEDX devstack

2017-08-09T21:04:06Z

Alexandre.paravani: /* Problemas */

Configurando OpenEDX devstack

2017-08-09T21:03:54Z

Alexandre.paravani: /* Problemas */

Configurando OpenEDX devstack

2017-08-09T19:51:24Z

Alexandre.paravani:

Configurando OpenEDX devstack

2017-08-09T19:14:24Z

Alexandre.paravani: /* Hardware */

Configurando OpenEDX devstack

2017-08-09T19:13:56Z

Alexandre.paravani: /* Dependências */

Configurando OpenEDX devstack

2017-08-09T19:12:57Z

Alexandre.paravani: /* Problemas */

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==

A máquina usada nessa operação foi:
CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz x4'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

Para iniciar o processo de instalação é preciso os itens abaixo:
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas ===
Após a criação da VM é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.
Talvez peça suas credenciais durante o processo.

= Referências =
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]

Configurando OpenEDX devstack

2017-08-09T19:12:32Z

Alexandre.paravani: /* Instalando Devstack */

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==

A máquina usada nessa operação foi:
CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz x4'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

Para iniciar o processo de instalação é preciso os itens abaixo:
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

=== Problemas ===
Após a criação da VM é preciso habilitar conexão por cabo na VM.
Abra o Virtualbox
selecione a máquina do devstack rodando
clique em Network( Rede ) no '''Adapter 1''' habilite o item '''Cable Connected'''
clique em OK.

= Referências =
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]

Configurando OpenEDX devstack

2017-08-09T19:05:11Z

Alexandre.paravani: /* Referências */

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==

A máquina usada nessa operação foi:
CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz x4'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

Para iniciar o processo de instalação é preciso os itens abaixo:
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

= Referências =
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]

Configurando OpenEDX devstack

2017-08-09T19:04:53Z

Alexandre.paravani: /* Referências */

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==

A máquina usada nessa operação foi:
CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz x4'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

Para iniciar o processo de instalação é preciso os itens abaixo:
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

= Referências =
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
* [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
* [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]

Configurando OpenEDX devstack

2017-08-09T19:01:59Z

Alexandre.paravani: Criou página com 'Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX. = Instalação = == Dependências == A máqu...'

Nessa página será feito a instalação e acompanhamento dos processos para instalar o ambiente de desenvolvimento do OpenEDX.

= Instalação =
== Dependências ==

A máquina usada nessa operação foi:
CPU: '''Intel(R) Core(TM) i3-2100 CPU @ 3.10GHz x4'''
SO: '''Debian 8.8 3.16.0-4-amd64 Mate 1.8.1'''
MEMÓRIA: '''10 GB'''

Para iniciar o processo de instalação é preciso os itens abaixo:
vagrant > 1.6.4
virtualbox = 4.3.*
nfs ( network file system )
curl/wget ( ou similar )
bash/sh/zsh ( ou similar)
'''conexão com internet'''
'''20 GB livres'''

== Pegando versão ==
Selecion um versão oficial no site [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases OpenEDX Release]

Após selecionar a versão desejada, vamos usar o '''Git Tag''' da mesma.

Neste processo utilizaremos a versão '''open-release/ficus.3'''.

Assim iremos cadastrar essa versão em um variável de ambiente, no terminal com a linha:
export OPENEDX_RELEASE="open-release/ficus.3"

Para baixar a imagem do box do vagrant, use o comando:
curl -OL https://raw.github.com/edx/configuration/$OPENEDX_RELEASE/util/install/install_stack.sh

== Instalando Devstack ==
É preciso criar um pasta chamada '''devstack''', e de dentro é preciso executar o script com o comando:
bash install_stack.sh devstack

Esse processo pode ser demorado, dependendo das condições de internet e máquina.

Na máquina citada levou por volta de '''3 horas'''.

= Referências =
- [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/installation_prerequisites.html Installation Prerequisites]
- [https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/devstack/install_devstack.html Installing Open edX Devstack]
- [https://openedx.atlassian.net/wiki/display/DOC/Open+edX+Releases Open edX Release]

Implantação Teamwork e Hubot para SEDUC

2017-06-21T12:22:11Z

Alexandre.paravani:

Nessa página será explicado o processo de implantação do serviço de customização do teamwork e hubot para a SEDUC.

Nas referências estão todos os dados que serão explicados nessa tópico.

= Servidor =
Configuração de hardware e software para execução dos serviços.

== Requisitos mínimos ==
=== Hardware ===
* CPU 1.7 GHz, 6 core, 4GB Ram, 500GB HD
* SO: Ubuntu 14.04 LTS ( CentOS 6.6+ )

=== Software ===
* Node 4.7.3
* MongoDB
* pm2

= Teamwork =
== Gerando pacote ==
* é preciso instalar o '''git na máquina do desenvolvedor''', [https://git-scm.com/downloads Git - downloads].
* é preciso instalar o '''meteor na máquina do desenvolvedor''', para que possamos fazer o build do projeto ( [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]).
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/custom/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git]
* executa em um cli( terminal ), '''na raiz do projeto''', o comando de build de pacote:
'''''meteor build ./ --server-only'''''
* será gerado um pacote '''custom.tar.gz''' que será colocado no '''servidor'''.

== Configurando layout ==

* É preciso fazer manualmente a alterações em adminstrativo/layout

Segue o parametros e cores:

=== COLORS ===
content Background color : #FFFFFF
Primary Background Color : #0F7043
Primary Font Color : #444444

Primary Action Color : #2F9E68
Secondary Background Color : #F4F4F4
Secondary Font Color : #7F7F7F
Secondary Action Color : #FFFFFF
Component Color : #EAEAEA
Success Color : #35AC19
Pending Color : #FCB316
Error Color : #D30230
Selection Color : #FF0000
theme-color-attention-color : #9C27B0
Secondary Action Color : #FFFFFF
Secondary Action Color : #FFFFFF

=== COLORS(MINOR) ===
Custom Scrollbar Color : #@transparent-darker ou #7F7F7F

= Hubot =
== Gerando pacote ==
* é preciso instalar o node e npm na máquina do desenvolvedor, [https://nodejs.org/en/download/releases/ NodeJS Download previous releases].
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git].
* executar: '''npm i'''
* gerar um zip '''com toda a pasta raiz''' e colocar no servidor.

= Configuração do serviços =
A configuração será feita através do '''pm2''', serviço de monitoramento e gerenciamento de serviços e processos, além de configurar o '''auto-start''' dos serviços de forma automática.

Aqui é preciso que esteja instalado o seguinte itens:'''node, npm, mongodb, pm2'''.

É preciso que os passos sejam executado seguindo os tópicos seguintes.

É fortemente sugerido que os serviços e suas pastas sejam criados na pasta '''opt''' ( para evitar problemas com atualização de sistema ).

'''[[Os passos abaixo precisam ser executados como root!]]'''

== MongoDB ==
É preciso instalar o '''mongodb''' no sistema seguinto as [https://docs.mongodb.com/manual/installation/ instruções para cada sistema].Se seguido corretamento link anterior, o mongo será configurado para iniciar sozinho.

=== Configuração de Daemon ===
É preciso configurar o serviços para que aceite a configuração de '''replSet''' para [[permitir múltiplas instâncias do serviços]], com o proposito de log.

Assim é preciso adicionar no arquivo '''/etc/mongod.config''' as configurações abaixo:

Habilita replicas.
replication:
replSetName: rs0
oplogSizeMB: 128

Habilita máximo de ram que o mongo pode usar para cache.
storage:
wiredTiger:
engineConfig:
cacheSizeGB: 2

Após isso será é preciso executar o '''mongod'''.

Caso tenha sido executa com sucesso, é preciso habilitar internamente as opções de replica com os comandos:
mongo rocketchat --eval "rs.initiate()"
mongo rocketchat --eval "rs.add('localhost:27017')"

ou:
mongo rocketchat --eval "rs.initiate({ _id: 'rs0', members: [ { _id: 0, host: 'localhost:27017' } ]})"

e habilitar modo slave
mongo rocketchat --eval "rs.slaveOk()"

----

Agora vamos configurar o banco para gerar os indexes para agilizar a busca.

É preciso pegar o script '''[https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js]''' na pasta [https://gitlab.mstech.com.br/teamwork/custom/tree/develop/.scripts '''.scripts''' no repositório]( pode estar oculta localmente ).

Para executar faça o seguinte:
* ir na pasta com o script [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js].
* executar verificar se os scripts estão olhando para o banco nomeado '''rocketchat''':
'''mongo localhost:27017/rocketchat mongo-custom-index.js'''

== Teamwork ==
=== Extrair pacote ===
Extrair pacote '''custom.tar.gz''' dentro da pasta '''/opt'''

=== Instalar dependências ===
Vá para a pasta em que o serviço foi colocado, depois acesso a pasta '''programs/server/''', é preciso fazer as instalação das dependências usando:
'''npm i'''

=== Validar pacote ===
Agora é preciso executar o serviço '''pm2 start main.js --name teamwork''', para validar se o serviço esta rodando execute o comando:
'''pm2 m'''

Agora será possível ver os logs do serviço e se está executando corretamente.Após iniciar o serviço é preciso acessar e cadastra um admin.

'''O primeiro login do teamwork sempre será o admin, e daí em diante será possível fazer o resto das configurações.'''

Agora é preciso parar o serviço com :
'''pm2 stop teamwork'''

=== Configurar serviço automatico ===
vamos criar um arquivo '''teamwork.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "8G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

Como é preciso fazer uso de vários núcleos de processamento, e devido a natureza dos serviços em '''nodejs''' se single thread,

é preciso que seja feito um '''json''' contendo '''N-1''' instâncias do serviço, onde '''N''' é o número de cpu.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "2G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
},
{
"name": "teamwork-'''N'''",
"max_memory_restart": "2G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "300'''N'''",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

'''Atenção aos itens [['name' e 'port']], que precisam ser[[ únicos ]]'''

Agora execute comando:
'''pm2 start teamwork.json --watch'''

== Hubot ==
Vá para a pasta em que o serviço foi colocado.

É preciso instalar as dependências globais do hubot, com o seguinte comando:
'''npm i -g coffee-script'''

Será preciso adicionar o caminho correto dentro do arquivo '''bin/hubot''' na linha com '''exec node_modules/..''' para '''exec /opt/''<pasta>''/node_modules/..'''

vamos criar um arquivo '''hubot.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "bot",
"max_memory_restart": "2048M",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/rockbot/bin/hubot",
"out_file": "/var/log/bot/app.log",
"error_file": "/var/log/bot/err.log",
"port": "1337"
}
]
}

Agora execute comando:
'''pm2 start hubot.json --watch'''

== pm2 ==
Essa parte deverá ser executada somente quando todos os serviços estiverem rodando '''corretamente e em paralelo !'''

Agora que os arquivos '''.json''' foram criados e executados podemos memorizar esses processos e suas ordem com o comando:
'''pm2 save'''

Isso irá salver a lista de processos, e agora vamos configurar o sistema para executar isso todas vez que a máquina for iniciada.

'''pm2 startup'''

Após isso reinicie a máquina e execute o comando abaixo para validar se os serviços estão rodando corretamente:
'''pm2 m ou pm2 status'''

----

Caso já exista algum conjunto de serviços configurados é preciso remover antes:
'''pm2 unstartup'''
E depois proceder com os processos anteriores.

= Configurações do sistema =
Caso haja algum problema em que o '''o primeiro login funciona e o restante não''', será preciso habilitar na opções administrativas na parte do LDAP.

O item de '''Mescar usuários já existentes''' para permitir o uso de '''username e email''' para login.

= Múltiplas instâncias =

Após ter configurado como descrito acima ambo os serviços do '''mongodb e teamwork''', usando o '''pm2'''.

É sugerido o seguinte passos para aumentar as instâncias:

* Não deve estar rodando o '''mongod'''.
* pm2 kill, para matar tudo que está rodando.
* pm2 start /opt/teamwork/<json>
* service mongod start
* service httpd restart

= Problemas possíveis =
== Serviços fora do ar ==
* É possível que o servidor apache não tenha renovado os arquivos alterados.

== Erro ao iniciar serviço ==
* É possível que a '''rota das pastas''' estejam erradas.
* É preciso executar o '''main.js''', no '''pm2''' ( atualmente é usando um arquivo de configuração '''pm2.json''' )
* É possível que '''falte dependências [[do hubot]]''' .

= Referências =

* [https://nodejs.org/en/download/releases/ NodeJS Download previous releases]
* [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop Repositório Hubot]
* [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]
* [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/MSTECH.md Documentação de instalação, configuração, pré-requisitos, build e deploy do Teamwork]
* [https://rocket.chat/docs/ Rocket.Chat Docs]
* https://rocket.chat/docs/installation/minimum-requirements Minimum Requirements for Server Deployment]
* [https://docs.mongodb.com/manual/tutorial/write-scripts-for-the-mongo-shell/#execute-a-javascript-file Executando script no mongodb]
* [https://rocket.chat/docs/installation/manual-installation/multiple-instances-to-improve-performance/ Rodando múltiplas instâncias do rocket.chat]
* [https://docs.mongodb.com/manual/reference/configuration-options/ Configurando mongodb no linux]

Implantação Teamwork e Hubot para SEDUC

2017-06-14T13:17:55Z

Alexandre.paravani: /* pm2 */

Nessa página será explicado o processo de implantação do serviço de customização do teamwork e hubot para a SEDUC.

Nas referências estão todos os dados que serão explicados nessa tópico.

= Servidor =
Configuração de hardware e software para execução dos serviços.

== Requisitos mínimos ==
=== Hardware ===
* CPU 1.7 GHz, 6 core, 4GB Ram, 500GB HD
* SO: Ubuntu 14.04 LTS ( CentOS 6.6+ )

=== Software ===
* Node 4.7.3
* MongoDB
* pm2

= Teamwork =
== Gerando pacote ==
* é preciso instalar o '''git na máquina do desenvolvedor''', [https://git-scm.com/downloads Git - downloads].
* é preciso instalar o '''meteor na máquina do desenvolvedor''', para que possamos fazer o build do projeto ( [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]).
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/custom/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git]
* executa em um cli( terminal ), '''na raiz do projeto''', o comando de build de pacote:
'''''meteor build ./ --server-only'''''
* será gerado um pacote '''custom.tar.gz''' que será colocado no '''servidor'''.

== Configurando layout ==

* É preciso fazer manualmente a alterações em adminstrativo/layout

Segue o parametros e cores:

=== COLORS ===
content Background color : #FFFFFF
Primary Background Color : #0F7043
Primary Font Color : #444444

Primary Action Color : #2F9E68
Secondary Background Color : #F4F4F4
Secondary Font Color : #7F7F7F
Secondary Action Color : #FFFFFF
Component Color : #EAEAEA
Success Color : #35AC19
Pending Color : #FCB316
Error Color : #D30230
Selection Color : #FF0000
theme-color-attention-color : #9C27B0
Secondary Action Color : #FFFFFF
Secondary Action Color : #FFFFFF

=== COLORS(MINOR) ===
Custom Scrollbar Color : #@transparent-darker ou #7F7F7F

= Hubot =
== Gerando pacote ==
* é preciso instalar o node e npm na máquina do desenvolvedor, [https://nodejs.org/en/download/releases/ NodeJS Download previous releases].
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git].
* executar: '''npm i'''
* gerar um zip '''com toda a pasta raiz''' e colocar no servidor.

= Configuração do serviços =
A configuração será feita através do '''pm2''', serviço de monitoramento e gerenciamento de serviços e processos, além de configurar o '''auto-start''' dos serviços de forma automática.

Aqui é preciso que esteja instalado o seguinte itens:'''node, npm, mongodb, pm2'''.

É preciso que os passos sejam executado seguindo os tópicos seguintes.

É fortemente sugerido que os serviços e suas pastas sejam criados na pasta '''opt''' ( para evitar problemas com atualização de sistema ).

'''[[Os passos abaixo precisam ser executados como root!]]'''

== MongoDB ==
É preciso instalar o '''mongodb''' no sistema seguinto as [https://docs.mongodb.com/manual/installation/ instruções para cada sistema].Se seguido corretamento link anterior, o mongo será configurado para iniciar sozinho.

=== Configuração de Daemon ===
É preciso configurar o serviços para que aceite a configuração de '''replSet''' para [[permitir múltiplas instâncias do serviços]], com o proposito de log.

Assim é preciso adicionar no arquivo '''/etc/mongod.config''' as configurações abaixo:

Habilita replicas.
replication:
replSetName: rs0
oplogSizeMB: 128

Habilita máximo de ram que o mongo pode usar para cache.
storage:
wiredTiger:
engineConfig:
cacheSizeGB: 2

Após isso será é preciso executar o '''mongod'''.

Caso tenha sido executa com sucesso, é preciso habilitar internamente as opções de replica com os comandos:
mongo rocketchat --eval "rs.initiate()"
mongo rocketchat --eval "rs.add('localhost:27017')"

ou:
mongo rocketchat --eval "rs.initiate({ _id: 'rs0', members: [ { _id: 0, host: 'localhost:27017' } ]})"

e habilitar modo slave
mongo rocketchat --eval "rs.slaveOk()"

----

Agora vamos configurar o banco para gerar os indexes para agilizar a busca.

É preciso pegar o script '''[https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js]''' na pasta [https://gitlab.mstech.com.br/teamwork/custom/tree/develop/.scripts '''.scripts''' no repositório]( pode estar oculta localmente ).

Para executar faça o seguinte:
* ir na pasta com o script [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js].
* executar verificar se os scripts estão olhando para o banco nomeado '''rocketchat''':
'''mongo localhost:27017/rocketchat mongo-custom-index.js'''

== Teamwork ==
=== Extrair pacote ===
Extrair pacote '''custom.tar.gz''' dentro da pasta '''/opt'''

=== Instalar dependências ===
Vá para a pasta em que o serviço foi colocado, depois acesso a pasta '''programs/server/''', é preciso fazer as instalação das dependências usando:
'''npm i'''

=== Validar pacote ===
Agora é preciso executar o serviço '''pm2 start main.js --name teamwork''', para validar se o serviço esta rodando execute o comando:
'''pm2 m'''

Agora será possível ver os logs do serviço e se está executando corretamente.Após iniciar o serviço é preciso acessar e cadastra um admin.

'''O primeiro login do teamwork sempre será o admin, e daí em diante será possível fazer o resto das configurações.'''

Agora é preciso parar o serviço com :
'''pm2 stop teamwork'''

=== Configurar serviço automatico ===
vamos criar um arquivo '''teamwork.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "8G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

Como é preciso fazer uso de vários núcleos de processamento, e devido a natureza dos serviços em '''nodejs''' se single thread,

é preciso que seja feito um '''json''' contendo '''N-1''' instâncias do serviço, onde '''N''' é o número de cpu.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "2G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
},
{
"name": "teamwork-'''N'''",
"max_memory_restart": "2G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "300'''N'''",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

'''Atenção aos itens [['name' e 'port']], que precisam ser[[ únicos ]]'''

Agora execute comando:
'''pm2 start teamwork.json --watch'''

== Hubot ==
Vá para a pasta em que o serviço foi colocado.

É preciso instalar as dependências globais do hubot, com o seguinte comando:
'''npm i -g coffee-script'''

Será preciso adicionar o caminho correto dentro do arquivo '''bin/hubot''' na linha com '''exec node_modules/..''' para '''exec /opt/''<pasta>''/node_modules/..'''

vamos criar um arquivo '''hubot.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "bot",
"max_memory_restart": "2048M",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/rockbot/bin/hubot",
"out_file": "/var/log/bot/app.log",
"error_file": "/var/log/bot/err.log",
"port": "1337"
}
]
}

Agora execute comando:
'''pm2 start hubot.json --watch'''

== pm2 ==
Essa parte deverá ser executada somente quando todos os serviços estiverem rodando '''corretamente e em paralelo !'''

Agora que os arquivos '''.json''' foram criados e executados podemos memorizar esses processos e suas ordem com o comando:
'''pm2 save'''

Isso irá salver a lista de processos, e agora vamos configurar o sistema para executar isso todas vez que a máquina for iniciada.

'''pm2 startup'''

Após isso reinicie a máquina e execute o comando abaixo para validar se os serviços estão rodando corretamente:
'''pm2 m ou pm2 status'''

----

Caso já exista algum conjunto de serviços configurados é preciso remover antes:
'''pm2 unstartup'''
E depois proceder com os processos anteriores.

= Configurações do sistema =
Caso haja algum problema em que o '''o primeiro login funciona e o restante não''', será preciso habilitar na opções administrativas na parte do LDAP.

O item de '''Mescar usuários já existentes''' para permitir o uso de '''username e email''' para login.

= Problemas possíveis =
== Serviços fora do ar ==
* É possível que o servidor apache não tenha renovado os arquivos alterados.

== Erro ao iniciar serviço ==
* É possível que a '''rota das pastas''' estejam erradas.
* É preciso executar o '''main.js''', no '''pm2''' ( atualmente é usando um arquivo de configuração '''pm2.json''' )
* É possível que '''falte dependências [[do hubot]]''' .

= Referências =

* [https://nodejs.org/en/download/releases/ NodeJS Download previous releases]
* [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop Repositório Hubot]
* [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]
* [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/MSTECH.md Documentação de instalação, configuração, pré-requisitos, build e deploy do Teamwork]
* [https://rocket.chat/docs/ Rocket.Chat Docs]
* https://rocket.chat/docs/installation/minimum-requirements Minimum Requirements for Server Deployment]
* [https://docs.mongodb.com/manual/tutorial/write-scripts-for-the-mongo-shell/#execute-a-javascript-file Executando script no mongodb]
* [https://rocket.chat/docs/installation/manual-installation/multiple-instances-to-improve-performance/ Rodando múltiplas instâncias do rocket.chat]
* [https://docs.mongodb.com/manual/reference/configuration-options/ Configurando mongodb no linux]

Implantação Teamwork e Hubot para SEDUC

2017-06-14T13:16:04Z

Alexandre.paravani: /* Referências */

Nessa página será explicado o processo de implantação do serviço de customização do teamwork e hubot para a SEDUC.

Nas referências estão todos os dados que serão explicados nessa tópico.

= Servidor =
Configuração de hardware e software para execução dos serviços.

== Requisitos mínimos ==
=== Hardware ===
* CPU 1.7 GHz, 6 core, 4GB Ram, 500GB HD
* SO: Ubuntu 14.04 LTS ( CentOS 6.6+ )

=== Software ===
* Node 4.7.3
* MongoDB
* pm2

= Teamwork =
== Gerando pacote ==
* é preciso instalar o '''git na máquina do desenvolvedor''', [https://git-scm.com/downloads Git - downloads].
* é preciso instalar o '''meteor na máquina do desenvolvedor''', para que possamos fazer o build do projeto ( [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]).
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/custom/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git]
* executa em um cli( terminal ), '''na raiz do projeto''', o comando de build de pacote:
'''''meteor build ./ --server-only'''''
* será gerado um pacote '''custom.tar.gz''' que será colocado no '''servidor'''.

== Configurando layout ==

* É preciso fazer manualmente a alterações em adminstrativo/layout

Segue o parametros e cores:

=== COLORS ===
content Background color : #FFFFFF
Primary Background Color : #0F7043
Primary Font Color : #444444

Primary Action Color : #2F9E68
Secondary Background Color : #F4F4F4
Secondary Font Color : #7F7F7F
Secondary Action Color : #FFFFFF
Component Color : #EAEAEA
Success Color : #35AC19
Pending Color : #FCB316
Error Color : #D30230
Selection Color : #FF0000
theme-color-attention-color : #9C27B0
Secondary Action Color : #FFFFFF
Secondary Action Color : #FFFFFF

=== COLORS(MINOR) ===
Custom Scrollbar Color : #@transparent-darker ou #7F7F7F

= Hubot =
== Gerando pacote ==
* é preciso instalar o node e npm na máquina do desenvolvedor, [https://nodejs.org/en/download/releases/ NodeJS Download previous releases].
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git].
* executar: '''npm i'''
* gerar um zip '''com toda a pasta raiz''' e colocar no servidor.

= Configuração do serviços =
A configuração será feita através do '''pm2''', serviço de monitoramento e gerenciamento de serviços e processos, além de configurar o '''auto-start''' dos serviços de forma automática.

Aqui é preciso que esteja instalado o seguinte itens:'''node, npm, mongodb, pm2'''.

É preciso que os passos sejam executado seguindo os tópicos seguintes.

É fortemente sugerido que os serviços e suas pastas sejam criados na pasta '''opt''' ( para evitar problemas com atualização de sistema ).

'''[[Os passos abaixo precisam ser executados como root!]]'''

== MongoDB ==
É preciso instalar o '''mongodb''' no sistema seguinto as [https://docs.mongodb.com/manual/installation/ instruções para cada sistema].Se seguido corretamento link anterior, o mongo será configurado para iniciar sozinho.

=== Configuração de Daemon ===
É preciso configurar o serviços para que aceite a configuração de '''replSet''' para [[permitir múltiplas instâncias do serviços]], com o proposito de log.

Assim é preciso adicionar no arquivo '''/etc/mongod.config''' as configurações abaixo:

Habilita replicas.
replication:
replSetName: rs0
oplogSizeMB: 128

Habilita máximo de ram que o mongo pode usar para cache.
storage:
wiredTiger:
engineConfig:
cacheSizeGB: 2

Após isso será é preciso executar o '''mongod'''.

Caso tenha sido executa com sucesso, é preciso habilitar internamente as opções de replica com os comandos:
mongo rocketchat --eval "rs.initiate()"
mongo rocketchat --eval "rs.add('localhost:27017')"

ou:
mongo rocketchat --eval "rs.initiate({ _id: 'rs0', members: [ { _id: 0, host: 'localhost:27017' } ]})"

e habilitar modo slave
mongo rocketchat --eval "rs.slaveOk()"

----

Agora vamos configurar o banco para gerar os indexes para agilizar a busca.

É preciso pegar o script '''[https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js]''' na pasta [https://gitlab.mstech.com.br/teamwork/custom/tree/develop/.scripts '''.scripts''' no repositório]( pode estar oculta localmente ).

Para executar faça o seguinte:
* ir na pasta com o script [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js].
* executar verificar se os scripts estão olhando para o banco nomeado '''rocketchat''':
'''mongo localhost:27017/rocketchat mongo-custom-index.js'''

== Teamwork ==
=== Extrair pacote ===
Extrair pacote '''custom.tar.gz''' dentro da pasta '''/opt'''

=== Instalar dependências ===
Vá para a pasta em que o serviço foi colocado, depois acesso a pasta '''programs/server/''', é preciso fazer as instalação das dependências usando:
'''npm i'''

=== Validar pacote ===
Agora é preciso executar o serviço '''pm2 start main.js --name teamwork''', para validar se o serviço esta rodando execute o comando:
'''pm2 m'''

Agora será possível ver os logs do serviço e se está executando corretamente.Após iniciar o serviço é preciso acessar e cadastra um admin.

'''O primeiro login do teamwork sempre será o admin, e daí em diante será possível fazer o resto das configurações.'''

Agora é preciso parar o serviço com :
'''pm2 stop teamwork'''

=== Configurar serviço automatico ===
vamos criar um arquivo '''teamwork.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "8G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

Como é preciso fazer uso de vários núcleos de processamento, e devido a natureza dos serviços em '''nodejs''' se single thread,

é preciso que seja feito um '''json''' contendo '''N-1''' instâncias do serviço, onde '''N''' é o número de cpu.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "2G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
},
{
"name": "teamwork-'''N'''",
"max_memory_restart": "2G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "300'''N'''",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

'''Atenção aos itens [['name' e 'port']], que precisam ser[[ únicos ]]'''

Agora execute comando:
'''pm2 start teamwork.json --watch'''

== Hubot ==
Vá para a pasta em que o serviço foi colocado.

É preciso instalar as dependências globais do hubot, com o seguinte comando:
'''npm i -g coffee-script'''

Será preciso adicionar o caminho correto dentro do arquivo '''bin/hubot''' na linha com '''exec node_modules/..''' para '''exec /opt/''<pasta>''/node_modules/..'''

vamos criar um arquivo '''hubot.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "bot",
"max_memory_restart": "2048M",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/rockbot/bin/hubot",
"out_file": "/var/log/bot/app.log",
"error_file": "/var/log/bot/err.log",
"port": "1337"
}
]
}

Agora execute comando:
'''pm2 start hubot.json --watch'''

== pm2 ==
Essa parte deverá ser executada somente quando todos os serviços estiverem rodando '''corretamente e em paralelo !'''

Agora que os arquivos '''.json''' foram criados e executados podemos memorizar esses processos e suas ordem com o comando:
'''pm2 save'''

Isso irá salver a lista de processos, e agora vamos configurar o sistema para executar isso todas vez que a máquina for iniciada.

'''pm2 startup'''

Após isso reinicie a máquina e execute o comando abaixo para validar se os serviços estão rodando corretamente:
'''pm2 m ou pm2 status'''

= Configurações do sistema =
Caso haja algum problema em que o '''o primeiro login funciona e o restante não''', será preciso habilitar na opções administrativas na parte do LDAP.

O item de '''Mescar usuários já existentes''' para permitir o uso de '''username e email''' para login.

= Problemas possíveis =
== Serviços fora do ar ==
* É possível que o servidor apache não tenha renovado os arquivos alterados.

== Erro ao iniciar serviço ==
* É possível que a '''rota das pastas''' estejam erradas.
* É preciso executar o '''main.js''', no '''pm2''' ( atualmente é usando um arquivo de configuração '''pm2.json''' )
* É possível que '''falte dependências [[do hubot]]''' .

= Referências =

* [https://nodejs.org/en/download/releases/ NodeJS Download previous releases]
* [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop Repositório Hubot]
* [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]
* [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/MSTECH.md Documentação de instalação, configuração, pré-requisitos, build e deploy do Teamwork]
* [https://rocket.chat/docs/ Rocket.Chat Docs]
* https://rocket.chat/docs/installation/minimum-requirements Minimum Requirements for Server Deployment]
* [https://docs.mongodb.com/manual/tutorial/write-scripts-for-the-mongo-shell/#execute-a-javascript-file Executando script no mongodb]
* [https://rocket.chat/docs/installation/manual-installation/multiple-instances-to-improve-performance/ Rodando múltiplas instâncias do rocket.chat]
* [https://docs.mongodb.com/manual/reference/configuration-options/ Configurando mongodb no linux]

Implantação Teamwork e Hubot para SEDUC

2017-06-14T13:14:39Z

Alexandre.paravani: /* MongoDB */

Nessa página será explicado o processo de implantação do serviço de customização do teamwork e hubot para a SEDUC.

Nas referências estão todos os dados que serão explicados nessa tópico.

= Servidor =
Configuração de hardware e software para execução dos serviços.

== Requisitos mínimos ==
=== Hardware ===
* CPU 1.7 GHz, 6 core, 4GB Ram, 500GB HD
* SO: Ubuntu 14.04 LTS ( CentOS 6.6+ )

=== Software ===
* Node 4.7.3
* MongoDB
* pm2

= Teamwork =
== Gerando pacote ==
* é preciso instalar o '''git na máquina do desenvolvedor''', [https://git-scm.com/downloads Git - downloads].
* é preciso instalar o '''meteor na máquina do desenvolvedor''', para que possamos fazer o build do projeto ( [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]).
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/custom/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git]
* executa em um cli( terminal ), '''na raiz do projeto''', o comando de build de pacote:
'''''meteor build ./ --server-only'''''
* será gerado um pacote '''custom.tar.gz''' que será colocado no '''servidor'''.

== Configurando layout ==

* É preciso fazer manualmente a alterações em adminstrativo/layout

Segue o parametros e cores:

=== COLORS ===
content Background color : #FFFFFF
Primary Background Color : #0F7043
Primary Font Color : #444444

Primary Action Color : #2F9E68
Secondary Background Color : #F4F4F4
Secondary Font Color : #7F7F7F
Secondary Action Color : #FFFFFF
Component Color : #EAEAEA
Success Color : #35AC19
Pending Color : #FCB316
Error Color : #D30230
Selection Color : #FF0000
theme-color-attention-color : #9C27B0
Secondary Action Color : #FFFFFF
Secondary Action Color : #FFFFFF

=== COLORS(MINOR) ===
Custom Scrollbar Color : #@transparent-darker ou #7F7F7F

= Hubot =
== Gerando pacote ==
* é preciso instalar o node e npm na máquina do desenvolvedor, [https://nodejs.org/en/download/releases/ NodeJS Download previous releases].
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git].
* executar: '''npm i'''
* gerar um zip '''com toda a pasta raiz''' e colocar no servidor.

= Configuração do serviços =
A configuração será feita através do '''pm2''', serviço de monitoramento e gerenciamento de serviços e processos, além de configurar o '''auto-start''' dos serviços de forma automática.

Aqui é preciso que esteja instalado o seguinte itens:'''node, npm, mongodb, pm2'''.

É preciso que os passos sejam executado seguindo os tópicos seguintes.

É fortemente sugerido que os serviços e suas pastas sejam criados na pasta '''opt''' ( para evitar problemas com atualização de sistema ).

'''[[Os passos abaixo precisam ser executados como root!]]'''

== MongoDB ==
É preciso instalar o '''mongodb''' no sistema seguinto as [https://docs.mongodb.com/manual/installation/ instruções para cada sistema].Se seguido corretamento link anterior, o mongo será configurado para iniciar sozinho.

=== Configuração de Daemon ===
É preciso configurar o serviços para que aceite a configuração de '''replSet''' para [[permitir múltiplas instâncias do serviços]], com o proposito de log.

Assim é preciso adicionar no arquivo '''/etc/mongod.config''' as configurações abaixo:

Habilita replicas.
replication:
replSetName: rs0
oplogSizeMB: 128

Habilita máximo de ram que o mongo pode usar para cache.
storage:
wiredTiger:
engineConfig:
cacheSizeGB: 2

Após isso será é preciso executar o '''mongod'''.

Caso tenha sido executa com sucesso, é preciso habilitar internamente as opções de replica com os comandos:
mongo rocketchat --eval "rs.initiate()"
mongo rocketchat --eval "rs.add('localhost:27017')"

ou:
mongo rocketchat --eval "rs.initiate({ _id: 'rs0', members: [ { _id: 0, host: 'localhost:27017' } ]})"

e habilitar modo slave
mongo rocketchat --eval "rs.slaveOk()"

----

Agora vamos configurar o banco para gerar os indexes para agilizar a busca.

É preciso pegar o script '''[https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js]''' na pasta [https://gitlab.mstech.com.br/teamwork/custom/tree/develop/.scripts '''.scripts''' no repositório]( pode estar oculta localmente ).

Para executar faça o seguinte:
* ir na pasta com o script [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js].
* executar verificar se os scripts estão olhando para o banco nomeado '''rocketchat''':
'''mongo localhost:27017/rocketchat mongo-custom-index.js'''

== Teamwork ==
=== Extrair pacote ===
Extrair pacote '''custom.tar.gz''' dentro da pasta '''/opt'''

=== Instalar dependências ===
Vá para a pasta em que o serviço foi colocado, depois acesso a pasta '''programs/server/''', é preciso fazer as instalação das dependências usando:
'''npm i'''

=== Validar pacote ===
Agora é preciso executar o serviço '''pm2 start main.js --name teamwork''', para validar se o serviço esta rodando execute o comando:
'''pm2 m'''

Agora será possível ver os logs do serviço e se está executando corretamente.Após iniciar o serviço é preciso acessar e cadastra um admin.

'''O primeiro login do teamwork sempre será o admin, e daí em diante será possível fazer o resto das configurações.'''

Agora é preciso parar o serviço com :
'''pm2 stop teamwork'''

=== Configurar serviço automatico ===
vamos criar um arquivo '''teamwork.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "8G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

Como é preciso fazer uso de vários núcleos de processamento, e devido a natureza dos serviços em '''nodejs''' se single thread,

é preciso que seja feito um '''json''' contendo '''N-1''' instâncias do serviço, onde '''N''' é o número de cpu.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "2G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
},
{
"name": "teamwork-'''N'''",
"max_memory_restart": "2G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "300'''N'''",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

'''Atenção aos itens [['name' e 'port']], que precisam ser[[ únicos ]]'''

Agora execute comando:
'''pm2 start teamwork.json --watch'''

== Hubot ==
Vá para a pasta em que o serviço foi colocado.

É preciso instalar as dependências globais do hubot, com o seguinte comando:
'''npm i -g coffee-script'''

Será preciso adicionar o caminho correto dentro do arquivo '''bin/hubot''' na linha com '''exec node_modules/..''' para '''exec /opt/''<pasta>''/node_modules/..'''

vamos criar um arquivo '''hubot.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "bot",
"max_memory_restart": "2048M",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/rockbot/bin/hubot",
"out_file": "/var/log/bot/app.log",
"error_file": "/var/log/bot/err.log",
"port": "1337"
}
]
}

Agora execute comando:
'''pm2 start hubot.json --watch'''

== pm2 ==
Essa parte deverá ser executada somente quando todos os serviços estiverem rodando '''corretamente e em paralelo !'''

Agora que os arquivos '''.json''' foram criados e executados podemos memorizar esses processos e suas ordem com o comando:
'''pm2 save'''

Isso irá salver a lista de processos, e agora vamos configurar o sistema para executar isso todas vez que a máquina for iniciada.

'''pm2 startup'''

Após isso reinicie a máquina e execute o comando abaixo para validar se os serviços estão rodando corretamente:
'''pm2 m ou pm2 status'''

= Configurações do sistema =
Caso haja algum problema em que o '''o primeiro login funciona e o restante não''', será preciso habilitar na opções administrativas na parte do LDAP.

O item de '''Mescar usuários já existentes''' para permitir o uso de '''username e email''' para login.

= Problemas possíveis =
== Serviços fora do ar ==
* É possível que o servidor apache não tenha renovado os arquivos alterados.

== Erro ao iniciar serviço ==
* É possível que a '''rota das pastas''' estejam erradas.
* É preciso executar o '''main.js''', no '''pm2''' ( atualmente é usando um arquivo de configuração '''pm2.json''' )
* É possível que '''falte dependências [[do hubot]]''' .

= Referências =

* [https://nodejs.org/en/download/releases/ NodeJS Download previous releases]
* [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop Repositório Hubot]
* [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]
* [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/MSTECH.md Documentação de instalação, configuração, pré-requisitos, build e deploy do Teamwork]
* [https://rocket.chat/docs/ Rocket.Chat Docs]
* https://rocket.chat/docs/installation/minimum-requirements Minimum Requirements for Server Deployment]
* [https://docs.mongodb.com/manual/tutorial/write-scripts-for-the-mongo-shell/#execute-a-javascript-file Executando script no mongodb]

Implantação Teamwork e Hubot para SEDUC

2017-06-14T12:52:13Z

Alexandre.paravani: /* Configurar serviço automatico */

Nessa página será explicado o processo de implantação do serviço de customização do teamwork e hubot para a SEDUC.

Nas referências estão todos os dados que serão explicados nessa tópico.

= Servidor =
Configuração de hardware e software para execução dos serviços.

== Requisitos mínimos ==
=== Hardware ===
* CPU 1.7 GHz, 6 core, 4GB Ram, 500GB HD
* SO: Ubuntu 14.04 LTS ( CentOS 6.6+ )

=== Software ===
* Node 4.7.3
* MongoDB
* pm2

= Teamwork =
== Gerando pacote ==
* é preciso instalar o '''git na máquina do desenvolvedor''', [https://git-scm.com/downloads Git - downloads].
* é preciso instalar o '''meteor na máquina do desenvolvedor''', para que possamos fazer o build do projeto ( [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]).
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/custom/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git]
* executa em um cli( terminal ), '''na raiz do projeto''', o comando de build de pacote:
'''''meteor build ./ --server-only'''''
* será gerado um pacote '''custom.tar.gz''' que será colocado no '''servidor'''.

== Configurando layout ==

* É preciso fazer manualmente a alterações em adminstrativo/layout

Segue o parametros e cores:

=== COLORS ===
content Background color : #FFFFFF
Primary Background Color : #0F7043
Primary Font Color : #444444

Primary Action Color : #2F9E68
Secondary Background Color : #F4F4F4
Secondary Font Color : #7F7F7F
Secondary Action Color : #FFFFFF
Component Color : #EAEAEA
Success Color : #35AC19
Pending Color : #FCB316
Error Color : #D30230
Selection Color : #FF0000
theme-color-attention-color : #9C27B0
Secondary Action Color : #FFFFFF
Secondary Action Color : #FFFFFF

=== COLORS(MINOR) ===
Custom Scrollbar Color : #@transparent-darker ou #7F7F7F

= Hubot =
== Gerando pacote ==
* é preciso instalar o node e npm na máquina do desenvolvedor, [https://nodejs.org/en/download/releases/ NodeJS Download previous releases].
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git].
* executar: '''npm i'''
* gerar um zip '''com toda a pasta raiz''' e colocar no servidor.

= Configuração do serviços =
A configuração será feita através do '''pm2''', serviço de monitoramento e gerenciamento de serviços e processos, além de configurar o '''auto-start''' dos serviços de forma automática.

Aqui é preciso que esteja instalado o seguinte itens:'''node, npm, mongodb, pm2'''.

É preciso que os passos sejam executado seguindo os tópicos seguintes.

É fortemente sugerido que os serviços e suas pastas sejam criados na pasta '''opt''' ( para evitar problemas com atualização de sistema ).

'''[[Os passos abaixo precisam ser executados como root!]]'''

== MongoDB ==
É preciso instalar o '''mongodb''' no sistema seguinto as [https://docs.mongodb.com/manual/installation/ instruções para cada sistema].Se seguido corretamento link anterior, o mongo será configurado para iniciar sozinho.

Agora vamos configurar o banco para gerar os indexes para agilizar a busca.

É preciso pegar o script '''[https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js]''' na pasta [https://gitlab.mstech.com.br/teamwork/custom/tree/develop/.scripts '''.scripts''' no repositório]( pode estar oculta localmente ).

Para executar faça o seguinte:
* ir na pasta com o script [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js].
* executar verificar se os scripts estão olhando para o banco nomeado '''rocketchat''':
'''mongo localhost:27017/rocketchat mongo-custom-index.js'''

== Teamwork ==
=== Extrair pacote ===
Extrair pacote '''custom.tar.gz''' dentro da pasta '''/opt'''

=== Instalar dependências ===
Vá para a pasta em que o serviço foi colocado, depois acesso a pasta '''programs/server/''', é preciso fazer as instalação das dependências usando:
'''npm i'''

=== Validar pacote ===
Agora é preciso executar o serviço '''pm2 start main.js --name teamwork''', para validar se o serviço esta rodando execute o comando:
'''pm2 m'''

Agora será possível ver os logs do serviço e se está executando corretamente.Após iniciar o serviço é preciso acessar e cadastra um admin.

'''O primeiro login do teamwork sempre será o admin, e daí em diante será possível fazer o resto das configurações.'''

Agora é preciso parar o serviço com :
'''pm2 stop teamwork'''

=== Configurar serviço automatico ===
vamos criar um arquivo '''teamwork.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "8G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

Como é preciso fazer uso de vários núcleos de processamento, e devido a natureza dos serviços em '''nodejs''' se single thread,

é preciso que seja feito um '''json''' contendo '''N-1''' instâncias do serviço, onde '''N''' é o número de cpu.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "2G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
},
{
"name": "teamwork-'''N'''",
"max_memory_restart": "2G",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "300'''N'''",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

'''Atenção aos itens [['name' e 'port']], que precisam ser[[ únicos ]]'''

Agora execute comando:
'''pm2 start teamwork.json --watch'''

== Hubot ==
Vá para a pasta em que o serviço foi colocado.

É preciso instalar as dependências globais do hubot, com o seguinte comando:
'''npm i -g coffee-script'''

Será preciso adicionar o caminho correto dentro do arquivo '''bin/hubot''' na linha com '''exec node_modules/..''' para '''exec /opt/''<pasta>''/node_modules/..'''

vamos criar um arquivo '''hubot.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "bot",
"max_memory_restart": "2048M",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/rockbot/bin/hubot",
"out_file": "/var/log/bot/app.log",
"error_file": "/var/log/bot/err.log",
"port": "1337"
}
]
}

Agora execute comando:
'''pm2 start hubot.json --watch'''

== pm2 ==
Essa parte deverá ser executada somente quando todos os serviços estiverem rodando '''corretamente e em paralelo !'''

Agora que os arquivos '''.json''' foram criados e executados podemos memorizar esses processos e suas ordem com o comando:
'''pm2 save'''

Isso irá salver a lista de processos, e agora vamos configurar o sistema para executar isso todas vez que a máquina for iniciada.

'''pm2 startup'''

Após isso reinicie a máquina e execute o comando abaixo para validar se os serviços estão rodando corretamente:
'''pm2 m ou pm2 status'''

= Configurações do sistema =
Caso haja algum problema em que o '''o primeiro login funciona e o restante não''', será preciso habilitar na opções administrativas na parte do LDAP.

O item de '''Mescar usuários já existentes''' para permitir o uso de '''username e email''' para login.

= Problemas possíveis =
== Serviços fora do ar ==
* É possível que o servidor apache não tenha renovado os arquivos alterados.

== Erro ao iniciar serviço ==
* É possível que a '''rota das pastas''' estejam erradas.
* É preciso executar o '''main.js''', no '''pm2''' ( atualmente é usando um arquivo de configuração '''pm2.json''' )
* É possível que '''falte dependências [[do hubot]]''' .

= Referências =

* [https://nodejs.org/en/download/releases/ NodeJS Download previous releases]
* [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop Repositório Hubot]
* [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]
* [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/MSTECH.md Documentação de instalação, configuração, pré-requisitos, build e deploy do Teamwork]
* [https://rocket.chat/docs/ Rocket.Chat Docs]
* https://rocket.chat/docs/installation/minimum-requirements Minimum Requirements for Server Deployment]
* [https://docs.mongodb.com/manual/tutorial/write-scripts-for-the-mongo-shell/#execute-a-javascript-file Executando script no mongodb]

Implantação Teamwork e Hubot para SEDUC

2017-06-01T14:28:53Z

Alexandre.paravani:

Nessa página será explicado o processo de implantação do serviço de customização do teamwork e hubot para a SEDUC.

Nas referências estão todos os dados que serão explicados nessa tópico.

= Servidor =
Configuração de hardware e software para execução dos serviços.

== Requisitos mínimos ==
=== Hardware ===
* CPU 1.7 GHz, 6 core, 4GB Ram, 500GB HD
* SO: Ubuntu 14.04 LTS ( CentOS 6.6+ )

=== Software ===
* Node 4.7.3
* MongoDB
* pm2

= Teamwork =
== Gerando pacote ==
* é preciso instalar o '''git na máquina do desenvolvedor''', [https://git-scm.com/downloads Git - downloads].
* é preciso instalar o '''meteor na máquina do desenvolvedor''', para que possamos fazer o build do projeto ( [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]).
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/custom/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git]
* executa em um cli( terminal ), '''na raiz do projeto''', o comando de build de pacote:
'''''meteor build ./ --server-only'''''
* será gerado um pacote '''custom.tar.gz''' que será colocado no '''servidor'''.

== Configurando layout ==

* É preciso fazer manualmente a alterações em adminstrativo/layout

Segue o parametros e cores:

=== COLORS ===
content Background color : #FFFFFF
Primary Background Color : #0F7043
Primary Font Color : #444444

Primary Action Color : #2F9E68
Secondary Background Color : #F4F4F4
Secondary Font Color : #7F7F7F
Secondary Action Color : #FFFFFF
Component Color : #EAEAEA
Success Color : #35AC19
Pending Color : #FCB316
Error Color : #D30230
Selection Color : #FF0000
theme-color-attention-color : #9C27B0
Secondary Action Color : #FFFFFF
Secondary Action Color : #FFFFFF

=== COLORS(MINOR) ===
Custom Scrollbar Color : #@transparent-darker ou #7F7F7F

= Hubot =
== Gerando pacote ==
* é preciso instalar o node e npm na máquina do desenvolvedor, [https://nodejs.org/en/download/releases/ NodeJS Download previous releases].
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git].
* executar: '''npm i'''
* gerar um zip '''com toda a pasta raiz''' e colocar no servidor.

= Configuração do serviços =
A configuração será feita através do '''pm2''', serviço de monitoramento e gerenciamento de serviços e processos, além de configurar o '''auto-start''' dos serviços de forma automática.

Aqui é preciso que esteja instalado o seguinte itens:'''node, npm, mongodb, pm2'''.

É preciso que os passos sejam executado seguindo os tópicos seguintes.

É fortemente sugerido que os serviços e suas pastas sejam criados na pasta '''opt''' ( para evitar problemas com atualização de sistema ).

'''[[Os passos abaixo precisam ser executados como root!]]'''

== MongoDB ==
É preciso instalar o '''mongodb''' no sistema seguinto as [https://docs.mongodb.com/manual/installation/ instruções para cada sistema].Se seguido corretamento link anterior, o mongo será configurado para iniciar sozinho.

Agora vamos configurar o banco para gerar os indexes para agilizar a busca.

É preciso pegar o script '''[https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js]''' na pasta [https://gitlab.mstech.com.br/teamwork/custom/tree/develop/.scripts '''.scripts''' no repositório]( pode estar oculta localmente ).

Para executar faça o seguinte:
* ir na pasta com o script [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js].
* executar verificar se os scripts estão olhando para o banco nomeado '''rocketchat''':
'''mongo localhost:27017/rocketchat mongo-custom-index.js'''

== Teamwork ==
=== Extrair pacote ===
Extrair pacote '''custom.tar.gz''' dentro da pasta '''/opt'''

=== Instalar dependências ===
Vá para a pasta em que o serviço foi colocado, depois acesso a pasta '''programs/server/''', é preciso fazer as instalação das dependências usando:
'''npm i'''

=== Validar pacote ===
Agora é preciso executar o serviço '''pm2 start main.js --name teamwork''', para validar se o serviço esta rodando execute o comando:
'''pm2 m'''

Agora será possível ver os logs do serviço e se está executando corretamente.Após iniciar o serviço é preciso acessar e cadastra um admin.

'''O primeiro login do teamwork sempre será o admin, e daí em diante será possível fazer o resto das configurações.'''

Agora é preciso parar o serviço com :
'''pm2 stop teamwork'''

=== Configurar serviço automatico ===
vamos criar um arquivo '''teamwork.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "8192M",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

Agora execute comando:
'''pm2 start teamwork.json --watch'''

== Hubot ==
Vá para a pasta em que o serviço foi colocado.

É preciso instalar as dependências globais do hubot, com o seguinte comando:
'''npm i -g coffee-script'''

Será preciso adicionar o caminho correto dentro do arquivo '''bin/hubot''' na linha com '''exec node_modules/..''' para '''exec /opt/''<pasta>''/node_modules/..'''

vamos criar um arquivo '''hubot.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "bot",
"max_memory_restart": "2048M",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/rockbot/bin/hubot",
"out_file": "/var/log/bot/app.log",
"error_file": "/var/log/bot/err.log",
"port": "1337"
}
]
}

Agora execute comando:
'''pm2 start hubot.json --watch'''

== pm2 ==
Essa parte deverá ser executada somente quando todos os serviços estiverem rodando '''corretamente e em paralelo !'''

Agora que os arquivos '''.json''' foram criados e executados podemos memorizar esses processos e suas ordem com o comando:
'''pm2 save'''

Isso irá salver a lista de processos, e agora vamos configurar o sistema para executar isso todas vez que a máquina for iniciada.

'''pm2 startup'''

Após isso reinicie a máquina e execute o comando abaixo para validar se os serviços estão rodando corretamente:
'''pm2 m ou pm2 status'''

= Configurações do sistema =
Caso haja algum problema em que o '''o primeiro login funciona e o restante não''', será preciso habilitar na opções administrativas na parte do LDAP.

O item de '''Mescar usuários já existentes''' para permitir o uso de '''username e email''' para login.

= Problemas possíveis =
== Serviços fora do ar ==
* É possível que o servidor apache não tenha renovado os arquivos alterados.

== Erro ao iniciar serviço ==
* É possível que a '''rota das pastas''' estejam erradas.
* É preciso executar o '''main.js''', no '''pm2''' ( atualmente é usando um arquivo de configuração '''pm2.json''' )
* É possível que '''falte dependências [[do hubot]]''' .

= Referências =

* [https://nodejs.org/en/download/releases/ NodeJS Download previous releases]
* [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop Repositório Hubot]
* [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]
* [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/MSTECH.md Documentação de instalação, configuração, pré-requisitos, build e deploy do Teamwork]
* [https://rocket.chat/docs/ Rocket.Chat Docs]
* https://rocket.chat/docs/installation/minimum-requirements Minimum Requirements for Server Deployment]
* [https://docs.mongodb.com/manual/tutorial/write-scripts-for-the-mongo-shell/#execute-a-javascript-file Executando script no mongodb]

Implantação Teamwork e Hubot para SEDUC

2017-05-29T20:25:30Z

Alexandre.paravani: /* Configurar serviço automatico */

Nessa página será explicado o processo de implantação do serviço de customização do teamwork e hubot para a SEDUC.

Nas referências estão todos os dados que serão explicados nessa tópico.

= Servidor =
Configuração de hardware e software para execução dos serviços.

== Requisitos mínimos ==
=== Hardware ===
* CPU 1.7 GHz, 6 core, 4GB Ram, 500GB HD
* SO: Ubuntu 14.04 LTS ( CentOS 6.6+ )

=== Software ===
* Node 4.7.3
* MongoDB
* pm2

= Teamwork =
== Gerando pacote ==
* é preciso instalar o '''git na máquina do desenvolvedor''', [https://git-scm.com/downloads Git - downloads].
* é preciso instalar o '''meteor na máquina do desenvolvedor''', para que possamos fazer o build do projeto ( [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]).
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/custom/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git]
* executa em um cli( terminal ), '''na raiz do projeto''', o comando de build de pacote:
'''''meteor build ./ --server-only'''''
* será gerado um pacote '''custom.tar.gz''' que será colocado no '''servidor'''.

== Configurando layout ==

* É preciso fazer manualmente a alterações em adminstrativo/layout

Segue o parametros e cores:

=== COLORS ===
content Background color : #FFFFFF
Primary Background Color : #0F7043
Primary Font Color : #444444

Primary Action Color : #2F9E68
Secondary Background Color : #F4F4F4
Secondary Font Color : #7F7F7F
Secondary Action Color : #FFFFFF
Component Color : #EAEAEA
Success Color : #35AC19
Pending Color : #FCB316
Error Color : #D30230
Selection Color : #FF0000
theme-color-attention-color : #9C27B0
Secondary Action Color : #FFFFFF
Secondary Action Color : #FFFFFF

=== COLORS(MINOR) ===
Custom Scrollbar Color : #@transparent-darker ou #7F7F7F

= Hubot =
== Gerando pacote ==
* é preciso instalar o node e npm na máquina do desenvolvedor, [https://nodejs.org/en/download/releases/ NodeJS Download previous releases].
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git].
* executar: '''npm i'''
* gerar um zip '''com toda a pasta raiz''' e colocar no servidor.

= Configuração do serviços =
A configuração será feita através do '''pm2''', serviço de monitoramento e gerenciamento de serviços e processos, além de configurar o '''auto-start''' dos serviços de forma automática.

Aqui é preciso que esteja instalado o seguinte itens:'''node, npm, mongodb, pm2'''.

É preciso que os passos sejam executado seguindo os tópicos seguintes.

É fortemente sugerido que os serviços e suas pastas sejam criados na pasta '''opt''' ( para evitar problemas com atualização de sistema ).

'''[[Os passos abaixo precisam ser executados como root!]]'''

== MongoDB ==
É preciso instalar o '''mongodb''' no sistema seguinto as [https://docs.mongodb.com/manual/installation/ instruções para cada sistema].Se seguido corretamento link anterior, o mongo será configurado para iniciar sozinho.

Agora vamos configurar o banco para gerar os indexes para agilizar a busca.

É preciso pegar o script '''[https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js]''' na pasta [https://gitlab.mstech.com.br/teamwork/custom/tree/develop/.scripts '''.scripts''' no repositório]( pode estar oculta localmente ).

Para executar faça o seguinte:
* ir na pasta com o script [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js].
* executar verificar se os scripts estão olhando para o banco nomeado '''rocketchat''':
'''mongo localhost:27017/rocketchat mongo-custom-index.js'''

== Teamwork ==
=== Extrair pacote ===
Extrair pacote '''custom.tar.gz''' dentro da pasta '''/opt'''

=== Instalar dependências ===
Vá para a pasta em que o serviço foi colocado, é preciso fazer as instalação das dependências usando:
'''npm i'''

=== Validar pacote ===
Agora é preciso executar o serviço '''pm2 start main.js --name teamwork''', para validar se o serviço esta rodando execute o comando:
'''pm2 m'''

Agora será possível ver os logs do serviço e se está executando corretamente.Após iniciar o serviço é preciso acessar e cadastra um admin.

'''O primeiro login do teamwork sempre será o admin, e daí em diante será possível fazer o resto das configurações.'''

Agora é preciso parar o serviço com :
'''pm2 stop teamwork'''

=== Configurar serviço automatico ===
vamos criar um arquivo '''teamwork.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "8192M",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "http://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

Agora execute comando:
'''pm2 start teamwork.json --watch'''

== Hubot ==
Vá para a pasta em que o serviço foi colocado.

É preciso instalar as dependências globais do hubot, com o seguinte comando:
'''npm i -g coffee-script'''

Será preciso adicionar o caminho correto dentro do arquivo '''bin/hubot''' na linha com '''exec node_modules/..''' para '''exec /opt/''<pasta>''/node_modules/..'''

vamos criar um arquivo '''hubot.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "bot",
"max_memory_restart": "2048M",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/rockbot/bin/hubot",
"out_file": "/var/log/bot/app.log",
"error_file": "/var/log/bot/err.log",
"port": "1337"
}
]
}

Agora execute comando:
'''pm2 start hubot.json --watch'''

== pm2 ==
Essa parte deverá ser executada somente quando todos os serviços estiverem rodando '''corretamente e em paralelo !'''

Agora que os arquivos '''.json''' foram criados e executados podemos memorizar esses processos e suas ordem com o comando:
'''pm2 save'''

Isso irá salver a lista de processos, e agora vamos configurar o sistema para executar isso todas vez que a máquina for iniciada.

'''pm2 startup'''

Após isso reinicie a máquina e execute o comando abaixo para validar se os serviços estão rodando corretamente:
'''pm2 m ou pm2 status'''

= Configurações do sistema =
Caso haja algum problema em que o '''o primeiro login funciona e o restante não''', será preciso habilitar na opções administrativas na parte do LDAP.

O item de '''Mescar usuários já existentes''' para permitir o uso de '''username e email''' para login.

= Problemas possíveis =
== Serviços fora do ar ==
* É possível que o servidor apache não tenha renovado os arquivos alterados.

== Erro ao iniciar serviço ==
* É possível que a '''rota das pastas''' estejam erradas.
* É preciso executar o '''main.js''', no '''pm2''' ( atualmente é usando um arquivo de configuração '''pm2.json''' )
* É possível que '''falte dependências [[do hubot]]''' .

= Referências =

* [https://nodejs.org/en/download/releases/ NodeJS Download previous releases]
* [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop Repositório Hubot]
* [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]
* [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/MSTECH.md Documentação de instalação, configuração, pré-requisitos, build e deploy do Teamwork]
* [https://rocket.chat/docs/ Rocket.Chat Docs]
* https://rocket.chat/docs/installation/minimum-requirements Minimum Requirements for Server Deployment]
* [https://docs.mongodb.com/manual/tutorial/write-scripts-for-the-mongo-shell/#execute-a-javascript-file Executando script no mongodb]

Implantação Teamwork e Hubot para SEDUC

2017-05-29T20:08:31Z

Alexandre.paravani: /* Referências */

Nessa página será explicado o processo de implantação do serviço de customização do teamwork e hubot para a SEDUC.

Nas referências estão todos os dados que serão explicados nessa tópico.

= Servidor =
Configuração de hardware e software para execução dos serviços.

== Requisitos mínimos ==
=== Hardware ===
* CPU 1.7 GHz, 6 core, 4GB Ram, 500GB HD
* SO: Ubuntu 14.04 LTS ( CentOS 6.6+ )

=== Software ===
* Node 4.7.3
* MongoDB
* pm2

= Teamwork =
== Gerando pacote ==
* é preciso instalar o '''git na máquina do desenvolvedor''', [https://git-scm.com/downloads Git - downloads].
* é preciso instalar o '''meteor na máquina do desenvolvedor''', para que possamos fazer o build do projeto ( [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]).
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/custom/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git]
* executa em um cli( terminal ), '''na raiz do projeto''', o comando de build de pacote:
'''''meteor build ./ --server-only'''''
* será gerado um pacote '''custom.tar.gz''' que será colocado no '''servidor'''.

== Configurando layout ==

* É preciso fazer manualmente a alterações em adminstrativo/layout

Segue o parametros e cores:

=== COLORS ===
content Background color : #FFFFFF
Primary Background Color : #0F7043
Primary Font Color : #444444

Primary Action Color : #2F9E68
Secondary Background Color : #F4F4F4
Secondary Font Color : #7F7F7F
Secondary Action Color : #FFFFFF
Component Color : #EAEAEA
Success Color : #35AC19
Pending Color : #FCB316
Error Color : #D30230
Selection Color : #FF0000
theme-color-attention-color : #9C27B0
Secondary Action Color : #FFFFFF
Secondary Action Color : #FFFFFF

=== COLORS(MINOR) ===
Custom Scrollbar Color : #@transparent-darker ou #7F7F7F

= Hubot =
== Gerando pacote ==
* é preciso instalar o node e npm na máquina do desenvolvedor, [https://nodejs.org/en/download/releases/ NodeJS Download previous releases].
* Pegar o arquivos do repositório: [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop git@gitlab.mstech.com.br:teamwork/custom.git].
* executar: '''npm i'''
* gerar um zip '''com toda a pasta raiz''' e colocar no servidor.

= Configuração do serviços =
A configuração será feita através do '''pm2''', serviço de monitoramento e gerenciamento de serviços e processos, além de configurar o '''auto-start''' dos serviços de forma automática.

Aqui é preciso que esteja instalado o seguinte itens:'''node, npm, mongodb, pm2'''.

É preciso que os passos sejam executado seguindo os tópicos seguintes.

É fortemente sugerido que os serviços e suas pastas sejam criados na pasta '''opt''' ( para evitar problemas com atualização de sistema ).

'''[[Os passos abaixo precisam ser executados como root!]]'''

== MongoDB ==
É preciso instalar o '''mongodb''' no sistema seguinto as [https://docs.mongodb.com/manual/installation/ instruções para cada sistema].Se seguido corretamento link anterior, o mongo será configurado para iniciar sozinho.

Agora vamos configurar o banco para gerar os indexes para agilizar a busca.

É preciso pegar o script '''[https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js]''' na pasta [https://gitlab.mstech.com.br/teamwork/custom/tree/develop/.scripts '''.scripts''' no repositório]( pode estar oculta localmente ).

Para executar faça o seguinte:
* ir na pasta com o script [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/.scripts/mongo-custom-index.js mongo-custom-index.js].
* executar verificar se os scripts estão olhando para o banco nomeado '''rocketchat''':
'''mongo localhost:27017/rocketchat mongo-custom-index.js'''

== Teamwork ==
=== Extrair pacote ===
Extrair pacote '''custom.tar.gz''' dentro da pasta '''/opt'''

=== Instalar dependências ===
Vá para a pasta em que o serviço foi colocado, é preciso fazer as instalação das dependências usando:
'''npm i'''

=== Validar pacote ===
Agora é preciso executar o serviço '''pm2 start main.js --name teamwork''', para validar se o serviço esta rodando execute o comando:
'''pm2 m'''

Agora será possível ver os logs do serviço e se está executando corretamente.Após iniciar o serviço é preciso acessar e cadastra um admin.

'''O primeiro login do teamwork sempre será o admin, e daí em diante será possível fazer o resto das configurações.'''

Agora é preciso parar o serviço com :
'''pm2 stop teamwork'''

=== Configurar serviço automatico ===
vamos criar um arquivo '''teamwork.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "teamwork",
"max_memory_restart": "8192M",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/teamwork/main.js",
"out_file": "/var/log/teamwork/app.log",
"error_file": "/var/log/teamwork/err.log",
"port": "3000",
"env": {
"MONGO_URL": "mongodb://localhost:27017/rocketchat",
"MONGO_OPLOG_URL": "mongodb://localhost:27017/local",
"ROOT_URL": "https://comunicador.seduc.rs.gov.br",
"PORT": "3000"
}
}
]
}

Agora execute comando:
'''pm2 start teamwork.json --watch'''

== Hubot ==
Vá para a pasta em que o serviço foi colocado.

É preciso instalar as dependências globais do hubot, com o seguinte comando:
'''npm i -g coffee-script'''

Será preciso adicionar o caminho correto dentro do arquivo '''bin/hubot''' na linha com '''exec node_modules/..''' para '''exec /opt/''<pasta>''/node_modules/..'''

vamos criar um arquivo '''hubot.json''' na pasta do projeto para configurar o serviço e executa-lo no pm2.

Segue o modelo:
{
"apps":[
{
"name": "bot",
"max_memory_restart": "2048M",
"log_date_format": "YYYY-MM-DD HH:mm:ss SSS",
"script": "/opt/rockbot/bin/hubot",
"out_file": "/var/log/bot/app.log",
"error_file": "/var/log/bot/err.log",
"port": "1337"
}
]
}

Agora execute comando:
'''pm2 start hubot.json --watch'''

== pm2 ==
Essa parte deverá ser executada somente quando todos os serviços estiverem rodando '''corretamente e em paralelo !'''

Agora que os arquivos '''.json''' foram criados e executados podemos memorizar esses processos e suas ordem com o comando:
'''pm2 save'''

Isso irá salver a lista de processos, e agora vamos configurar o sistema para executar isso todas vez que a máquina for iniciada.

'''pm2 startup'''

Após isso reinicie a máquina e execute o comando abaixo para validar se os serviços estão rodando corretamente:
'''pm2 m ou pm2 status'''

= Configurações do sistema =
Caso haja algum problema em que o '''o primeiro login funciona e o restante não''', será preciso habilitar na opções administrativas na parte do LDAP.

O item de '''Mescar usuários já existentes''' para permitir o uso de '''username e email''' para login.

= Problemas possíveis =
== Serviços fora do ar ==
* É possível que o servidor apache não tenha renovado os arquivos alterados.

== Erro ao iniciar serviço ==
* É possível que a '''rota das pastas''' estejam erradas.
* É preciso executar o '''main.js''', no '''pm2''' ( atualmente é usando um arquivo de configuração '''pm2.json''' )
* É possível que '''falte dependências [[do hubot]]''' .

= Referências =

* [https://nodejs.org/en/download/releases/ NodeJS Download previous releases]
* [https://gitlab.mstech.com.br/teamwork/hubot/tree/develop Repositório Hubot]
* [https://gitlab.mstech.com.br/teamwork/custom/tree/develop Repośitório Teamwork]
* [https://gitlab.mstech.com.br/teamwork/custom/blob/develop/MSTECH.md Documentação de instalação, configuração, pré-requisitos, build e deploy do Teamwork]
* [https://rocket.chat/docs/ Rocket.Chat Docs]
* https://rocket.chat/docs/installation/minimum-requirements Minimum Requirements for Server Deployment]
* [https://docs.mongodb.com/manual/tutorial/write-scripts-for-the-mongo-shell/#execute-a-javascript-file Executando script no mongodb]

Implantação Teamwork e Hubot para SEDUC

2017-05-29T15:54:55Z

Alexandre.paravani: /* Teamwork */

Implantação Teamwork e Hubot para SEDUC

2017-05-29T15:50:53Z

Alexandre.paravani:

Implantação Teamwork e Hubot para SEDUC

2017-05-26T13:36:00Z

Alexandre.paravani: /* COLORS(MINOR) */

Implantação Teamwork e Hubot para SEDUC

2017-05-25T19:37:00Z

Alexandre.paravani:

Approxima

2017-04-24T15:38:31Z

Alexandre.paravani: /* Link do Product Backlog */

==Descrição==

Uma ferramenta que permite o fluxo das informações do dia a dia da escola e do aluno para seus pais ou responsáveis e propicia um canal de comunicação direto entre todos os envolvidos de forma prática e em tempo real.

Para atingir esse objetivo, o usuário que instalar o aplicativo poderá contar ainda com uma plataforma web que possui as mesmas ferramentas disponíveis no aplicativo. São elas:

MENSAGEIRO, que permite a troca de mensagens síncronas entre diretoria, coordenações, docentes, alunos e responsáveis por meio da gestão de grupos e/ou em conversas .

AGENDA, que possibilita cadastrar, compartilhar e visualizar eventos recebidos no calendário como provas, reuniões de pais, recesso, feriados, e demais eventos. Com isso, mantendo todos os usuários sempre

O BOLETIM ESCOLAR garante uma visão aos alunos e seus responsáveis da frequência, notas obtidas em cada uma das disciplinas e as médias da turma para que se possa fazer uma análise comparativa do rendimento escolar.

A ENQUETE, que permite que a equipe diretiva, coordenadores e professores criem questões de múltipla escolha para levantamento de opiniões.

As NOTIFICAÇÕES mantém todos os usuários alertas sobre cada novidade, ou seja, por meio dela é possível verificar se uma nova mensagem, novo evento, nova enquete ou demais novidades que foram cadastradas e estão disponíveis aos usuários.

==Funcionalidades de Ouro==

* MENSAGEIRO
* BOLETIM ESCOLAR
* ENQUETE
* NOTIFICAÇÕES

==Link do Product Backlog==

Nesta seção, insira o link do Product Backlog do produto

* '''Filho sem fila''' - sistema que permite agilizar o processo de pegar o filho na escola.Ao ativar o serviço, é disparado uma notificação avisando a escola/filho que os pais estão indo buscar seu filho, ao entrar no perímetro de 100 metros da escola, a mesma é notificada para deixar de prontidão o seu filho, também é possível notificar os filhos para eles ficarem de prontidão.

==Outras informações==
* [[Requisitos funcionais]]
* [[Requisitos não funcionais]]
* [[Especificações mínimas de hardware e software]]
* [[Arquitetura do produto]]
* [[Integrações]]
* [[Manual de instalação]]

== Tabela de permissões ==
{| class="wikitable"
! Linha do tempo (Novidades)
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Acessar e visualizar eventos por turma
| Sim
| Não
| Não
| Não
|-
| Acessar e visualizar eventos por filho
| Não
| Não
| Sim
| Não
|-
| Visualizar itens na timeline
| Sim
| Sim
| Sim
| Sim
|-
| Criar notícia com foto
| Sim
| Não
| Não
| Sim
|-
| Enviar parabéns ou comunicados aos pais
| Sim
| Não
| Não
| Sim
|-
| Enviar atualizações (Status de matrícula/solicitações)
| Sim
| Não
| Não
| Sim
|-
! Autorizações*
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Assinar autorizações
| Não
| Não
| Sim
| Não
|-
| Visualizar a autorização respondida na timeline
| Não
| Sim
| Sim
| Sim
|-
| Visualizar autorizações enviadas
| Sim
| Não
| Não
| Não
|-
| Visualizar as autorizações já respondidas
| Não
| Não
| Sim
| -
|-
! Mensagens
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Iniciar conversas
| Sim
| Não
| Não
| Sim
|-
| Responder mensagens
| Sim
| Sim
| Sim
| Sim
|-
! Avaliações
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Visualizar notas por bimestre
| Não
| Sim
| Não
| Não
|-
| Visualizar notas por bimestre/filho
| Não
| Não
| Sim
| Não
|-
! Agenda
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Criar eventos
| Sim
| Sim
| Sim
| Sim
|-
| Compartilhar eventos com a turma
| Sim
| Não
| Não
| Sim
|-
| Visualizar eventos criados por professores
| Sim
| Sim
| Sim
| Sim
|-
| Visualizar eventos por filho
| Não
| Não
| Sim
| Não
|-
! Questionários
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Responder questionários
| Sim
| Sim
| Sim
| Sim
|-
| Visualizar questionários recebidos
| Sim
| Sim
| Sim
| Sim
|-
| Visualizar questionários enviados
| Sim
| Não
| Não
| Sim
|-
| Criar questionários
| Sim
| Não
| Não
| Sim
|-
! Grade horária
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Visualizar horários de aula
| Não
| Sim
| Sim
| Não
|-
| Visualizar atribuições de aula
| Sim
| Não
| Não
| Não
|-
| Visualizar horários de aula dos filhos
| Não
| Não
| Sim
| Não
|-
! Buscar filho
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Indicar que está próximo a escola/indo buscar
| Não
| Não
| Sim
| Não
|-
| Visualizar o quadro de responsáveis próximos
| Sim
| Não
| Não
| Sim
|-
| Remover responsáveis do quadro após a retirada
| Sim
| Não
| Não
| Sim
|}

== Versões testadas do produto ==
[[Approxima 1.0.0.74]]

Approxima

2017-04-20T13:27:54Z

Alexandre.paravani:

==Descrição==

Uma ferramenta que permite o fluxo das informações do dia a dia da escola e do aluno para seus pais ou responsáveis e propicia um canal de comunicação direto entre todos os envolvidos de forma prática e em tempo real.

Para atingir esse objetivo, o usuário que instalar o aplicativo poderá contar ainda com uma plataforma web que possui as mesmas ferramentas disponíveis no aplicativo. São elas:

MENSAGEIRO, que permite a troca de mensagens síncronas entre diretoria, coordenações, docentes, alunos e responsáveis por meio da gestão de grupos e/ou em conversas .

AGENDA, que possibilita cadastrar, compartilhar e visualizar eventos recebidos no calendário como provas, reuniões de pais, recesso, feriados, e demais eventos. Com isso, mantendo todos os usuários sempre

O BOLETIM ESCOLAR garante uma visão aos alunos e seus responsáveis da frequência, notas obtidas em cada uma das disciplinas e as médias da turma para que se possa fazer uma análise comparativa do rendimento escolar.

A ENQUETE, que permite que a equipe diretiva, coordenadores e professores criem questões de múltipla escolha para levantamento de opiniões.

As NOTIFICAÇÕES mantém todos os usuários alertas sobre cada novidade, ou seja, por meio dela é possível verificar se uma nova mensagem, novo evento, nova enquete ou demais novidades que foram cadastradas e estão disponíveis aos usuários.

==Funcionalidades de Ouro==

* MENSAGEIRO
* BOLETIM ESCOLAR
* ENQUETE
* NOTIFICAÇÕES

==Link do Product Backlog==

Nesta seção, insira o link do Product Backlog do produto

==Outras informações==
* [[Requisitos funcionais]]
* [[Requisitos não funcionais]]
* [[Especificações mínimas de hardware e software]]
* [[Arquitetura do produto]]
* [[Integrações]]
* [[Manual de instalação]]

== Tabela de permissões ==
{| class="wikitable"
! Linha do tempo (Novidades)
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Acessar e visualizar eventos por turma
| Sim
| Não
| Não
| Não
|-
| Acessar e visualizar eventos por filho
| Não
| Não
| Sim
| Não
|-
| Visualizar itens na timeline
| Sim
| Sim
| Sim
| Sim
|-
| Criar notícia com foto
| Sim
| Não
| Não
| Sim
|-
| Enviar parabéns ou comunicados aos pais
| Sim
| Não
| Não
| Sim
|-
| Enviar atualizações (Status de matrícula/solicitações)
| Sim
| Não
| Não
| Sim
|-
! Autorizações*
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Assinar autorizações
| Não
| Não
| Sim
| Não
|-
| Visualizar a autorização respondida na timeline
| Não
| Sim
| Sim
| Sim
|-
| Visualizar autorizações enviadas
| Sim
| Não
| Não
| Não
|-
| Visualizar as autorizações já respondidas
| Não
| Não
| Sim
| -
|-
! Mensagens
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Iniciar conversas
| Sim
| Não
| Não
| Sim
|-
| Responder mensagens
| Sim
| Sim
| Sim
| Sim
|-
! Avaliações
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Visualizar notas por bimestre
| Não
| Sim
| Não
| Não
|-
| Visualizar notas por bimestre/filho
| Não
| Não
| Sim
| Não
|-
! Agenda
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Criar eventos
| Sim
| Sim
| Sim
| Sim
|-
| Compartilhar eventos com a turma
| Sim
| Não
| Não
| Sim
|-
| Visualizar eventos criados por professores
| Sim
| Sim
| Sim
| Sim
|-
| Visualizar eventos por filho
| Não
| Não
| Sim
| Não
|-
! Questionários
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Responder questionários
| Sim
| Sim
| Sim
| Sim
|-
| Visualizar questionários recebidos
| Sim
| Sim
| Sim
| Sim
|-
| Visualizar questionários enviados
| Sim
| Não
| Não
| Sim
|-
| Criar questionários
| Sim
| Não
| Não
| Sim
|-
! Grade horária
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Visualizar horários de aula
| Não
| Sim
| Sim
| Não
|-
| Visualizar atribuições de aula
| Sim
| Não
| Não
| Não
|-
| Visualizar horários de aula dos filhos
| Não
| Não
| Sim
| Não
|-
! Buscar filho
! Professor
! Aluno
! Responsável
! Func. da escola
|-
| Indicar que está próximo a escola/indo buscar
| Não
| Não
| Sim
| Não
|-
| Visualizar o quadro de responsáveis próximos
| Sim
| Não
| Não
| Sim
|-
| Remover responsáveis do quadro após a retirada
| Sim
| Não
| Não
| Sim
|}

== Versões testadas do produto ==
[[Approxima 1.0.0.74]]

Implantação Teamwork e Hubot para SEDUC

2017-04-05T20:54:32Z

Alexandre.paravani:

Implantação Teamwork e Hubot para SEDUC

2017-04-05T20:53:23Z

Alexandre.paravani:

Implantação Teamwork e Hubot para SEDUC

2017-03-30T14:53:42Z

Alexandre.paravani: /* Configuração do serviços */

Implantação Teamwork e Hubot para SEDUC

2017-03-30T14:53:20Z

Alexandre.paravani: /* Configuração do serviços */

Implantação Teamwork e Hubot para SEDUC

2017-03-30T14:51:29Z

Alexandre.paravani: /* Configuração do serviços */

Implantação Teamwork e Hubot para SEDUC

2017-03-30T14:40:53Z

Alexandre.paravani: /* Configuração do serviços */

Implantação Teamwork e Hubot para SEDUC

2017-03-30T14:22:35Z

Alexandre.paravani: /* MongoDB */

Implantação Teamwork e Hubot para SEDUC

2017-03-30T14:14:08Z

Alexandre.paravani:

Implantação Teamwork e Hubot para SEDUC

2017-03-30T13:48:32Z

Alexandre.paravani: