monero-project/monero-site
monero-project/monero-site
1
0
Fork 0
mirror of https://github.com/monero-project/monero-site.git synced 2024-11-17 08:18:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'master' into patch-1

Browse source
This commit is contained in:
Mike Justman 2017-08-31 10:44:19 -04:00 committed by GitHub
commit c96b8efd91
20 changed files with 360 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.ruby-version Normal file
View file

@ -0,0 +1 @@
2.4.1

6
Gemfile Normal file
View file

@ -0,0 +1,6 @@
source 'https://rubygems.org'
gem 'jekyll'
gem 'jekyll-paginate'
gem 'builder'
gem 'rubysl-rexml'

57
Gemfile.lock Normal file
View file

@ -0,0 +1,57 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.5.1)
public_suffix (~> 2.0, >= 2.0.2)
builder (3.2.3)
colorator (1.1.0)
ffi (1.9.18)
forwardable-extended (2.6.0)
jekyll (3.5.2)
addressable (~> 2.4)
colorator (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-paginate (1.1.0)
jekyll-sass-converter (1.5.0)
sass (~> 3.4)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
kramdown (1.14.0)
liquid (4.0.0)
listen (3.0.8)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
mercenary (0.3.6)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
public_suffix (2.0.5)
rb-fsevent (0.10.2)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (1.11.1)
rubysl-rexml (2.0.4)
safe_yaml (1.0.4)
sass (3.5.1)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
PLATFORMS
ruby
DEPENDENCIES
builder
jekyll
jekyll-paginate
rubysl-rexml
BUNDLED WITH
1.15.4

46
README.md
View file

@ -40,25 +40,20 @@ If for any reason you have questions or need to contact us, you can find us on t
## 2.0 What you'll need
* Jekyll: Getmonero.org is made using a simple, static website generator called [Jekyll](https://jekyllrb.com/). You will need it installed on your system to test any changes that you made. If you're using a Linux-based system you can just follow the instructions on the website to get up and going. If you're using Windows, you will want to check out [this site](http://jekyll-windows.juthilo.com/) for instructions on how to get Jekyll working on your system.
* Jekyll: Getmonero.org is made using a simple, static website generator called [Jekyll](https://jekyllrb.com/). You will need it installed on your system to test any changes that you made. If you're using Windows, you will want to check out [this site](http://jekyll-windows.juthilo.com/) for instructions on how to get Jekyll working on your system. If you're using a Linux-based system you can just follow the instructions on the website to get up and going:
* Install Ruby
* Install Bundler: `gem install bundler`
* Install Jekyll with all dependencies (run from the project directory): `bundle`
* GitHub: Pretty much everything in Monero is hosted on [GitHub](https://github.com) and uses Git as the primary version control system. If you're not familiar with how to use Git, you can check out [this tutorial](https://guides.github.com/activities/hello-world/) for a good overview. It will take you through pretty much everything you'll need to know to edit the website. If you haven't already, register for GitHub and fork the [Monero Website repository](https://github.com/monero-project/monero-site).
* Markdown experience: To write pages, you're going to need to know how to use Markdown. It's basically a in-between language that enables people who don't know HTML to just write, and it will be compiled into HTML for you. You can find a great Markdown cheat sheet with examples [here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). IF you need more help, Google and YouTube are great resources.
* Markdown experience: To write pages, you're going to need to know how to use Markdown. It's basically an in-between language that enables people who don't know HTML to just write, and it will be compiled into HTML for you. You can find a great Markdown cheat sheet with examples [here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). IF you need more help, Google and YouTube are great resources.
*Note: If you're confused, feel free to click other files in the same directory (folder) that you are in for the step that you are on to see some working examples. Compare them to the instructions and you should understand better.*
* Jekyll Gems: The current iteration of the getmonero.org website uses the following plugins:
* [jekyll-paginate](https://jekyllrb.com/docs/pagination/)
* builder
* rubysl-rexml
* In the event that more gems are added, this documentation will be updated to reflect the changes needed to build the site.
*Note:* To install them all at once, use the command: `gem install builder rubysl-rexml jekyll-paginate`
Once you have the above list of things, it's typically a good idea to build the website from your local computer to make sure it works before you make any changes. To do this, complete the following steps:
1. Navigate to the your local `monero-site` repository.
1. Navigate to your local `monero-site` repository.
2. Serve the website: `jekyll serve`
3. Open a browser and go to [http://127.0.0.1:4000](http://127.0.0.1:4000).
4. If all went well, you should see the Monero website and you're ready to make changes.
@ -69,12 +64,21 @@ The average Monero user that will want to contribute to the website should proba
If you are a web developer and would like to make large macro-level changes, it would be best to get in contact with rehrar. The HTML/CSS framework is custom, though quite easy to use for a seasoned developer. Still, there are some pages that are more complicated than others and would require fair amounts of styling changes should the structure change significantly.
This website is completely open-source however, and anything and everything is available for changing should the community deem it necessary.
This website is completely open-source however and anything and everything is available for changing should the community deem it necessary.
Every section from here on out will talk about how to make a specific type of web page. It will start with a bullet point list of what to do for the advanced among you that just want a quick overview. For those who are still learning this list is followed by a detailed explanation, starting with example front matter. Any variable in the front matter written in all caps you are expected to change (make sure your changes are not all caps though). It will then lead you through the rest of the process until it's time to type your content.
All external links must have http:// or https:// in front of them or they will not redirect properly.
### 3.1 Housekeeping
#### GitHub Issues
We ask that if you open an issue on the site that you remain available for clarifying questions or corrections. We do our best to close issues that are resolved when we make changes to the site, but If your issue is resolved by a contributer and the issue is not closed we ask that you close it in a timely manner. A contributer (rerhar, SamsungGalaxyPlayer, or other community members, etc) may ask you to close an issue after it's confirmed fixed. Please review the changes to the site and close your issue if you can verify that it's fixed.
#### Pull Requests
Contributers should use [issue keywords](https://help.github.com/articles/closing-issues-using-keywords/) to make it easier for maintainers to close issues when they merge. Include close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved, etc in the commit message or pull request description, so that the correct issue can be closed if your PR is merged. (Example: 'fixes #1234' could close Issue 1234 when merged.)
Pull requests allow others to make comments or review your changes to the site. We ask that you remain available to comment or make changes to your PR. Pull requests with pending changes for more than 30 days will be closed and need to be resubmitted in the future. Sometimes someone else's changes might make your changes conflict with the current site. If that happens you may need to rebase your PR. (If you're unsure about how to do so, you can reach out to other contributers on IRC (freenode #monero) and someone should be able to walk you through it.
## 4.0 How to make a blog post
### 4.1 Quick Start
@ -111,7 +115,7 @@ You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure
### 5.1 Quick Start
* Make file in /resources/user-guides with a .md ending and no spaces in filename.
* Make file in /resources/user-guides with an .md ending and no spaces in filename.
* Front Matter as in 5.3
* Write User Guide
* Add guide using markdown in the correct category in /resources/user-guides/index.md being careful not to mess with any indentation
@ -139,7 +143,7 @@ DO NOT CHANGE ANYTHING IN THIS DOCUMENT BESIDES WHAT YOU ARE INSTRUCTED TO.
This file will look quite different because it's HTML. Don't panic. Simply Ctrl + F (i.e. the find feature) and search for the category that you want to put your User Guide in. You will see there are some sections that are not indented like the others. They are flush with the left side of the screen. **Do not change the indentation.** You can put markdown in these areas.
Once you've identified the non-indented area under the category you would like your User Guide to be under, you can use markdown to insert your link underneath the others. `[TITLE OF USER GUIDE](LINK-TO-USER-GUIDE.html)`. Please note that the file name in between the paranthases must be EXACTLY the same name as the file name you made in step 5.2, but with a `.html` at the end instead of `.md`.
Once you've identified the non-indented area under the category you would like your User Guide to be under, you can use markdown to insert your link underneath the others. `[TITLE OF USER GUIDE](LINK-TO-USER-GUIDE.html)`. Please note that the file name in between the parentheses must be EXACTLY the same name as the file name you made in step 5.2, but with a `.html` at the end instead of `.md`.
In the event that you think your User Guide should be in a new Category that doesn't exist yet, contact rehrar to make one for you.
@ -296,9 +300,9 @@ and paste it IN THE CHRONOLOGICAL ORDER that it will be in. So if there is an ev
Fill in the data as follows:
* `event:` The name of the event goes here as well as the date. The recommended format is: `Event Name - January 1st, 2000`
* `where:` Where the event will take place. Vanue name and address are recommended.
* `where:` Where the event will take place. Venue name and address are recommended.
* `when:` Date and time
* `description:` Descriptoin of the happenings of your event
* `description:` Description of the happenings of your event
* `link:` The website of your event (if applicable, this can be left blank and everything will be ok). This link must have http:// at the beginning if it is an external link.
**Make sure the indentation is EXACTLY the same as the other proposals in the area. If it's not the jekyll build WILL fail.**
@ -326,7 +330,7 @@ Find the year that you want to update and copy the code below:
date:
status:
```
and paste it in the correct years `accomplishments:` section IN THE CHRONOLOGICAL ORDER that it will be in. So if there is a accomplishment that happened/is happening before the one you are inputting, make sure it is higher up than yours. If there is an accomplishment that happened/is happening AFTER yours, make sure it is after yours. If you don't have exact dates, just do your best to estimate.
and paste it in the correct year's `accomplishments:` section IN THE CHRONOLOGICAL ORDER that it will be in. So if there is a accomplishment that happened/is happening before the one you are inputting, make sure it is higher up than yours. If there is an accomplishment that happened/is happening AFTER yours, make sure it is after yours. If you don't have exact dates, just do your best to estimate.
Fill in the data as follows:
* `name:` The name of the accomplishment. Try to keep it short, a sentence or two at most.
@ -360,7 +364,7 @@ Find the category that best describes your business/service and copy the code be
and paste it in the correct category under the `merchants:` section.
Fill in the data as follows:
* `name:` The name of the the business/service.
* `name:` The name of the business/service.
* `url:` The external url of the business/service. This link must have http:// (or https://) at the beginning if it is an external link.
**Make sure the indentation is EXACTLY the same as the other proposals in the area. If it's not the jekyll build WILL fail.**
@ -378,7 +382,7 @@ You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure
## 12.0 How to add a question to the FAQ
### 12.1 Copy/Paste Code
Navigate to the `/get-started/faq` folder and open the `index.md` file. Inside you will see HTML code, but you will see it is very repetetive.
Navigate to the `/get-started/faq` folder and open the `index.md` file. Inside you will see HTML code, but you will see it is very repetitive.
Copy the code below:
```
@ -394,7 +398,7 @@ CHANGE ANSWER
</div>
```
And paste it at the very bottom of the file. Literally underneath everything else.
And paste it at the very bottom of the file (literally underneath everything else).
Now we're going to change just a couple of things. Find the section with:
```
@ -430,4 +434,4 @@ Redistribution and use in source and binary forms, with or without modification,
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

2
_data/merchants.yml
View file

@ -173,4 +173,4 @@
- name: MoneroDice
url: https://monerodice.net
- name: SafeDice
url: https://safedice.com
url: https://safedice.com

2
_includes/header.html
View file

@ -60,6 +60,7 @@
<a href="/resources/moneropedia/">Moneropedia</a>
<a href="/resources/user-guides/">User Guides</a>
<a href="/resources/developer-guides/">Developer Guides</a>
<a href="/resources/vrp/">Vulnerability Response</a>
</div>
</div>
</div>
@ -147,6 +148,7 @@
<a href="/resources/moneropedia/">Moneropedia</a>
<a href="/resources/user-guides/">User Guides</a>
<a href="/resources/developer-guides/">Developer Guides</a>
<a href="/resources/vrp/">Vulnerability Response</a>
</div>
</div>
</div>

1
_strings_en.yml
View file

@ -37,6 +37,7 @@ menu:
people: The People Behind Monero
userguides: User Guides
developerguides: Developer Guides
vrp: Vulnerability Response Process
goals: Design & Development Goals
openalias: The OpenAlias Project
lab: Monero Research Lab

4
get-started/mining/index.md
View file

@ -66,7 +66,7 @@ title: Mining Monero
</div>
</div>
<div class="row center-xs">
<p>Depending on your hardware, there are various mining programs available for use. You might consider trying different ones and seeing how it affects you hasrate. Please note, that some miners also have developer fees.</p>
<p>Depending on your hardware, there are various mining programs available for use. You might consider trying different ones and seeing how it affects your hashrate. Please note, that some miners also have developer fees.</p>
</div>
<div class="row miners">
<div class="col-md-4 col-xs-12 center-xs">
@ -94,4 +94,4 @@ title: Mining Monero
</section>
</div>
</div>

12
get-started/what-is-monero/index.md
View file

@ -1,6 +1,6 @@
---
layout: default
title: "What Is Monero?"
title: "What Is Monero (XMR)?"
---
<div class="site-wrap">
@ -15,8 +15,8 @@ title: "What Is Monero?"
<div class="row middle-xs info-block-row private">
<div class="col-lg-7 col-md-6 col-sm-8 col-xs-12 why-text">
<h3>Monero is the leading cryptocurrency with a focus on private and censorship-resistant transactions.</h3>
<p>Almost all cryptocurrencies (including Bitcoin and Ethereum) are transparent. They reveal your entire transaction history to the world.</p>
<p>Monero uses unbreakable cryptography to ensure that no one can see how much money you have or where you spend it, even if they know your wallet address.</p>
<p>Most existing cryptocurrencies, including Bitcoin and Ethereum, have transparent blockchains, meaning that transactions are openly verifiable and traceable by anyone in the world. Furthermore, sending and receiving addresses for these transactions may potentially be linkable to a person's real-world identity. </p>
<p>Monero uses cryptography to shield sending and receiving addresses, as well as transacted amounts.</p>
</div>
<div class="col-lg-5 col-md-6 col-sm-4 col-xs-12 last-sm first-xs center-xs">
<img src="/img/crypto-lock.png" alt="Encrypted lock" class="main-icon">
@ -28,9 +28,9 @@ title: "What Is Monero?"
</div>
<div class="col-lg-7 col-md-6 col-sm-8 col-xs-12 why-text">
<h3>Monero transactions are confidential and untraceable.</h3>
<p>The source of funds in every Monero transaction is untraceable, and the transaction amounts are confidential. Always-on privacy means that every Monero user's activity enhances the privacy of all other users.</p>
<p>Because funds on the Monero blockchain are untraceable, they cannot become tainted by association with their previous owners. This means you can accept Monero without risk of the funds you've received being blocked or censored at currency exchanges or merchants.</p>
<p>Monero's <a href="https://getkovri.org/">Kovri project</a> (coming soon) encrypts and routes transactions through the I2P Invisible Internet Project nodes to hide your IP address and protect you from network monitoring.</p>
<p>Every Monero transaction, by default, obfuscates sending and receiving addresses as well as transacted amounts. This always-on privacy means that every Monero user's activity enhances the privacy of all other users, unlike selectively transparent cryptocurrencies (e.g. Z-Cash).</p>
<p>Monero is fungible. By virtue of obfuscation, Monero cannot become tainted through participation in previous transactions. This means Monero will always be accepted without the risk of censorship.</p>
<p>The Kovri Project <a href="https://getkovri.org/"> ,currently in development, will route and encrypt transactions via I2P Invisible Internet Project nodes. This will obfuscate a transactor's IP address and provide further protection against network monitoring.<
</div>
</div>

12
index.html
View file

@ -20,8 +20,8 @@ Title: Home
<div class="main-info">
<h1 id="main-h1">Monero</h1>
<h2 id="main-h2">Private Digital Currency</h2>
<p id="main-text">Monero is a secure, private, untraceable currency. It is open-source and freely available to all. With Monero, you are your own bank. Only
you control and are responsible for your funds; your accounts
<p id="main-text">Monero is a secure, private, and untraceable cryptocurrency. It is open-source and accessible to all. With Monero, you are your own bank. Only
you control and are responsible for your funds. Your accounts
and transactions are kept private from prying eyes.</p>
<p><a href="/get-started/using/" class="btn-link btn-auto btn-primary">Get Started</a></p>
</div>
@ -40,7 +40,7 @@ Title: Home
<div class="row middle-xs info-block-row private">
<div class="col-lg-6 col-md-6 col-sm-8 col-xs-12 why-text">
<h3>Monero is secure.</h3>
<p>Monero can't be hacked to steal your funds, due to the power of distributed consensus, which you can read about here. This means that you are responsible for your money, and don't have to trust any entity to keep it safe for you.</p>
<p>Monero is a decentralized cryptocurrency, meaning it is extremely difficult to hack and steal your funds. Transactions are confirmed by distributed consensus, and then immutably recorded on the blockchain. Third-parties do not need to be trusted to keep your Monero safe. </p>
</div>
<div class="col-lg-6 col-md-6 col-sm-4 col-xs-12 last-sm first-xs center-xs">
<img src="/img/secure-monero.png" alt="Secure safe" class="main-icon">
@ -52,14 +52,14 @@ Title: Home
</div>
<div class="col-lg-6 col-md-6 col-sm-8 col-xs-12 why-text">
<h3>Monero is private.</h3>
<p>The power of the blockchain usually increases security at the cost of privacy, but with Monero's sophisticated privacy-centric technology, you get all of the security benefits of the blockchain without any of the privacy trade-offs.</p>
<p>Monero uses ring signatures and ring confidential transactions to obfuscate the amounts, origins, and destinations of all transactions. Monero gains all the benefits of a decentralized cryptocurrency, without any of the standard privacy concessions. </p>
</div>
</div>
<div class="row middle-xs info-block-row">
<div class="col-lg-6 col-md-6 col-sm-8 col-xs-12 why-text">
<h3>Monero is untraceable.</h3>
<p>By taking advantage of ring signatures, Monero makes it ambiguous which funds have been spent, and thus extremely unlikely that a transaction could be linked to particular user.</p>
<p>Sending and receiving addresses as well as transacted amounts are obfuscated by default. Transactions on the Monero blockchain cannot be linked to a particular user or real-world identity.</p>
</div>
<div class="col-lg-6 col-md-6 col-sm-4 col-xs-12 last-sm first-xs center-xs">
<img src="/img/untraceable-monero.png" alt="Untraceable Monero paths" class="main-icon">
@ -71,7 +71,7 @@ Title: Home
</div>
<div class="col-lg-6 col-md-6 col-sm-8 col-xs-12 why-text">
<h3>Monero is fungible.</h3>
<p>Because of the on-by-default nature of the privacy technologies, Monero is fungible, meaning one Monero will always be equal to another. This means you won't have to worry about Monero blacklisted by exchanges or vendors.</p>
<p> Monero is fungible because it is private by default. In its current state, it is extremely unlikely that Monero will ever be blacklisted by exchanges or vendors due to its association in previous transactions.</p>
</div>
</div>
</div>

61
resources/user-guides/importing_blockchain.md Normal file
View file

@ -0,0 +1,61 @@
---
layout: static_page
title: Importing the Monero Blockchain from an outside source
---
# Importing the Blockchain to Monero GUI wallet (Windows)
### Step 1
Download the Current bootstrap from https://downloads.getmonero.org/blockchain.raw; you can skip this step if you are importing the Blockchain from another source.
### Step 2
Find the path of your Monero wallet (the folder where you extracted your wallet). For example mine is:
`D:\monero-gui-0.10.3.1`
Your path may be different depending on where you decided to download your wallet and what version of the Monero wallet you have.
### Step 3
Find the path of your downloaded Blockchain for example mine was:
`C:\Users\KeeJef\Downloads\blockchain.raw`
Yours might be different depending on where you downloaded the Blockchain to.
### Step 4
Open a Command Prompt window. You can do this by pressing the Windows key + R, and then typing in the popup box `CMD`
### Step 5
Now you need to navigate using the CMD window to the path of your Monero wallet. You can do this by typing:
`cd C:\YOUR\MONERO\WALLET\FILE\PATH\HERE`
It should look something like:
`cd D:\monero-gui-0.10.3.1`
If your Monero wallet is on another drive you can use `DriveLetter:` for example if your Monero wallet was on your D drive then before using the cd command you would do `D:`
### Step 6
Now type in your command prompt window:
`monero-blockchain-import --verify 1 --input-file C:\YOUR\BLOCKCHAIN\FILE\PATH\HERE`
For example I would type :
`monero-blockchain-import --verify 1 --input-file C:\Users\KeeJef\Downloads\blockchain.raw`
If you downloaded the Blockchain from a trusted, reputable source you may set `verify 0` this will reduce the amount of time to sync the Blockchain.
### Step 7
After the the Blockchain has finished syncing up you can open your Monero wallet normally. Your downloaded blockchain.raw can be deleted.
Author: Kee Jefferys

4
resources/user-guides/index.md
View file

@ -16,6 +16,7 @@ title: "User Guides"
[Monero Tools](monero_tools.html)
[How to make an offline backup](Offline_Backup.html)
[Importing the Monero blockchain](importing_blockchain.html)
[How to run a node on VPS](vps_run_node.html)
[Securely purchasing and storing Monero](securely_purchase.html)
@ -35,6 +36,7 @@ title: "User Guides"
[How to make a view-only wallet](view_only.html)
[How to prove payment](prove-payment.html)
[Restoring wallet from keys](restore_from_keys.html)
[How to connect to a remote node within GUI wallet](remote_node_gui.html)
</div>
</div>
@ -68,6 +70,8 @@ title: "User Guides"
</div>
<div class="row start-xs text-center" markdown="1">
[How to solo mine with the GUI](solo_mine_GUI.html)
[How to mine on a pool with xmr-stak-cpu](mine-to-pool.html)
[Mining with Docker and XMRig](mining_with_xmrig_and_docker.html)

BIN
resources/user-guides/png/remote_node/remote-node-screenshot.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 98 KiB

BIN
resources/user-guides/png/solo_mine_GUI/01.PNG Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 58 KiB

BIN
resources/user-guides/png/solo_mine_GUI/02.PNG Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 64 KiB

BIN
resources/user-guides/png/solo_mine_GUI/03.PNG Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 64 KiB

2
resources/user-guides/prove-payment.md
View file

@ -55,6 +55,8 @@ The information supplied by Alice plugs neatly instead of the placeholders. mone
key to decode the transaction, and display how much this particular transaction sent to this address. Obviously,
Charlie will want to double check with Bob the address is really his - same as with Bitcoin.
Alternatively, the transaction key can be obtained in the GUI in the History tab. Click on details for each individual transaction to get the key.
Note: if several transactions were made, this needs repeating for each such transaction.

15
resources/user-guides/remote_node_gui.md Normal file
View file

@ -0,0 +1,15 @@
---
layout: static_page
title: How to use a remote node in the GUI wallet
---
## Finding a node
First things first, you need to find a node to connect to! [moneroworld.com](https://moneroworld.com/#nodes) has some great resources for finding nodes. One of the easiest methods
would be to use a node run by moneroworld, but they have a tool for finding random nodes too.
## Connecting to the node from the GUI wallet
After you enter your password for your wallet, you will see a pop up that will give you the option to "use custom settings". Click on it. You will then be
sent to the "Settings" page in the GUI. At this point you should see two text boxes to the right of a label that says "Daemon address". In the first box (the on to the left) you need to enter the address of the node that you want to
connect to. This address might look like `node.moneroworld.com` or it could look like any old ip address. The smaller box to the right is where you enter the node's port. The default port is `18081` but if you are using a random node the port that is used will vary. The port for node.moneroworld.com uses 18089.
### Your screen should look a bit like this
<img src="/resources/user-guides/png/remote_node/remote-node-screenshot.png" width="600">

26
resources/user-guides/solo_mine_GUI.md Normal file
View file

@ -0,0 +1,26 @@
---
layout: static_page
title: "How to solo mine with the GUI"
title-pre-kick: "Solo mining with the GUI"
title-kick: ""
title-post-kick: ""
kick-class: ""
icon: "icon_userguides"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
---
It is very easy to solo mine with the official GUI. If you have not done so already, go to the <a href="/downloads/">Monero downloads page</a> and download the official GUI for your operating system. Then, run the setup and be patient as Monero synchronizes with the network. You should see that it displays "Connected" in the lower left corner.
<img src="/resources/user-guides/png/solo_mine_GUI/01.PNG" style="width: 600px;"/>
Click on the "Advanced" tab. You should see that several other options appear. Now click on the "Mining" sub-tab.
<img src="/resources/user-guides/png/solo_mine_GUI/02.PNG" style="width: 600px;"/>
You should now have an option to start mining. You can optionally change the number of threads to mine with. For optimal efficiency, you should mine with your CPU's cache divided by 2. You will need to look up your CPU's specs on the manufacturer's website. If you are unsure, leave the number of threads at 1. Click the "Start mining" button.
<img src="/resources/user-guides/png/solo_mine_GUI/03.PNG" style="width: 600px;"/>
You are now mining with the network, as you can see on the bottom of the image. In this example, the computer is contributing 23 H/s to the Monero network. Mining helps keep the network secure, and you may get lucky and receive a reward for protecting the network.
To stop mining, simply click the "Stop mining" button.

145
resources/vrp/index.md Normal file
View file

@ -0,0 +1,145 @@
---
layout: static_page
title: "Vulnerability Response Process"
icon: "icon_people"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
---
# Monero Site Vulnerability Response Process
## Preamble
Researchers/Hackers: while you research/hack, we ask that you please refrain from committing the following:
- Denial of Service / Active exploiting against the network
- Social Engineering of Monero staff or contractors
- Any physical or electronic attacks against Monero community property and/or data centers
## I. Points of Contact for Security Issues
```
ric@getmonero.org
BDA6 BD70 42B7 21C4 67A9 759D 7455 C5E3 C0CD CEB9
luigi1111@getmonero.org
8777 AB8F 778E E894 87A2 F8E7 F4AC A018 3641 E010
```
## II. Security Response Team
- fluffypony
- luigi1111
## III. Incident Response
1. Researcher submits report via one or both of two methods:
- a. Email
- b. [HackerOne](https://hackerone.com/monero)
2. Response Team designates a Response Manager who is in charge of the particular report based on availability and/or knowledge-set
3. In no more than 3 working days, Response Team should gratefully respond to researcher using only encrypted, secure channels
4. Response Manager makes inquiries to satisfy any needed information to confirm if submission is indeed a vulnerability
- a. If submission proves to be vulnerable, proceed to next step
- b. If not vulnerable:
- i. Response Manager responds with reasons why submission is not a vulnerability
- ii. Response Manager moves discussion to a new or existing ticket on GitHub if necessary
5. If over email, Response Manager opens a HackerOne issue for new submission
6. Establish severity of vulnerability:
- a. HIGH: impacts site as a whole, has potential to break entire site, results in the loss of user-data, or is on a scale of great catastrophe
- b. MEDIUM: impacts individual users, or must be carefully exploited
- c. LOW: is not easily exploitable
7. Respond according to the severity of the vulnerability:
- a. HIGH severities must be notified on website and reddit /r/Monero within 3 working days of classification
- i. The notification should list appropriate steps for users to take, if any
- ii. The notification must not include any details that could suggest an exploitation path
- iii. The latter takes precedence over the former
- b. LOW and MEDIUM and HIGH severities will require a rolling release update of the site
8. Response Team applies appropriate patch(es)
- a. Response Manager designates a PRIVATE git "hotfix branch" to work in
- b. Patches are reviewed with the researcher
- c. Any messages associated with PUBLIC commits during the time of review should not make reference to the security nature of the PRIVATE branch or its commits
- d. Vulnerability announcement is drafted
- i. Include the severity of the vulnerability
- ii. Include all vulnerable systems/apps/code
- iii. Include solutions (if any) if patch cannot be applied
- e. Release date is discussed
9. At release date, Response Team coordinates with developers to finalize update:
- a. Response Manager propagates the "hotfix branch" to trunk
- b. Response Manager includes vulnerability announcement draft in release notes
- c. Proceed with the Point or Regular Release
## IV. Post-release Disclosure Process
1. Response Team has 90 days to fulfill all points within section III
2. If the Incident Response process in section III is successfully completed:
- a. Response Manager contacts researcher and asks if researcher wishes for credit
- b. Finalize vulnerability announcement draft and include the following:
- i. Project name and URL
- ii. Versions known to be affected
- iii. Versions known to be not affected (for example, the vulnerable code was introduced in a recent version, and older versions are therefore unaffected)
- iv. Versions not checked
- v. Type of vulnerability and its impact
- vi. If already obtained or applicable, a CVE-ID
- vii. The planned, coordinated release date
- viii. Mitigating factors (for example, the vulnerability is only exposed in uncommon, non-default configurations)
- ix. Workarounds (configuration changes users can make to reduce their exposure to the vulnerability)
- x. If applicable, credits to the original reporter
- c. Release finalized vulnerability announcement on website and reddit /r/Monero
- d. For HIGH severities, release finalized vulnerability announcement on well-known mailing lists:
- i. oss-security@lists.openwall.com
- ii. bugtraq@securityfocus.com
- e. If applicable, developers request a CVE-ID
- i. The commit that applied the fix is made reference too in a future commit and includes a CVE-ID
3. If the Incident Response process in section III is *not* successfully completed:
- a. Response Team and developers organize an IRC meeting to discuss why/what points in section III were not resolved and how the team can resolve them in the future
- b. Any developer meetings immediately following the incident should include points made in section V
- c. If disputes arise about whether or when to disclose information about a vulnerability, the Response Team will publicly discuss the issue via IRC and attempt to reach consensus
- d. If consensus on a timely disclosure is not met (no later than 90 days), the researcher (after 90 days) has every right to expose the vulnerability to the public
## V. Incident Analysis
1. Isolate codebase
- a. Response Team and developers should coordinate to work on the following:
- i. Problematic implementation of classes/libraries/functions, etc.
- ii. Focus on apps/distro packaging, etc.
- iii. Operator/config error, etc.
2. Auditing
- a. Response Team and developers should coordinate to work on the following:
- i. Auditing of problem area(s) as discussed in point 1
- ii. Generate internal reports and store for future reference
- iii. If results are not sensitive, share with the public via IRC or GitHub
3. Response Team has 45 days following completion of section III to ensure completion of section V
## VI. Resolutions
Any further questions or resolutions regarding the incident(s) between the researcher and response + development team after public disclosure can be addressed via the following:
- [GitHub](https://github.com/monero-project/monero/issues/)
- [HackerOne](https://hackerone.com/monero)
- [Reddit /r/Monero](https://reddit.com/r/Monero/)
- IRC
- Email
## VII. Continuous Improvement
1. Response Team and developers should hold annual meetings to review the previous year's incidents
2. Response Team or designated person(s) should give a brief presentation, including:
- a. Areas of Monero affected by the incidents
- b. Any network downtime or monetary cost (if any) of the incidents
- c. Ways in which the incidents could have been avoided (if any)
- d. How effective this process was in dealing with the incidents
3. After the presentation, Response Team and developers should discuss:
- a. Potential changes to development processes to reduce future incidents
- b. Potential changes to this process to improve future responses