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

Created Install Script for Debian #3041

Open
wants to merge 25 commits into
base: testnet3
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,17 +82,31 @@ Next, move into the `snarkOS` directory:
cd snarkOS
```

Lastly, install `snarkOS`:
```
cargo install --locked --path .
```

Please ensure ports `4133/tcp` and `3033/tcp` are open on your router and OS firewall.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's get rid of port recommendations. Also these are not even the defaults? 🤔


**[For Ubuntu users]** A helper script to install dependencies is available. From the `snarkOS` directory, run:
```
./build_ubuntu.sh
```

Lastly, install `snarkOS`:

**[For Debian users]**

Firstly, install the most recent versions of LLVM and Clang.
Download the official install script from here (https://apt.llvm.org/llvm.sh) and then run:
```
cargo install --locked --path .
./llvm.sh
```

Please ensure ports `4133/tcp` and `3033/tcp` are open on your router and OS firewall.
A helper script to install dependencies is available. From the `snarkOS` directory, run:
```
./build_debian.sh
```

## 3. Run an Aleo Node

Expand Down
40 changes: 40 additions & 0 deletions build_debian.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#!/bin/bash
echo "================================================"
echo " Attention - Building snarkOS from source code."
echo " This will request root permissions with sudo."
echo "================================================"

# Install Debian dependencies

sudo apt-get update
sudo apt-get install -y \
build-essential \
curl \
gcc \
libssl-dev \
make \
pkg-config \
sudo \
tmux \
xz-utils \
fabrinasr marked this conversation as resolved.
Show resolved Hide resolved

# Install Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
source $HOME/.cargo/env

# Install snarkOS
# cargo clean
cargo install --locked --path .

echo "=================================================="
echo " Attention - Please ensure ports 4130 and 3030"
echo " are enabled on your local network."
echo ""
echo " Cloud Providers - Enable ports 4130 and 3030"
echo " in your network firewall"
echo ""
echo " Home Users - Enable port forwarding or NAT rules"
echo " for 4130 and 3030 on your router."
echo "=================================================="

1 change: 1 addition & 0 deletions build_ubuntu.sh
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ sudo apt-get install -y \
llvm \
make \
pkg-config \
sudo \
tmux \
xz-utils \
ufw
Expand Down