|
33 | 33 |
|
34 | 34 | ############################################################################### |
35 | 35 | # Allow insecure (invalid, expired TLS/SSL certificates) connections. |
36 | | -# |
| 36 | +# |
37 | 37 | # [IMPORTANT] |
38 | 38 | # ==== |
39 | 39 | # We strongly recommend keeping this value set to false except for local development or demos. |
|
203 | 203 |
|
204 | 204 | ############################################################################### |
205 | 205 | # Password for the web console endpoint. When running in dev environment, password is not required. |
206 | | -# |
| 206 | +# |
207 | 207 | # Corteza intentionally sets default password to random chars to prevent security incidents. |
208 | 208 | # Type: string |
209 | 209 | # Default: <no value> |
|
290 | 290 | # Email sending |
291 | 291 | # |
292 | 292 | # Configure your local SMTP server or use one of the available providers. |
293 | | -# |
| 293 | +# |
294 | 294 | # These values are copied to settings when the server starts and can be managed from the administration console. |
295 | 295 | # We recommend you remove these values after they are copied to settings. |
296 | 296 | # If server detects difference between these options and settings, it shows a warning in the log on server start. |
|
430 | 430 |
|
431 | 431 | ############################################################################### |
432 | 432 | # Password security allows you to disable constraints to which passwords must conform to. |
433 | | -# |
| 433 | +# |
434 | 434 | # [CAUTION] |
435 | 435 | # ==== |
436 | 436 | # Disabling password security can be useful for development environments as it removes the need for complex passwords. |
|
442 | 442 |
|
443 | 443 | ############################################################################### |
444 | 444 | # Algoritm to be use for JWT signature. |
445 | | -# |
| 445 | +# |
446 | 446 | # Supported valus: |
447 | 447 | # - HS256, HS384, HS512 |
448 | 448 | # - PS256, PS384, PS512, |
449 | 449 | # - RS256, RS384, RS512 |
450 | | -# |
| 450 | +# |
451 | 451 | # Provide shared secret string for HS256, HS384, HS512 and full private key or path to the file PS* and RS* algorithms. |
452 | 452 | # Type: string |
453 | 453 | # Default: HS512 |
|
456 | 456 | ############################################################################### |
457 | 457 | # Secret used for signing JWT tokens. |
458 | 458 | # Value is used only when HS256, HS384 or HS512 algorithm is used. |
459 | | -# |
| 459 | +# |
460 | 460 | # [IMPORTANT] |
461 | 461 | # ==== |
462 | 462 | # If secret is not set, system auto-generates one from DB_DSN and HOSTNAME environment variables. |
|
480 | 480 |
|
481 | 481 | ############################################################################### |
482 | 482 | # Lifetime of the refresh token. Should be much longer than lifetime of the access token. |
483 | | -# |
| 483 | +# |
484 | 484 | # Refresh tokens are used to exchange expired access tokens with new ones. |
485 | 485 | # Type: time.Duration |
486 | 486 | # Default: 72h |
487 | 487 | # AUTH_OAUTH2_REFRESH_TOKEN_LIFETIME=72h |
488 | 488 |
|
489 | 489 | ############################################################################### |
490 | 490 | # Redirect URL to be sent with OAuth2 authentication request to provider |
491 | | -# |
| 491 | +# |
492 | 492 | # `provider` placeholder is replaced with the actual value when used. |
493 | 493 | # Type: string |
494 | 494 | # Default: <no value> |
495 | 495 | # AUTH_EXTERNAL_REDIRECT_URL=<no value> |
496 | 496 |
|
497 | 497 | ############################################################################### |
498 | 498 | # Secret used for securing cookies |
499 | | -# |
| 499 | +# |
500 | 500 | # [IMPORTANT] |
501 | 501 | # ==== |
502 | 502 | # If secret is not set, system auto-generates one from DB_DSN and HOSTNAME environment variables. |
|
539 | 539 |
|
540 | 540 | ############################################################################### |
541 | 541 | # Maximum time user is allowed to stay idle when logged in without "remember-me" option and before session is expired. |
542 | | -# |
| 542 | +# |
543 | 543 | # Recomended value is between an hour and a day. |
544 | | -# |
| 544 | +# |
545 | 545 | # [IMPORTANT] |
546 | 546 | # ==== |
547 | 547 | # This affects only profile (/auth) pages. Using applications (admin, compose, ...) does not prolong the session. |
548 | 548 | # ==== |
549 | | -# |
| 549 | +# |
550 | 550 | # Type: time.Duration |
551 | 551 | # Default: 24h |
552 | 552 | # AUTH_SESSION_LIFETIME=24h |
553 | 553 |
|
554 | 554 | ############################################################################### |
555 | 555 | # Duration of the session in /auth lasts when user logs-in with "remember-me" option. |
556 | | -# |
| 556 | +# |
557 | 557 | # If set to 0, "remember-me" option is removed. |
558 | 558 | # Type: time.Duration |
559 | 559 | # Default: 8640h |
|
580 | 580 |
|
581 | 581 | ############################################################################### |
582 | 582 | # Secret used for securing CSRF protection |
583 | | -# |
| 583 | +# |
584 | 584 | # [IMPORTANT] |
585 | 585 | # ==== |
586 | 586 | # If secret is not set, system auto-generates one from DB_DSN and HOSTNAME environment variables. |
|
610 | 610 |
|
611 | 611 | ############################################################################### |
612 | 612 | # Handle for OAuth2 client used for automatic redirect from /auth/oauth2/go endpoint. |
613 | | -# |
| 613 | +# |
614 | 614 | # This simplifies configuration for OAuth2 flow for Corteza Web applications as it removes |
615 | 615 | # the need to suply redirection URL and client ID (oauth2/go endpoint does that internally) |
616 | | -# |
| 616 | +# |
617 | 617 | # Type: string |
618 | 618 | # Default: corteza-webapp |
619 | 619 | # AUTH_DEFAULT_CLIENT=corteza-webapp |
620 | 620 |
|
621 | 621 | ############################################################################### |
622 | 622 | # Path to js, css, images and template source files |
623 | | -# |
| 623 | +# |
624 | 624 | # When corteza starts, if path exists it tries to load template files from it. |
625 | | -# |
| 625 | +# |
626 | 626 | # When empty path is set (default value), embedded files are used. |
627 | 627 | # Type: string |
628 | 628 | # Default: <no value> |
|
631 | 631 | ############################################################################### |
632 | 632 | # When enabled, corteza reloads template before every execution. |
633 | 633 | # Enable this for debugging or when developing auth templates. |
634 | | -# |
| 634 | +# |
635 | 635 | # Should be disabled in production where templates do not change between server restarts. |
636 | 636 | # Type: bool |
637 | 637 | # Default: <no value> |
|
640 | 640 | ############################################################################### |
641 | 641 | # When set, Corteza creates one or more users with the configured values using provided email as a password. |
642 | 642 | # It skips existing (email, handle). All new users are assigned to all bypass roles. |
643 | | -# |
| 643 | +# |
644 | 644 | # When set in production, Corteza stops and reports an error |
645 | 645 | # Type: string |
646 | 646 | # Default: <no value> |
|
810 | 810 | # Default: <no value> |
811 | 811 | # LIMIT_SYSTEM_USERS=<no value> |
812 | 812 |
|
| 813 | +############################################################################### |
| 814 | +# Maximum number of records per namespace |
| 815 | +# Type: int |
| 816 | +# Default: <no value> |
| 817 | +# LIMIT_RECORD_COUNT_PER_NAMESPACE=<no value> |
| 818 | + |
813 | 819 | ############################################################################### |
814 | 820 | ############################################################################### |
815 | 821 | # locale |
|
818 | 824 | ############################################################################### |
819 | 825 | # List of compa delimited languages (language tags) to enable. |
820 | 826 | # In case when an enabled language can not be loaded, error is logged. |
821 | | -# |
| 827 | +# |
822 | 828 | # When loading language configurations (config.xml) from the configured path(s). |
823 | | -# |
| 829 | +# |
824 | 830 | # Type: string |
825 | 831 | # Default: en |
826 | 832 | # LOCALE_LANGUAGES=en |
827 | 833 |
|
828 | 834 | ############################################################################### |
829 | 835 | # One or more paths to locale config and translation files, separated by colon |
830 | | -# |
| 836 | +# |
831 | 837 | # When with LOCALE_DEVELOPMENT_MODE=true, default value for path is ../../locale |
832 | 838 | # Type: string |
833 | 839 | # Default: <no value> |
|
837 | 843 | # Name of the query string parameter used to pass the language tag (it overrides Accept-Language header). |
838 | 844 | # Set it to empty string to disable detection from the query string. |
839 | 845 | # This parameter is ignored if only one language is enabled |
840 | | -# |
| 846 | +# |
841 | 847 | # Type: string |
842 | 848 | # Default: lng |
843 | 849 | # LOCALE_QUERY_STRING_PARAM=lng |
|
868 | 874 |
|
869 | 875 | ############################################################################### |
870 | 876 | # Disables json format for logging and enables more human-readable output with colors. |
871 | | -# |
| 877 | +# |
872 | 878 | # Disable for production. |
873 | | -# |
| 879 | +# |
874 | 880 | # Type: bool |
875 | 881 | # Default: <no value> |
876 | 882 | # LOG_DEBUG=<no value> |
877 | 883 |
|
878 | 884 | ############################################################################### |
879 | 885 | # Minimum logging level. If set to "warn", |
880 | 886 | # Levels warn, error, dpanic panic and fatal will be logged. |
881 | | -# |
| 887 | +# |
882 | 888 | # Recommended value for production: warn |
883 | | -# |
| 889 | +# |
884 | 890 | # Possible values: debug, info, warn, error, dpanic, panic, fatal |
885 | | -# |
| 891 | +# |
886 | 892 | # Type: string |
887 | 893 | # Default: warn |
888 | 894 | # LOG_LEVEL=warn |
889 | 895 |
|
890 | 896 | ############################################################################### |
891 | 897 | # Log filtering rules by level and name (log-level:log-namespace). |
892 | 898 | # Please note that level (LOG_LEVEL) is applied before filter and it affects the final output! |
893 | | -# |
| 899 | +# |
894 | 900 | # Leave unset for production. |
895 | | -# |
| 901 | +# |
896 | 902 | # Example: |
897 | 903 | # `warn+:* *:auth,workflow.*` |
898 | 904 | # Log warnings, errors, panic, fatals. Everything from auth and workflow is logged. |
899 | | -# |
900 | | -# |
| 905 | +# |
| 906 | +# |
901 | 907 | # See more examples and documentation here: https://github.com/moul/zapfilter |
902 | | -# |
| 908 | +# |
903 | 909 | # Type: string |
904 | 910 | # Default: <no value> |
905 | 911 | # LOG_FILTER=<no value> |
906 | 912 |
|
907 | 913 | ############################################################################### |
908 | 914 | # Set to true to see where the logging was called from. |
909 | | -# |
| 915 | +# |
910 | 916 | # Disable for production. |
911 | | -# |
| 917 | +# |
912 | 918 | # Type: bool |
913 | 919 | # Default: <no value> |
914 | 920 | # LOG_INCLUDE_CALLER=<no value> |
915 | 921 |
|
916 | 922 | ############################################################################### |
917 | 923 | # Include stack-trace when logging at a specified level or below. |
918 | 924 | # Disable for production. |
919 | | -# |
| 925 | +# |
920 | 926 | # Possible values: debug, info, warn, error, dpanic, panic, fatal |
921 | | -# |
| 927 | +# |
922 | 928 | # Type: string |
923 | 929 | # Default: dpanic |
924 | 930 | # LOG_STACKTRACE_LEVEL=dpanic |
|
1013 | 1019 | # |
1014 | 1020 | # Provisioning allows you to configure a {PRODUCT_NAME} instance when deployed. |
1015 | 1021 | # It occurs automatically after the {PRODUCT_NAME} server starts. |
1016 | | -# |
| 1022 | +# |
1017 | 1023 | # [IMPORTANT] |
1018 | 1024 | # ==== |
1019 | 1025 | # We recommend you to keep provisioning enabled as it simplifies version updates by updating the database and updating settings. |
1020 | | -# |
| 1026 | +# |
1021 | 1027 | # If you're doing local development or some debugging, you can disable this. |
1022 | 1028 | # ==== |
1023 | 1029 | # |
|
1043 | 1049 | # ==== |
1044 | 1050 | # These parameters help in the development and testing process. |
1045 | 1051 | # When you are deploying to production, these should be disabled to improve performance and reduce storage usage. |
1046 | | -# |
| 1052 | +# |
1047 | 1053 | # You should configure external services such as Sentry or ELK to keep track of logs and error reports. |
1048 | 1054 | # ==== |
1049 | 1055 | # |
|
1149 | 1155 | # Delay system startup |
1150 | 1156 | # |
1151 | 1157 | # You can configure these options to defer API execution until another external (HTTP) service is up and running. |
1152 | | -# |
| 1158 | +# |
1153 | 1159 | # [ TIP ] |
1154 | 1160 | # ==== |
1155 | 1161 | # Delaying API execution can come in handy in complex setups where execution order is important. |
|
1173 | 1179 | ############################################################################### |
1174 | 1180 | # Space delimited list of hosts and/or URLs to probe. |
1175 | 1181 | # Host format: `host` or `host:443` (port will default to 80). |
1176 | | -# |
| 1182 | +# |
1177 | 1183 | # [NOTE] |
1178 | 1184 | # ==== |
1179 | 1185 | # Services are probed in parallel. |
|
0 commit comments