Configuração padrão e variáveis de ambiente

Introdução:

A configuração padrão do site espera ter acesso a instâncias locais de mongo e acesso ao file system como por exemplo /tmp para ter acesso ao banco de dados SQLite.

Todas as definições padrão atualizadas estão definidas em: opac/webapp/config/default.py

Ajustando as configurações de uma instância em particular:

É possível redefinir estas configurações para determinado ambiente, o que é recomendado por questões de segurança, por exemplo para redefinir a configuração do SECRET_KEY e as credencias de acesso ao banco.

Para ajustar configurações, pode definir as variáveis de ambiente (ver abaixo) no seu host, ou copie o template que melhor se ajuste a seu ambiente, e apontando o caminho absoluto na variável de ambiente: OPAC_CONFIG, por exemplo:

1. copiar este template: cp opac/config/templates/development.template /foo/var/baz/opac.config.py
2. editar: vim /foo/var/baz/opac.config.py, pode consultar o arquivo: opac/webapp/config/default.py
3. definir a variável de ambiente OPAC_CONFIG: export OPAC_CONFIG="/foo/var/baz/opac.config.py"
4. iniciar/reiniciar o servidor web

Configuração padrão e variáveis de ambiente asociadas:

Na Configuração padrão, definimos estas configurações para deixar a app rodando em modo "produção". Porém é recomendado ajustar algumas configuração para deixar uma instalação segura e funcional no seu ambiente, por exemplo definindo a coleção que o site deve atender.

Para saber mais sobre configuração, visite:

• http://flask.pocoo.org/docs/0.10/config/#builtin-configuration-values
• https://pythonhosted.org/flask-mail/#configuring-flask-mail
• http://flask-sqlalchemy.pocoo.org/2.1/config/
• https://flask-mongoengine.readthedocs.org/en/latest/#configuration

Variáveis de ambiente:

• Modo Debug:

  • OPAC_DEBUG_MODE: ativa/desativa o modo Debug da app, deve estar desativado em produção! (default: False)

• Segurança:

  • OPAC_SECRET_KEY: chave necessária para segurança nos formulário da app (default: 'secr3t-k3y')

• Coleção:

  • OPAC_COLLECTION: acrônimo da coleção do opac (default: 'spa')

• Para envio de emails:

  • OPAC_DEFAULT_EMAIL: conta de email para envio de mensagens desde o site (default: '[email protected]')
  • OPAC_MAIL_SERVER: host do servidor de emails (default: localhost)
  • OPAC_MAIL_PORT: porta do servidor de emails (default: 1025)
  • OPAC_MAIL_USE_TLS: ativa/desativa envio de email com TLS (default: False)
  • OPAC_MAIL_USE_SSL: ativa/desativa envio de email com SSL (default: False)

• Banco Mongo:

  • OPAC_MONGODB_NAME: nome do banco (default: 'opac')
  • OPAC_MONGODB_HOST: host do banco (default: 'localhost')
  • OPAC_MONGODB_PORT: porta do banco (default: 27017)
  • OPAC_MONGODB_USER: [opcional] usuário para acessar o banco (default: None)
  • OPAC_MONGODB_PASS: [opcional] password para acessar o banco (default: None)

• Banco SQL:

  • OPAC_DATABASE_FILE: nome do arquivo (sqlite) (default: 'opac.sqlite')
  • OPAC_DATABASE_DIR: pasta aonde fica o banco (sqlite) (default: '/tmp')
  • OPAC_DATABASE_URI: [opcional] URI do banco sql (default: 'sqlite:////tmp/opac.sqlite')

• Google Analytics:

  • GA_TRACKING_CODE: código de google analytics (acesse https://goo.gl/HE77SO para resgatar seu código) (default: None)

• Armazenamento de arquivos subidos pelos usuários (pelo admin):

  • OPAC_MEDIA_ROOT: caminho absoluto da pasta que vai armazenar os arquivos (OPAC_MEDIA_ROOT/files/) e as imagens (OPAC_MEDIA_ROOT/images/). (default: <pasta do projeto>/webapp/media/)
  • OPAC_MEDIA_URL: prefixo da url que vai atender para servir os arquivos e imagens subidos pelos usuários. (default: /media)

• Twitter:

  • OPAC_TWITTER_CONSUMER_KEY: Twitter comuser key (default: 'consum3r-k3y')
  • OPAC_TWITTER_CONSUMER_SECRET: Twitter comuser secret (default: 'consum3r-secr3t')
  • OPAC_TWITTER_ACCESS_TOKEN: Twitter access token (default: 'acc3ss-tok3n-secr3t')
  • OPAC_TWITTER_ACCESS_TOKEN_SECRET: Twitter access token (default: 'acc3ss-tok3n-secr3t')
  • OPAC_TWITTER_SCREEN_NAME: Twitter screen name (default: 'RedeSciELO')