An image that uses the Clubhouse exporter (copied to this repo) to extract
data from Clubhouse to a volume mounted at /export
and then (optionally)
write it to an AWS S3 bucket.
You don't need to mount a volume if you're backing-up the files to an AWS S3 bucket. A mounted volume is needed if you;re not using AWS S3 in order to persist the export once the backup container has completed.
The container is configured by a number of environment variables: -
CLUBHOUSE_API_TOKEN
The Clubhouse API tokenBUCKET_NAME
The AWS S3 bucket name, if writing export to AWS s3AWS_ACCESS_KEY_ID
The AWS Access Key with permission to write to the bucketAWS_SECRET_ACCESS_KEY
teh AWS secret key
The container image is built using Travis. Inspect the project's .travis.yml
to see how the container image is built. The simplest thing to do is
to run the Docker build command: -
$ docker build -t informaticsmatters/clubhouse-exporter:latest .
You can run the container locally to quickly archive your Clubhouse data
to the current directory (where a ./data
directory will be created)...
$ export CLUBHOUSE_API_TOKEN=00000000
$ docker run \
-v ${PWD}:/export \
-e CLUBHOUSE_API_TOKEN=${CLUBHOUSE_API_TOKEN} \
--rm informaticsmatters/clubhouse-exporter:latest
Or you can deploy it to Kubernetes as a CronJob for regular execution. Where you can checkout our peer Ansible repository.