Skip to content

Commit c93baac

Browse files
committed
Update core node documentation
* add information about debian package signing * add information about adding apt repo to Ubuntu systems * add list of packages and install instructions * clarify "Network Access" section name to make it explicit this it's specific to the stellar network
1 parent 230e45a commit c93baac

File tree

2 files changed

+36
-3
lines changed

2 files changed

+36
-3
lines changed

docs/validators/admin-guide/installation.mdx

+35-2
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,42 @@ The version number scheme that we follow is `protocol_version.release_number.pat
2525

2626
## Package-Based Installation
2727

28-
If you are using a recent LTS version of Ubuntu, we provide the latest stable releases of [`stellar-core`](https://github.com/stellar/stellar-core) and [`stellar-horizon`](https://github.com/stellar/go/tree/master/services/horizon) in Debian binary package format.
28+
If you are using a recent LTS version of Ubuntu, we provide [`stellar-core`](https://github.com/stellar/stellar-core) and [`stellar-horizon`](https://github.com/stellar/go/tree/master/services/horizon) in Debian binary package format. The packages are cryptographically signed by SDF and files can be validated on the system to confirm they were not tampered with. Debian packages also allow for safe upgrades and downgrades.
2929

30-
You may choose to install these packages individually, which offers the greatest flexibility, but requires **manual** creation of the relevant configuration files and configuration of a **PostgreSQL** database.
30+
SDF package signing key fingerprint is **AEAF 01EE A6CA FCEF DDAE 8AA7 0463 8272 A136 B5A6** (A136B5A6)
31+
32+
### Configure SDF Apt Repository On The System
33+
34+
```bash
35+
sudo install -d /etc/apt/keyrings
36+
sudo curl -fsSL https://apt.stellar.org/SDF.asc -o /etc/apt/keyrings/SDF.asc
37+
sudo chmod a+r /etc/apt/keyrings/SDF.asc
38+
echo "deb [signed-by=/etc/apt/keyrings/SDF.asc] https://apt.stellar.org $(lsb_release -cs) stable" | sudo tee -a /etc/apt/sources.list.d/SDF.list
39+
```
40+
41+
Optionally you can add testing repository. This is not recommended for production systems but may be useful for non-production systems using testnet:
42+
```bash
43+
echo "deb [signed-by=/etc/apt/keyrings/SDF.asc] https://apt.stellar.org $(lsb_release -cs) stable" | sudo tee -a /etc/apt/sources.list.d/SDF.list
44+
```
45+
46+
### Install packages
47+
48+
We publish multiple packages for convenience.
49+
50+
| Package | Dependencies | Comments |
51+
| --- | --- | --- |
52+
| stellar-core | none | installs stellar-core binary, systemd service, logrotate script, documentation |
53+
| stellar-core-utils | none | installs useful command line tools (stellar-core-cmd, stellar-core-gap-detect) |
54+
| stellar-core-prometheus-exporter | none | installs a Prometheus exporter to facilitate ingesting stellar-core metrics |
55+
| stellar-core-postgres | stellar-core, PostgreSQL | configures a PostgreSQL server, creates a stellar db,role and system user, the default stellar-core configuration contained in this package will connect to the Testnet|
56+
| stellar-archivist | none | installs stellar-archivist cli tool for managing stellar-core History archives |
57+
58+
To install a chosen package run:
59+
60+
```bash
61+
# To install stellar-core
62+
sudo apt-get update && apt-get install <package_name>
63+
```
3164

3265
## Installing From Source
3366

docs/validators/admin-guide/prerequisites.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Stellar Core is designed to run on relatively modest hardware so that a whole ra
2323

2424
_\* Assuming a 30-day retention window for data storage._
2525

26-
## Network Access
26+
## Stellar Network Access
2727

2828
Stellar Core interacts with the peer-to-peer network to keep a distributed ledger in sync, which means that your node needs to make certain [TCP ports](https://en.wikipedia.org/wiki/Transmission_Control_Protocol#TCP_ports) available for inbound and outbound communication.
2929

0 commit comments

Comments
 (0)