spiegel | Scalable replication and change listening for CouchDB | SQL Database library

We recommend that you install Spiegel via Docker, especially Docker Swarm, as this will allow you to easily scale up or down as your needs change. Moreover, Docker will take care of automatically restarting the processes in the event of a permanent error. You can of course run Spiegel via npm, but then the scaling and auto restarting will be up to you to implement.
Install Docker Swarm: see the official Docker documentation or Installing Docker Swarm on Ubuntu
Create a passwords file for your change_listeners, e.g. change-listener-passwords.json: { "yourapi.com": { "apiuser": "apipassword" } }
Create a passwords file for your replicators, e.g. replicator-passwords.json: { "yourcouchdb.com": { "user": "password" } }
Install Spiegel: $ docker run -it \ -e TYPE='install' \ -e URL='http://user:password@yourcouchdb.com:5984' \ redgeoff/spiegel Note: the system database _global_changes must exist. If it doesn't exist, create it.
Create the Update Listener Service: $ docker service create \ --name update-listener \ --detach=true \ --replicas 2 \ -e TYPE='update-listener' \ -e URL='http://user:password@yourcouchdb.com:5984' \ redgeoff/spiegel
Create the Change Listener Service: $ docker service create \ --name change-listener \ --detach=true \ --replicas 2 \ -e TYPE='change-listener' \ -e URL='http://user:password@yourcouchdb.com:5984' \ --mount type=bind,source=change-listener-passwords.json,destination=/usr/src/app/passwords.json \ -e PASSWORDS_FILE=/usr/src/app/passwords.json \ redgeoff/spiegel
Create the Replicator Service: $ docker service create \ --name replicator \ --detach=true \ --replicas 2 \ -e TYPE='replicator' \ -e URL='http://user:password@yourcouchdb.com:5984' \ --mount type=bind,source=replicator-passwords.json,destination=/usr/src/app/passwords.json \ -e PASSWORDS_FILE=/usr/src/app/passwords.json \ redgeoff/spiegel
Create your on_change docs in the spiegel DB
Create your replicator docs in the spiegel DB
yourapi.com and yourcouchdb.com cannot be equal to localhost as you will be running the Spiegel processes from within docker containers, which means that localhost will refer to the VM's localhost. If you don't have a domain name to use then you can use the IP address of your host machine. Alternatively, you can also use defined entries in your host's hosts file if you use the --network=host when running docker service create.
For extra security, use the Docker Secrets to encrypt the URL parameter.
For a complete list of options see Usage.
Install via NPM $ npm install -g spiegel --unsafe Note: --unsafe is needed to properly install leveldown (a PouchDB dependency)
Create a passwords file for your change_listeners, e.g. change-listener-passwords.json: { "yourapi.com": { "apiuser": "apipassword" } }
Create a passwords file for your replicators, e.g. replicator-passwords.json: { "yourcouchdb.com": { "user": "password" } }
Install Spiegel: $ spiegel \ --type='install' \ --url='http://user:password@yourcouchdb.com:5984' Note: the system database _global_changes must exist. If it doesn't exist, create it.
Run the Update Listener Process: $ spiegel \ --type='update-listener' \ --url='http://user:password@yourcouchdb.com:5984'
Run the Change Listener Process: $ spiegel \ --type='change-listener' \ --url='http://user:password@yourcouchdb.com:5984' \ --passwords-file=change-listener-passwords.json
Run the Replicator Process: $ spiegel \ --type='replicator' \ --url='http://user:password@yourcouchdb.com:5984' \ --passwords-file=replicator-passwords.json
Create your on_change docs in the spiegel DB
Create your replicator docs in the spiegel DB
The Docker image's environment variables are equal to the uppercase snake case of the options available on the command line, e.g. use LOG_LEVEL instead of --log-level
To check the version via Docker use docker run -it -e VERSION=true redgeoff/spiegel