🗜️ Archiver

Service for archiving old RapidPro/TextIt runs and messages. It interacts directly with the database and writes archive files to S3.

Configuration

The service uses a tiered configuration system, each option takes precendence over the ones above it:

1. The configuration file
2. Environment variables starting with ARCHIVER_
3. Command line parameters

We recommend running it with no changes to the configuration and no parameters, using only environment variables to configure it. You can use % rp-archiver --help to see a list of the environment variables and parameters and for more details on each option.

• ARCHIVER_DB: URL describing how to connect to the database
• ARCHIVER_TEMP_DIR: The directory that temporary archives will be written before upload

AWS services:

• ARCHIVER_AWS_ACCESS_KEY_ID: AWS access key id used to authenticate to AWS
• ARCHIVER_AWS_SECRET_ACCESS_KEY: AWS secret access key used to authenticate to AWS
• ARCHIVER_AWS_REGION: AWS region (e.g. eu-west-1)

For writing of archives, Archiver needs access to a storage bucket on an S3 compatible service. We recommend that you choose SSE-S3 encryption as this is the only type that supports validation of upload ETags.

• ARCHIVER_S3_BUCKET: name of your S3 bucket (e.g. dl-archiver-test")

If using a different encryption type or service that produces non-MD5 ETags:

• ARCHIVER_CHECK_S3_HASHES: can be set to FALSE to disable checking of upload hashes.

Logging and error reporting:

• ARCHIVER_DEPLOYMENT_ID: used for metrics reporting
• ARCHIVER_SENTRY_DSN: DSN to use when logging errors to Sentry
• ARCHIVER_LOG_LEVEL: logging level to use