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.

Sign up for GitHub

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

Debian copy-paste installation commands #343

Open
wants to merge 2 commits into
base: 00-gitbook-docs
Choose a base branch
from
Open

Debian copy-paste installation commands #343

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d45d61
Ubuntu copy-paste installation commands
akalmykov Nov 7, 2023
3a5eaa5
Updated original instructions
akalmykov Nov 8, 2023
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
8 changes: 8 additions & 0 deletions gitbook-docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ apt update
apt install -y zkllvm cmake libboost-all-dev
```

For Ubuntu, use the following commands:
Copy link
Contributor

Choose a reason for hiding this comment

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

It's not about Ubuntu, but rather about running under an unprivileged user. In most cases it means that we're not in a container.

It's supposed that devs either run these commands under a privileged user or use sudo when it's needed.

But if you feel it's better to add sudo explicitly, please amend the original instruction instead.

Copy link
Author

Choose a reason for hiding this comment

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

Yes, this is not Ubuntu specific, rather it covers most Debian use cases. The goal was just to make a sure a developer can copy-paste commands to install - right now this is not the case.

It's highly unusual for any *nix distro for a user to run a terminal under a priveledged user by default. At the same time, using su before executing a series of commands is less secure because sudo offers more granular control over user permissions. But a developer cannot just prefix the commands in the doc with sudo, e.g. this doesn't work

sudo echo 'deb [trusted=yes]  http://deb.nil.foundation/ubuntu/ all main' >>/etc/apt/sources.list

and has to be changed to:

sudo bash -c "echo 'deb [trusted=yes]  http://deb.nil.foundation/ubuntu/ all main' >>/etc/apt/sources.list"

I'll change the orginal instructions


```bash
sudo bash -c "echo 'deb [trusted=yes] http://deb.nil.foundation/ubuntu/ all main' >>/etc/apt/sources.list"
sudo apt update
sudo apt install -y zkllvm cmake libboost-all-dev
```

# Installation from sources

## Clone repository
Expand Down