.env.example 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. # Database
  2. DATABASE_URL="postgresql://torqvoice:torqvoice@db:5432/torqvoice"
  3. # Docker only (docker-compose.yml): the password of the `db` service, put into
  4. # the app's DATABASE_URL there as it is, so letters and digits only
  5. # (`openssl rand -hex 24`); a `/`, `@`, `#` or `%` breaks the URL. Set it
  6. # before the first start; unset, it is `torqvoice`, and the port is bound to
  7. # 127.0.0.1 so nothing outside the host can try it.
  8. # POSTGRES_PASSWORD=""
  9. # Authentication (generate with: openssl rand -hex 32)
  10. BETTER_AUTH_SECRET="your-secret-here"
  11. # App URL (used by both the app and Better Auth)
  12. NEXT_PUBLIC_APP_URL="http://localhost:3000"
  13. # Where uploaded files and the app's other data live. Unset, it is `data`
  14. # beside the app, which is where everything has always been written; set it to
  15. # put uploads on a disk with room on them. Files already written to the old
  16. # place keep being found, so this can be turned on at any time.
  17. #
  18. # In Docker, move the volume with it: the compose file mounts
  19. # `/app/data/uploads`, and a DATA_ROOT pointing anywhere else would write into
  20. # the container instead, where a redeploy loses it.
  21. # DATA_ROOT="/var/lib/torqvoice"
  22. # How much the server says in its log (`docker logs`): error, warn, info or
  23. # debug; info unless set. At info, recurring jobs (backups, integration jobs,
  24. # scheduled messages) print an hourly total instead of a line per run, and
  25. # every failure still prints at once. Set debug to see each run.
  26. # LOG_LEVEL=info
  27. # Scheduled backups (Settings → Integrations). Both are optional.
  28. # The Docker image ships restic at /usr/local/bin/restic. An install that runs
  29. # outside Docker points this at its own restic binary; unset, `restic` is
  30. # looked up on the PATH.
  31. # RESTIC_BIN="/usr/local/bin/restic"
  32. # Where the Local folder destination keeps its repositories, for self-hosted
  33. # installs only. Unset, it is `backups` under DATA_ROOT, which the compose file
  34. # mounts as a volume of its own. A folder on another disk is a better place.
  35. # BACKUP_LOCAL_ROOT="/mnt/backup-disk/torqvoice"
  36. # The largest backup data file a restore or the restore point explorer reads
  37. # into memory, in MiB; 128 unless set. Parsed, a file takes three to five times
  38. # its size in heap, so raise this only on a server with the memory for it. A
  39. # backup whose data file is over the limit still runs, and says so in its log.
  40. # BACKUP_MAX_DATA_FILE_MB=128
  41. # Set to true only when Cloudflare proxies every request AND the origin
  42. # refuses traffic that did not come through it (Cloudflare IP ranges allowed
  43. # at the firewall or in nginx).
  44. #
  45. # Behind Cloudflare this is required, not optional: the proxy sets X-Real-IP
  46. # from the connection it sees, which is a Cloudflare edge address shared by
  47. # thousands of visitors, so leaving this off collapses everyone into a handful
  48. # of rate-limit buckets and real users start getting 429s.
  49. #
  50. # Without the origin lock it is worse than useless, because cf-connecting-ip is
  51. # then just a header anyone reaching the box directly can write for themselves.
  52. TRUST_CF_CONNECTING_IP=false
  53. # Integrations (Settings → Integrations)
  54. # Key that seals third-party tokens at rest (generate with: openssl rand -hex 32).
  55. # Without it the key is derived from BETTER_AUTH_SECRET, with a warning at startup.
  56. INTEGRATIONS_ENCRYPTION_KEY=""
  57. # OAuth apps the platform registers with each provider. Leave empty on a
  58. # self-hosted install to have each workshop enter its own app credentials.
  59. GOOGLE_INTEGRATION_CLIENT_ID=""
  60. GOOGLE_INTEGRATION_CLIENT_SECRET=""
  61. MICROSOFT_INTEGRATION_CLIENT_ID=""
  62. MICROSOFT_INTEGRATION_CLIENT_SECRET=""
  63. ZOOM_INTEGRATION_CLIENT_ID=""
  64. ZOOM_INTEGRATION_CLIENT_SECRET=""
  65. # Intuit development keys reach sandbox companies, production keys live ones;
  66. # the connector works out which it was given.
  67. QUICKBOOKS_INTEGRATION_CLIENT_ID=""
  68. QUICKBOOKS_INTEGRATION_CLIENT_SECRET=""
  69. # The app registered in Fiken under Rediger konto, API. While it is in
  70. # development only the Fiken users listed on the app can connect.
  71. FIKEN_INTEGRATION_CLIENT_ID=""
  72. FIKEN_INTEGRATION_CLIENT_SECRET=""
  73. # A Web app registered at developer.xero.com under My Apps. The webhook key is
  74. # on the app's Webhooks page, pointed at <app url>/api/webhooks/xero; without
  75. # it payments recorded in Xero arrive with the half-hourly pull instead.
  76. XERO_INTEGRATION_CLIENT_ID=""
  77. XERO_INTEGRATION_CLIENT_SECRET=""
  78. XERO_INTEGRATION_WEBHOOK_KEY=""
  79. ZOHO_BOOKS_INTEGRATION_CLIENT_ID=""
  80. ZOHO_BOOKS_INTEGRATION_CLIENT_SECRET=""
  81. # One Open Labor Project key for every workshop on this install. Unset, each
  82. # workshop pastes its own key when it connects the labor guide. Set, a
  83. # workshop that leaves its key empty uses this one, lookups made with it are
  84. # shared between workshops, and each workshop gets the daily number of
  85. # lookups below (40 unless set).
  86. # OPEN_LABOR_PROJECT_API_KEY=""
  87. # REPAIR_DATA_SERVER_KEY_DAILY_LOOKUPS=40
  88. # Torqvoice Codes, the fault code service Torqvoice runs (cloud only: a
  89. # self-hosted install shows the card greyed out and cannot connect it).
  90. # Where the service answers, never typed by a workshop; in the dev
  91. # containers it is http://torqvoice-codes:8090 (http://localhost:8090 from
  92. # the host).
  93. # TORQVOICE_CODES_URL="http://torqvoice-codes:8090"
  94. # A key for every workshop, with read:codes, read:fixes and write:fixes
  95. # (sharing fixes needs the last two). Set, every workshop is connected with
  96. # it on its first page load, sees no key field, and stays disconnected if it
  97. # disconnects. Unset, the connect page asks for a key.
  98. # TORQVOICE_CODES_API_TOKEN=""
  99. # Development only: cloud-only connectors to show on a self-hosted dev
  100. # machine without putting the app in cloud mode. Ignored by any production
  101. # build (it needs `next dev`).
  102. # TORQVOICE_DEV_CLOUD_CONNECTORS="torqvoice-codes"