-
Notifications
You must be signed in to change notification settings - Fork 2k
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 doc/book/src/user/installation.md
and remove readthedocs.io
references.
#6779
base: master
Are you sure you want to change the base?
Add doc/book/src/user/installation.md
and remove readthedocs.io
references.
#6779
Conversation
…/installation.md` with debian instructions.
…ase checklist for apt fingerprint.
This should resolve #6778 . |
@@ -1 +1 @@ | |||
Please read [our Development Guidelines](https://zcash.readthedocs.io/en/latest/rtd_pages/development_guidelines.html). | |||
Please read [our Development Guidelines](doc/book/src/dev.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link is to the top-level page for the developer documentation, which doesn't have any of the necessary information and isn't rendered with links. We should either change this to point to the rendered version:
Please read [our Development Guidelines](doc/book/src/dev.md). | |
Please read [our Development Documentation](https://zcash.github.io/zcash/dev.html). |
or recreate the developer documentation page. For now I suggest changing the link.
|
||
``` | ||
wget -qO - https://apt.z.cash/zcash.asc | gpg --import | ||
gpg --export B1C9095EAA1848DBB54D9DDA1D05FDC66B372CFE | sudo apt-key add - |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have not verified this key handle.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I calculated this with these commands:
$ wget -qO - https://apt.z.cash/zcash.asc | gpg --import
gpg: key 1D05FDC66B372CFE: "Zcash Master Signing Key (Electric Coin Company) <sysadmin@z.cash>" not changed
gpg: Total number processed: 1
gpg: unchanged: 1
$ gpg --fingerprint 1D05FDC66B372CFE
pub rsa3072 2023-06-19 [SC]
B1C9 095E AA18 48DB B54D 9DDA 1D05 FDC6 6B37 2CFE
uid [ unknown] Zcash Master Signing Key (Electric Coin Company) <sysadmin@z.cash>
sub rsa3072 2023-06-19 [E]
$ gpg --fingerprint 1D05FDC66B372CFE | grep 2CFE | sed 's/ *//g'
B1C9095EAA1848DBB54D9DDA1D05FDC66B372CFE
So this is relying on apt.z.cash
(and the wget/tls/gpg toolchain). We should verify this matches the debian signing keypair we use for deploying those packages.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The key used is the correct one, it is the one used for debian package releases.
See the Zcash documentation wiki (https://zcash.readthedocs.io/en/latest/rtd_pages/zcashd.html) for instructions on building zcashd, | ||
the intended-for-services, no-graphical-interface, reference | ||
implementation of Zcash. | ||
See [the Zcashd book](doc/book/src/) for installation, build, and operation instructions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should link to the rendered version in this case (as this file is aimed at users, not contributors):
See [the Zcashd book](doc/book/src/) for installation, build, and operation instructions. | |
See [the `zcashd` book](https://zcash.github.io/zcash/) for installation, build, and operation instructions. |
* :blue_book: See the documentation at the [ReadTheDocs](https://zcash.readthedocs.io) | ||
for help and more information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Revert this removal and change it to See [the `zcashd` book](https://zcash.github.io/zcash/)
TODO:
|
for instructions on joining the main Zcash network. | ||
Please see our [user documentation](user.md) for instructions on joining the main Zcash network. | ||
|
||
<!-- Relative link destinations like `user.md` live under `./doc/book/src`. --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be possible to make this link Just Work, at least on a Unix checkout:
- Move all book content into a subdirectory, say
guide
. - Symlink
guide
todoc/book/src/guide
.
|
||
## Different Instruction Sets | ||
|
||
Only x86-64 processors are supported. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this true? We have Tier 3 support for aarch64-linux-gnu
.
|
||
If you’re starting from a new virtual machine, sudo may not come installed. See this issue for instructions to get up and running: https://github.com/zcash/zcash/issues/1844 | ||
|
||
## libgomp1 or libstdc++6 version problems |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
libgomp1 was related to OpenMP which we no longer use. Also we don't dynamically link to libstdc++6 any more, we statically link libc++. This whole section should be removed. (Definitely trying to "upgrade" to gcc/g++ 4.9 will not help; that is very out-of-date advice.)
|
||
## Tor | ||
|
||
The repository is also accessible via Tor, after installing the apt-transport-tor package, at the address zcaptnv5ljsxpnjt.onion. Use the following pattern in your sources.list file: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please check that this still works, and delete the section if not.
sudo apt-key del AEFD26F966E279CD | ||
``` | ||
|
||
Then [retrieve the latest key](#fetching-a-new-signing-key), then rerun `sudo apt update`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then [retrieve the latest key](#fetching-a-new-signing-key), then rerun `sudo apt update`. | |
[Retrieve the latest key](#fetching-a-new-signing-key), then rerun `sudo apt update`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The request to remove the section on libgomp1 and libstdc++6 is blocking.
Context: we used to host some docs on https://zcash.readthedocs.io/en/latest/rtd_pages/zcashd.html
and that's goneso we're striving to consolidate docs into the zcashd book in this repo.Edit 2024-04-25: that page on readthedocs was restored.
This adds an installation page to the book, which (currently) only contains Debian instructions.
Important details:
zcash-fetch-params
step. I also followed those instructions on a Debian Bullseye vm.doc/release-process.md
to check that apt fingerprint in the pre-release process.README.md
to replace readthedocs links with internalmdbook
links. The issue here is that this works/makes sense in anmdbook
rendering, but may be confusing in the top-levelREADME.md
context (such as github repo homepage). I added an html comment in order to help local file readers make the connection.