.. Popebu CMS documentation master file, created by
   sphinx-quickstart on Wed Mar  5 15:17:30 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Bem vindo ao Popebu CMS!
======================================

.. toctree::
   :maxdepth: 2
   
Popebu é um CMS opensource baseado no Django_.
 
.. _Django: https://www.djangoproject.com/

Sinta-se a vontade para fazer um fork ou relatar um incidente no repositório do projeto.

Requisitos
------

- Python 2.7 +
- Pip
- Virtualenv (opcional)

Instalação
------

Caso tenha optado por utilizar o virtualenv, é necessário antes criar e ativar o seu ambiente virtual. Após isso, siga os seguintes passos:

1. Instale as bibliotecas de dependência do projeto.
::
    $ pip install -r popebu/conf/requirements/requirements.txt
2. Atualize o arquivo *popebu/conf/settings/settings.py* com as suas configurações do projeto. Este arquivo será detalhado adiante na seção :ref:`configuracoes-label`.
 
3. Executar os comandos:
::
    $ python manage.py syncdb
    $ python manage.py migrate
    $ python manage.py loaddata popebu/conf/data/*

.. _configuracoes-label:

Configurações
-------
As configurações a seguir devem ser feitas no arquivo *popebu/conf/settings/settings.py* de acordo com as necessidades do seu projeto.

ALLOWED_HOSTS: Tag de segurança do Django. Deve listar os domínios utilizados pelo projeto. Caso o seu projeto esteja rodando localmente, esta tag pode ser comentada.
::
    ALLOWED_HOSTS = [
        '.example.com',
        '.example.com.',
    ]

DATABASES: Tag que deve conter as informações para conexão com o banco de dados do projeto. Deve ser preenchida conforme a documentação do Django sobre databases_.

.. _databases: https://docs.djangoproject.com/en/dev/ref/settings/#databases
    
RECAPTCHA_PUBLIC_KEY e RECAPTCHA_PRIVATE_KEY: Tags de segurança responsáveis por renderizar o captcha do login. Devem ser geradas em https://www.google.com/recaptcha.

HAYSTACK_CONNECTIONS: O Popebu já possui instalado todas as bibliotecas necessárias para busca semantica com Solr_. Caso você possua algum servidor com Solr rodando, é só informar a url nesta tag. 
Para maiores informações, acessar a documentação do Haystack_   

.. _Solr: http://lucene.apache.org/solr/
.. _Haystack: http://django-haystack.readthedocs.org/en/v2.1.0/

*Memcached*: Para melhorar a performance, o Popebu já possui todas as bibliotecas necessárias para o cacheamento de dados com Memcached_. Para maiores informações, acesse a documentação do Django sobre cache_.

.. _Memcached: http://memcached.org/
.. _cache: https://docs.djangoproject.com/en/dev/topics/cache/#memcached

Segurança
-------

Para acessar a área administrativa em *<url_projeto>/admin*, dois usuários são cadastrados no momento da instalação do Popebu.

- Usuário Master: Senha admin
- Usuário Redator: Senha admin

É recomendado que após o primeiro acesso as senhas e os **emails** destes usuários sejam modificados.

Existem dois pontos importantes sobre o Popebu em questão de segurança:

- Ao cadastrar um usuário, sempre informe um email válido. O email será utilizado para o envio de senha no momento da criação e para recuperar a mesma caso seja esquecida.
- Após três tentativas de acesso, surge um captcha para garantir a segurança no acesso.

Widgets
-------

.. image:: _static/images/popebu_blog_url_sample.png

Na imagem acima temos a visão do layout padrão instalado com o Popebu dividida em três partes:

- Área lilás: É considerada a área mutável do layout. É formada por um método no arquivo widgets/views.py que retorna a consulta para um template em widgets/templates.
- Área rosa: É uma área fixa do layout, porém são resultado de uma consulta de um método presente no arquivo templatetags/sidebar_tags.py para um template.
- Área restante: São áreas fixas do layout, que não resultam de consultas, mas podem ser separadas em arquivos (header, conteúdo, footer, etc) para ajudar na organização.

Todos os arquivos do Popebu estão livres para edição e os widgets podem ser modificados ou podem ter novos arquivos adicionados.
Para maiores informações acesse a documentação do Django sobre templates_ e templatetags_.

.. _templates: https://docs.djangoproject.com/en/dev/ref/templates/api/
.. _templatetags: https://docs.djangoproject.com/en/dev/howto/custom-template-tags/