How to make Send Receive work in Paratext 10 Studio - paranext/paranext GitHub Wiki

Send/Receive should work fine out-of-the-box if you already have Paratext 9 installed and registered on the same machine as Paratext 10 Studio.

Everyone else will need to do some setup:

Have or create an account on the Paratext Registry,
Set up Paratext Registration in Paratext 10 Studio
Install Mercurial

Users who already have Send/Receive working in Paratext 9 on a different computer than the one on which they want to use Send/Receive in Paratext 10 Studio can skip to Step 2.

1. Get a Paratext Registry account

Tip

Skip this step if you already have Paratext 9 Send/Receive working on any computer.

Follow Paratext 9's registration instructions, either on the

Paratext Registry or the
Paratext Registry (development)

2. Set up Registration in Paratext 10 Studio

Tip

Skip this step if you already have Paratext 9 Send/Receive working on the computer on which you want to use Send/Receive in Paratext 10 Studio.

Users must connect their Paratext registration on the computer on which they want to use Send/Receive in Paratext 10 Studio (or in Paratext 9).

The simplest way to set up Paratext Registration information is to use the Paratext Registration Information dialog in Paratext 10 Studio:

Open Paratext 10 Studio
Click Menu → Help → Paratext Registration Information...
Enter your name, registration code, and email address exactly as they appear in the Paratext Registry
Optionally, expand the Internet Settings dropdown and adjust the settings as desired.
Click Save and Restart

Optional: Set up Paratext Registration Info manually

Users can alternatively create registration files on the computer on which they want to use Send/Receive in Paratext 10 Studio using one of the following methods:

2a. Create registration files with Paratext 9

Install Paratext 9
Enter registration info in Paratext 9
If you're running Paratext 10 Studio on the same computer, you're done.
Otherwise, copy these registration files to your Paratext 10 Studio computer for use in Step 3:
- %localappdata%/Paratext100/InternetSettings.xml and
- %localappdata%/Paratext100/RegistrationInfo.xml

2b. Create registration files with a template

Create your own registration files based on these templates.

`RegistrationInfo.xml` template:

<?xml version="1.0" encoding="utf-8"?>
<RegistrationData>
  <Name>YOUR-NAME</Name>
  <Code>YOUR-PARATEXT-REGISTRATION-CODE</Code>
  <Email>[email protected]</Email>
  <SupporterName />
</RegistrationData>

Replace YOUR-NAME, YOUR-PARATEXT-REGISTRATION-CODE, and [email protected] with your information from the Paratext Registry.

`InternetSettings.xml` template:

<?xml version="1.0" encoding="utf-8"?>
<InternetSettingsMemento>
  <SelectedServer>Development</SelectedServer>
  <PermittedInternetUse>Enabled</PermittedInternetUse>
  <ProxyPort>0</ProxyPort>
</InternetSettingsMemento>

Configuration Options:

Change the value of <SelectedServer> to Production if you want to use the production server.
For <PermittedInternetUse>, choose a value from Enabled, VpnRequired, Disabled, and ProxyOnly.

3. Place registration files on your computer

If you’re running Paratext 9 with on the same computer as Paratext 10 Studio, you’re done. Paratext 10 Studio knows where to find Paratext 9's registration files.

Otherwise, place the registration files from Step 2 in locations where Paratext 10 Studio expects them.

On Windows

%localappdata%/Paratext100/InternetSettings.xml and
%localappdata%/Paratext100/RegistrationInfo.xml

On macOS

~/Library/Application Support/Paratext100/InternetSettings.xml and
~/Library/Application Support/Paratext100/RegistrationInfo.xml

On Linux

~/.local/share/Paratext100/InternetSettings.xml and
~/.local/share/Paratext100/RegistrationInfo.xml

3. Install Mercurial

Download Mercurial and install it.
Then make sure Paratext 10 Studio can find it.

We've provided platform-specific installation instructions for Windows, macOS, and Linux below to help you get set up quickly and correctly.

Install Mercurial on Windows

Mercurial is installed at an expected location by Paratext 9.
If you choose not to install Paratext 9, install Mercurial or TortoiseHG directly.

Download Mercurial for Windows

Install Mercurial on Linux

If you are running Paratext 10 Studio from the snap store, you do not need to install Mercurial separately. It comes bundled with Paratext. If you are working on Paratext 10 Studio as a software developer, you will need to install Mercurial separately.

On Ubuntu 22, you can install Mercurial this way:

sudo apt install python2-dev python-pip python2
sudo pip2 install mercurial
sudo apt remove python2-dev python-pip

On Ubuntu 24, python2 is no longer supported by the default package management servers. You can install the latest version of Mercurial this way:

sudo apt-get install mercurial

Or read how to build Mercurial package files yourself.

Install Mercurial on macOS

Install Mercurial or TortoiseHG with the above guide or with Homebrew

brew install mercurial                    # Get Mercurial with Homebrew, or

brew install tortoisehg                   # Get TortoiseHG with Homebrew
xattr -c /Applications/TortoiseHg.app     # Disable quarantine, or

Download TortoiseHg for macOS.

On Apple Silicon (M1–4), you may need to disable Gatekeeper's quarantine—assuming you trust TortoiseHg.

Help Paratext Studio find Mercurial

Paratext 10 Studio will look for Mercurial at specific paths.

Windows

C:/Program Files/Mercurial/hg.exe or
C:/Program Files/Paratext 9/Repository/HgResources/Mercurial/hg.exe or
C:/Program Files/TortoiseHg/hg.exe

Linux

/usr/bin/hg or
/usr/local/bin/hg or
/opt/local/bin/hg

macOS

/Applications/TortoiseHg.app/Contents/MacOS/hg or
/usr/bin/hg or
/opt/local/bin/hg or
/usr/local/bin/hg or
/opt/homebrew/bin/hg

If you install Mercurial in a different location, you may need to

create a softlink to an expected location, or
specify the path in setting "Mercurial Config → Mercurial (hg) Executable Path" (platform.hgExecutablePath).