Installation Instructions
Domain Time DTLinux Version 5.2 |
Please read the README.txt file before installing.
(Note the latest version of this file will be in the distribution file you download)
NOTES:
- Disable any other time synchronization software to prevent conflicts, including chronyd, ntpd, or any PTP daemons or drivers (i.e. phc2sys).
- Check your routers and firewalls to be sure the ports for the time protocols you'll be using are open.
IEEE 1588-2008 or 1588-2019 (PTP) require inbound and outbound access
to ports 319/udp and 320/udp. All packets sent will have a source port
of either 319 or 320, and a target port of 319 or 320. Inbound packets
will have a source port of 319 or 320, and a target port of 319 or 320.
So, essentially, for PTP, you need to open 319/udp and 320/udp in both
directions.
Other time protocols have a fixed target port, but requests are sent from
ephemeral ports. Replies will have a source port matching the target
port, but a target port matching the ephemeral port used for the request.
You need to allow outgoing to ports 123/udp, 9909/udp, and 9909/tcp.
You need to allow incoming replies. If this is a problem for your fire-
wall, you may change soucePortUDP above to any unused port on your system.
If network:sourcePortUDP is zero, the operating system will choose an
ephemeral port. If it is non-zero, it indicates the start of a range of
five ports beginning with the port number you specify. For example, if
you use network:sourcePortUDP=333, then the program will attempt to
bind to port 333. If 333 is already in use, it will try 334, and so on,
for up to five ports. If none of the ports in the range you specify are
available, then the bind (and transaction) will fail. The range is
required because multiple threads may be trying to sending unicast
requests at the same time. Choose a starting port number where you are
sure that the range (port through port + 4) is not being used by other
protocols.
NOTE: network:sourcePortUDP only applies to UDP-based protocols. TCP will
always use an ephemeral source port.
If you are using other Domain Time II products, such as Domain Time II
Manager, Audit Server, or any of the command-line tools, you must open
ports 9909/udp and 9909/tcp for incoming packets. Requests will come
via multicast or unicast directed toward 9909/udp or 9909/tcp. Replies
will be sent to the source port of the request.
If you want to use Manager's ssh feature, you will need configure ssh
on your OS and allow incoming access from port 22/udp.
- If you will be installing DTLinux on a virtual machine, see this article from our
knowledgebase for more information on proper use with virtualization systems.
- If you use cloned OS images to install machines, please read this article
from our knowledgebase about configuring Domain Time properly on your clone image.
Distribution Types
There are three flavors of packaging available:
- TGZ: The most flexible option. Distro-independent, with included scripts to install, upgrade, and remove.
- DEB: For Debian-derived distros like Ubuntu.
- RPM: For distros using the RPM package manager, like Red Hat.
Caution about Graphical Installers: Some distros offer a graphical RPM or DEB package installers. We
recommend using the command line version of rpm or
apt instead, because each graphical overlay behaves differently, and may not give complete installation, upgrade, or remove options.
For example, some graphical installers "upgrade" by doing a remove followed by a re-install. This causes a loss of settings and registration info.
The command line options for RPM ( rpm -U) and
DEB (apt-get install) will upgrade in place, preserving settings.
Installation
- To install DTLinux:
- Download
the latest version of the distribution file you prefer. If using TGZ, extract the files into a blank folder.
cd to the folder containing your installation file(s).
Run the installation command as root (or sudo):
./install.sh
DEB: apt-get install ./[filename]
RPM: rpm -U ./[filename]
If you have purchased a license, register the software by applying the license key. See the registration instructions below.
Configure the software either by:
- Editing the /etc/opt/domtime/dtlinux.conf file locally from within the OS.
or
- Editing the dtlinux.conf file remotely from Domain Time Manager. See the Managing DTLinux Remotely page.
Test your installation
- Ensure the service is started correctly by issuing the
systemctl status dtlinux.service command as root (or sudo).
Examine the /var/log/domtime/dtlinux.log file to see if the service is synchronizing correctly.
Use Domain Time II Manager to connect to DTLinux remotely, if desired. See the Managing DTLinux Remotely page.
Make a backup of your settings
After making config changes and/or applying your registration key, run sudo dtcheck -backup from the Linux command-line.
This preserves your settings
and license in case you mistakenly remove instead of upgrading.
You may restore backed-up settings by running
sudo dtcheck -restore.
Use dtcheck -help for a more detailed explanation.
Upgrade
IMPORTANT: The latest instructions for updating DTLinx can be found in the UpdatingDTLinux.html file
located in the DTLinux distribution files or in the /opt/domtime folder of your DTLinux system.
Please review this file before proceeding.
- To upgrade DTLinux:
If the machine has access to the web (via port 80 TCP), dtlinux can download the update and upgrade for you, regardless of which installation package you used.
(As an alternative, you may configure your Domain Time Manager as an alternate upstream data source so that upgrades do not require Internet access.
See the UpdatingDTLinux.html file located in the DTLinux distribution files or in the /opt/domtime
folder of your DTLinux system for instructions).
To see if there's a newer version available:
dtcheck -update
If so, run either of the following commands as root or sudo:
dtlinux-update
or
/opt/domtime/update.sh
To upgrade if the machine doesn't have Internet access, or if you prefer to download the software yourself:
- Download
the latest version of the distribution file you prefer. If using TGZ, extract the files into a blank folder.
cd to the folder containing your installation file(s).
Run the upgrade command as root (or sudo):
./install.sh
DEB: apt-get install ./[filename]
RPM: rpm -U ./[filename]
Your existing settings and registration info will be preserved during the upgrade.
Upgrading remotely using Domain Time Manager
As of version 5.2.b.2021025, you may push upgrades from Domain Time Manager, allowing you to easily update multiple machines at once.
Please see the Upgrade instructions on the Managing DTLinux Remotely page for the requirements.
Removal
- Run the following command as root (or sudo) regardless of which package installation method you used:
/opt/domtime/remove.sh
Registration
This program is delivered as an evaluation version. You may use it for up
to 30 days for testing. If you want to continue using it after that, you
must obtain a registration code from your vendor. The registration code
will look something like this: 692310601-94007843. The number of digits
may vary.
To register your program, run the following command as root or sudo:
dtlinux -registration=692310601-94007843 *
* Use the real code provided by your vendor, not the example code shown above.
NOTE: You can also send the registration code from a Windows machine running Domain Time,
using either the DTCheck command-line utility or Domain Time II Manager. If you use Manager,
you may register multiple machines at the same time.
- From an elevated Windows command-prompt (requires version 5.2.b.20210103 or later):
dtcheck [name or ip address of the remote Linux machine] -registration=692310601-94007843 *
* Use the real code provided by your vendor, not the example code shown above.
or
Using Domain Time II Manager (requires version 5.2.b.20210103 or later):
Highlight the machine(s) you want to register (this can be done from any Node List in Manager, i.e Domains & Workgroups, DT Nodes, etc.),
right-click and chooose Register Eval Versions from the context menu. Enter your registration code. Manager will apply the code to each selected system.
Proceed to the DTLinux Configuration page Back to the DTLinux page
|
|