mirrors/electrs
1
0
Fork 0
mirror of https://github.com/romanz/electrs.git synced 2024-11-19 09:54:09 +01:00
Code Issues Projects Releases Wiki Activity
1,591 Commits 12 Branches 54 Tags 12 MiB
7773c266d1
Commit Graph

111 Commits

Author SHA1 Message Date
ben-grande
1d249edc10
Document cleanse of build artifacts (#1014) 
Fixes: https://github.com/romanz/electrs/issues/1001
 2024-03-08 15:10:05 +02:00
vuittont60
0eec28e0f7
doc: fix typos (#999) 
Signed-off-by: vuittont60 <81072379+vuittont60@users.noreply.github.com>
 2024-01-30 12:59:38 +02:00
Martin Habovštiak
d84d7d672c
Explain behavior of config file loading (#964) 
Previously it was not clear from the documentation that configuration files are optional or why non-not-exist errors are hard errors. This change adds the information about these important properties of config files to the documentation.
 2023-12-03 11:35:43 +02:00
Martin Habovštiak
b24fcae186
Improve config documentation (#963) 
The `--skip-default-conf-files` flag is often desired but people may miss it because it's not in the doc, so this documents it.

Further, to avoid problems with people missing flags this adds a recommendation to run `electrs --help` so if we ever forget to update the doc people will learn about the new arguments anyway.

Following #962.
 2023-12-01 20:12:59 +02:00
Martin Massera
2f7727bac4
Added note about tunneling to config.md 2023-09-11 23:25:03 -03:00
Martin Massera
279307a2f8
Update config.md 
Documentation for connecting an Electrum client
 2023-09-11 21:54:28 -03:00
Roman Zeyde
1663bddf8a
Update expected sync duration for Aug 2023 (#923) 2023-08-19 00:09:38 +03:00
Roman Zeyde
d2c794cc20
Bump MSRV to 1.63.0 and update dependencies 2023-06-10 17:08:32 +03:00
Roman Zeyde
3e3bc3a642
Update systemd example in docs (#885) 
Also, remove `contrib/electrs.service` (following #876).
 2023-05-30 20:07:36 +03:00
Roman Zeyde
d128aef758 Update prometheus instructions 2023-01-27 17:21:11 +02:00
Dimitris Apostolou
118fa1b7d3
Fix typos 2023-01-12 20:41:00 +02:00
Martin Habovštiak
5de0f1e250
Clarify that electrs doesn't use HTTP 
People seeing Nginx config may falsely assume electrs uses HTTP but it's not the case.
Putting heads up about this may avoid future confusion.

Closes #813
 2022-12-09 00:26:48 +01:00
zciendor
dc6718a692
added requested changes 
Added a note and fixed redundancy of gcc package into g++
 2022-12-04 21:57:31 +00:00
zciendor
f664b0a329
cross-compilation instructions using debootstrap 
Added instructions how to cross-compile for a different architecture and OS version (Debian based) than the target system.
 2022-11-14 21:36:04 +00:00
zciendor
804c5652ea
fix redundancy or copy & paste typo 
Cross compilation instructions contained `gcc` dependency two times, but it should certainly be `gcc` and `g++` instead.
 2022-11-14 17:34:48 +00:00
MG-ng
f9bcf9b01c
Fixed Typo: Changed iif to if 2022-11-01 18:21:25 +01:00
Matheus Bach
b80ae9f304
fix typo 2022-07-22 22:44:49 -03:00
Ayanami
3e3868367e
Add guide for other Ubuntu & Debian releases to compile and install librocksdb 2022-03-17 10:32:08 +09:00
brandonblack
40ba05a47c
More accurate free space required for reindexing 
The free space required peaks higher than the final size before and during compaction.

Final size is ~40G, peak was ~60G on my machine.
 2022-01-25 16:04:48 -08:00
Roman Zeyde
1b6e5a60da Add asciinema screencasts for quickstart installation and usage 2021-11-17 14:37:03 +02:00
Roman Zeyde
a90871a9fc Fixup --log-filters documentation and examples 
Drop `-v` and `--verbose` mentions.
 2021-11-12 19:59:11 +02:00
Roman Zeyde
64bc7e1583 Update release notes 2021-11-08 19:46:48 +02:00
Roman Zeyde
304426d0b2 Update MSRV requirements to Rust 1.48 2021-10-31 15:53:22 +02:00
Brijan
6f0a723b92
Updated checkout version and verify-tag to v0.9.1 
Updated git checkout version and verify-tag to v0.9.1 from v0.9.0
 2021-10-24 17:09:22 -04:00
Roman Zeyde
1ca8cb83c7 Re-organize and split documentation 2021-10-21 18:18:44 +03:00
Roman Zeyde
8a0e22f1c8 Add a Docker-related disclaimer 2021-10-20 11:36:12 +03:00
Roman Zeyde
73f971df63 Add a note about Dockerfile changes 2021-10-20 10:45:31 +03:00
Frederic Lepied
74f13419a8 enhance contribs to allow to connect to an external server 2021-10-13 15:06:03 +02:00
Roman Zeyde
fbda004ecb Drop ELECTRS_VERBOSE and ELECTRS_TIMESTAMP from Docker usage example 2021-10-07 21:36:50 +03:00
Roman Zeyde
fc81d95940 Update build description for 32-bit OS 2021-10-04 09:13:03 +03:00
Martin Habovštiak
759cc64978
Clarify upgrading to 0.9.0 
Removing/renaming unsupported switches was not called out explicitly and it's possible that someone is using a different bitcoind address, not just port.

Closes #520
 2021-09-30 16:50:21 +02:00
Martin Habovštiak
0db0e8c8c1
Update documentation regarding cargo features 
With new `rocksdb` it's no longer necessary to disable features when dynamically linking.
Thus this change removes instructions to add `--no-default-features`.
However there's now a new feature called `metrics` which enables Prometheus.
This change also documents this and explains how to turn it off.

Closes #517
 2021-09-30 14:09:26 +02:00
Martin Habovstiak
5537c963c0 Detailed documentation of db_dir 
This warns users that they shouldn't touch `db_dir` internals except for
deleting the old `mainnet` database. It explains in details how to do
upgrade and deleting properly, calls it out in release notes and fixes
small style mistake in nearby heading.

It can be thought of as more explicit/detailed version of
8b8ebea0018d3e9a97ce965845b1914df4b4d8a4 or a textual alternative to
PR #513.
 2021-09-29 22:15:53 +02:00
Martin Habovštiak
c299183289
Explain verbose level in usage 2021-09-25 19:46:01 +02:00
Roman Zeyde
f420188650 Add a release note about db/mainnet -> db/bitcoin rename 
https://github.com/romanz/electrs/issues/502
 2021-09-25 18:07:17 +03:00
Roman Zeyde
a53048f2ef Fixup schema.md table formatting 2021-09-18 20:19:58 +03:00
Roman Zeyde
3c4e616901 Add p2p daemon address to config_example.toml 2021-09-18 00:28:55 +03:00
Roman Zeyde
2152ac9cca Merge branch 'p2p' 2021-09-17 16:08:19 +03:00
Martin Habovstiak
ce96481522 Improve documentation of 0.8.x -> 0.9.0 upgrade 
This should hopefully make the major changes more visible and avoid
surprises.
 2021-09-17 15:28:24 +03:00
Roman Zeyde
382d71787a Update documentation for the upcoming 0.9 version 2021-09-13 11:09:51 +03:00
Roman Zeyde
4b24e649d6 Move local-electrum.bash to contrib/ 2021-08-26 23:16:00 +03:00
Martin Habovštiak
5b77773a54
Update relevant versions in README to 0.8.10 2021-07-30 11:50:01 +02:00
Simon Vrouwe
3bb0fb7920 p2p doc: in bitcoin.conf maxconnections should be >11, fixes #429 2021-07-21 07:46:26 +03:00
Tobin Harding
9e33cb6d9b
Fix spelling of 'hyphens' 2021-07-16 10:54:48 +10:00
moneroexamples
6caf8017af
Added json.dumps to Python example RPC examples 
As suggested in https://github.com/romanz/electrs/pull/415#issuecomment-870345086 `json.dumps` is added in-place of a manual construction of a request message.
 2021-06-29 17:00:22 +08:00
moneroexamples
a31723cbb5
json.loads added 
As suggested, `json.loads` was added to parse the raw response.
 2021-06-28 17:44:59 +08:00
moneroexamples
2d4369cf93
Add python example in RPC examples 
Current `usage.md` contains only one example in `RPC examples` which uses `echo` and `netcat`. The PR adds new and corresponding example in `Python` which can speed up the initial use of the `electrs` for people who try to use the project for the first time.
 2021-06-25 18:38:26 +08:00
Roman Zeyde
3780d7d48b Refactor and sync using p2p protocol 2021-04-14 18:38:59 +03:00
Simon Kurowski
c4ea110795 Fix Dockerfile, add another example 2021-03-23 21:38:17 +01:00
Simon Kurowski
25702d1217 Add missing \ to usage.md 2021-03-21 01:01:01 +01:00