settings.json.template

/*
 * This file must be valid JSON. But comments are allowed
 *
 * Please edit settings.json, not settings.json.template
 *
 * Please note that starting from Etherpad 1.6.0 you can store DB credentials in
 * a separate file (credentials.json).
 *
 *
 * ENVIRONMENT VARIABLE SUBSTITUTION
 * =================================
 *
 * All the configuration values can be read from environment variables using the
 * syntax "${ENV_VAR}" or "${ENV_VAR:default_value}".
 *
 * This is useful, for example, when running in a Docker container.
 *
 * DETAILED RULES:
 *   - If the environment variable is set to the string "true" or "false", the
 *     value becomes Boolean true or false.
 *   - If the environment variable is set to the string "null", the value
 *     becomes null.
 *   - If the environment variable is set to the string "undefined", the setting
 *     is removed entirely, except when used as the member of an array in which
 *     case it becomes null.
 *   - If the environment variable is set to a string representation of a finite
 *     number, the string is converted to that number.
 *   - If the environment variable is set to any other string, including the
 *     empty string, the value is that string.
 *   - If the environment variable is unset and a default value is provided, the
 *     value is as if the environment variable was set to the provided default:
 *       - "${UNSET_VAR:}" becomes the empty string.
 *       - "${UNSET_VAR:foo}" becomes the string "foo".
 *       - "${UNSET_VAR:true}" and "${UNSET_VAR:false}" become true and false.
 *       - "${UNSET_VAR:null}" becomes null.
 *       - "${UNSET_VAR:undefined}" causes the setting to be removed (or be set
 *         to null, if used as a member of an array).
 *   - If the environment variable is unset and no default value is provided,
 *     the value becomes null. THIS BEHAVIOR MAY CHANGE IN A FUTURE VERSION OF
 *     ETHERPAD; if you want the default value to be null, you should explicitly
 *     specify "null" as the default value.
 *
 * EXAMPLE:
 *    "port":     "${PORT:9001}"
 *    "minify":   "${MINIFY}"
 *    "skinName": "${SKIN_NAME:colibris}"
 *
 * Would read the configuration values for those items from the environment
 * variables PORT, MINIFY and SKIN_NAME.
 *
 * If PORT and SKIN_NAME variables were not defined, the default values 9001 and
 * "colibris" would be used.
 * The configuration value "minify", on the other hand, does not have a
 * designated default value. Thus, if the environment variable MINIFY were
 * undefined, "minify" would be null.
 *
 * REMARKS:
 * 1) please note that variable substitution always needs to be quoted.
 *
 *    "port":     9001,            <-- Literal values. When not using
 *    "minify":   false                substitution, only strings must be
 *    "skinName": "colibris"           quoted. Booleans and numbers must not.
 *
 *    "port":     "${PORT:9001}"   <-- CORRECT: if you want to use a variable
 *    "minify":   "${MINIFY:true}"     substitution, put quotes around its name,
 *    "skinName": "${SKIN_NAME}"       even if the required value is a number or
 *                                     a boolean.
 *                                     Etherpad will take care of rewriting it
 *                                     to the proper type if necessary.
 *
 *    "port":     ${PORT:9001}     <-- ERROR: this is not valid json. Quotes
 *    "minify":   ${MINIFY}            around variable names are missing.
 *    "skinName": ${SKIN_NAME}
 *
 * 2) Beware of undefined variables and default values: nulls and empty strings
 *    are different!
 *
 *    This is particularly important for user's passwords (see the relevant
 *    section):
 *
 *    "password": "${PASSW}"  // if PASSW is not defined would result in password === null
 *    "password": "${PASSW:}" // if PASSW is not defined would result in password === ''
 *
 *    If you want to use an empty value (null) as default value for a variable,
 *    simply do not set it, without putting any colons: "${SOFFICE}".
 *
 * 3) if you want to use newlines in the default value of a string parameter,
 *    use "\n" as usual.
 *
 *    "defaultPadText" : "${DEFAULT_PAD_TEXT:Line 1\nLine 2}"
 */
{
  /*
   * Name your instance!
   */
  "title": "Etherpad",

    /*
    * Whether to show recent pads on the homepage or not.
    */
    "showRecentPads": true,

  /*
   * Pathname of the favicon you want to use. If null, the skin's favicon is
   * used if one is provided by the skin, otherwise the default Etherpad favicon
   * is used. If this is a relative path it is interpreted as relative to the
   * Etherpad root directory.
   */
  "favicon": null,

  /*
   * Canonical public origin of this Etherpad instance, e.g.
   * "https://pad.example.com" (no trailing slash, must include scheme).
   *
   * When set, this is used to build absolute URLs in server-rendered output
   * such as the Open Graph / Twitter Card link-preview meta tags (og:url,
   * og:image, ...). When null, those URLs fall back to the request's
   * protocol+Host, which can reflect client-controlled headers if your
   * reverse proxy passes them through unsanitized.
   *
   * Set this in production deployments to lock down the canonical origin
   * advertised in shared link previews.
   */
  "publicURL": null,

  /*
   * Open Graph / Twitter Card metadata, served on the homepage, pad pages and
   * timeslider for nicer previews when a pad URL is shared in chat apps
   * (WhatsApp, Signal, Slack, ...).
   *
   * - description: when set to a non-empty string, this exact text is used as
   *   og:description / twitter:description regardless of the visitor's
   *   negotiated language. Most link-preview crawlers don't send an
   *   Accept-Language header, so without an override they always see the
   *   English fallback. Set this if your instance serves a non-English
   *   audience and you want a fixed blurb in shared previews.
   *
   * Leave description as null to use Etherpad's i18n catalog (key
   * `pad.social.description`), which honours Accept-Language and can be
   * overridden per-language via `customLocaleStrings` further down.
   */
  "socialMeta": {
    "description": null
  },

  /*
   * Skin name.
   *
   * Its value has to be an existing directory under src/static/skins.
   * You can write your own, or use one of the included ones:
   *
   * - "no-skin":  an empty skin (default). This yields the unmodified,
   *               traditional Etherpad theme.
   * - "colibris": the new experimental skin (since Etherpad 1.8), candidate to
   *               become the default in Etherpad 2.0
   */
  "skinName": "colibris",

  /*
   * Skin Variants
   *
   * Use the UI skin variants builder at /p/test#skinvariantsbuilder
   *
   * For the colibris skin only, you can choose how to render the three main
   * containers:
   * - toolbar (top menu with icons)
   * - editor (containing the text of the pad)
   * - background (area outside of editor, mostly visible when using page style)
   *
   * For each of the 3 containers you can choose 4 color combinations:
   * super-light, light, dark, super-dark.
   *
   * For example, to make the toolbar dark, you will include "dark-toolbar" into
   * skinVariants.
   *
   * You can provide multiple skin variants separated by spaces. Default
   * skinVariant is "super-light-toolbar super-light-editor light-background".
   *
   * For the editor container, you can also make it full width by adding
   * "full-width-editor" variant (by default editor is rendered as a page, with
   * a max-width of 900px).
   */
  "skinVariants": "super-light-toolbar super-light-editor light-background",

  /*
   * IP and port which Etherpad should bind at.
   *
   * Binding to a Unix socket is also supported: just use an empty string for
   * the ip, and put the full path to the socket in the port parameter.
   *
   * EXAMPLE USING UNIX SOCKET:
   *    "ip": "",                             // <-- has to be an empty string
   *    "port" : "/somepath/etherpad.socket", // <-- path to a Unix socket
   */
  "ip": "0.0.0.0",
  "port": 9001,

  /*
   * Option to hide/show the settings.json in admin page.
   *
   * Default option is set to true
   */
  "showSettingsInAdminPage": true,

  /*
   * Enable/disable the metrics endpoint.
   *
   * This is used by the monitoring plugins to collect metrics about Etherpad.
   * If you do not use any monitoring plugins, you can disable this.
   */
   "enableMetrics": "${ENABLE_METRICS:true}",

  /*
   * Self-update subsystem.
   * tier: "off" | "notify" | "manual" | "auto" | "autonomous"
   * Default "notify" shows a banner when an update is available. "off" disables the version check.
   */
  "updates": {
    "tier": "${UPDATES_TIER:notify}",
    "source": "github",
    "channel": "stable",
    "installMethod": "auto",
    "checkIntervalHours": 6,
    "githubRepo": "ether/etherpad",
    /*
     * Lock /admin/update/status to authenticated admins. Default false keeps the
     * endpoint open (the version is already public via /health). Set true to hide
     * full update detail from non-admins without turning the updater off.
     */
    "requireAdminForStatus": false,
    /*
     * Tier 2+ knobs. Only meaningful at tier "manual" or higher.
     * - preApplyGraceMinutes: tier 3 only — grace minutes between detecting a new
     *     release and starting the drain. Clamped to [0, 7*24*60] (one week).
     *     Default 0 applies immediately when allowed; raise it to give admins
     *     time to cancel via /admin/update.
     * - drainSeconds: how long to broadcast "restart imminent" before exiting.
     * - rollbackHealthCheckSeconds: window after restart for /health to come up.
     * - diskSpaceMinMB: pre-flight refuses to start an update without this much free.
     * - requireSignature: refuse updates whose tag isn't signed by a trusted key.
     * - trustedKeysPath: override the keyring location passed to git verify-tag (GNUPGHOME).
     * - maintenanceWindow: tier 4 only — nightly window during which the scheduler
     *     may fire. Null = tier 4 disabled (with tier="autonomous", the policy
     *     downgrades to canAuto). Shape: {"start":"HH:MM","end":"HH:MM","tz":"local"|"utc"}.
     *     `end` is exclusive; `end < start` denotes a cross-midnight window.
     */
    "preApplyGraceMinutes": 0,
    "drainSeconds": 60,
    "rollbackHealthCheckSeconds": 60,
    "diskSpaceMinMB": 500,
    "requireSignature": false,
    "trustedKeysPath": null,
    "maintenanceWindow": null
  },

  /*
   * Admin OpenAPI document at /admin/openapi.json.
   *
   * Disabled by default per Etherpad's "new features behind a flag, off by
   * default" policy. The admin UI's typed client embeds the spec at build
   * time, so the runtime route is only useful for third-party tooling
   * (Postman, swagger-ui, downstream clients). Set `enabled: true` to mount
   * the route; the SPA at /admin/ continues to serve normally either way.
   */
  "adminOpenAPI": {
    "enabled": false
  },

  /*
   * Contact address for admin notifications (updates, security advisories, future features).
   * Set to null to disable outbound mail from the updater.
   */
  "adminEmail": null,

  /*
   * SMTP transport for outbound admin notifications. host=null keeps the
   * legacy log-only behaviour (Notifier still dedupes; nothing leaves the
   * box). Set host+from (and optionally auth) to deliver via nodemailer.
   * The dependency is lazy-loaded so installs without mail.host pay no
   * runtime cost.
   *
   *   "mail": {
   *     "host": "smtp.example.com",
   *     "port": 587,
   *     "secure": false,
   *     "from": "etherpad@example.com",
   *     "auth": { "user": "smtp-user", "pass": "smtp-pass" }
   *   }
   */
  "mail": {
    "host": null,
    "port": 587,
    "secure": false,
    "from": null,
    "auth": null
  },

  /*
   * Settings for cleanup of pads
   */
  "cleanup": {
    "enabled": false,
    "keepRevisions": 5
  },

  /*
   * Pad retention: delete pads nobody has edited for `deleteAfterDays` days.
   *
   * Deletion is permanent: revisions, chat and the read-only link all go, and
   * no copy is kept. Export anything you need first.
   *
   * enabled            - off by default.
   * dryRun             - while true, only log the pads that would be deleted.
   *                      Check the log, then set it to false.
   * deleteAfterDays    - days without an edit before a pad is deleted. A pad
   *                      that was never edited counts from when it was created.
   * warnBeforeDays     - show a notice in pads this close to deletion
   *                      (0 = never).
   * sweepIntervalHours - how often to check every pad. Pads are also checked
   *                      when someone opens them.
   * excludeGroupPads   - leave group pads (g.xxx$name) alone. Integrations such
   *                      as Nextcloud and Moodle create these and keep their own
   *                      links to them.
   * excludePattern     - regex of pad IDs to keep, e.g. "^(welcome|rules)$".
   */
  "padRetention": {
    "enabled": false,
    "dryRun": true,
    "deleteAfterDays": 365,
    "warnBeforeDays": 7,
    "sweepIntervalHours": 1,
    "excludeGroupPads": true,
    "excludePattern": null
  },

  /*
   * GDPR Art. 17 author erasure REST endpoint (anonymizeAuthor).
   *
   * Disabled by default — enable only when an operator process exists to
   * authorise erasure requests. While disabled, calls to anonymizeAuthor
   * return an apierror and the AuthorManager helper is not exposed via
   * the public API.
   */
  "gdprAuthorErasure": {
    "enabled": false
  },

  /*
   * Node native SSL support
   *
   * This is disabled by default.
   * Make sure to have the minimum and correct file access permissions set so
   * that the Etherpad server can access them
   */

  /*
  "ssl" : {
            "key"  : "/path-to-your/epl-server.key",
            "cert" : "/path-to-your/epl-server.crt",
            "ca": ["/path-to-your/epl-intermediate-cert1.crt", "/path-to-your/epl-intermediate-cert2.crt"]
          },
  */

  /*
   * The type of the database.
   *
   * You can choose between many DB drivers, for example: dirty, postgres,
   * sqlite, mysql.
   *
   * You shouldn't use "dirty" for for anything else than testing or
   * development.
   *
   *
   * Database specific settings are dependent on dbType, and go in dbSettings.
   * Remember that since Etherpad 1.6.0 you can also store this information in
   * credentials.json.
   *
   * For a complete list of the supported drivers, please refer to:
   * https://www.npmjs.com/package/ueberdb2
   */

  "dbType": "dirty",
  "dbSettings": {
    "filename": "var/dirty.db"
  },

  /*
   * An Example of MySQL Configuration (commented out).
   *
   * See: https://github.com/ether/etherpad/wiki/How-to-use-Etherpad-Lite-with-MySQL
   */

  /*
  "dbType" : "mysql",
  "dbSettings" : {
    "user":     "etherpaduser",
    "host":     "localhost",
    "port":     3306,
    "password": "PASSWORD",
    "database": "etherpad_lite_db",
    "charset":  "utf8mb4"
  },
  */

  /*
   * The default text of a pad
   */
  "defaultPadText" : "Welcome to Etherpad!\n\nThis pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!\n\nGet involved with Etherpad at https:\/\/etherpad.org\n",

  /*
   * Default Pad behavior.
   *
   * Change them if you want to override.
   */
  "padOptions": {
    "noColors":         false,
    "showControls":     true,
    "showChat":         true,
    "showLineNumbers":  true,
    "useMonospaceFont": false,
    "userName":         null,
    "userColor":        null,
    "rtl":              false,
    "alwaysShowChat":   false,
    "chatAndUsers":     false,
    "lang":             null,
    /*
     * When true (default), each author's caret/background color fades toward white
     * as the author goes inactive. Set to false if users pick light colors and the
     * faded variants become visually indistinguishable.
     */
    "fadeInactiveAuthorColors": true,
    /*
     * Clamp author background colors to a WCAG 2.1 AA contrast ratio (4.5:1)
     * against the rendered text colour at render time. The author's stored
     * colour is not modified — only the displayed shade is adjusted. Set to
     * false to render exact author colours regardless of contrast.
     */
    "enforceReadableAuthorColors": true
  },

  /*
   * Pad Shortcut Keys
   */
  "padShortcutEnabled" : {
    "altF9":     true, /* focus on the File Menu and/or editbar */
    "altC":      true, /* focus on the Chat window */
    "cmdShift2": true, /* shows a gritter popup showing a line author */
    "delete":    true,
    "return":    true,
    "esc":       true, /* in mozilla versions 14-19 avoid reconnecting pad */
    "cmdS":      true, /* save a revision */
    "tab":       true, /* indent */
    "cmdZ":      true, /* undo/redo */
    "cmdY":      true, /* redo */
    "cmdI":      true, /* italic */
    "cmdB":      true, /* bold */
    "cmdU":      true, /* underline */
    "cmd5":      true, /* strike through */
    "cmdShiftL": true, /* unordered list */
    "cmdShiftN": true, /* ordered list */
    "cmdShift1": true, /* ordered list */
    "cmdShiftC": true, /* clear authorship */
    "cmdH":      true, /* backspace */
    "ctrlHome":  true, /* scroll to top of pad */
    "pageUp":    true,
    "pageDown":  true
  },

  /*
   * Enables the use of a different server. We have a different one that syncs changes from the original server.
   * It is hosted on GitHub and should not be blocked by many firewalls.
   *  https://etherpad.org/ep_infos
   */

  "updateServer": "${UPDATE_SERVER:https://etherpad.org/ep_infos}",

  /*
   * Outbound network calls. See PRIVACY.md for what each one sends.
   *  - updateCheck=false  : disables hourly version check (UpdateCheck.ts)
   *  - pluginCatalog=false: disables admin plugin browser
   *                        (manual install-by-name via CLI still works)
   * Air-gapped / firewalled deployments should set both PRIVACY_UPDATE_CHECK and
   * PRIVACY_PLUGIN_CATALOG to false (or UPDATES_TIER=off, which covers the version check).
   */
  "privacy": {
    "updateCheck": "${PRIVACY_UPDATE_CHECK:true}",
    "pluginCatalog": "${PRIVACY_PLUGIN_CATALOG:true}"
  },

  /*
   * Should we suppress errors from being visible in the default Pad Text?
   */
  "suppressErrorsInPadText": false,

  /*
   * If this option is enabled, a user must have a session to access pads.
   * This effectively allows only group pads to be accessed.
   */
  "requireSession": false,

  /*
   * Users may edit pads but not create new ones.
   *
   * Pad creation is only via the API.
   * This applies both to group pads and regular pads.
   */
  "editOnly": false,

  /*
   * If true, all css & js will be minified before sending to the client.
   *
   * This will improve the loading performance massively, but makes it difficult
   * to debug the javascript/css
   */
  "minify": true,

  /*
   * How long may clients use served javascript code (in seconds)?
   *
   * Not setting this may cause problems during deployment.
   * Set to 0 to disable caching.
   */
  "maxAge": 21600, // 60 * 60 * 6 = 6 hours

  /*
   * Absolute path to the soffice (LibreOffice) executable.
   *
   * When configured, soffice handles all advanced office-format
   * conversions (docx, pdf, odt, doc, rtf — both directions). When
   * null, Etherpad falls back to pure-JS in-process converters
   * that handle docx export, pdf export, and docx import natively.
   * odt/doc/rtf export and pdf import still require soffice.
   */
  "soffice": null,

  /*
   * When true (the default), the "Microsoft Word" export button
   * downloads a .docx file -- via soffice if it's configured, or via
   * the in-process html-to-docx converter otherwise. Set to false to
   * revert to legacy .doc output (.doc still requires soffice).
   */
  "docxExport": true,

  /*
   * Extra fonts the built-in PDF exporter may embed.
   *
   * When LibreOffice ("soffice") is not configured, PDF export is rendered
   * in-process. That renderer only has the PDF standard fonts available, so
   * it maps every CSS font-family onto Helvetica (sans-serif), Times (serif)
   * or Courier (monospace). Use this setting to give it real font files for
   * families that need their exact face.
   *
   * Keys are CSS font-family names as they appear in the pad (matching is
   * case-insensitive and treats "-", "_" and spaces alike, so "Times New
   * Roman" and "times-new-roman" are the same key). Values are either a path
   * to a single TTF/OTF, or an object with per-variant paths. Relative paths
   * resolve against the Etherpad root. "fallback" picks the built-in family
   * ("helvetica", "times" or "courier") used if a file is missing.
   *
   * Etherpad ships no fonts for this; point it at fonts you are licensed to
   * embed.
   *
   *   "exportPdfFonts": {
   *     "Garamond": {
   *       "regular":    "/usr/share/fonts/truetype/EBGaramond-Regular.ttf",
   *       "bold":       "/usr/share/fonts/truetype/EBGaramond-Bold.ttf",
   *       "italic":     "/usr/share/fonts/truetype/EBGaramond-Italic.ttf",
   *       "boldItalic": "/usr/share/fonts/truetype/EBGaramond-BoldItalic.ttf",
   *       "fallback":   "times"
   *     },
   *     "Inter": "/usr/share/fonts/truetype/Inter-Regular.ttf"
   *   }
   */
  "exportPdfFonts": {},

  /*
   * txt, doc, docx, rtf, odt, html & htm
   */
  "allowUnknownFileEnds": true,

  /*
   * This setting is used if you require authentication of all users.
   *
   * Note: "/admin" always requires authentication.
   */
  "requireAuthentication": false,

  /*
   * Require authorization by a module, or a user with is_admin set, see below.
   */
  "requireAuthorization": false,

  /*
   * When you use NGINX or another proxy/load-balancer set this to true.
   *
   * This is especially necessary when the reverse proxy performs SSL
   * termination, otherwise the cookies will not have the "secure" flag.
   *
   * The other effect will be that the logs will contain the real client's IP,
   * instead of the reverse proxy's IP.
   *
   * Setting this to `true` also makes Etherpad honor two standard URL-path-
   * prefix headers from upstream proxies:
   *   - `X-Forwarded-Prefix` (HAProxy / Traefik convention)
   *   - `X-Ingress-Path` (Home Assistant supervisor ingress)
   *
   * Both are sanitised before use. Etherpad's own `x-proxy-path` header is
   * honored regardless of this setting; the operator is presumed to have
   * configured their proxy intentionally when sending the custom header.
   */
  "trustProxy": false,

  /*
   * Settings controlling the session cookie issued by Etherpad.
   */
  "cookie": {
    /*
     * Prefix for all cookie names set by Etherpad. Set this to "ep_" or similar
     * if Etherpad's cookie names (token, sessionID, etc.) conflict with those
     * of another application on the same domain. Default: "" (no prefix).
     */
    // "prefix": "ep_",

    /*
     * How often (in milliseconds) the key used to sign the express_sid cookie
     * should be rotated. Long rotation intervals reduce signature verification
     * overhead (because there are fewer historical keys to check) and database
     * load (fewer historical keys to store, and less frequent queries to
     * get/update the keys). Short rotation intervals are slightly more secure.
     *
     * Multiple Etherpad processes sharing the same database (table) is
     * supported as long as the clock sync error is significantly less than this
     * value.
     *
     * Key rotation can be disabled (not recommended) by setting this to 0 or
     * null, or by disabling session expiration (see sessionLifetime).
     */
    "keyRotationInterval": 86400000, // = 1d * 24h/d * 60m/h * 60s/m * 1000ms/s

    /*
     * Value of the SameSite cookie property. "Lax" is recommended unless
     * Etherpad will be embedded in an iframe from another site, in which case
     * this must be set to "None". Note: "None" will not work (the browser will
     * not send the cookie to Etherpad) unless https is used to access Etherpad
     * (either directly or via a reverse proxy with "trustProxy" set to true).
     *
     * "Strict" is not recommended because it has few security benefits but
     * significant usability drawbacks vs. "Lax". See
     * https://stackoverflow.com/q/41841880 for discussion.
     */
    "sameSite": "Lax",

    /*
     * How long (in milliseconds) after navigating away from Etherpad before the
     * user is required to log in again. (The express_sid cookie is set to
     * expire at time now + sessionLifetime when first created, and its
     * expiration time is periodically refreshed to a new now + sessionLifetime
     * value.) If requireAuthentication is false then this value does not really
     * matter.
     *
     * The "best" value depends on your users' usage patterns and the amount of
     * convenience you desire. A long lifetime is more convenient (users won't
     * have to log back in as often) but has some drawbacks:
     *   - It increases the amount of state kept in the database.
     *   - It might weaken security somewhat: The cookie expiration is refreshed
     *     indefinitely without consulting authentication or authorization
     *     hooks, so once a user has accessed a pad, the user can continue to
     *     use the pad until the user leaves for longer than sessionLifetime.
     *   - More historical keys (sessionLifetime / keyRotationInterval) must be
     *     checked when verifying signatures.
     *
     * Session lifetime can be set to infinity (not recommended) by setting this
     * to null or 0. Note that if the session does not expire, most browsers
     * will delete the cookie when the browser exits, but a session record is
     * kept in the database forever.
     */
    "sessionLifetime": 864000000, // = 10d * 24h/d * 60m/h * 60s/m * 1000ms/s

    /*
     * How long (in milliseconds) before the expiration time of an active user's
     * session is refreshed (to now + sessionLifetime). This setting affects the
     * following:
     *   - How often a new session expiration time will be written to the
     *     database.
     *   - How often each user's browser will ping the Etherpad server to
     *     refresh the expiration time of the session cookie.
     *
     * High values reduce the load on the database and the load from browsers,
     * but can shorten the effective session lifetime if Etherpad is restarted
     * or the user navigates away.
     *
     * Automatic session refreshes can be disabled (not recommended) by setting
     * this to null.
     */
    "sessionRefreshInterval": 86400000, // = 1d * 24h/d * 60m/h * 60s/m * 1000ms/s

    /*
     * Whether to periodically clean up expired and stale sessions from the
     * database. Set to false to disable. Default: true.
     *
     * Cleanup runs hourly and walks the sessionstorage:* keyspace in 500-key
     * pages so very large session tables don't pin the keys in memory all at
     * once (see https://github.com/ether/etherpad/issues/7830). A single run
     * is capped at 10 minutes; if your DB is so large the budget is reached,
     * a warning is logged and the next scheduled run continues.
     */
    "sessionCleanup": true
  },

  /*
   * Controls what Etherpad writes to its logs about client IP addresses.
   *
   *   "anonymous" — replace every IP with the literal "ANONYMOUS" (default)
   *   "truncated" — zero the last octet of IPv4 (1.2.3.0); truncate IPv6 to
   *                 the first /48 (2001:db8:1::). Keeps aggregate visibility.
   *   "full"      — log the full IP (document a legal basis + retention
   *                 policy before choosing this).
   *
   * In-memory rate-limiting always keys on the raw IP and is never persisted.
   */
  "ipLogging": "anonymous",

  /*
   * Deprecated — use `ipLogging` above instead. Still honoured for one release
   * cycle: `true` maps to `ipLogging: "anonymous"`, `false` maps to `"full"`.
   * A deprecation warning is emitted when only this legacy setting is present.
   */
  "disableIPlogging": false,

  /*
   * Allow any user who can edit a pad to delete it without the one-time pad
   * deletion token. If false, only the original creator's author cookie or the
   * deletion token can delete the pad.
   */
  "allowPadDeletionByAllUsers": false,

  /*
   * Do not show the one-time "Save your pad deletion token" modal to the pad
   * creator. Unlike allowPadDeletionByAllUsers this does NOT let other users
   * delete the pad: the token is still issued and can still be used to delete
   * the pad from another device, it is simply not displayed on arrival. Useful
   * when the modal confuses users who will never need the token (issue #7996).
   */
  "suppressPadDeletionTokenModal": false,

  /*
   * Time (in seconds) to automatically reconnect pad when a "Force reconnect"
   * message is shown to user.
   *
   * Set to 0 to disable automatic reconnection.
   */
  "automaticReconnectionTimeout": 0,

  /*
   * By default, when caret is moved out of viewport, it scrolls the minimum
   * height needed to make this line visible.
   */
  "scrollWhenFocusLineIsOutOfViewport": {

    /*
     * Percentage of viewport height to be additionally scrolled.
     *
     * E.g.: use "percentage.editionAboveViewport": 0.5, to place caret line in
     *       the middle of viewport, when user edits a line above of the
     *       viewport
     *
     * Set to 0 to disable extra scrolling
     */
    "percentage": {
      "editionAboveViewport": 0,
      "editionBelowViewport": 0
    },

    /*
     * Time (in milliseconds) used to animate the scroll transition.
     * Set to 0 to disable animation
     */
    "duration": 0,

    /*
     * Flag to control if it should scroll when user places the caret in the
     * last line of the viewport
     */
    "scrollWhenCaretIsInTheLastLineOfViewport": false,

    /*
     * Percentage of viewport height to be additionally scrolled when user
     * presses arrow up in the line of the top of the viewport.
     *
     * Set to 0 to let the scroll to be handled as default by Etherpad
     */
    "percentageToScrollWhenUserPressesArrowUp": 0
  },

  /*
   * User accounts. These accounts are used by:
   *   - default HTTP basic authentication if no plugin handles authentication
   *   - some but not all authentication plugins
   *   - some but not all authorization plugins
   *
   * User properties:
   *   - password: The user's password. Some authentication plugins will ignore
   *     this.
   *   - is_admin: true gives access to /admin. Defaults to false. If you do not
   *     uncomment this, /admin will not be available!
   *   - readOnly: If true, this user will not be able to create new pads or
   *     modify existing pads. Defaults to false.
   *   - canCreate: If this is true and readOnly is false, this user can create
   *     new pads. Defaults to true.
   *
   * Authentication and authorization plugins may define additional properties.
   *
   * WARNING: passwords should not be stored in plaintext in this file.
   *          If you want to mitigate this, please install ep_hash_auth and
   *          follow the section "secure your installation" in README.md
   */

  /*
  "users": {
    "admin": {
      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
      // 2) please note that if password is null, the user will not be created
      "password": "changeme1",
      "is_admin": true
    },
    "user": {
      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
      // 2) please note that if password is null, the user will not be created
      "password": "changeme1",
      "is_admin": false
    }
  },
  */

  /*
   * Restrict socket.io transport methods
   */
  "socketTransportProtocols" : ["websocket", "polling"],

  "socketIo": {
    /*
     * Maximum permitted client message size (in bytes). This controls the
     * maximum single-message size for socket.io and directly affects large
     * paste operations. All messages from clients that are larger than this
     * will be rejected. Large values make it possible to paste large amounts
     * of text, and plugins may require a larger value to work properly, but
     * increasing the value increases susceptibility to denial of service
     * attacks (malicious clients can exhaust memory).
     *
     * 1MB accommodates large pastes while still preventing abuse.
     */
    "maxHttpBufferSize": 1000000
  },

  /*
   * Allow Load Testing tools to hit the Etherpad Instance.
   *
   * WARNING: this will disable security on the instance.
   */
  "loadTest": false,

  /**
  * Disable dump of objects preventing a clean exit
  */
  "dumpOnUncleanExit": false,

  /*
   * Disable indentation on new line when previous line ends with some special
   * chars (':', '[', '(', '{')
   */

  /*
  "indentationOnNewLine": false,
  */

  /*
   * From Etherpad 1.8.3 onwards, import and export of pads is always rate
   * limited.
   *
   * The default is to allow at most 10 requests per IP in a 90 seconds window.
   * After that the import/export request is rejected.
   *
   * See https://github.com/nfriedly/express-rate-limit for more options
   */
  "importExportRateLimiting": {
    // duration of the rate limit window (milliseconds)
    "windowMs": 90000,

    // maximum number of requests per IP to allow during the rate limit window
    "max": 10
  },

  /*
   * From Etherpad 1.8.3 onwards, the maximum allowed size for a single imported
   * file is always bounded.
   *
   * File size is specified in bytes. Default is 50 MB.
   */
  "importMaxFileSize": 52428800, // 50 * 1024 * 1024

  /*
    The authentication method used by the server.
    The default value is sso
    If you want to use the old authentication system, change this to apikey
   */
  "authenticationMethod": "${AUTHENTICATION_METHOD:sso}",

    /**
    * Allow setting dark mode for the enduser. This is so if the user has preferred dark mode in their browser, Etherpad will respect that.
    * Of course this overrides all the skin variants and the skinName set by the administrator.
    **/
    "enableDarkMode": "${ENABLE_DARK_MODE:true}",

    /**
    * Enable creator-owned Pad-wide Settings and new-pad default seeding from My View.
    * The pad creator (revision-0 author) gets the "Pad-wide Settings" section,
    * which lets them set defaults and optionally enforce them for other users.
    * Other users see only "User Settings" (their own view options).
    * Set to false to revert to the legacy single-settings behavior.
    **/
    "enablePadWideSettings": "${ENABLE_PAD_WIDE_SETTINGS:true}",

  /*
    * Allow plugins to ride the existing padoptions COLLABROOM rail by
    * accepting pad-wide values under plugin-namespaced keys matching
    * /^ep_[a-z0-9_]+$/ (e.g. ep_table_of_contents). Values are validated
    * (JSON-safe, 64 KB per key, 256 KB total) and broadcast to every
    * connected client just like native pad-wide toggles. Enabled by
    * default; set to false to lock plugins out of pad-wide state. See
    * doc/plugins.md.
    **/
    "enablePluginPadOptions": "${ENABLE_PLUGIN_PAD_OPTIONS:true}",

  /*
   * Optional privacy banner shown once the pad loads. Disabled by default.
   *
   *   enabled      — toggle the feature
   *   title        — plain-text heading (HTML is escaped)
   *   body         — plain-text body; newlines become paragraph breaks
   *   learnMoreUrl — optional URL rendered as a "Learn more" link
   *   dismissal    — "dismissible" (close button, stored in localStorage)
   *                  or "sticky"  (always shown, no close button)
   */
  "privacyBanner": {
    "enabled": false,
    "title": "Privacy notice",
    "body": "This instance processes pad content on our servers. See the linked policy for retention and how to request erasure.",
    "learnMoreUrl": null,
    "dismissal": "dismissible"
  },

  /*
   * From Etherpad 1.8.5 onwards, when Etherpad is in production mode commits from individual users are rate limited
   *
   * The default is to allow at most 10 changes per IP in a 1 second window.
   * After that the change is rejected.
   *
   * See https://github.com/animir/node-rate-limiter-flexible/wiki/Overall-example#websocket-single-connection-prevent-flooding for more options
   */
  "commitRateLimiting": {
    // duration of the rate limit window (seconds)
    "duration": 1,

    // maximum number of changes per IP to allow during the rate limit window
    "points": 10
  },

  /*
   * Toolbar buttons configuration.
   *
   * Uncomment to customize.
   */

  /*
  "toolbar": {
    "left": [
      ["bold", "italic", "underline", "strikethrough"],
      ["orderedlist", "unorderedlist", "indent", "outdent"],
      ["undo", "redo"],
      ["clearauthorship"]
    ],
    "right": [
      ["importexport", "timeslider", "savedrevision"],
      ["settings", "embed", "home"],
      ["showusers"]
    ],
    "timeslider": [
      ["timeslider_export", "timeslider_returnToPad"]
    ]
  },
  */

  /*
   * Expose Etherpad version in the web interface and in the Server http header.
   *
   * Do not enable on production machines.
   */
  "exposeVersion": false,

  /*
   * The log level we are using.
   *
   * Valid values: DEBUG, INFO, WARN, ERROR
   */
  "loglevel": "INFO",

    /*
   * The log layout type to use.
   *
   * Valid values: basic, colored
   */
   "logLayoutType": "colored",

  /*
   * Override any strings found in locale directories.
   *
   * Format: { "<lang>": { "<key>": "<text>", ... }, ... }
   * Example, per-language Open Graph description for link previews:
   *   "customLocaleStrings": {
   *     "en": { "pad.social.description": "Our team's collaborative pads." },
   *     "de": { "pad.social.description": "Kollaborative Notizblöcke." }
   *   }
   * For a single description regardless of language, prefer
   * `socialMeta.description` above — link-preview crawlers usually don't
   * send Accept-Language and otherwise hit the English fallback.
   */
  "customLocaleStrings": {},

  /* Disable Admin UI tests */
  "enableAdminUITests": false,

  /*
   * Enable/Disable case-insensitive pad names.
   */
  "lowerCasePadIds": false,

  "sso": {
    "issuer": "${SSO_ISSUER:http://localhost:9001}",
      /*
       * Signing keys for the embedded OIDC provider's cookies. Leave empty and
       * Etherpad derives a secret key from the persisted session secret
       * (SESSIONKEY.txt), which is stable across restarts and shared across
       * horizontally-scaled pods. Set an explicit ordered array to rotate: the
       * first key signs, the rest are still accepted for verify.
       */
      "cookieKeys": ["${OIDC_COOKIE_KEY:}"],
      "clients": [
        {
          "client_id": "${ADMIN_CLIENT:admin_client}",
          "client_secret": "${ADMIN_SECRET:admin}",
          "grant_types": ["authorization_code"],
          "response_types": ["code"],
          "redirect_uris": ["${ADMIN_REDIRECT:http://localhost:9001/admin/}"]
        },
        {
          "client_id": "${USER_CLIENT:user_client}",
          "client_secret": "${USER_SECRET:user}",
          "grant_types": ["authorization_code"],
          "response_types": ["code"],
          "redirect_uris": ["${USER_REDIRECT:http://localhost:9001/}"]
        }
      ]
    }

    /* Set the time to live for the tokens
         This is the time of seconds a user is logged into Etherpad
    "ttl":  {
        "AccessToken": 3600,
        "AuthorizationCode": 600,
        "ClientCredentials": 3600,
        "IdToken": 3600,
        "RefreshToken": 86400
    }
    */
}