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

Add info on where to download binaries to our install docs #2661

Closed
evan-forbes opened this issue Oct 11, 2023 · 8 comments
Closed

Add info on where to download binaries to our install docs #2661

evan-forbes opened this issue Oct 11, 2023 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@evan-forbes
Copy link
Member

evan-forbes commented Oct 11, 2023

          Perhaps we should be adding some of this information to our public docs

Originally posted by @cmwaters in #2654 (review)

cc @jcstein

@evan-forbes evan-forbes added documentation Improvements or additions to documentation and removed needs:triage labels Oct 11, 2023
@jcstein
Copy link
Member

jcstein commented Oct 11, 2023

hiya, where are your install docs? or is this solely referring to adding prebuilt binary downloads as option to the documentation site?

https://github.com/celestiaorg/celestia-app/releases/download/v1.0.0/celestia-app_Linux_x86_64.tar.gz

quick version:

# Define the version and tarball URL
VER="v1.0.0"
URL="https://github.com/celestiaorg/celestia-app/releases/download/$VER/celestia-app_Linux_x86_64.tar.gz"

# Navigate to your home directory (or any other directory where you want to download the tarball)
cd $HOME

# Download the tarball
wget "$URL"

# Extract the tarball to a directory of your choice (for example, /usr/local)
# Note: You might need to adjust the directory and/or permissions, depending on your setup
sudo tar -C /usr/local -xzf "celestia-app_Linux_x86_64.tar.gz"

# Remove the tarball to clean up
rm "celestia-app_Linux_x86_64.tar.gz"

# Now, you can navigate to the directory where the Celestia app was extracted, and run the app from there
cd /usr/local/  # Adjust this path based on where the tarball was extracted
chmod +x celestia-appd  # Make the binary executable, if necessary
./celestia-appd version  # Run the app and check version

@rootulp
Copy link
Collaborator

rootulp commented Oct 12, 2023

hiya, where are your install docs?

There exists an Install section in the celestia-app README.md.

or is this solely referring to adding prebuilt binary downloads as option to the documentation site?

Yea, I think the issue wants to add pre-build binaries to the docs site. Potentially near Installing celestia-app b/c users don't strictly need to do the git clone method, they can use a pre-built binary. As for the docs content, I like what you proposed above! Thanks for drafting so quickly.

Note: with a PR that just merged, pre-built binaries should be created for:

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

so we may want to slightly modify the first step to:

# Modify VERSION to the celestia-app version you would like to install.
VERSION="v1.0.0"

# Modify PLATFORM based on the operating system and architecture of the machine you are installing celestia-app on.
# Ex. Linux_x86_64, Darwin_x86_64, Linux_arm64, Darwin_arm64
PLATFORM="Linux_x86_64"

URL="https://github.com/celestiaorg/celestia-app/releases/download/$VERSION/celestia-app_$PLATFORM.tar.gz"

Based on

Screenshot 2023-10-12 at 9 37 57 AM

From https://github.com/rootulp/celestia-app/releases/tag/v1.0.0-rc5

@jcstein
Copy link
Member

jcstein commented Oct 12, 2023

awesome, thanks @rootulp! I'll go ahead and try to rework that script to detect architecture, and go from there. for now, i'll plan just to add this in Documentation site for now. but can also add to celestia-app Install section if appropriate

@jcstein
Copy link
Member

jcstein commented Oct 25, 2023

picking this up meow

@jcstein
Copy link
Member

jcstein commented Oct 25, 2023

It looks like the binaries weren't published for v1.2.0, and I see the related issues to that.

I have a script in the works, that detects OS/arch, and pulls the latest release. And it's working!

./install.sh
Working from temporary directory: /Users/joshcs/celestia-temp
Latest version detected: v1.2.0
Downloading from: https://github.com/celestiaorg/celestia-app/releases/download/v1.2.0/celestia-app_Darwin_arm64.tar.gz
--2023-10-25 14:38:49--  https://github.com/celestiaorg/celestia-app/releases/download/v1.2.0/celestia-app_Darwin_arm64.tar.gz
Resolving github.com (github.com)... 140.82.114.4
Connecting to github.com (github.com)|140.82.114.4|:443... connected.
HTTP request sent, awaiting response... 404 Not Found
2023-10-25 14:38:49 ERROR 404: Not Found.

Download failed. Exiting.

Here's an example that uses a hard-coded variable for v1.1.0 instead

curl -L https://raw.githubusercontent.com/celestiaorg/devrel-tools/jcs/celestia-app-prebuilt-binaries/celestia-app/install-temp.sh | bash

@jcstein
Copy link
Member

jcstein commented Oct 25, 2023

cooking now. added a checksum verification! here are the logs from that run

@jcstein
Copy link
Member

jcstein commented Oct 25, 2023

and lastly, cleaned up verbose logs and stored in log file

./install-temp.sh
Log file is located at: /Users/joshcs/celestia-temp/logfile.log
Working from temporary directory: /Users/joshcs/celestia-temp
Latest version detected: v1.1.0
Downloading from: https://github.com/celestiaorg/celestia-app/releases/download/v1.1.0/celestia-app_Darwin_arm64.tar.gz
Checksum verification successful.
Binary extracted to: /Users/joshcs/celestia-temp
Temporary files cleaned up.
You can navigate to /Users/joshcs/celestia-temp to find and run the Celestia app.
To run the app and check its version, you may execute the following commands:
  cd /Users/joshcs/celestia-temp
  chmod +x celestia-appd
  ./celestia-appd version

@rootulp
Copy link
Collaborator

rootulp commented Nov 1, 2023

Josh completed this in celestiaorg/docs#1198.
The docs are live at https://docs.celestia.org/nodes/celestia-app#installing-a-pre-built-binary

@rootulp rootulp closed this as completed Nov 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants