omairsalman/usersconnect-checkin repository overview

⁠UsersConnect check-in service

The service that UsersConnect⁠ instances call once a day to check for updates. It tells each instance whether a newer version is available, occasionally returns a short notice, and counts how many distinct instances check in each day.

Source code: github.com/omairsalman03/usersconnect-checkin⁠. The README there explains exactly what is received and stored.

⁠Privacy, in short

• Instances send only the product name and their version number
• IP addresses are never stored: they're hashed with a secret that's deleted daily
• The service can count distinct instances per day, but can't follow one instance across days

⁠Running it

It must run behind exactly one reverse proxy that sets X-Forwarded-For, and must not publish its port directly.

services:
  checkin:
    image: omairsalman/usersconnect-checkin:1.1.0
    restart: unless-stopped
    volumes:
      - checkin-data:/app/data
    networks:
      - checkin        # shared with the reverse proxy; no ports published
    read_only: true
    tmpfs:
      - /tmp

networks:
  checkin:
    name: checkin

volumes:
  checkin-data:

The data volume holds a single SQLite database. The image runs as a non-root user and includes a healthcheck.

⁠Tags

• latest: the most recent release
• x.y.z: a specific version. Pin one in production

⁠License

AGPL-3.0-only⁠