Settings¶
A - B - C - D - E - F - G - H - I - K - L - M - P - R - S - T - U - V - W
A¶
access-log¶
When the access-log setting is enabled, all login attempts (successful and unsuccessful) on the web interface are recorded in the “access” table of the repository.
admin-log¶
When the admin-log setting is enabled, configuration changes are recorded in the “admin_log” table of the repository.
allow-symlinks¶
When allow-symlinks is OFF, VisionByte does not see symbolic links (a.k.a “symlinks”) on disk as a separate class of object. Instead VisionByte sees the object that the symlink points to. VisionByte will only manage files and directories, not symlinks. When a symlink is added to a repository, the object that the symlink points to is added, not the symlink itself.
When allow-symlinks is ON, VisionByte sees symlinks on disk as a separate object class that is distinct from files and directories. When a symlink is added to a repository, VisionByte stores the target filename. In other words, VisionByte stores the symlink itself, not the object that the symlink points to.
Symlinks are not cross-platform. They are not available on all operating systems and file systems. Hence the allow-symlinks setting is OFF by default, for portability.
auto-captcha¶
If enabled, the /login page provides a button that will automatically fill in the captcha password. This makes things easier for human users, at the expense of also making logins easier for malicious robots.
auto-hyperlink¶
If non-zero, enable hyperlinks on web pages even for users that lack the “h” privilege as long as the UserAgent string in the HTTP request (The HTTP_USER_AGENT cgi variable) looks like it comes from a human and not a robot. Details depend on the value of the setting:
(0) Off: No adjustments are made to the 'h' privilege based on
the user agent.
(1) UserAgent and Javascript: The the href= values of hyperlinks
initially point to /honeypot and are changed to point to the
correct target by javascript that runs after the page loads.
The :ref:`auto-hyperlink-delay<auto-hyperlink-delay>` and :ref:`auto-hyperlink-mouseover<auto-hyperlink-mouseover>` settings
influence that javascript.
(2) UserAgent only: If the HTTP_USER_AGENT looks human
then generate hyperlinks, otherwise do not.
Better robot exclusion is obtained when this setting is 1 versus 2. However, a value of 1 causes the visited/unvisited colors of hyperlinks to stop working on Safari-derived web browsers. When this setting is 2, the hyperlinks work better on Safari, but more robots are able to sneak in.
auto-hyperlink-delay¶
When the auto-hyperlink setting is 1, the javascript that runs to set the href= attributes of hyperlinks delays by this many milliseconds after the page load. Suggested values: 50 to 200.
auto-hyperlink-mouseover¶
When the auto-hyperlink setting is 1 and this setting is on, the javascript that runs to set the href= attributes of hyperlinks waits until either a mousedown or mousemove event is seen. This helps to distinguish real users from robots. For maximum robot defense, the recommended setting is ON.
auto-shun¶
If enabled, automatically pull the shunning list from a server to which the client autosyncs.
autosync¶
This setting determines when autosync occurs. The setting is a string that provides a lot of flexibility for determining when and when not to autosync. Examples:
on Always autosync for command where autosync
makes sense (:doc:`"commit"<commandline/commit>`, :doc:`"merge"<commandline/merge>`, doc::`"open"<commandline/open>`, doc::`"update"<commandline/update>`)
off Never autosync.
pullonly Only to pull autosyncs
all Sync with all remotes
on,open=off Autosync for most commands, but not for doc::`"open"<open>`
off,commit=pullonly Do not autosync, except do a pull before each
:doc:`"commit"<commandline/commit>`, presumably to avoid undesirable
forks.
The syntax is a comma-separated list of VALUE and COMMAND=VALUE entries. A plain VALUE entry is the default that is used if no COMMAND matches. Otherwise, the VALUE of the matching command is used.
The “all” value is special in that it applies to the “sync” command in addition to “commit”, “merge”, doc::”open”<commandline/open>, doc::”update”<commandline/update>.
autosync-tries¶
If autosync is enabled setting this to a value greater than zero will cause autosync to try no more than this number of attempts if there is a sync failure.
B¶
backoffice-disable¶
If backoffice-disable is true, then the automatic backoffice processing is disabled. Automatic backoffice processing is the backoffice work that normally runs after each web page is rendered. Backoffice processing that is triggered by the “vb backoffice” command is unaffected by this setting.
Backoffice processing does things such as delivering email notifications. So if this setting is true, and if there is no cron job periodically running “vb backoffice”, email notifications and other work normally done by the backoffice will not occur.
backoffice-logfile¶
If backoffice-logfile is not an empty string and is a valid filename, then a one-line message is appended to that file every time the backoffice runs. This can be used for debugging, to ensure that backoffice is running appropriately.
backoffice-nodelay¶
If backoffice-nodelay is true, then the backoffice processing will never invoke sleep(). If it has nothing useful to do, it simply exits.
binary-glob¶
The VALUE of this setting is a list of GLOB patterns matching files that should be treated as “binary” for committing and merging purposes. Example: .jpg,.png The parsing rules are complex; see https://fossil-scm.org/home/doc/trunk/www/globs.md#syntax
C¶
case-sensitive¶
If TRUE, the files whose names differ only in case are considered distinct. If FALSE files whose names differ only in case are the same file. Defaults to TRUE for unix and FALSE for Cygwin, Mac and Windows.
chat-alert-sound¶
This is the name of the builtin sound file to use for the alert tone. The value must be the name of a builtin WAV file.
chat-initial-history¶
If this setting has an integer value of N, then when /chat first starts up it initializes the screen with the N most recent chat messages. If N is zero, then all chat messages are loaded.
chat-inline-images¶
Specifies whether posted images in /chat should default to being displayed inline or as downloadable links. Each chat user can change this value for their current chat session in the UI.
chat-keep-count¶
When /chat is cleaning up older messages, it will always keep the most recent chat-keep-count messages, even if some of those messages are older than the discard threshold. If this value is zero, then /chat is free to delete all historic messages once they are old enough.
chat-keep-days¶
The /chat subsystem will try to discard messages that are older then chat-keep-days. The value of chat-keep-days can be a floating point number. So, for example, if you only want to keep chat messages for 12 hours, set this value to 0.5.
A value of 0.0 or less means that messages are retained forever.
chat-poll-timeout¶
On an HTTP request to /chat-poll, if there is no new content available, the reply is delayed waiting for new content to arrive. (This is the “long poll” strategy of event delivery to the client.) This setting determines approximately how long /chat-poll will delay before giving up and returning an empty reply. The default value is about 7 minutes, which works well for VisionByte behind the althttpd web server. Other server environments may choose a longer or shorter delay.
For maximum efficiency, it is best to choose the longest delay that does not cause timeouts in intermediate proxies or web server.
chat-timeline-user¶
If this setting is defined and is not an empty string, then timeline events are posted to the chat as they arrive. The synthesized chat messages appear to come from the user identified by this setting, not the user on the timeline event.
All chat messages that come from the chat-timeline-user are interpreted as text/x-fossil-wiki instead of as text/x-markdown. For this reason, the chat-timeline-user name should probably not be a real user.
clean-glob¶
The VALUE of this setting is a list of GLOB patterns matching files that the “clean” command will delete without prompting or allowing undo. Example: .a,.o,*.so The parsing rules are complex; see https://fossil-scm.org/home/doc/trunk/www/globs.md#syntax
clearsign¶
When enabled, vb will attempt to sign all commits with gpg or ssh. When disabled, commits will be unsigned.
crlf-glob¶
The VALUE of this setting is a list of GLOB patterns matching files in which it is allowed to have CR, CR+LF or mixed line endings, suppressing VisionByte’s normal warning about this. Set it to “*” to disable CR+LF checking entirely. Example: .md,.txt The crnl-glob setting is a compatibility alias.
crnl-glob¶
This is an alias for the crlf-glob setting.
D¶
default-csp¶
The text of the Content Security Policy that is included in the Content-Security-Policy: header field of the HTTP reply and in the default HTML <head> section that is added when the skin header does not specify a <head> section. The text “$nonce” is replaced by the random nonce that is created for each web page.
If this setting is an empty string or is omitted, then the following default Content Security Policy is used:
default-src 'self' data:;
script-src 'self' 'nonce-$nonce';
style-src 'self' 'unsafe-inline';
img-src * data:;
The default CSP is recommended. The main reason to change this setting would be to add CDNs from which it is safe to load additional content.
default-perms¶
Permissions given automatically to new users. For more information on permissions see the Users page in Server Administration of the HTTP UI.
default-skin¶
If the text value if this setting is the name of a built-in skin then the named skin becomes the default skin for the repository.
diff-binary¶
If enabled, permit files that may be binary or that match the “binary-glob” setting to be used with external diff programs. If disabled, skip these files.
diff-command¶
The value is an external command to run when performing a diff. If undefined, the internal text diff will be used.
dont-commit¶
If enabled, prevent committing to this repository, as an extra precaution against accidentally checking in to a repository intended to be read-only.
dont-push¶
If enabled, prevent this repository from pushing from client to server. This can be used as an extra precaution to prevent accidental pushes to a public server from a private clone.
dotfiles¶
If enabled, include –dotfiles option for all compatible commands.
E¶
editor¶
The value is an external command that will launch the text editor command used for check-in comments.
If this value is not set, then environment variables VISUAL and EDITOR are consulted, in that order. If neither of those are set, then a search is made for common text editors, including “notepad”, “nano”, “pico”, “jove”, “edit”, “vi”, “vim”, and “ed”.
If this setting is false (“off”, “no”, “false”, or “0”) then no text editor is used.
email-admin¶
This is the email address for the human administrator for the system. Abuse and trouble reports and password reset requests are send here.
email-listid¶
If this setting is not an empty string, then it becomes the argument to a “List-ID:” header that is added to all out-bound notification emails.
email-renew-interval¶
If this setting as an integer N that is 14 or greater then email notification is suspended for subscriptions that have a “last contact time” of more than N days ago. The “last contact time” is recorded in the SUBSCRIBER.LASTCONTACT entry of the database. Logging in, sending a forum post, editing a wiki page, changing subscription settings at /alerts, or visiting /renew all update the last contact time. If this setting is not an integer value or is less than 14 or undefined, then subscriptions never expire.
email-self¶
This is the email address for the repository. Outbound emails add this email address as the “From:” field.
email-send-command¶
This is a command to which outbound email content is piped when the email-send-method is set to “pipe”. The command must extract recipient, sender, subject, and all other relevant information from the email header.
email-send-db¶
This is an SQLite database file into which outbound emails are written if the email-send-method is set to “db”.
email-send-dir¶
This is a directory into which outbound emails are written as individual files if the email-send-method is set to “dir”.
email-send-method¶
Determine the method used to send email. Allowed values are “off”, “relay”, “pipe”, “dir”, “db”, and “stdout”. The “off” value means no email is ever sent. The “relay” value means emails are sent to an Mail Sending Agent using SMTP located at email-send-relayhost. The “pipe” value means email messages are piped into a command determined by the email-send-command setting. The “dir” value means emails are written to individual files in a directory determined by the email-send-dir setting. The “db” value means that emails are added to an SQLite database named by the* email-send-db setting. The “stdout” value writes email text to standard output, for debugging.
email-send-relayhost¶
This is the hostname and TCP port to which output email messages are sent when email-send-method is “relay”. There should be an SMTP server configured as a Mail Submission Agent listening on the designated host and port and all times.
email-subname¶
This is a short name used to identifies the repository in the Subject: line of email alerts. Traditionally this name is included in square brackets. Examples: “[vb-src]”, “[sqlite-src]”.
email-url¶
This is the main URL used to access the repository for cloning or syncing or for operating the web interface. It is also the basename for hyperlinks included in email alert text. Omit the trailing “/”. If the repository is not intended to be a long-running server and will not be sending email notifications, then leave this setting blank.
empty-dirs¶
The value is a list of pathnames parsed according to the same rules as the *-glob settings. On update and checkout commands, if no directory exists with that name, an empty directory will be be created, even if it must create one or more parent directories.
encoding-glob¶
The VALUE of this setting is a list of GLOB patterns matching files that the “commit” command will ignore when issuing warnings about text files that may use another encoding than ASCII or UTF-8. Set to “*” to disable encoding checking. Example: .md,.txt The parsing rules are complex; see https://fossil-scm.org/home/doc/trunk/www/globs.md#syntax
exec-rel-paths¶
When executing certain external commands (e.g. diff and gdiff), use relative paths.
F¶
fileedit-glob¶
The VALUE of this setting is a list of GLOB patterns matching files which are allowed to be edited using the /fileedit page. An empty list suppresses the feature. Example: .md,.txt The parsing rules are complex; see https://fossil-scm.org/home/doc/trunk/www/globs.md#syntax Note that /fileedit cannot edit binary files, so the list should not contain any globs for, e.g., images or PDFs.
forbid-delta-manifests¶
If enabled on a client, new delta manifests are prohibited on commits. If enabled on a server, whenever a client attempts to obtain a check-in lock during auto-sync, the server will send the “pragma avoid-delta-manifests” statement in its reply, which will cause the client to avoid generating a delta manifest.
forum-close-policy¶
If true, forum moderators may close/re-open forum posts, and reply to closed posts. If false, only administrators may do so. Note that this only affects the forum web UI, not post-closing tags which arrive via the command-line or from synchronization with a remote.
forum-title¶
This is the name or “title” of the Forum for this repository. The default is just “Forum”. But in some setups, admins might want to change it to “Developer Forum” or “User Forum” or whatever other name seems more appropriate for the particular usage.
G¶
gdiff-command¶
The value is an external command to run when performing a graphical
diff. If undefined, a --tk diff is done if commands “tclsh” and “wish”
are on PATH, or a --by diff is done if “tclsh” or “wish” are unavailable.
gmerge-command¶
The value is a graphical merge conflict resolver command operating on four files. Examples:
kdiff3 "%baseline" "%original" "%merge" -o "%output"
xxdiff "%original" "%baseline" "%merge" -M "%output"
meld "%baseline" "%original" "%merge" --output "%output"
H¶
hash-digits¶
The number of hexadecimal digits of the SHA3 hash to display.
hooks¶
The “hooks” setting contains JSON that describes all defined hooks. The value is an array of objects. Each object describes a single hook. Example:
{
"type": "after-receive", // type of hook
"cmd": "command-to-run", // command to run
"seq": 50 // run in this order
}
http-port¶
The default TCP/IP port number to use by the “server” and “ui” commands.
https-login¶
If true, then the VisionByte web server will redirect unencrypted login screen requests to HTTPS.
I¶
ignore-glob¶
The VALUE of this setting is a list of GLOB patterns matching files that the “add”, “addremove”, “clean”, and doc::”extras”<commandline/extras> commands will ignore. Example: *.log,notes.txt The parsing rules are complex; see https://fossil-scm.org/home/doc/trunk/www/globs.md#syntax
K¶
keep-glob¶
The VALUE of this setting is a list of GLOB patterns matching files that the “clean” command must not delete. Example: build/precious.exe The parsing rules are complex; see https://fossil-scm.org/home/doc/trunk/www/globs.md#syntax
L¶
large-file-size¶
VisionByte considers any file whose size is greater than this value to be a “large file”. VisionByte might issue warnings if you try to “add” or “commit” a “large file”. Set this value to 0 or less to disable all such warnings.
localauth¶
If enabled, require that HTTP connections from the loopback address (127.0.0.1) be authenticated by password. If false, some HTTP requests might be granted full “Setup” user privileges without having to present login credentials. This mechanism allows the “vb ui” command to provide full access to the repository without requiring the user to log in first.
In order for full “Setup” privilege to be granted without a login, the following conditions must be met:
(1) This setting ("localauth") must be off
(2) The HTTP request arrive over the loopback TCP/IP
address (127.0.01) or else via SSH.
(3) The request must be HTTP, not HTTPS. (This
restriction is designed to help prevent accidentally
providing "Setup" privileges to requests arriving
over a reverse proxy.)
(4) The command that launched the vb server must be
one of the following:
(a) :doc:`"vb ui"<commandline/ui>`
(b) :doc:`"vb server"<commandline/server>` with the :option:`--localauth<server --localauth>` option
(c) :doc:`"vb http"<commandline/http>` with the :option:`--localauth<http --localauth>` option
(d) :doc:`CGI<commandline/cgi>` with the :option:`"localauth"<cgi --localauth>` setting in the cgi script.
For maximum security, set “localauth” to 1. However, because of the other restrictions (2) through (4), it should be safe to leave “localauth” set to 0 in most installations, and especially on cloned repositories on workstations. Leaving “localauth” at 0 makes the “vb ui” command more convenient to use.
lock-timeout¶
This is the number of seconds that a check-in lock will be held on the server before the lock expires. The default is a 60-second delay. Set this value to zero to disable the check-in lock mechanism.
This value should be set on the server to which users auto-sync their work. This setting has no effect on client repositories. The check-in lock mechanism is only effective if all users are auto-syncing to the same server.
Check-in locks are an advisory mechanism designed to help prevent accidental forks due to a check-in race in installations where many users are committing to the same branch and auto-sync is enabled. As forks are harmless, there is no danger in disabling this mechanism. However, keeping check-in locks turned on can help prevent unnecessary confusion.
M¶
main-branch¶
The value is the primary branch for the project.
manifest¶
If enabled, automatically create files “manifest” and “manifest.uuid” in every check-out.
Optionally use combinations of characters ‘r’ for “manifest”, ‘u’ for “manifest.uuid” and ‘t’ for “manifest.tags”. The SQLite and VisionByte repositories both require manifests.
max-body-size¶
A limit on the size of uplink HTTP requests.
max-cache-entry¶
This is the maximum number of entries to allow in the web-cache for tarballs, ZIP-archives, and SQL-archives.
max-loadavg¶
Some CPU-intensive web pages (ex: /zip, /tarball, /blame) are disallowed if the system load average goes above this value. “0.0” means no limit. This only works on unix. Only local settings of this value make a difference since when running as a web-server, VisionByte does not open the global configuration database.
max-upload¶
A limit on the size of uplink HTTP requests.
mimetypes¶
A list of file extension-to-mimetype mappings, one per line. e.g. “foo application/x-foo”. File extensions are compared case-insensitively in the order listed in this setting. A leading ‘.’ on file extensions is permitted but not required.
mtime-changes¶
Use file modification times (mtimes) to detect when files have been modified. If disabled, all managed files are hashed to detect changes, which can be slow for large projects.
mv-rm-files¶
If enabled, the “mv” and “rename” commands will also move the associated files within the check-out -AND- the “rm” and “delete” commands will also remove the associated files from within the check-out.
P¶
pgp-command¶
Command used to clear-sign manifests at check-in. Default value is “gpg –clearsign -o”. For SSH, use e.g. “ssh-keygen -q -Y sign -n fossilscm -f ~/.ssh/id_ed25519”
preferred-diff-type¶
The preferred-diff-type setting determines the preferred diff format for web pages if the format is not otherwise specified, for example by a query parameter or cookie. Allowed values:
1 Unified diff
2 Side-by-side diff
If this setting is omitted or has a value of 0 or less, then it is ignored.
proxy¶
URL of the HTTP proxy. If undefined or “system”, the “http_proxy” environment variable is consulted. If “off”, a direct HTTP connection is used.
R¶
raw-bgcolor¶
VisionByte usually tries to adjust user-specified background colors for checkins so that the text is readable and so that the color is not too garish. This setting disables that filter. When this setting is on, the user-selected background colors are shown exactly as requested.
redirect-to-https¶
Specifies whether or not to redirect unencrypted “http://” requests to encrypted “https://” URIs. A value of 0 (the default) means do not redirect, 1 means to redirect only the /login page, and 2 means to always redirect.
For security, a value of 2 is recommended. The default value is 0 because not all sites are TLS-capable. But you should definitely enable TLS and change this setting to 2 for all public-facing repositories.
relative-paths¶
When showing changes and extras, report paths relative to the current working directory.
repo-cksum¶
Compute checksums over all files in each check-out as a double-check of correctness. Disable this on large repositories for a performance improvement.
repolist-skin¶
If non-zero then use this repository as the skin for a repository list such as created by the one of:
1) vb :doc:`server<commandline/server>` DIRECTORY :option:`--repolist<server --repolist>`
2) vb :doc:`ui<commandline/ui>` DIRECTORY :option:`--repolist<ui --repolist>`
3) vb :doc:`http<commandline/http>` DIRECTORY :option:`--repolist<http --repolist>`
4) (The "repolist" option in a :doc:`CGI<commandline/cgi>` script)
5) vb :doc:`all ui<commandline/all>`
6) vb :doc:`all server<commandline/all>`
All repositories are searched (in lexicographical order) and the first repository with a non-zero “repolist-skin” value is used as the skin for the repository list page. If none of the repositories on the list have a non-zero “repolist-skin” setting then the repository list is displayed using unadorned HTML (“skinless”), with the page title taken from the FOSSIL_REPOLIST_TITLE environment variable.
If repolist-skin has a value of 2, then the repository is omitted from the list in use cases 1 through 4, but not for 5 and 6.
robot-restrict¶
The VALUE of this setting is a list of GLOB patterns that match pages for which complex HTTP requests from robots should be disallowed. The recommended value for this setting is:
timeline,vdiff,fdiff,annotate,blame
robots-txt¶
This setting is the override value for the /robots.txt file that VisionByte returns when run as a stand-alone server for a domain. As VisionByte is seldom run as a stand-alone server (and is more commonly deployed as a CGI or SCGI or behind a reverse proxy) this setting rarely needed. A reasonable default robots.txt is sent if this setting is empty.
S¶
safe-html¶
This setting controls whether or not unsafe HTML elements (such as SCRIPT or STYLE tags) are allowed in Markdown-formatted documents. Unsafe HTML is disabled by default. If this setting exists and is a string, then letters in that string can enable unsafe HTML in various contexts:
- b Unsafe HTML allowed in embedded documentation
- f Unsafe HTML allowed in forum posts
- t Unsafe HTML allowed in tickets
- w Unsafe HTML allowed on wiki pages
self-pw-reset¶
Allow users to request that an email containing a hyperlink to the /resetpw page be sent to their email address of record, thus allowing forgetful users to reset their forgotten passwords without administrator involvement.
self-register¶
Allow users to register themselves through the HTTP UI. This is useful if you want to see other names than “Anonymous” in e.g. ticketing system. On the other hand users can not be deleted.
sitemap-extra¶
The sitemap-extra setting defines extra links to appear on the /sitemap web page as sub-items of the “Home Page” entry before the “Documentation Search” entry (if any). For skins that use the /sitemap page to construct a hamburger menu dropdown, new entries added here will appear on the hamburger menu.
This setting should be a TCL list divided into triples. Each triple defines a new entry:
* The first term is the display name of the /sitemap entry
* The second term is a hyperlink to take when a user clicks on the
entry. Hyperlinks that start with "/" are relative to the
repository root.
* The third term is an argument to the TH1 "capexpr" command.
If capexpr evaluates to true, then the entry is shown. If not,
the entry is omitted. "*" is always true.
The default value is blank, meaning no added entries.
ssh-command¶
The command used to talk to a remote machine with the “ssh://” protocol.
ssl-ca-location¶
The full pathname to a file containing PEM encoded CA root certificates, or a directory of certificates with filenames formed from the certificate hashes as required by OpenSSL.
If set, this will override the OS default list of OpenSSL CAs. If unset, the default list will be used. Some platforms may add additional certificates. Checking your platform behaviour is required if the exact contents of the CA root is critical for your application.
This setting is overridden by environment variables SSL_CERT_FILE and SSL_CERT_DIR.
ssl-identity¶
The full pathname to a file containing a certificate and private key in PEM format. Create by concatenating the certificate and private key files.
This identity will be presented to SSL servers to authenticate this client, in addition to the normal password authentication.
T¶
tcl¶
If enabled Tcl integration commands will be added to the TH1 interpreter, allowing arbitrary Tcl expressions and scripts to be evaluated from TH1. Additionally, the Tcl interpreter will be able to evaluate arbitrary TH1 expressions and scripts.
tcl-setup¶
This is the setup script to be evaluated after creating and initializing the Tcl interpreter. By default, this is empty and no extra setup is performed.
tclsh¶
Name of the external TCL interpreter used for such things
as running the GUI diff viewer launched by the --tk option
of the various “diff” commands.
th1-docs¶
If enabled, this allows embedded documentation files to contain arbitrary TH1 scripts that are evaluated on the server. If native Tcl integration is also enabled, this setting has the potential to allow anybody with check-in privileges to do almost anything that the associated operating system user account could do. Extreme caution should be used when enabling this setting.
th1-hooks¶
If enabled, special TH1 commands will be called before and after any VisionByte command or web page.
th1-setup¶
This is the setup script to be evaluated after creating and initializing the TH1 interpreter. By default, this is empty and no extra setup is performed.
th1-uri-regexp¶
Specify which URI’s are allowed in HTTP requests from TH1 scripts. If empty, no HTTP requests are allowed whatsoever.
ticket-default-report¶
If this setting has a string value, then when the ticket search page query is blank, the report with this title is shown. If the setting is blank (default), then no report is shown.
timeline-hard-newlines¶
If enabled, the timeline honors newline characters in check-in comments. In other words, newlines are coverted into <br> for HTML display. The default behavior, when this setting is off, is that newlines are treated like any other whitespace character.
timeline-plaintext¶
If enabled, no wiki-formatting is done for timeline comment messages. Hyperlinks are activated, but they show up on screen using the complete input text, not just the display text. No other formatting is done.
timeline-truncate-at-blank¶
If enabled, check-in comments displayed on the timeline are truncated at the first blank line of the comment text. The comment text after the first blank line is only seen in the /info or similar pages that show details about the check-in.
timeline-tslink-info¶
The hyperlink on the timestamp associated with each timeline entry, on the far left-hand side of the screen, normally targets another /timeline page that shows the entry in context. However, if this option is turned on, that hyperlink targets the /info page showing the details of the entry.
timeline-utc¶
If the timeline-utc setting is true, then VisionByte tries to understand and display all time values using UTC. If this setting is false, VisionByte tries to understand and display time values using the local timezone.
The word “timeline” in the name of this setting is historical. This setting applies to all user interfaces of VisionByte, not just the timeline.
Note that when accessing VisionByte using the web interface, the localtime used is the localtime on the server, not on the client.
U¶
user-color-map¶
The user-color-map setting can be used to override user color choices. The setting is a list of space-separated words pairs. The first word of each pair is a login name. The second word is an alternative name used by the color chooser algorithm.
This list is intended to be relatively short. The idea is to only use this map to resolve color collisions between common users.
Visit /hash-color-test?rand for a list of suggested names for the second word of each pair in the list.
uv-sync¶
If true, automatically send unversioned files as part of a “vb clone” or “vb sync” command. The default is false, in which case the -u option is needed to clone or sync unversioned files.
V¶
verify-comments¶
This setting determines how much sanity checking, if any, the “vb commit” and “vb amend” commands do against check-in comments. Recognized values:
on (Default) Check for bad syntax and/or broken hyperlinks
in check-in comments and offer the user a chance to
continue editing for interactive sessions, or simply
abort the :doc:`commit<commandline/commit>`" if the comment was entered using :option:`-m<commit -m>` or :option:`-M<commit -M>`
off Do not do syntax checking of any kind
preview Do all the same checks as "on" but also always preview the
check-in comment to the user during interactive sessions
even if no obvious errors are found, and provide an
opportunity to accept or re-edit
vuln-report¶
This setting controls VisionByte’s behavior when it encounters a potential XSS or SQL-injection vulnerability due to misuse of TH1 configuration scripts. Choices are:
off Do nothing. Ignore the vulnerability.
log Write a report of the problem into the error log.
block Like "log" but also prevent the offending TH1 command
from running.
fatal Render an error message page instead of the requested
page.
W¶
web-browser¶
A shell command used to launch your preferred web browser when given a URL as an argument. Defaults to “start” on windows, “open” on Mac, and “firefox” on Unix.
comment-format¶
Set the algorithm for printing timeline comments to the console.
Possible values are:
1 Use the original comment printing algorithm: * Leading and trialing whitespace is removed * Internal whitespace is converted into a single space (0x20) * Line breaks occurs at whitespace or hyphens if possible This is the recommended value and the default.Or a bitwise combination of the following flags:
Note: To preserve line breaks and/or other whitespace within comment text, make this setting some integer value that omits the “1” bit.