Install & upgrade

Install & upgrade#

Install#

  • Install the required packages. Everything else will be installed automatically when starting the local server.

  • Set up your account if you haven't done so yet.

    • You should have received a login link of the form https://t-doc.org#?token=.... Navigate to that link to log in.

    • In the navigation bar, select " → Settings", click one of the "Add login with ..." buttons and follow the process. You will then be able to log in with that account.

  • Generate a repository access password if this is the first time you access a t-doc repository.

    • Go to t-doc.org and ensure you are logged in.

    • In the navigation bar, select " → Settings", then open "Repository access".

    • Click "Reset" to generate the password. Keep the dialog open for the next step.

  • Edit the Mercurial configuration for your user. If the file doesn't exist yet, create it as an empty plain-text file.

    • Windows: %USERPROFILE%\.hgrc (typically C:\Users\USERNAME\.hgrc)

    • macOS: $HOME/.hgrc (typically /Users/USERNAME/.hgrc)

    • Linux: $HOME/.hgrc (typically /home/USERNAME/.hgrc)

    Copy the [auth] section from the dialog above (if you generated a new password) or from another install (if you already had a password), and paste it into the configuration. Also, add a [ui] section and specify your username (substitute FIRST and LAST with your first and last name, and EMAIL with your email address, e.g. Joe Smith <joe@example.com>). Save the file.

    [auth]
t-doc.prefix = https://rc.t-doc.org/
t-doc.username = USER_ID
t-doc.password = PASSWORD

[ui]
username = FIRST LAST <EMAIL>

Upgrade#

  • The local server indicates when upgrades are available.

    • Check the changes introduced in new t-doc versions in the release notes.

    • Restart the local server. When prompted, accept the upgrade.

  • Check for upgrades to the required packages and install them when available.

Requirements#

t-doc requires the following software to be installed:

Windows#

  • Install Python.

    winget install --id Python.Python.3.14

    • Check that Python can be launched from the command-line, by running:

      python

      If this opens the Microsoft Store, open Windows settings, search for "App execution aliases", and disable the "App Installer" entries for python.exe and python3.exe.

  • Install Graphviz. The installer must be run interactively and the "Add Graphviz to the system PATH for all users" option must be enabled.

    winget install --id Graphviz.Graphviz --interactive

  • Install TortoiseHg.

    winget install --id TortoiseHg.TortoiseHg

  • (Optional, Windows 10) Install Windows Terminal (it's already installed on Windows 11 and later).

    winget install --id Microsoft.WindowsTerminal

Upgrades#

  • If a new minor version of Python is recommended (e.g. 3.13.5 is installed and 3.14 is recommended), install the new version.

    winget install --id Python.Python.3.14

  • Otherwise, upgrade the installed minor version.

    winget upgrade --id Python.Python.3.14

  • Upgrade the other packages.

    winget upgrade --id Graphviz.Graphviz
winget upgrade --id TortoiseHg.TortoiseHg
winget upgrade --id Microsoft.WindowsTerminal

macOS#

Linux#