Skip to content
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.

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

docs: update quickstart #1766

Merged
merged 7 commits into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
33 changes: 23 additions & 10 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -255,14 +255,15 @@ function nav() {
text: "Join the network",
items: [
{ text: "Learn", link: "/learn/how-celestia-works/overview" },
{ text: "Quick start", link: "/how-to-guides/quick-start" },
{ text: "Build whatever", link: "/how-to-guides/build-whatever" },
{ text: "Node API", link: "/tutorials/node-api" },
{ text: "Discord", link: "https://discord.gg/celestiacommunity" },
{
text: "Quick start",
text: "Resources",
items: [
{ text: "Run a node", link: "/how-to-guides/nodes-overview" },
{ text: "Blob tutorial", link: "/tutorials/node-tutorial" },
{
text: "Celestia Improvement Proposals (CIPs)",
link: "https://cips.celestia.org/",
},
{
text: "celestia-app specs",
link: "https://celestiaorg.github.io/celestia-app/",
Expand Down Expand Up @@ -380,14 +381,20 @@ function sidebarHome() {
items: [
{
text: "Run a node",
link: "/how-to-guides/nodes-overview",
collapsed: true,
items: [
{
text: "Quick start",
link: "/how-to-guides/quick-start",
text: "Overview",
link: "/how-to-guides/nodes-overview",
},
{
text: "Getting started",
collapsed: true,
items: [
{
text: "Quick start",
link: "/how-to-guides/quick-start",
},
{
text: "Deciding which node to run",
link: "/how-to-guides/decide-node",
Expand Down Expand Up @@ -552,9 +559,12 @@ function sidebarHome() {
},
{
text: "Build whatever",
link: "/how-to-guides/build-whatever",
collapsed: true,
items: [
{
text: "Overview",
link: "/how-to-guides/build-whatever",
},
{
text: "EVM",
collapsed: true,
Expand Down Expand Up @@ -807,9 +817,12 @@ function sidebarHome() {
items: [
{
text: "Node API Tutorials",
link: "/tutorials/node-api",
collapsed: true,
items: [
{
text: "Overview",
link: "/tutorials/node-api",
},
{
text: "CLI tutorial",
link: "/tutorials/node-tutorial",
Expand Down
3 changes: 3 additions & 0 deletions how-to-guides/celestia-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ This tutorial will guide you through installing celestia-app, both
[from source](#building-binary-from-source) and with
[a pre-built binary](#installing-a-pre-built-binary)

Celestia-app is the software that allows you to run
validator nodes and provide RPC endpoints.

## Building binary from source

This section of the tutorial presumes you completed the steps in
Expand Down
49 changes: 32 additions & 17 deletions how-to-guides/celestia-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,36 +96,51 @@ commit hash, build date, system version, and Golang version.

## Installing a pre-built binary

Installing a pre-built binary is the fastest way to get started with your
Celestia data availability node. Releases after celestia-node v0.13.3 should have
these binaries available.
Installing a pre-built binary is the fastest way to get started with your Celestia data availability node. Releases after celestia-node v0.13.3 have these binaries available.

The steps below will download a binary file named `celestia`.
Depending on the setup that you choose during installation, the `celestia`
binary will be available at either:

- `$HOME/celestia-node-temp/celestia`
The installation script will download a binary file named `celestia`. Depending on your chosen installation option, the `celestia` binary will be available at one of these locations:
- `$GOPATH/bin/celestia` (if Go is installed)
- `/usr/local/bin/celestia`
- `$HOME/celestia-node-temp/celestia`

Pre-built binaries are available for:

- Operating systems: Darwin (Apple), Linux
- Architectures: x86_64 (amd64), arm64

To install the latest pre-built binary you can run this command in your
terminal:
### Installation Options

```bash
You can install the latest version or specify a particular version:

```bash-vue
# Install latest version
bash -c "$(curl -sL https://docs.celestia.org/celestia-node.sh)"

# Install specific version
bash -c "$(curl -sL https://docs.celestia.org/celestia-node.sh)" -- -v {{mainnetVersions['node-latest-tag']}}
```

Follow the instructions in the terminal output to choose your installation
preferences.
The script will:
1. Detect your system's operating system and architecture
2. Download the appropriate binary
3. Verify the checksum for security
4. Provide installation location options based on your environment:
- If Go is installed:
- Go bin directory (`$GOPATH/bin`)
- System bin directory (`/usr/local/bin`)
- Keep in current directory
- If Go is not installed:
- System bin directory (`/usr/local/bin`)
- Keep in current directory

Follow the instructions in the terminal output to choose your installation preferences. After installation, you can verify the setup by checking the version:

```bash
celestia version && celestia --help
```

You will see an output with the menu for `celestia`.
View [the script](https://github.com/celestiaorg/docs/tree/main/public/celestia-node.sh) to learn more about what it is doing.

View [the script](https://github.com/celestiaorg/docs/tree/main/public/celestia-node.sh)
to learn more about what it is doing.
> **Note**: The script maintains a log file at `$HOME/celestia-node-temp/logfile.log` for troubleshooting purposes.

## Next steps

Expand Down
Loading
Loading