Docs
Deployment
Updating

Updating

Generic instructions

Backward compatibility is kept on the level of public APIs of Private Captcha, not service configuration itself. It is your responsibility to check for any and all changes before applying updates.
It is not recommended to use something like a Watchtower or any other solution that automatically bumps tag versions.
Before each update make sure to backup your data in case you’re using any backup solutions.

For this guide it is assumed you are using the self-hosting repository setup.

  1. (optional) Make backups if you’re using any backup solution.
  2. Navigate to the repo 
    cd /path/to/the/self-hosting/repo/checkout
  3. Pull latest changes 
    git pull
  4. Pull new images 
    docker compose pull
  5. Check which version is currently running 
    docker compose ps
  6. Perform all instructions below for each version between running version and the one you’re about to upgrade to.
    Changes in files to look out for: compose.yml, .env.example
  7. Recreate containers with new images 
    docker compose up -d

Notable deployment changes

v0.0.24

  • widget has been updated, purge your CDN cache
  • a new environment variable is available for Enterprise edition: EE_AUDIT_LOGS_DAYS (retention period in days for audit logs)

v0.0.23

  • a new environment variable can be added: PC_COUNTRY_CODE_HEADER (a header from CDN provider with 2-letter country code). Usual suspects are: Bunny CDN (CDN-RequestCountryCode), CloudFlare (CF-IPCountry), AWS CloudFront (CloudFront-Viewer-Country)

v0.0.22

  • a new highly recommended (albeit non-mandatory) environment variable has to be added: PC_ID_HASH_SALT (used to obscure internal IDs in URLs)
  • in case you’re monitoring Private Captcha with Prometheus-compatible agent, a new metric has been added: fine_http_error_total with dimensions code, method, service, handler. This is the metric for “soft” internal errors happening in Portal.

v0.0.21

  • widget has been updated, purge your CDN cache

v0.0.16

  • a new mandatory environment variable has to be added: PC_XSRF_KEY (which does what it says on the box)
Last updated on
Bunny CDN