Static configuration
Comentario command-line and environment configuration
The static, or start-up, configuration of Comentario server can be set using command-line options or environment variables. Both methods are equivalent, with command-line options taking precedence.
Command-line help
Some command-line options have an equivalent setting in the form of an environment variable. You can get a complete list of supported options and variables by running:
./comentario -h
Usage
comentario [OPTIONS]
Options
Below is a list of available command-line options, with their environment equivalents.
| Option | Description | Environment variable | Default value |
|---|---|---|---|
-h, --help | Show help message (option summary) and exit | ||
--cleanup-timeout=VALUE | Grace period for which to wait before killing idle connections | 10s | |
--graceful-timeout=VALUE | Grace period for which to wait before shutting down the server | 15s | |
--max-header-size=VALUE | Maximum number of bytes to read for request header (not request body) | 1MiB | |
--socket-path=VALUE | The unix socket to listen on | /var/run/comentario.sock | |
--host=VALUE | The IP to listen on | $HOST | localhost |
--port=VALUE | The port to listen on | $PORT | Random port number |
--listen-limit=VALUE | Limits the number of outstanding requests | ||
--keep-alive=VALUE | Sets the TCP keep-alive timeouts on accepted connections | 3m | |
--read-timeout=VALUE | Maximum duration before timing out read of the request | 30s | |
--write-timeout=VALUE | Maximum duration before timing out write of the response | 60s | |
-v, --verbose | Verbose logging (use -vv for debug logging) | ||
--no-color | Disable log colouring | $NO_COLOR | |
--base-url=VALUE | Server’s own base URL | $BASE_URL | http://localhost:8080 |
--base-docs-url=VALUE | Base documentation URL | $BASE_DOCS_URL | https://docs.comentario.app |
--tos-url=VALUE | URL of the Terms of Service page | $TOS_URL | <base docs URL>/en/legal/tos/ |
--privacy-policy-url=VALUE | URL of the Privacy Policy page | $PRIVACY_POLICY_URL | <base docs URL>/en/legal/privacy/ |
--cdn-url=VALUE | Static file CDN URL | $CDN_URL | The base URL |
--email-from=VALUE | ‘From’ address in sent emails | $EMAIL_FROM | SMTP username (smtpServer.username secret value) |
--db-idle-conns=VALUE | Max. number of idle DB connections | $DB_MAX_IDLE_CONNS | 50 |
--disable-xsrf | Disable XSRF protection (for development purposes only) | ||
--enable-swagger-ui | Enable Swagger UI at /api/docs | ||
--static-path=VALUE | Path to static files | $STATIC_PATH | . |
--db-migration-path=VALUE | Path to DB migration files | $DB_MIGRATION_PATH | . |
--db-debug | Enable database debug logging | ||
--template-path=VALUE | Path to template files | $TEMPLATE_PATH | . |
--secrets=VALUE | Path to YAML file with secrets | $SECRETS_FILE | secrets.yaml |
--superuser=VALUE | UUID or email of a user to become a superuser | $SUPERUSER | |
--log-full-ips | Log IP addresses in full | $LOG_FULL_IPS | |
--home-content-url=VALUE | URL of a HTML page to display on homepage | $HOME_CONTENT_URL | |
--gitlab-url=VALUE | Custom GitLab URL for authentication | $GITLAB_URL | |
--no-live-update | Disable live updates via WebSockets | $NO_LIVE_UPDATE | |
--no-page-view-stats | Disable page view statistics gathering and reporting | $NO_PAGE_VIEW_STATS | |
--stats-max-days | Statistics retention and reporting period, in days | $STATS_MAX_DAYS | 30 |
--ws-max-clients=VALUE | Maximum number of WebSocket clients | $WS_MAX_CLIENTS | 10000 |
--e2e | Start server in end-to-end testing mode |
Documentation
Comentario provides numerous links to various docpages in its frontend and the embedded part. The base URL of the documentation site points to Comentario production documentation by default.
Legal pages
Comentario provides users with links to the Terms of Service and the Privacy Policy pages; apart from being required by law in most cases, these pages are often mandatory when configuring federated authentication via an external service.
By default, these point to the Terms of Service and the Privacy Policy on the documentation website, respectively.
If you apply your own policies, you should reconfigure Comentario using the --tos-url and --privacy-policy-url parameters listed above. These pages have to be hosted elsewhere as Comentario provides no means for storing them at the moment.