Skip to content
This repository has been archived by the owner on Feb 13, 2024. It is now read-only.

Latest commit

 

History

History
91 lines (80 loc) · 3.75 KB

configuration.md

File metadata and controls

91 lines (80 loc) · 3.75 KB
Raw

Configuration

If a configuration value is not recognized, it falls back to the default.

The values are case-insensitive.

Frontend

In bedtime-writer/.env:

  • BACKEND
    • remote (default): use the Cloud Function backend.
    • local: use the local backend.
  • DEBUG_AUTH
    • false (default)
    • true: display helpful info about the user ID on the home screen, and a button to log in / log out easily.
  • DEBUG_AUTH_NO_ACCOUNT_LIMIT
    • false (default)
    • true: do not implement the account creation limit, so many accounts can be created in a short timeframe.
  • DEBUG_PREFERENCES
    • false (default)
    • true: display buttons to reset some preferences.
  • DEBUG_USER_STATS
    • false (default)
    • true: display helpful info about user stats, like the number of generated stories overall and today.
  • DEBUG_STORY
    • false (default)
    • true: display helpful info about story errors, like during story generation or in the library.

Backend

functions/.env is always read. Then, only if using the Firebase emulators, functions/.env.local is read and overrides all previously set values.

In other words, when developing locally, edit functions/.env.local. If you wish to modify the production settings, edit functions/.env (and redeploy).

There is one exception: USE_FIREBASE_EMULATORS, which is only in .env.local and used for the tests and the admin tools.

  • RATE_LIMITER_MAX_REQUESTS_PER_DAY_USER
    • default is 50
    • The maximum number of requests per day and per user.
  • RATE_LIMITER_MAX_REQUESTS_PER_DAY_GLOBAL
    • default is 1000
    • The maximum number of requests per day globally.
  • TEXT_API
    • openai (default): use OpenAI's text generation API. Use the Google Cloud Secret as a key, which can be read from .secret.local when using the Firebase emulators.
    • fake: use the fake text API.
  • FAKE_TEXT_API_NUM_PARTS
    • between 1 and 10 (default)
    • The number of parts provided by the fake text API. A part is ended by two consecutive end-of-lines.
  • FAKE_TEXT_API_NUM_TOKENS_PER_PART
    • between 1 and 200 (default)
    • The number of tokens per part.
  • FAKE_TEXT_API_START_WAIT
    • between 0 and 10000 (default is 1500)
    • The number of ms to wait before starting generating tokens (only for stream).
  • FAKE_TEXT_API_PART_WAIT
    • between 0 and 10000 (default is 1500)
    • The number of ms to wait between each part (only for stream).
  • IMAGE_API
    • openai (default): use OpenAI's image generation API. Use the Google Cloud Secret as a key, which can be read from .secret.local when using the Firebase emulators.
    • fake: use the fake image API.
  • USE_FIREBASE_EMULATORS
    • Only useful in .env.local.
    • If true, the application will use the Firebase emulators. This is required for launching tests (either locally or on the CI) and using the admin tools locally.
    • If unspecified or not true, the tests will fail and the admin tools will write to the remote database.
  • CACHE_RETRY_MAX_TRIES
    • between 1 and 10 (default 3)
    • The maximum number of tries (api calls) the cache manager makes for a given story, as one may fail due to a network or other issues.
  • CACHE_RETRY_TIMEOUT
    • positive integer (default 60000)
    • The timeout in milliseconds after which the cache manager will consider a story generation to be timed out.
  • CACHE_RETRY_DELAY
    • positive integer (default 1000)
    • The delay in milliseconds between the end of the last unsuccessful story generation and the new try.
  • JEST_TIMEOUT
    • positive integer (default 5000)
    • The timeout in milliseconds of Jest tests, is convenient to increase locally in case of a slow computer.