You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
* refresh various commands and ensure they will work by default on a package based installation
Copy file name to clipboardexpand all lines: docs/validators/admin-guide/commands.mdx
+4-4
Original file line number
Diff line number
Diff line change
@@ -20,10 +20,10 @@ Additionally, while the commands on this page are _CLI_ commands, there is an ad
20
20
The `--help` (aliases: `-h` or `-?`) option can be specified at _any place_ in the command line. It will show you the help message for the relevant command. Some example useage is as follows:
Copy file name to clipboardexpand all lines: docs/validators/admin-guide/configuring.mdx
+2-1
Original file line number
Diff line number
Diff line change
@@ -15,12 +15,13 @@ Before attempting to configure stellar-core, it is highly recommended to first t
15
15
16
16
After you've [installed](./installation.mdx) Stellar Core, your next step is to complete a configuration file that specifies crucial things about your node — like whether it connects to the Testnet or the Mainnet public network, what database it writes to, and which other nodes are in its [quorum set](#choosing-your-quorum-set).
17
17
18
-
All configuration for stellar-core is done with a [TOML](https://github.com/toml-lang/toml) file. By default, Stellar Core loads that file from `./stellar-core.cfg`, but you can specify a different file to load on the command line:
18
+
All configuration for stellar-core is done with a [TOML](https://github.com/toml-lang/toml) file. By default, Stellar Core loads that file from `./stellar-core.cfg` and Debian packages will use the `/etc/stellar/stellar-core.cfg` file. You can specify a different file to load on the command line:
19
19
20
20
```bash
21
21
stellar-core --conf betterfile.cfg <COMMAND>
22
22
```
23
23
24
+
When installing using official Debian packages systemd unit file is configured to use `/etc/stellar/stellar-core.cfg` file
24
25
The examples in these docs don't specify `--conf betterfile.cfg` for the sake of brevity.
25
26
26
27
This page will walk you through the key fields you'll need to include in your config file to get your node up and runninig.
Copy file name to clipboardexpand all lines: docs/validators/admin-guide/environment-preparation.mdx
+11
Original file line number
Diff line number
Diff line change
@@ -79,6 +79,17 @@ The very first time you want to use your archive, _before starting your node_, y
79
79
stellar-core new-hist <historyarchive>
80
80
```
81
81
82
+
:::note
83
+
84
+
In a secure, production, environment Stellar Core should be run as a dedicated user. Debian packages will ensure the `stellar` user exists on the system.
85
+
For this reason you may need to run commands as the stellar user, for example:
More detailed guidance and strategies for publishing history archives can be found in the [publishing history archives](./publishing-history-archives.mdx) page. Please check there for more information.
Copy file name to clipboardexpand all lines: docs/validators/admin-guide/installation.mdx
+36-3
Original file line number
Diff line number
Diff line change
@@ -25,9 +25,42 @@ The version number scheme that we follow is `protocol_version.release_number.pat
25
25
26
26
## Package-Based Installation
27
27
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 the Stellar Development Foundation and files can be validated on the system to confirm they were not tampered with. Debian packages utilize operating system built-in cryptographic verification during upgrades which mitigates many supply chain attacks.
29
29
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.
| 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 |
@@ -65,7 +98,7 @@ docker run -v "/path/to/config/dir:/etc/stellar/" stellar/stellar-core:latest ne
65
98
docker run -d -v "/path/to/config/dir:/etc/stellar/" stellar/stellar-core:latest run
66
99
```
67
100
68
-
The image utilizes deb packages so it's possible to confirm the checksum of the `stellar-core` binary in the docker image matches what is in the cryptographically signed deb package. See [packages documentation](https://github.com/stellar/packages/) for information on installing Ubuntu packages. To calculate this checksum in the docker image you can run:
101
+
The image utilizes deb packages so it's possible to confirm the checksum of the `stellar-core` binary in the docker image matches what is in the cryptographically signed deb package. See [package based installation section](#package-based-installation) for information. To calculate this checksum in the docker image you can run:
69
102
70
103
```bash
71
104
docker run --entrypoint=/bin/sha256sum stellar/stellar-core:latest /usr/bin/stellar-core
Copy file name to clipboardexpand all lines: docs/validators/admin-guide/logging.mdx
+2-2
Original file line number
Diff line number
Diff line change
@@ -14,15 +14,15 @@ Log messages at different priority levels can be color-coded on standard error b
14
14
The log level can be controlled by configuration, the `--ll` command-line flag, or adjusted dynamically by administrative (HTTP) commands. To do so, run:
Log levels can also be adjusted on a partition-by-partition basis through the administrative interface. For example the history system can be set to `DEBUG`-level logging by running:
Copy file name to clipboardexpand all lines: docs/validators/admin-guide/monitoring.mdx
+11-11
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ However you decide to monitor, the most important thing is that you have a syste
19
19
20
20
## General Node Information
21
21
22
-
If you run `$ stellar-core http-command 'info'`, the output will look something like this:
22
+
If you run `sudo -u stellar stellar-core --conf /etc/stellar/stellar-core.cfg http-command 'info'`, the output will look something like this:
23
23
24
24
```json
25
25
{
@@ -90,7 +90,7 @@ The `peers` command returns information on the peers your node is connected to.
90
90
This list is the result of both inbound connections from other peers and outbound connections from this node to other peers. If `compact=false` is used in the command, then it also returns some extra metrics on each peer such as the number of dropped messages.
Overall network health can be evaluated by walking through all nodes and looking at their health. Note that this is only an approximation, as remote nodes may not have received the same messages (in particular: `missing` for other nodes is not reliable).
@@ -452,7 +452,7 @@ When showing quorum-set information about the local node rather than some other
452
452
The quorum endpoint can also retrieve detailed information about the transitive quorum. This is a format that's easier to process than what `scp` returns, as it doesn't contain all SCP messages.
Copy file name to clipboardexpand all lines: docs/validators/admin-guide/prerequisites.mdx
+1-1
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Stellar Core is designed to run on relatively modest hardware so that a whole ra
23
23
24
24
_\* Assuming a 30-day retention window for data storage._
25
25
26
-
## Network Access
26
+
## Stellar Network Access
27
27
28
28
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.
Copy file name to clipboardexpand all lines: docs/validators/admin-guide/running-node.mdx
+2-2
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Once you've [set up your environment](./prerequisites.mdx), [configured your nod
10
10
Use a command equivalent to:
11
11
12
12
```bash
13
-
stellar-core run
13
+
sudo systemctl start stellar-core
14
14
```
15
15
16
16
At this point, you're ready to observe your core node's activity as it joins the network.
@@ -22,7 +22,7 @@ You may want to skip ahead and review the [Logging](./logging.mdx) page to famil
22
22
When your node is running, you can interact with Stellar Core via an administrative HTTP endpoint. Commands can be issued using command-line HTTP tools such as `curl`, or by running a CLI command such as
The HTTP endpoint is [not intended to be exposed to the public internet](./prerequisites.mdx#internal-system-access). It's typically accessed by administrators, or by a mid-tier application to submit transactions to the Stellar network.
0 commit comments