External services

Step by step how-to instructions on installing and running KoBo Toolbox on a standalone server.
Jump to: navigation, search

Email service provider

KoBo Toolbox will try to send out email on a number of events; re-setting the forgotten password is a good example. Only the outgoing, SMTP service is required, and you can any mailbox (ISP, gmail, even your own!) as long as it publishes SMTP for users. Please have a mailbox created upfront, and take note of all the access parameters that the configuration file below:

$ nano $KOBO_DOCKER/envfiles/smtp.txt
##################################
# For sending e-mail using SMTP. #
##################################

# NOTE: These and the e-mail settings from `envfiles/aws.txt` are mutually exclusive; do not use both.
# See https://docs.djangoproject.com/en/1.8/topics/email/#smtp-backend.
EMAIL_BACKEND=django.core.mail.backends.smtp.EmailBackend
EMAIL_HOST=smtp.office365.com
EMAIL_PORT=587
EMAIL_HOST_USER=Kobo-OCB@brussels.msf.org
EMAIL_HOST_PASSWORD=DertVzer98
EMAIL_USE_TLS=True
DEFAULT_FROM_EMAIL=Kobo-OCB@brussels.msf.org
This file contains the settings for MS Office 365, using the account Kobo-OCB@brussels.msf.org.

Tracking services

Three tracking services are instantly applicable to KoBo application:

  1. Google Analytics - user tracking
  2. Sentry/Raven - application state tracking
  3. trackJS - JavaScript error tracking

Please register with the service beforehand, and have your property ID ready. Note that the environment file is named external_services.txt and it configures tracking services only.

$ nano $KOBO_DOCKER/envfiles/external_services.txt
GOOGLE_ANALYTICS_TOKEN=UA-89355929-1
#RAVEN_DSN=
#TRACKJS_TOKEN=

AWS filesystem

In Docker-based application, persistance of the fie system is achieved "elsewhere", since all the containers are created from stateless Images that contain no operating data.

Kobo Toolbox provides the instant way of setting up the filesystem on the (previously purchased) Amazon S3. The configuration is located in envfiles/aws.txt of

KOBO_DOCKER=/home/ate/kobo-docker/
####################
# Account settings #
####################

#AWS_ACCESS_KEY_ID=
#AWS_SECRET_ACCESS_KEY=


###################
# E-mail settings #
###################

# NOTE: These and the settings from `envfiles/smtp.txt` are mutually exclusive; do not use both.
# In order to use SES to send e-mails, you must already have SES set up on AWS, and the owner of your `AWS_ACCESS_KEY_ID` must have the appropriate SES permissions.
#EMAIL_BACKEND=django_ses.SESBackend
# E.g. `us-east-1`
#AWS_SES_REGION_NAME=
# E.g. `email.us-east-1.amazonaws.com`.
#AWS_SES_REGION_ENDPOINT=
#DEFAULT_FROM_EMAIL=


####################
# Storage settings #
####################

#KOBOCAT_DEFAULT_FILE_STORAGE=storages.backends.s3boto.S3BotoStorage
# To use S3 for KoBoCAT's storage, the specified bucket must already exist and the owner of your `AWS_ACCESS_KEY_ID` must have the appropriate S3 permissions.
#KOBOCAT_AWS_STORAGE_BUCKET_NAME=