System Admin

TinyPixel only requires one environment variable to be set in order to function properly.

  • RAILS_SECRET_KEY_BASE: Set to random, secure string at least 64 characters long. The simplest way to generate a suitable secret key base it to run openssl rand -hex 64 and use the resulting value.

# Other Variables

While not essential, TinyPixel also accepts a few other variables.

  • TP_DOMAIN_NAME: Set to your domain name of choice. This can be a subdomain of an existing domain.

# Allowing User Registration

By default, users cannot register for new accounts. It’s possible to allow registration via the TP_ALLOW_REGISTRAION.

If you’re deploying TinyPixel to the open internet, you can use the system admin to control which email domains are permitted for user registration.

# Email Support

TinyPixel can send emails to users for registration, password resets, and other features. Email support is entirely optional. Presently, two options exists and can be enabled by setting TP_ACTION_MAILER_DELIVERY to one of the following values:

  • "smtp": Generic SMTP support. This value requires the following environment values:
    • TP_SMTP_USER_NAME
    • TP_SMTP_PASSWORD
    • TP_SMTP_ADDRESS
    • TP_SMTP_PORT optional; default to 587
  • "postmark" Support for delivery via Postmark. This value requires the following environment values:
    • TP_POSTMARK_API_TOKEN API token from Postmark

When email delivery is enabled, TP_DOMAIN_NAME must also be set.

# Maxmind DB

TinyPixel will attempt country level IP based geo-location using MaxmindDB.

  1. First Sign Up for GeoLite on Maxmind
  2. Download the country level database file
  3. Copy the database file to the persisted storage location for wherever you are deploying TinyPixel.