233d756518
Logging and startup improvements ( #3038 )
...
* Logging and startup improvements
Color support for released binaries!
* startup scripts no longer log to file by default - this only affects
source builds - released binaries don't support file logging
* add --log-stdout option to control logging to stdout (colors, json)
* detect tty:s vs redirected logs and log accordingly
* add option to disable log colors at runtime
* simplify several "common" logs, showing the most important information
earlier and more clearly
* remove line numbers / file information / tid - these take up space and
are of little use to end users
* still enabled in debug builds and tools
* remove `testnet_servers_image` compile-time option
* server images, released binaries and compile-from-source now offer
the same behaviour and features
* fixes https://github.com/status-im/nimbus-eth2/issues/2326
* fixes https://github.com/status-im/nimbus-eth2/issues/1794
* remove instanteneous block speed from sync message, keeping only
average
before:
```
INF 2021-10-28 16:45:59.000+02:00 Slot start topics="beacnde" tid=386429 file=nimbus_beacon_node.nim:884 lastSlot=2384027 wallSlot=2384028 delay=461us84ns peers=0 head=75a10ee5:3348 headEpoch=104 finalized=cd6804ba:3264 finalizedEpoch=102 sync="wwwwwwwwww:0:0.0000:0.0000:00h00m (3348)"
INF 2021-10-28 16:45:59.046+02:00 Slot end topics="beacnde" tid=386429 file=nimbus_beacon_node.nim:821 slot=2384028 nextSlot=2384029 head=75a10ee5:3348 headEpoch=104 finalizedHead=cd6804ba:3264 finalizedEpoch=102 nextAttestationSlot=-1 nextProposalSlot=-1 nextActionWait=n/a
```
after:
```
INF 2021-10-28 22:43:23.033+02:00 Slot start topics="beacnde" slot=2385815 epoch=74556 sync="DDPDDPUDDD:10:5.2258:01h19m (2361088)" peers=37 head=eacd2dae:2361096 finalized=73782:a4751487 delay=33ms687us715ns
INF 2021-10-28 22:43:23.291+02:00 Slot end topics="beacnde" slot=2385815 nextActionWait=n/a nextAttestationSlot=-1 nextProposalSlot=-1 head=eacd2dae:2361096
```
* fix comment
* documentation updates
* mention `--log-file` may be deprecated in the future
* update various docs
2021-11-02 18:06:36 +01:00
56c6d6b583
update troubleshooting ( #3044 )
...
* update troubleshooting
* remove pyrmont references
2021-11-01 17:46:59 +01:00
07e4dd5f23
edit networking, remove references to pyrmont ( #3027 )
2021-10-25 19:40:29 +02:00
dc3c23788a
update networking, update hardware requirements, set up health.md ( #3020 )
2021-10-21 16:18:46 +02:00
c3c8e27011
Network setup update ( #2999 )
...
* cp
* cp
* Update docs/the_nimbus_book/src/faq.md
Co-authored-by: Ștefan Talpalaru <stefantalpalaru@yahoo.com>
* Update docs/the_nimbus_book/src/faq.md
Co-authored-by: Ștefan Talpalaru <stefantalpalaru@yahoo.com>
* Update docs/the_nimbus_book/src/networking.md
Co-authored-by: Jacek Sieka <jacek@status.im>
* Update docs/the_nimbus_book/src/networking.md
Co-authored-by: Jacek Sieka <jacek@status.im>
* Update docs/the_nimbus_book/src/networking.md
Co-authored-by: Jacek Sieka <jacek@status.im>
* Update docs/the_nimbus_book/src/networking.md
Co-authored-by: Jacek Sieka <jacek@status.im>
* Update docs/the_nimbus_book/src/networking.md
Co-authored-by: Jacek Sieka <jacek@status.im>
* fix links
* new line
* extip edits
* update read logs
* cp
* cp
Co-authored-by: Ștefan Talpalaru <stefantalpalaru@yahoo.com>
Co-authored-by: Jacek Sieka <jacek@status.im>
2021-10-21 15:34:46 +02:00
6cc8757930
update 18 spec URLs to v1.1.2; switch from eth2.0-specs to consensus-specs ( #2990 )
2021-10-14 06:30:21 +00:00
6f1cfc2a8c
add testing apis ( #2953 )
2021-10-04 18:34:24 +02:00
653fc72b2e
Document that the REST API is out of beta ( #2947 )
2021-10-04 13:55:02 +02:00
2ec34e6761
Book edits ( #2887 )
...
* cp
* cp
2021-09-22 15:52:42 +02:00
7b6976d3fd
bump Nim version in developer docs ( #2841 )
...
The developer documentation contains a comment mentioning the version of
Nim that the project is tested against. This comment was not updated for
a while (last Nim update in #2508 ). Bumping now to be in sync once more.
2021-09-01 14:55:54 +02:00
860897172a
connect-eth2.md: fix small typo ( #2804 )
2021-08-22 11:24:56 +02:00
c3a0e4ec16
API doc fixes
...
`getSpecPreset` was removed pre-1.0.0 and has never worked - debug calls
were renamed around 1.1.0.
2021-08-16 18:41:13 +02:00
01f78fb93e
update links to joe's guides ( #2775 )
2021-08-11 15:29:49 +02:00
fe96c3e993
add page on security audit ( #2774 )
...
* add page on security audit
* incorporate feedback
2021-08-11 15:16:02 +02:00
3d7bee8502
REST API client, JSON-RPC cleanups ( #2756 )
...
This refactoring puts the JSON-RPC and REST APIs on more equal footing
by renaming and moving things around, creating a separation between
client and server, and documenting what they are - the aim is to have a
simple-to-use base to start from when developing API clients, as well as
make it easier to navigate the code when looking for the legacy JSON-RPC
interface vs the new REST API.
* move REST client, serialization and supporting types to spec/eth2_apis
* REST stuff now starts with `rest_`, JSON-RPC stuff starts with `rpc_`,
more or less
* simplify imports such that there's a simple module to import for both
server and client
* map REST type and proc names to yaml spec more closely - in
particular, reuse operation and type names in `rest_types` to make
comparisons against spec more easy
* cleaner separation between client and server modules - modules common
between server and client such as `rest_types` and serialization move to
the spec folder - this allows the client to be built with less knowledge
about server internals
2021-08-03 17:17:11 +02:00
bb0a086be3
book updates ( #2721 )
...
* cp
* rename API to JSON-RPC API
* rename api to json-rpc api, add rest api page
* remove extra emacs generated file
* remove extra emacs generated file
2021-07-14 13:14:39 +02:00
3c7d10cd2a
misc book updates ( #2702 )
2021-07-05 16:17:35 +02:00
c0bbdb0f9f
bin dist related docs ( #2684 )
...
* bin dist related docs
* Update docker/README.md
Co-authored-by: 0xmiel <sacha@status.im>
* Update docker/README.md
Co-authored-by: 0xmiel <sacha@status.im>
* Update docker/README.md
Co-authored-by: 0xmiel <sacha@status.im>
* Update docs/the_nimbus_book/src/binaries.md
Co-authored-by: 0xmiel <sacha@status.im>
* Update docs/the_nimbus_book/src/distribution_internals.md
Co-authored-by: 0xmiel <sacha@status.im>
* Update docs/the_nimbus_book/src/distribution_internals.md
Co-authored-by: 0xmiel <sacha@status.im>
* Update docs/the_nimbus_book/src/binaries.md
Co-authored-by: 0xmiel <sacha@status.im>
Co-authored-by: 0xmiel <sacha@status.im>
2021-07-05 12:31:25 +02:00
72544f06c0
Update FAQ + minor edits ( #2678 )
2021-06-25 11:52:06 +02:00
42738848f3
Update keep-updated.md
...
fix typo
2021-06-22 12:05:57 +02:00
fed0a1dc00
update keep updated page ( #2665 )
2021-06-21 22:50:26 +02:00
96c489bb3d
Faq update + misc edits ( #2653 )
...
* update faq with permissions help, link in migration guide and importing keys
* add link to Git for Windows
* update windows install
2021-06-16 11:55:58 +02:00
f2588be9ab
update faq and add example to systemd ( #2645 )
2021-06-11 13:56:15 +02:00
042600a134
Document ncli_db validatorPerf ( #2638 )
...
* add work done so far on ncli_db
* remove file
* Monitor attestation performance: tidy up
* remove test.csv
* tersec's feedback
2021-06-11 11:27:09 +02:00
09a459b1d7
Book updates end may ( #2629 )
...
* break up long commands, geth > infura
* fill out profitability page
* fill in 'increase privacy'
* update systemd
* add tersec's restarting loop
* update privacy page
* consolidate eth1 instructions
* tidy up eth1.md
* fill out health.md
* rm contribute-network.md from toc
* edit eth1.md
* incorporate review feedback modulo profits.md
* update health.md
* remove script to monitor logs
2021-06-03 14:43:20 +02:00
c01357c47f
Book: Add instructions on how to download precompiled release ( #2600 )
2021-05-26 10:43:06 +02:00
b7db2f0a29
Book edits ( #2597 )
...
* simplify beacon node quickstart
* remove extra emacs generated file
* focus sync info around slot start message
* sync edits
* log rotate edits + clarifications
* remove validator keys folder
2021-05-24 16:03:45 +02:00
038102cb92
update toc
2021-05-22 11:24:03 +02:00
b400243bda
refocus guide around prater
2021-05-22 11:13:27 +02:00
7088ed8f89
update book toc
2021-05-21 14:54:36 +02:00
4131e0941f
Book updates may 21 ( #2590 )
...
* update deposit page
* edit keys.md
* edit connect-eth2.md
* remove extra emacs generated file
* update run a validator guide
* update system requirements
* update start-syncing.md
2021-05-21 14:49:12 +02:00
14c258db8b
Fix typo in book ( #2580 )
2021-05-20 12:41:33 +02:00
5bf5804bc1
update faq
2021-05-19 16:29:57 +02:00
8ca2329a20
minor restructure
2021-05-19 16:26:39 +02:00
62a98e9c6d
minor restructure
2021-05-19 16:21:05 +02:00
d27c7b1f53
Add clarity to docs surrounding command line arguments, suggest data-dir when syncing, and polishing up for mainnet ( #2527 )
...
* mainnet
* add clarity to command line rules
* add datadir suggestion when syncing
* remind to pass with all calls
* noCommand added into troubleshooting
* review
Co-authored-by: 0xmiel <sacha.saint-leger@ethereum.org>
* review
Co-authored-by: 0xmiel <sacha.saint-leger@ethereum.org>
* review
Co-authored-by: 0xmiel <sacha.saint-leger@ethereum.org>
* review
Co-authored-by: 0xmiel <sacha.saint-leger@ethereum.org>
* typo
* /lib/systemd/system/ lets you enable on startup
Co-authored-by: 0xmiel <sacha.saint-leger@ethereum.org>
Co-authored-by: Jacek Sieka <arnetheduck@gmail.com>
Co-authored-by: 0xmiel <sacha@status.im>
2021-05-19 16:17:07 +02:00
199ebc995b
restructure, merge, simplify ( #2581 )
2021-05-19 16:12:25 +02:00
07533f41ba
update binaries page
2021-05-19 12:04:10 +02:00
ed2e1e1c6b
update docker page
2021-05-19 11:58:48 +02:00
3fe589a511
Update migration-options.md
2021-05-18 20:18:17 +02:00
80e11ac002
Update migration-options.md
2021-05-18 20:17:41 +02:00
5eba5b530d
Update migration-options.md
2021-05-18 20:15:39 +02:00
2d3b9e4c07
Update migration-options.md
...
Edits
2021-05-18 18:53:59 +02:00
faf07737de
Sacha book updates (ready for review) ( #2552 )
...
* add doppelganger detection explanation to FAQ and link to Joe's guide from our Pi guide
* Edit CLI options page
* cp
* merge with ith unstable
* prysm migration guide: add steps until import slashing db
* update systemd
* update troubleshooting
* update pi guide
* metrics: replace winners with community
* update migration guide
* cp
* progress with guides, various edits
2021-05-18 18:42:51 +02:00
4cdbc17e39
remove references to devel
2021-04-28 16:06:00 +02:00
7af4f7c665
Guide updates ( #2525 )
...
* update nimbus book readme
* Revert "update nimbus book readme"
This reverts commit d568f0f7a3
2021-04-28 15:55:43 +02:00
7e31798649
Nimbus guide simplifications ( #2516 )
...
* update nimbus book readme
* Revert "update nimbus book readme"
This reverts commit d568f0f7a3
2021-04-22 13:12:24 +02:00
bf3305fa65
Nimbus guide: add database backup page ( #2505 )
...
* update nimbus book readme
* Revert "update nimbus book readme"
This reverts commit d568f0f7a3
2021-04-14 17:00:47 +02:00
f0f6b6869f
Nimbus guide: updates for new release ( #2504 )
...
* update nimbus book readme
* Revert "update nimbus book readme"
This reverts commit d568f0f7a3
2021-04-14 16:48:11 +02:00
f821bc878e
Remove `-d:insecure` compile option ( #2468 )
...
With metrics running on top of chronos, the metrics server no longer
needs to be compiled in conditionally - it remains disabled by default.
2021-04-01 14:44:11 +02:00
8f441588cd
Add a few help defaults, format all of them the same ( #2284 ) ( #2467 )
...
No support in confutils, so so this code simply hardcodes it
2021-04-01 12:28:57 +00:00
981e25a99b
Nimbus book: update homepage ( #2466 )
...
* update nimbus book readme
* Revert "update nimbus book readme"
This reverts commit d568f0f7a3
2021-03-31 14:18:20 +02:00
0355c27194
Nimbus book: add Prater page ( #2465 )
...
* update nimbus book readme
* Revert "update nimbus book readme"
This reverts commit d568f0f7a3
2021-03-31 13:59:12 +02:00
1af07ad124
Simple RPC for modifying the Graffiti bytes
2021-03-26 19:42:20 +02:00
5362d966ad
Nimbus guide: Rocket Pool edits ( #2446 )
...
* update nimbus book readme
* Revert "update nimbus book readme"
This reverts commit d568f0f7a3
2021-03-22 17:57:22 +01:00
b2c4441834
book: document "logrotate" ( #2390 )
...
* book: document "logrotate"
* Update docs/the_nimbus_book/src/log-rotate.md
Co-authored-by: Sacha Saint-Leger <sacha@status.im>
* Update docs/the_nimbus_book/src/log-rotate.md
Co-authored-by: Sacha Saint-Leger <sacha@status.im>
* Update docs/the_nimbus_book/src/log-rotate.md
Co-authored-by: Sacha Saint-Leger <sacha@status.im>
* Update docs/the_nimbus_book/src/log-rotate.md
Co-authored-by: Sacha Saint-Leger <sacha@status.im>
* Update docs/the_nimbus_book/src/log-rotate.md
Co-authored-by: Sacha Saint-Leger <sacha@status.im>
* rewording
* Update docs/the_nimbus_book/src/log-rotate.md
Co-authored-by: Sacha Saint-Leger <sacha@status.im>
Co-authored-by: Sacha Saint-Leger <sacha@status.im>
2021-03-22 16:40:26 +01:00
895fe4baf1
Make it clear that the default port for ETH2 is 9000 udp/tcp ( #2421 )
...
* Add default port info
* Add default port info
* Edit CLI and docs to reflect 9000 port
* Apply suggestions from code review
Co-authored-by: Jacek Sieka <arnetheduck@gmail.com>
2021-03-22 08:22:56 +01:00
756c82671d
Update rp-quick-start.md
2021-03-17 17:12:32 +01:00
b9f3fc4ceb
Rocket Pool guide ( #2425 )
...
* update nimbus book readme
* Revert "update nimbus book readme"
This reverts commit d568f0f7a3
2021-03-17 15:33:28 +01:00
dfc3322fe2
last few v1.0.0 spec refs to v1.0.1 ( #2404 )
2021-03-13 20:51:39 +00:00
74a75d05a0
update doc links
2021-03-10 09:47:42 +01:00
c6f94ce165
docs: add link to keep-updated in build, fix #2379 ( #2380 )
2021-03-05 09:53:55 +01:00
3d25f0db01
book updates ( #2345 )
...
* edit log rotation page
* update command line options
* add github edit button
2021-02-19 12:17:48 +01:00
ff94e1a212
Document log rotation ( #2327 )
...
* Document log rotation
* phrasing updates
Co-authored-by: Dustin Brody <tersec@users.noreply.github.com>
2021-02-18 07:57:41 +01:00
855c3e849d
update intro and binary distribution edits ( #2306 )
...
* update intro and binary distribution edits
* stefan's suggestions
2021-02-10 17:29:48 +01:00
237453ec45
fix api error
2021-02-08 15:00:21 +01:00
979bb39b41
docs: binary distribution internals
2021-02-08 14:53:12 +02:00
6528707e44
add local simulations to the for developers page
2021-01-27 20:38:16 +01:00
fa07c0f0a1
link to quickstart guide in intro
2021-01-27 19:32:04 +01:00
3016815860
update quickstart
2021-01-27 19:26:08 +01:00
20435880db
CI: build and publish a Docker image for end-users
...
Also disable the log file and log colours for distribution binaries, to
avoid duplicate logs.
2021-01-26 18:52:59 +02:00
Jakub Sokołowski
095b191aee
add cname file to docs to fix domain issues ( #2260 )
...
mdbook has an option called `cname`:
https://rust-lang.github.io/mdBook/format/config.html#html-renderer-options
But it appears to be only included starting from `0.4.3`:
https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-043
Which means this will be more robust, if uglier.
Signed-off-by: Jakub Sokołowski <jakub@status.im>
2021-01-22 17:57:55 +01:00
173a2fe018
update intro and metrics tutorial
2021-01-22 16:53:49 +01:00
67cce36f06
fix metrics guide ( #2234 )
2021-01-13 14:21:00 +01:00
37c3c3877c
add troubleshooting section on time ( #2232 )
2021-01-13 11:41:47 +01:00
3a59b76a01
Update broken repo link ( #2208 )
2020-12-30 09:55:20 +01:00
be74df70e0
Update systemd page: change metrics default and add note ( #2204 )
...
* change default and add note on metrics to systemd page
* add link to metrics guide from systemd page
2020-12-21 17:59:20 +01:00
a1ba188de3
Update systemd page and delete old files ( #2200 )
...
* remove old pages
* update systemd file and move it to how-to's
2020-12-21 10:04:46 +01:00
3d87bc0033
Branch guide
...
* update developer resources to include new branch structure
(https://github.com/status-im/nimbus-eth2/issues/2163 )
* remove some information duplicated between readme and developer
handbook
2020-12-18 19:32:27 +02:00
9df437541d
Book updates ( #2183 )
...
* remove eth2stats from systemd guide
* Make clear that eth2stats is not recommended for mainnet
* edits
2020-12-15 12:31:23 +01:00
14c5d6db1e
Update Pi guide: systemd advice ( #2181 )
2020-12-14 12:51:16 +01:00
e59437c5e2
new Make target: "benchmarks" ( #2174 )
...
It runs some benchmarks, collects the output and generates HTML charts.
2020-12-11 12:12:43 +01:00
e361221d72
remove mention of genesis
2020-12-10 13:09:38 +01:00
8ad3b3f551
rm empty file
2020-12-09 13:10:52 +01:00
e11c27b1ab
update toc
2020-12-09 13:10:15 +01:00
f785466638
add design goals page ( #2166 )
2020-12-09 12:59:42 +01:00
d0c743e6c4
Quickstart guide + updates
2020-12-07 16:38:34 +01:00
46c2740097
Documentation for Validators API. ( #2147 )
...
* Recover proper validator API call and remove incorrect one.
Add more examples to API documentation.
2020-12-07 14:51:14 +02:00
eff98e6550
Update toc and title
2020-12-07 11:05:49 +01:00
e73f3e77b8
Edit generate keys page
2020-12-07 11:01:48 +01:00
34eb5d33c8
Edit Recover keys
2020-12-07 00:47:26 +01:00
14ddf68402
Edit key recovery page
2020-12-07 00:26:56 +01:00
c26b06dd12
Add page on recovering key(s) ( #2153 )
...
* Add page on recovering key
* rm extra file
2020-12-07 00:15:19 +01:00
508ea91998
Remove incorrectly commented out css lines
2020-12-03 14:38:52 +01:00
2d6c80da2d
fix typo in SUMMARY.MD
2020-12-03 14:06:36 +01:00
b4defc9b4a
add placeholders
2020-12-03 04:00:14 +01:00
9c568748a5
fix toc bug
2020-12-03 03:37:44 +01:00
7f77fa29bc
Restructure
2020-12-03 03:29:33 +01:00
ba215706fa
Edits
2020-12-03 03:07:56 +01:00
eddb4fe250
style edits
2020-12-03 02:50:11 +01:00
Jacek Sieka
sacha
tersec
zah
Etan Kissling
Zachinquarantine
Ștefan Talpalaru
Johann Bauer
yslcrypto
TennisBowling
Mentor Palokaj
Afr Schoe
Jakub Sokołowski
Nikola Ristić
Eugene Kabanov