Skip to content

Updated installation instructions for RH based systems #1109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 4, 2023
Merged

Updated installation instructions for RH based systems #1109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,22 @@ If a feature you need is missing please let us know by opening an issue.

Be sure to check out the [documentation website] as it includes guides on getting started, installation and migration, as well as a high-level overview of the code structure.

## Use
## Usage

You can install the packages from the [releases page]. These packages configure ntpd-rs to synchronize your computers clock to servers from the [NTP pool]. After installation, check the status of the ntpd-rs daemon with

```console
$ sudo systemctl status ntpd-rs
```

If ntpd-rs was not started automatically, you can do so now with

```console
$ sudo systemctl start ntpd-rs
```

You should now be able to check the synchronization status with

After installing the packages from the [releases page], ntpd-rs will by default synchronize your computers clock to servers from the [NTP pool]. When installed, you can check the synchronization status with
```console
$ ntp-ctl status
Synchronization status:
Expand Down
13 changes: 7 additions & 6 deletions docs/guide/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,14 @@ The recommended way of installing ntpd-rs is through an installer or package man
We recommend the packages from our [release page](https://github.com/pendulum-project/ntpd-rs/releases). The package takes care of putting the configuration in the right place and setting up the recommended users and permissions. The default configuration file is located at `/etc/ntpd-rs/ntp.toml`

On a debian based linux, the `.deb` package can be installed with
```
sudo dpkg -i /path/to/deb/file.deb
```console
$ sudo dpkg -i /path/to/deb/file.deb
```

On an red hat based linux, the `.rpm` package can be installed with
```
sudo rpm -ivh /path/to/rpm/file.rpm
On a red hat based linux, the `.rpm` package can be installed with
```console
$ sudo rpm -ivh /path/to/rpm/file.rpm
$ sudo systemctl start ntpd-rs
```

### FreeBSD
Expand Down Expand Up @@ -68,7 +69,7 @@ It is by far the easiest to have your operating system and standard tools take c

- ensure that no competing NTP daemon is running
- ensure that the daemon is started on startup
- handling the ntpd-rs logs
- handling the ntpd-rs logs

Below are configurations for linux (using `SystemD`) and FreeBSD (using a .rc file).

Expand Down