Git Product home page Git Product logo

md's Introduction

MoneroDocs

About

Monerodocs attempts to organize basic technical knowledge on Monero in one place.

While technical explanations are out there, knowledge is scattered through reddit posts, git comments, stack exchange answers, chat logs and the source code. This makes it hard to find complete and up-to-date explanations on advanced topics.

The goal is to educate and onboard power users faster.

Contributing

To contribute to MoneroDocs, you'll need to setup your local Mkdocs-Material environment:

# Fork the monerodocs/md Github repo

# Clone your newly created repo- be sure to include the submodule flag
git clone --recurse-submodules [email protected]:your-user-name/md.git

cd md

# Install mkdocs dependencies
pip install mkdocs-material mkdocs-minify-plugin

# Run the documentation server locally
python3 -m mkdocs serve

md's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

md's Issues

ports wrong?

https://monerodocs.org/running-node/open-node-tor-onion/

https://github.com/monerodocs/md/blob/master/docs/running-node/open-node-tor-onion.md

# Tor: add P2P seed nodes for the Tor network
# For an up-to-date list of working nodes see https://www.ditatompel.com/monero/node-peers
add-peer=4egylyolrzsk6rskorqvocipdo4tqqoyzxnplbjorns7issmgpoxvtyd.onion:18083
add-peer=fagmobguo6u4z4b2ghyg3jegcdpmd4qj4wxkhemph5d5q6dltllveqyd.onion:18083
add-peer=monerokdwzyuml7vfp73fjx5277lzesbrq4nvbl3r3t5ctgodsx34vid.onion:18089
add-peer=b75obarnhi42p7js7wgzo7v3wtiwcgf4bknrwv6ihatop77jivrtwpid.onion:15892
add-peer=5nvd6jbefgto3u74nzzdkcsbqgxyzrkk7bz5qupsdqg4gbuj5valiaqd.onion:18083
add-peer=ozeavjybjbxbvmfcpxzjcn4zklbgohjwwndzenjt44pypvx6jisy74id.onion:18083
add-peer=xcccrsxi2zknef6zl3sviasqg4xnlkh5k3xqu7ytwkpfli3huyfvsjid.onion:18083

# Make the seed nodes permanent to fix monerod issue of not maintaining enough connections,
# based on this reddit comment:
# https://www.reddit.com/r/monerosupport/comments/k3m3x2/comment/ge5ehcy/?utm_source=share&utm_medium=web2x&context=3
add-priority-node=4egylyolrzsk6rskorqvocipdo4tqqoyzxnplbjorns7issmgpoxvtyd.onion:18083
add-priority-node=fagmobguo6u4z4b2ghyg3jegcdpmd4qj4wxkhemph5d5q6dltllveqyd.onion:18083
add-priority-node=monerokdwzyuml7vfp73fjx5277lzesbrq4nvbl3r3t5ctgodsx34vid.onion:18089
add-priority-node=b75obarnhi42p7js7wgzo7v3wtiwcgf4bknrwv6ihatop77jivrtwpid.onion:15892
add-priority-node=5nvd6jbefgto3u74nzzdkcsbqgxyzrkk7bz5qupsdqg4gbuj5valiaqd.onion:18083
add-priority-node=ozeavjybjbxbvmfcpxzjcn4zklbgohjwwndzenjt44pypvx6jisy74id.onion:18083
add-priority-node=xcccrsxi2zknef6zl3sviasqg4xnlkh5k3xqu7ytwkpfli3huyfvsjid.onion:18083

the reddit link goes to some thread about i2p... not about tor... anyway

are all these ports or most wrong?
It took me hours of figuring out and I finally figured out it wasn't me but this config all the 18083 are supposed to be 18080.
I read on this random post from 2 years ago monero-project/monero#8034 (comment) and it immediately started working then...
no idea about the 15892 port

Possible typo in monerod command reference.

In the Node RPC API section for this entry

--rpc-restricted-bind-ip | IP to listen on with the limited version of API. The limited API can be made public to create an Open Node.
-- | --
--rpc-restricted-bind-port | TCP port to listen on with the limited version of API. To be used in combination with `--rpc-restricted-bind-port.

the rpc-restricted-bind-port says it should be used in combination with rpc-restriced-bind-port. i think it should maybe say used in combination with rpc-restricted-bind-ip

thanks.

Subaddress section should describe Janus attack

The subaddress section implies that subaddresses are enough to maintain separate identities, but in the case of two colluding entities with disparate subaddresses, subaddresses are not sufficient.

The documentation should add a disclaimer that until Janus is mitigated, maintaining entirely separate wallets per desired identity is recommended for utmost privacy.

see:

Big chunk of RPC commands not documented

I looked at this page and couldn't find many of the commands that are listed via the help RPC command.

These include (I didn't test everything, because there were just too many missing):

  1. alt_chain_info
  2. apropos
  3. banned
  4. flush_cache
  5. mining_status
  6. pop_blocks
  7. print_net_stats
  8. set_bootstrap_daemon
  9. ...

For some of these, the equivalent command line switch is shown. However, I'd assume people would prefer to change settings without restarting monerod where possible.

Deploy website to github pages

The version on monerodocs.org seems outdated compared to the repository. Can it get updated? Thanks.

22 Feb 2019 was the last time it got deployed and there have been a few changes since then.

Docs are Terrible

No other way to put it.

This is the most incomplete documentation I've come across in quite some time (and that's saying a lot considering we're in the crypto space).

There are multiple pages that are simply incomplete, incorrect or both. And that actually hurts a lot more than it helps.

If I had more personal free time and thought that the "developers" of this project were honest people that had intentions on protecting the project from warlording, then I would definitely be about it. But, unfortunately, I'm not. And I dislike the fact that Monero is built to benefit the pockets of a few (like the core developers ; i.e., 'Spagni').

Change is coming in the near future. The community has mandated it.

Invalid peer addresses in example config

In the config example, most of the hosts specified inside "add-peer" and "add-priority-peer" options have RPC ports instead of P2P ports. Also, a comment there points to a few websites where you could get a list of Monero nodes, but those websites only list RPC addresses.

Request for Info on Contributing

In lieu of my last pulled issue, I concur with the maintainer of this repo that it would be more constructive to make a pull request rather than point out what I perceive as deficits in the current version.

There are a few places where I'm sure that I can contribute. Let me know what the process for doing that would be (i.e., just a simple pull request, notes on the amendments + reason added[?]), etc.

[Proposal] Transfer this repository to the Monero Ecosystem project

i always found monerodocs a very useful source of information and it's a waste that not many in the Monero community are aware of it's existence,

Would you consider transferring the repo to the Monero Ecosystem project and maintain it from there.

It would have more visibility in the Ecosystem and i would personally be happy to contribute to moerodocs when i can. Please see the readme for info about the Ecosystem and the governance process we adopted

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.