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
{{ message }}
This repository was archived by the owner on Feb 23, 2023. It is now read-only.
Update Horizon deployment docs to reflect the latest release (#636)
* Update docs to reflect latest Horizon version:
- ingestion is enabled by default
- guidance around building stellar-core
- there is no stellar-captive-core package on stable
- more guidance around using pubnet
* Prefer links to doc site rather than external places
- The first parameter, `--ingest=true`, enables the ingestion subservice.
53
-
- The second parameter, `--captive-core-config-path`, points to a Captive Core configuration file. This TOML file only requires a few fields (explained [below](#configuring-captive-core)) to get up and running.
54
-
- The final parameter, `--stellar-core-binary-path`, is a filesystem path to a Stellar Core binary. Horizon will actually search your PATH for `stellar-core` by default, so if your environment is configured appropriately, you won't even need to pass this.
51
+
Note that **ingestion is enabled by default**.
52
+
53
+
- The first parameter, `--captive-core-config-path`, points to a Captive Core configuration file. This TOML file only requires a few fields (explained [below](#configuring-captive-core)) to get up and running.
54
+
- The second parameter, `--stellar-core-binary-path`, is a filesystem path to a Stellar Core binary. Horizon will actually search your PATH for `stellar-core` by default, so if your environment is configured appropriately, you don't need to pass this.
55
55
56
56
#### Without Ingestion
57
57
If you aren't configuring your Horizon instance to perform ingestion, it still needs awareness about what's going on in the Stellar network to be useful. Thus, you need to point Horizon to a running Stellar Core instance:
This can be a [Remote Captive Core](./remote-core.mdx) instance with its underlying Core node exposed or a [standalone](../run-core-node/) Stellar-Core instance.
@@ -78,7 +79,7 @@ This script invokes Horizon with the `stellar` user, so make sure that permissio
78
79
79
80
</Alert>
80
81
81
-
Note that the default configuration (located at `/etc/default/stellar-horizon`) provided by the package manager will **enable ingestion by default** (`INGEST=true`). Again, refer to the later [Ingestion](./ingestion.mdx) page to see what setup is right for you. If you want certain nodes dedicated exclusively to fulfilling requests, you should drop this flag accordingly.
82
+
Note that the default configuration (located at `/etc/default/stellar-horizon`) provided by the package manager **enables ingestion by default**. Again, refer to the later [Ingestion](./ingestion.mdx) page to see what setup is right for you. If you want certain nodes dedicated exclusively to fulfilling requests, you should set this flag to `false` accordingly.
82
83
83
84
84
85
## Preparing the Database
@@ -141,7 +142,7 @@ _(For the remainder of this guide, we'll assume this file lives at `/etc/default
141
142
142
143
The minimum required fields are the `[[HOME_DOMAINS]]` and a set of `[[VALIDATORS]]`.
143
144
144
-
If you wanted to adapt this and configure your nodes to work on the Stellar **pubnet**, you'll need to think more carefully about the validators you want to trust in your quorum. As inspiration, [here](https://github.com/stellar/go/blob/master/services/horizon/docker/stellar-core-pubnet.cfg#L15-L202) is the set of domains and validators that SDF includes in its pubnet quorum.
145
+
If you wanted to adapt this and configure your nodes to work on the Stellar **pubnet**, you'll need to think more carefully about the validators you want to trust in your quorum. As inspiration, [here](https://github.com/stellar/go/blob/master/services/horizon/docker/stellar-core-pubnet.cfg#L15-L202) is the set of domains and validators that SDF includes in its pubnet quorum. You should also familiarize yourself with how to configure a proper quorum set; the [Core documentation](../run-core-node/configuring.mdx#choosing-your-quorum-set) has more on this.
145
146
146
147
Captive Core's functionality is controlled through this file. Note that while the Captive Core configuration looks like a subset of a traditional Stellar Core configuration file, you cannot use a traditional Stellar Core configuration file to configure Captive Core. The TOML format is preserved for operator ease of [migrating](./migrating.mdx) from Horizon 1.x, but this is a fundamentally different architecture and should be treated as such.
Copy file name to clipboardExpand all lines: content/docs/run-api-server/installing.mdx
+4-2
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ import { CodeExample } from "components/CodeExample";
8
8
To install Horizon, you have a few choices. You can...
9
9
- install prebuilt binaries [from our repositories](#package-manager) via your package manager if running a Debian-based system,
10
10
- download a [prebuilt release](https://github.com/stellar/go/releases/latest) of Horizon for your target architecture and operation system, or
11
-
-[build Horizon yourself](#building) from scratch.
11
+
-[build Horizon and Stellar Core yourself](#building) from scratch.
12
12
13
13
**The first method is recommended**: Not only do you ensure OS compatibility and dependency management, you'll also install some convenient wrappers that make running Horizon and Stellar Core in their respective environments much simpler.
14
14
@@ -22,7 +22,7 @@ SDF publishes new releases to its custom Ubuntu repositories. Follow [this guide
You will also need to compile Stellar Core from its source code if you need ingestion or transaction submission. You should refer to [their installation guide](https://github.com/stellar/stellar-core/blob/master/INSTALL.md) for details.
65
+
64
66
Next, jump ahead to [Testing Your Installation](#completing-and-testing-your-installation).
Copy file name to clipboardExpand all lines: content/docs/run-api-server/migrating.mdx
+3-15
Original file line number
Diff line number
Diff line change
@@ -82,17 +82,7 @@ If you want to continue to have access to the underlying Stellar Core subprocess
82
82
83
83
### Installation
84
84
85
-
Once you have a configuration file ready, you can install the Captive Core package to prepare the Horizon configuration:
86
-
87
-
<CodeExample>
88
-
89
-
```bash
90
-
sudo apt install stellar-captive-core
91
-
```
92
-
93
-
</CodeExample>
94
-
95
-
Note the block in the new `/etc/default/stellar-horizon` file:
85
+
Once you have a configuration file ready, you should also modify your Horizon configuration to include Captive Core parameters. Within `/etc/default/stellar-horizon`, you should add:
(Your old configuration will have a `.old` suffix appended to it, so be sure to bring the parameters back over to the new default.)
111
-
112
-
You will need to adjust these accordingly, for example by pointing `CAPTIVE_CORE_CONFIG_PATH` to your configuration file and possibly `CAPTIVE_CORE_STORAGE_PATH` to where you'd like Captive Core to store its bucket files (but keep in mind the [disk space](./prerequisites.mdx) and [permissions](./configuring.mdx#package-manager-installation) requirements).
100
+
You may need to adjust these accordingly, for example by pointing `CAPTIVE_CORE_CONFIG_PATH` to your configuration file and possibly `CAPTIVE_CORE_STORAGE_PATH` to where you'd like Captive Core to store its bucket files (but keep in mind the [disk space](./prerequisites.mdx) and [permissions](./configuring.mdx#package-manager-installation) requirements).
113
101
114
102
Finally, the process for upgrading both Stellar Core and Horizon is covered [here](https://github.com/stellar/packages/blob/master/docs/upgrading.md#upgrading).
The logs should show Captive Core running successfully as a subprocess, and eventually Horizon will be running as usual except with Captive Core rapidly generating transaction metadata in-memory!
124
+
After a few moments, the logs should show Captive Core running successfully as a subprocess, and eventually Horizon will be running as usual except with Captive Core rapidly generating transaction metadata in-memory!
0 commit comments