keygen-sh/keygen-api v1.3.0

Multi-user licenses and more

on GitHub

Upgrade to the keygen/api:latest or keygen/api:v1.3 image. This release will include multiple database migrations, so we recommend taking a database backup beforehand and performing the upgrade during off-peak hours. Depending on your data's size, some migrations could take up to a few minutes as data is migrated. But for most self-hosted installs, each migration should be quick.

docker pull keygen/api:latest

After deploying, but before "rolling over the release", run the following command in the container to migrate the database:

# Migrate the database
rake db:migrate

After deploying and running the migrations, run the following commands in the container to seed new permissions:

# Add new permissions and event types
rake db:seed

# Migrate existing role permissions
rake keygen:permissions:admins:add[license.users.attach,license.users.detach,license.owner.update,machine.owner.update]
rake keygen:permissions:environments:add[license.users.attach,license.users.detach,license.owner.update,machine.owner.update]
rake keygen:permissions:products:add[license.users.attach,license.users.detach,license.owner.update,machine.owner.update]

After running the above, and you have a large database, you may also want to vacuum the following tables:

# Vacuum these tables to improve performance of large tables
VACUUM ANALYZE licenses;
VACUUM ANALYZE users;

You may now roll over the release, i.e. route traffic to the new containers and shut down old containers.

For more information on database migrations, see the Rails documentation.

For more information on upgrading, see the docs.