Herder is a tool for automagically generate schedules for your convention, given such information as "when", "who's coming" and "what events do they want to attend". It leverages OptaPlanner for constraint satisfaction solving to be able to figure out the best schedule it can given your constraints, or at least the one that violates the smallest number of them.
It's a Clojure(Script) Boot app, with a tiny little bit of Java for helping OptaPlanner along.
This will get you a running dev setup using h2.
dev boot target builds, tests and runs the system. There's also
prod-build which makes a
target directory with all the parts in and
prod-run which assumes you've done
prod-build and runs that.
This uses Docker, PostgreSQL and Let's Encrypt, but if you set DATABASE_URL and HOST you can run this outside of Docker. See
docker-compose.yml for information. We're using prebuilt images from Docker Hub using
- Find a suitable machine to run all of this on (I suggest DigitalOcean, because then I get referrer credit). Main tested environment is a Debian 8.3 x64 machine.
apt-get install vim curl
- Follow https://docs.docker.com/engine/installation/linux/debian/#debian-jessie-80-64-bit
docker versionand then follow https://github.com/docker/compose/releases instructions for latest release
git clone https://github.com/palfrey/herder.git
LETSENCRYPT_HOSTto your host (hereafter assumed to be "herder.example.com"). Set
LETSENCRYPT_EMAILto your email.
docker-compose -f docker-compose-public.yml up -d
- Goto http://herder.example.com:3000, and make sure you've got the main "Conventions" page. If not, check
docker logs -f herder_herder_1for "Starting #'herder.systems/prod-system" at the end. This takes a bit to occur after the "Postgres is up" line
- Goto https://herder.example.com. If that doesn't work, check
docker logs -f letsencrypt-nginx-proxy-companionfor no ERROR lines
- If this all works, replace "ports:" section of "herder" in "docker-compose-public.yml" with an "expose:" section
ports: - "3000:3000"
expose: - "3000"
docker-compose -f docker-compose-public.yml up -d, which will stop the port 3000 version being exposed to the outside world.
If you've done the Production setup, backing up your data is good. Here's an example way to backup the Postgres data
apt-get install postgresql-client ssmtp uudeview
- Create backup.sh as follows (replacing the "From" and "To" addresses)
and doing a
#!/bin/bash PGPASSWORD=mysecretpassword pg_dump postgres --host localhost --username=postgres | gzip -c - > backup.sql.gz echo -e "From: email@example.com\nTo: firstname.lastname@example.org\nSubject: Herder backup\n\n"|uuenview -a -bo backup.sql.gz |sendmail -t
chmod +x backup.sh
- To then backup every night at 2am,
crontab -eand add the following
0 2 * * * /root/herder/backup.sh(assuming that's the path to