Maintenance

Upgrades

At some point after installing, you'll want to upgrade to a newer version of the Liquid bundle.

Watch out for breaking changes in the configuration by looking at the changelogs (tag messages) in:

• the node releases page
• the cluster releases page

1. Update the cluster to version X.X.X:

cd /opt/cluster
git fetch -ap
git checkout vX.X.X
# check for new settings in `examples/cluster.ini` and add them to `cluster.ini`
bin/docker.sh --rm --pull --image liquidinvestigations/cluster:X.X.X
# wait for services to be ready
docker exec cluster ./cluster.py wait

2. Updatenode to version Z.Z.Z:

cd /opt/node
git fetch
git checkout vZ.Z.Z
# check for new settings in `examples/liquid.ini` and add them to `liquid.ini`
./liquid resources
./liquid deploy

Shutting down

To shut down the bundle, stop the cluster container, with a generous timeout:

docker stop -t 300 cluster

If Nomad isn't configured to drain jobs (or the drain operation fails) you may also need to kill all containers it left behind:

docker stop -t 300 $(docker ps -qa)

Clean reset

Some Nomad versions require clearing the server data for upgrades. In those cases it's best to clear the docker system images too, using the following command sequence.

./liquid halt
docker stop -t 300 cluster
docker stop -t 300 $(docker ps -qa)
sudo rm -rf /opt/cluster/var/nomad

... and continue with deploying normally as described in the beginning of this article:

cd /opt/cluster
git fetch -ap
git checkout vX.X.X
bin/docker.sh --rm --pull --image liquidinvestigations/cluster:X.X.X
docker exec cluster ./cluster.py wait

cd /opt/node
git fetch -ap
git checkout vZ.Z.Z
./liquid resources
./liquid deploy

Note: if the docker system prune --all --force --volumes command takes too long to finish, sudo systemctl restart docker and re-run it.

Backup

run ./liquid backup [OPTIONS] $DIR to back up the system.

Optional parameters to specify which parts of the system will be backed up:

--no-apps : excludes app data from backup
--no-collections : excludes collections from backup
--no-pg : excludes collection databases from backup
--no-es : excludes collection es snapshots from backup
--no-blobs : excludes collection blobs (Binary Large OBjects) from backup
--collection $NAME : backup specific collection

When no optional parameter is given, the whole system will be backed up.

Restore

Make sure a clean system is installed before starting with the restore process.

Restoring apps: ./liquid restore-apps $DIR

Restore collection: ./liquid restore-collection $DIR $NAME

Restoring collections: ./liquid restore-all-collections $DIR

Note: The collections have to be disabled in the liquid.ini to be restored. After the restore process is finished the collections have to be enabled in the liquid.ini again to be accessible.

To finish the restore process run ./liquid deploy.

Ex-/Import Accounts

To create a full data dump containing auth and otp data, use Django's dumpdata command like this:

./liquid shell liquid:core ./manage.py dumpdata auth otp_totp > users.json

Restore this, maybe on a different machine, using the users.json file, copy it into the liquid:core container and run:

docker cp users-json core-...:/app/users.json
./liquid shell liquid:core
./manage.py loaddata users.json
rm users.json
exit

Changing domain name

After changing the upstream network configuration, you will also have to change the following:

• domain in liquid.ini
• change domain under volumes/nextcloud/nextcloud/config/config.php (it appears two times)

Issues after domain change

Hypothesis

Bulk changing of annotation target URLs is not officially supported by upstream (docs page), so we use database-level replace to change the targets ourselves.

To fix hypothesis configuration, run these commands after replacing NEW.DOMAIN.ORG and OLD.DOMAIN.COM with the new and domains you set in [liquid] liquid_domain.

./liquid shell hypothesis:hypothesis ./bin/hypothesis -- --  move-uri --old 'OLD.DOMAIN.COM' --new 'NEW.DOMAIN.COM'

./liquid dockerexec hypothesis-deps:pg pg_dump -U hypothesis hypothesis -C -c > h.sql
sed -i.bak 's/OLD.DOMAIN.COM/NEW.DOMAIN.ORG/g' h.sql

# stop the Hypothesis web service from the UI, then run:
./liquid dockerexec hypothesis-deps:pg dropdb hypothesis -U hypothesis
echo "create database hypothesis with owner = hypothesis" | ./liquid shell hypothesis-deps:pg psql -U hypothesis -d postgres
cat h.sql | ./liquid dockerexec hypothesis-deps:pg psql -U hypothesis

The previous command doesn't replace the USER IDs, but our database script above does, so please run both.

And restart hypothesis from the Nomad Web UI.

After finishing the requests above, run:

./liquid shell hypothesis:hypothesis ./bin/hypothesis -- -- search reindex

Rocketchat

Login with the auto-generated admin user and password and update all these settings by hand:

• General > Site URL
• OAuth2 > Liquid

Take care in updating HTTP vs. HTTPS for your new domain.

HTTPS certificates

HTTPS certificates are not automatically removed. See the Admin Guide: FAQ for more details.

Other problems

Use the Admin Guide: FAQ for miscellaneous operating details and the Security page on how to keep a production system secure.