Skip to content
Snippets Groups Projects
Verified Commit 82610300 authored by Diego Salazar's avatar Diego Salazar
Browse files

Adjsuted front matter of user guides for translation

parent ab82e3cc
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 60 additions and 1098 deletions
resources/user-guides/Offline_Backup.md
+ 3
− 43
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "Creating an Offline Backup of your Monero Account"
title-pre-kick: "Creating an Offline Backup "
title-kick: "of your Monero "
title-post-kick: "Account"
kick-class: "purple-kicks"
icon: "icon_userguides"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
permalink: /resources/user-guides/Offline_Backup.html
---
## Operating Systems: Various versions of Linux and Windows 7, 8
### Wallet Software: Simplewallet
#### Resource for Creating Bootable Disks: [Linux](http://www.pendrivelinux.com/), [Windows](https://www.microsoft.com/en-us/download/windows-usb-dvd-download-tool)
#### Resource for Monero Binaries: [Monero Binaries](https://getmonero.org/downloads/)
- Take any computer you have lying around, even your normal workstation. You may find it easier to use an older computer that has no wifi or bluetooth if you're particularly paranoid
- Create a Linux or Windows bootable disk, and make sure you have the Monero binaries on the same disk or on a second disk (for Linux make sure you have also downloaded copies of the dependencies you will need, libboost1.55 and miniupnpc for instance)
- Disconnect the network and/or Internet cables from your computer, physically remove the wifi card or switch the wifi/bluetooth off on a laptop if possible
- Boot into your bootable OS, install the dependencies if necessary
- Copy the Monero binaries to a RAM disk (/dev/shm in Linux, Windows bootable ISOs normally have a Z: drive or something)
- Don't run the Monero daemon. Instead, using the command line, use monero-wallet-cli to create a new Monero @account
- When prompted for a name, give it any name, it doesn't really matter
- When prompted for a password, type in like 50 - 100 random characters. Don't worry that you don't know the password, just make it LONG
- **CRITICAL STEP**: Write down (on paper) your 25 word @mnemonic-seed
**WARNING**: If you forget to write down this information your funds may be lost forever
- Write down (on your phone, on paper, on another computer, wherever you want) your address and view key
- Switch off the computer, remove the battery if there is one, and leave it physically off for a few hours
The account you've created was created in RAM, and the digital files are now inaccessible. If some adversary manages to somehow obtain the data, they will lack the long password to open it. If you need to receive payments, you have your public address, and you have the view key if needed. If you need access to it, you have your 25 word @mnemonic-seed, and you can now write out several copies of it, including an offsite copy (e.g. a bank deposit box).
Credit: Riccardo Spagni
Related: [Offline Account Generator](http://moneroaddress.org/)
{% tf resources/user-guides/Offline_Backup.md %}
\ No newline at end of file
resources/user-guides/create_wallet.md
+ 3
− 67
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "Creating a Monero wallet"
title-pre-kick: "Creating a Monero wallet "
title-kick: "on Ubuntu "
title-post-kick: ""
kick-class: "purple-kicks"
icon: "icon_userguides"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
permalink: /resources/user-guides/create_wallet.html
---
### Operating Systems: Ubuntu
- Download the [official binaries](https://getmonero.org/downloads/) or compile the last source available on [Github](https://github.com/monero-project/bitmonero)
![image1](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/1.png)
![image2](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/2.png)
- Extract the files with the archive manager (same as Winzip on Windows). Note the path where the files "monerod" and "monero-wallet-cli" are
![image3](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/3.png)
![image4](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/4.png)
- You only need to do this step once : open a terminal (ctrl+alt+t) and install the required dependencies by typing : "*sudo apt-get install libboost-all-dev libssl-dev libevent-dev libdb++-dev*". When asked, press the Y key and then Enter to continue
![image5](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/5.png)
![image6](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/6.png)
- Open a terminal and load the path where your binaries are extracted (cf. step 2) by typing : "*cd yourPathFromStep2*"
![image7](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/7.png)
- Load monerod by typing in your terminal : "*./monerod*". Wait for the synchronization with the network (monerod is updating the blockchain you have downloaded in step 4 or is downloading it from scratch). This can take a lot of time the first time, so be patient
![image8](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/8.png)
![image9](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/9.png)
![image10](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/10.png)
![image11](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/11.png)
- Once monerod is synchronized with the network, open a new terminal, change the directory (cf. step 5), and launch monero-wallet-cli by typing "*./monero-wallet-cli*"
![image12](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/12.png)
- Enter the name you want for your portfolio and follow the instructions from the terminal
![image13](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/13.png)
![image14](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/14.png)
![image15](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/15.png)
![image16](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/16.png)
*This is your private key. Write it down and keep it in a safe place!*
![image17](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/17.png)
*This is your view key. You need it to create a view only wallet (cf. associated user guide)*
![image18](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/18.png)
*This is the address of your wallet*
![image19](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/19.png)
![image20](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/20.png)
![image21](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/21.png)
![image22](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/22.png)
![image23](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/create_wallet/23.png)
- To exit monerod or monero-wallet-cli just type "*exit*" in the associated terminal
Now to access the portfolio you have just created you will have to launch monerod, wait for it to be synchronized with the network, launch monero-wallet-cli, and type the name of your portfolio and your password.
{% tf resources/user-guides/create_wallet.md %}
\ No newline at end of file
resources/user-guides/easiest_buy.md
+ 3
− 71
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "Easiest way to buy Monero"
title-pre-kick: "Easiest way"
title-kick: "to buy Monero"
title-post-kick: ""
kick-class: "purple-kicks"
icon: "icon_userguides"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
permalink: /resources/user-guides/easiest_buy.html
---
## How to obtain Monero
This is a guide to obtain your own Monero as of 20150919. This is perhaps the easiest way to purchase and hold Monero.
####Step 1: Buy Bitcoin
There are many ways to buy Bitcoin. Perhaps the easiest way is through circle.com. Once you have purchased some Bitcoin, you are ready to buy some Monero! Buying Bitcoin is straightforward. Please goto circle.com and just follow the instructions there.
####Step 2: Set up a mymonero.com account
MyMonero.com is an online wallet for Monero, maintained by Monero Core Developer Ricardo Spagni (fluffpony). It is the easiest wallet to use. Simply go to MyMonero.com and click on the "Create an Account" button.
![image1](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/01.png)
After clicking the button, you will see your private key. This key is what gives you access to your funds. Never share this key with anyone!
### WRITE DOWN THIS KEY IMMEDIATELY!
![image2](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/02.png)
Type in your private key in the box below, and click the button.
On the next page, you will see your address.
![image3](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/03.png)
Copy your address to the clipboard by highlighting the whole thing and hitting ctrl+c (or edit menu, copy), or clicking the little icon next to your address. Save your address somewhere. This is how others will send Monero to you, and what you will use to deposit Monero into your account!
#### Step 3: Buy Monero and transfer the Monero to your new address
Go to www.shapeshift.io . On the righthand side, of the screen, click icon under "Receive" to select Monero.
![image5](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/05.png)
![image6](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/06.png)
Paste your address into the field under the Monero logo. Select the "agree to terms" button, then hit "Start"
![image7](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/07.png)
In the new screen that pops up, copy the Deposit Address into your clipboard (select and hit ctrl+c or edit-copy)
![image8](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/08.png)
Go back to your circle.com page, hit the "transfer" button, and paste the Bitcoin address into the field
Enter the amount of Bitcoin you would like to spend.
![image4](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/04.png)
![image9](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/09.png)
You will get a text message verification code. Enter code and hit send.
![image10](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/10.png)
You will see the shapeshift change to "awaiting exchange"
![image11](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/11.png)
Then it will change to COMPLETE!
![image12](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/12.png)
After a while you will see it in your Monero account
![image13](https://github.com/luuul/monero-site/blob/master/knowledge-base/user-guides/png/easiest_way/13.png)
{% tf resources/user-guides/easiest_buy.md %}
\ No newline at end of file
resources/user-guides/howto_fix_stuck_funds.md
+ 3
− 37
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "How to fix stuck funds"
title-pre-kick: "Fix "
title-kick: "Stuck funds"
title-post-kick: ""
kick-class: "kicks"
icon: "icon_about"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
permalink: /resources/user-guides/howto_fix_stuck_funds.html
---
Sometimes, your funds will become stuck - you will have some locked funds that never become unlocked. This is how you fix it.
- Load your wallet in monero-wallet-cli.
- Type
> seed
into the command prompt. Write down your 25 word seed, if you haven't already. This is the best way to make sure you don't loose access to your funds.
- Close monero-wallet-cli by typing
> exit
- Backup all of your wallet related files. These include:
> yourwalletname.bin
> yourwalletname.bin.keys
> yourwalletname.bin.address.txt
This can be done by copying the files to a new folder.
Sometimes, when creating your wallet, you might have named it something without the .bin part. In that case, the wallet file will be called yourwalletname without the .bin at the end.
- Delete yourwallet.bin
- Load monero-wallet-cli, type in the name of the wallet you just deleted
- Enter password. The wallet will now refresh and hopefully your locked funds will now become unlocked.
{% tf resources/user-guides/howto_fix_stuck_funds.md %}
\ No newline at end of file
resources/user-guides/importing_blockchain.md
+ 4
− 58
View file @ 82610300
---
layout: static_page
title: Importing the Monero Blockchain from an outside source
layout: user-guide
title: Importing the Monero Blockchain from an outside source
permalink: /resources/user-guides/importing_blockchain.html
---
# 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 Blockchain has finished syncing up you can open your Monero wallet normally. Your downloaded blockchain.raw can be deleted.
Author: Kee Jefferys
\ No newline at end of file
{% tf resources/user-guides/importing_blockchain.md %}
\ No newline at end of file
resources/user-guides/index.md
+ 2
− 124
View file @ 82610300
---
layout: custom
title: "User Guides"
title: titles.userguides
---
<div class="guides">
<section class="container">
<div class="row">
<div class="left half no-pad-sm col-lg-6 col-md-6 col-sm-12 col-xs-12">
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>General</h2>
</div>
</div>
<div class="row start-xs" markdown="1">
[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)
</div>
</div>
</div>
<div class="right half col-lg-6 col-md-6 col-sm-12 col-xs-12">
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Wallets</h2>
</div>
</div>
<div class="row start-xs" markdown="1">
[Getting started with the CLI wallet](monero-wallet-cli.html)
[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>
</div>
</div>
</section>
<section class="container">
<div class="row">
<div class="left half no-pad-sm col-lg-6 col-md-6 col-sm-12 col-xs-12">
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Recovery</h2>
</div>
</div>
<div class="row start-xs" markdown="1">
[How to fix locked up funds](howto_fix_stuck_funds.html)
[How to restore your account](restore_account.html)
</div>
</div>
</div>
<div class="right half col-lg-6 col-md-6 col-sm-12 col-xs-12">
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Mining</h2>
</div>
</div>
<div class="row start-xs" 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)
</div>
</div>
</div>
</div>
</section>
<section class="container">
<div class="row">
<div class="left half no-pad-sm col-lg-6 col-md-6 col-sm-12 col-xs-12">
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Website</h2>
</div>
</div>
<div class="row start-xs" markdown="1">
[General Web Edit Instructions (READ FIRST!)](website-general.html)
[How to make a blog post](website-blog.html)
[How to make a User Guide](website-user-guide.html)
[How to make a Moneropedia entry](website-moneropedia.html)
[How to make a FFS proposal](website-ffs.html)
[How to update the Team page](website-team.html)
[How to add update Events page](website-events.html)
[How to update the Roadmap](website-roadmap.html)
[How to add a new Merchant](website-merchants.html)
[How to add a new question to the FAQ](website-faq.html)
</div>
</div>
</div>
<div class="right half col-lg-6 col-md-6 col-sm-12 col-xs-12">
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Miscellaneous</h2>
</div>
</div>
<div class="row start-xs" markdown="1">
Coming Soon
</div>
</div>
</div>
</div>
</section>
</div>
\ No newline at end of file
{% tf resources/user-guides/index.md %}
\ No newline at end of file
resources/user-guides/mine-to-pool.md
+ 3
− 114
View file @ 82610300
---
layout: static_page
layout: user-guide
title: How to mine on a pool with xmr-stak-cpu
permalink: /resources/user-guides/mine-to-pool.html
---
# Selecting a pool
There are many pools to choose from, a list is available at
[moneropools.com](https://moneropools.com). Mining on a larger pool could mean
more frequent payouts, but mining on a smaller pool helps to keep the network
decentralized.
# Selecting a CPU miner
Just like pools, there are a lot of miners to choose from. The one that you
should pick depends on the hardware you want to mine on. This guide will only
use a CPU miner, and will be using
[xmr-stak-cpu](https://github.com/fireice-uk/xmr-stak-cpu). Alternatives include
[wolf's CPUMiner](https://github.com/wolf9466/cpuminer-multi) and
[sgminer-gm](https://github.com/genesismining/sgminer-gm). However, their
configuration is slightly different and will not be covered in this guide.
## For Windows Systems
If you are using a Windows system, the developer of xmr-stak-cpu provides
binaries to download on the
[GitHub release page](https://github.com/fireice-uk/xmr-stak-cpu/releases).
Download `xmr-stak-cpu-win64.zip` and extract it somewhere you'll be able to
find it again.
## For Other Operating Systems
If you're not using Windows, you will have to compile xmr-stak-cpu for yourself,
luckily this isn't as hard as it sounds. Before you can compile the miner, you
will need to install some of its prerequisites.
For Debian-based distros:
sudo apt-get install libmicrohttpd-dev libssl-dev cmake build-essential
For Red Hat based distros:
sudo yum install openssl-devel cmake gcc-c++ libmicrohttpd-devel
<!-- TODO: Add dependencies for other operating systems? -->
Following this, you just need to use cmake to generate the build files, run
make and copy the config file:
mkdir build-$(gcc -dumpmachine)
cd $_
cmake ../
make -j$(nproc)
cp ../config.txt bin/
cd bin
Don't celebrate just yet, as the miner needs to be configured. Running the miner
now should give you a block of text to copy and paste:
![image1](png/mine_to_pool/1.png)
Open `config.txt` and *replace* the two `"cpu_threads_conf"` lines with the text
you just copied. It should look something like this afterwards:
![image2](png/mine_to_pool/2.png)
Scroll down in the file until you see the lines containing `"pool_address"`.
*Replace* the contents of the second set of quotes with the address and port of
the pool you chose earlier. You can find this information on the pool's website.
Put your wallet address between the quotes on the wallet address. You may leave
the password blank unless the pool specifies otherwise.
After this, your config should look something like this:
![image3](png/mine_to_pool/3.png)
# Running the miner
**Save the config** file and run the miner!
![image4](png/mine_to_pool/4.png)
Some pools allow you to monitor your hashrate by pasting your address into their
website. You can also monitor your hashrate by pressing the `h` key.
# Tuning the miner
You might see nasty messages like this:
[2017-07-09 12:04:02] : MEMORY ALLOC FAILED: mmap failed
This means that you can get around a 20% hashrate boost by enabling large pages.
## Large pages on Linux
Firstly stop the miner (if it's running), run the following commands to enable
large pages and then start the miner as root:
sudo sysctl -w vm.nr_hugepages=128
sudo ./xmr-stak-cpu
## Large pages on Windows
Taken from `config.txt`:
>By default we will try to allocate large pages. This means you need to "Run As Administrator" on Windows
You need to edit your system's group policies to enable locking large pages. Here are the steps from MSDN
1. On the Start menu, click Run. In the Open box, type gpedit.msc.
2. On the Local Group Policy Editor console, expand Computer Configuration, and then expand Windows Settings.
3. Expand Security Settings, and then expand Local Policies.
4. Select the User Rights Assignment folder.
5. The policies will be displayed in the details pane.
6. In the pane, double-click Lock pages in memory.
7. In the Local Security Setting – Lock pages in memory dialog box, click Add User or Group.
8. In the Select Users, Service Accounts, or Groups dialog box, add an account that you will run the miner on
9. Reboot for change to take effect.
{% tf resources/user-guides/mine-to-pool.md %}
\ No newline at end of file
resources/user-guides/mining_with_xmrig_and_docker.md
+ 3
− 44
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "Mining with XMRig and Docker"
title-pre-kick: "Mining XMR"
title-kick: "With XMRig and DOcker"
title-post-kick: ""
kick-class: "purple-kicks"
icon: "icon_userguides"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
permalink: /resources/user-guides/mining_with_xmrig_and_docker.html
---
## Introduction
This guide is two fold, ease of use for mining on Linux distributions and some extra security around mining as most of these miners have not had security auditing.
At the end of this guide you will be able to sleep a little easier knowing that if the miner gets exploited it will not migrate to your OS.
### Why Docker
[Docker](https://www.docker.com/) is being used as it is the most well known and has the biggest chance to be already installed.
The container I an using is [alpine-xmrig](https://hub.docker.com/r/bitnn/alpine-xmrig/) as per the name it is built on the [Alpine Linux](https://www.alpinelinux.org/) image.
If you are interested in getting started with Docker, here are some really good starting references.
* Arch Linux Wiki [Docker Page](https://wiki.archlinux.org/index.php/Docker)
* Container Solutions [Security Cheat Sheet](http://container-solutions.com/content/uploads/2015/06/15.06.15_DockerCheatSheet_A2.pdf)
* Digital Oceans [Dockerfile Howto](https://www.digitalocean.com/community/tutorials/docker-explained-using-dockerfiles-to-automate-building-of-images).
For distribution specific installation please refer to the [Docker Docs](https://docs.docker.com/engine/installation/) website.
### Why XMRig
[XMRig](https://github.com/xmrig/xmrig) is just a really solid miner to me. Nice output and statistics, no flashy web-ui's or dependencies. The XMRig container is only ~4MB what makes it extremely portable.
#### Step 1: Mining with XMRig
Run the following
```bash
# docker run --restart unless-stopped --read-only -m 50M -c 512 bitnn/alpine-xmrig -o POOL01 -o POOL02 -u WALLET -p PASSWORD -k
# docker run --restart unless-stopped --read-only -m 50M -c 512 bitnn/alpine-xmrig -o pool.supportxmr.com:7777 -u 45CJVagd6WwQAQfAkS91EHiTyfVaJn12uM4Su8iz6S2SHZ3QthmFM9BSPHVZY388ASWx8G9Wbz4BA24RQZUpGczb35fnnJz -p docker:secret -k
```
#### Step 2: There is no Step 2
You have already done everything you need to do. You are now mining in a docker container with XMRig `ctrl+c` to exit the miner or add `-d` just after `docker run` to background the miner.
{% tf resources/user-guides/mining_with_xmrig_and_docker.md %}
\ No newline at end of file
resources/user-guides/monero-wallet-cli.md
+ 3
− 152
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "Monero tools"
title-pre-kick: "Monero tools "
title-kick: "for the network "
title-post-kick: ""
kick-class: "purple-kicks"
icon: "icon_userguides"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
permalink: /resources/user-guides/monero-wallet-cli.html
---
# monero-wallet-cli
`monero-wallet-cli` is the wallet software that ships with the Monero tree. It is a console program,
and manages an account. While a bitcoin wallet manages both an account and the blockchain,
Monero separates these: `monerod` handles the blockchain, and `monero-wallet-cli` handles the account.
This guide will show how to perform various operations from the `monero-wallet-cli` UI. The guide assumes you are using the most recent version of Monero and have already created an account according to the other guides.
## Checking your balance
Since the blockchain handling and the wallet are separate programs, many uses of `monero-wallet-cli`
need to work with the daemon. This includes looking for incoming transactions to your address.
Once you are running both `monero-wallet-cli` and `monerod`, enter `balance`.
Example:
This will pull blocks from the daemon the wallet did not yet see, and update your balance
to match. This process will normally be done in the background every minute or so. To see the
balance without refreshing:
balance
Balance: 64.526198850000, unlocked balance: 44.526198850000, including unlocked dust: 0.006198850000
In this example, `Balance` is your total balance. The `unlocked balance` is the amount currently available to spend. Newly received transactions require 10 confirmations on the blockchain before being unlocked. `unlocked dust` refers to very small amounts of unspent outputs that may have accumulated in your account.
## Sending monero
You will need the standard address you want to send to (a long string starting with '4'), and
possibly a payment ID, if the receiving party requires one. In that latter case, that party
may instead give you an integrated address, which is both of these packed into a single address.
### Sending to a standard address:
transfer ADDRESS AMOUNT PAYMENTID
Replace `ADDRESS` with the address you want to send to, `AMOUNT` with how many monero you want to send,
and `PAYMENTID` with the payment ID you were given. Payment ID's are optional. If the receiving party doesn't need one, just
omit it.
### Sending to an integrated address:
transfer ADDRESS AMOUNT
The payment ID is implicit in the integrated address in that case.
### Specify the number of outputs for a transaction:
transfer MIXIN ADDRESS AMOUNT
Replace `MIXIN` with the number of outputs you wish to use. **If not specified, the default is 4.** It's a good idea to use the default, but you can increase the number if you want to include more outputs. The higher the number, the larger the transaction, and higher fees are needed.
## Receiving monero
If you have your own Monero address, you just need to give your standard address to someone.
You can find out your address with:
address
Since Monero is anonymous, you won't see the origin address the funds you receive came from. If you
want to know, for instance to credit a particular customer, you'll have to tell the sender to use
a payment ID, which is an arbitrary optional tag which gets attached to a transaction. To make life
easier, you can generate an address that already includes a random payment ID:
integrated_address
This will generate a random payment ID, and give you the address that includes your own account
and that payment ID. If you want to select a particular payment ID, you can do that too:
integrated_address 12346780abcdef00
Payments made to an integrated address generated from your account will go to your account,
with that payment id attached, so you can tell payments apart.
## Proving to a third party you paid someone
If you pay a merchant, and the merchant claims to not have received the funds, you may need
to prove to a third party you did send the funds - or even to the merchant, if it is a honest
mistake. Monero is private, so you can't just point to your transaction in the blockchain,
as you can't tell who sent it, and who received it. However, by supplying the per-transaction
private key to a party, that party can tell whether that transaction sent monero to that
particular address. Note that storing these per-transaction keys is disabled by default, and
you will have to enable it before sending, if you think you may need it:
set store-tx-info 1
You can retrieve the tx key from an earlier transaction:
get_tx_key 1234567890123456789012345678901212345678901234567890123456789012
Pass in the transaction ID you want the key for. Remember that a payment might have been
split in more than one transaction, so you may need several keys. You can then send that key,
or these keys, to whoever you want to provide proof of your transaction, along with the
transaction id and the address you sent to. Note that this third party, if knowing your
own address, will be able to see how much change was returned to you as well.
If you are the third party (that is, someone wants to prove to you that they sent monero
to an address), then you can check this way:
check_tx_key TXID TXKEY ADDRESS
Replace `TXID`, `TXKEY` and `ADDRESS` with the transaction ID, per-transaction key, and destination
address which were supplied to you, respectively. monero-wallet-cli will check that transaction
and let you know how much monero this transaction paid to the given address.
## Getting a chance to confirm/cancel payments
If you want to get a last chance confirmation when sending a payment:
set always-confirm-transfers 1
## How to find a payment to you
If you received a payment using a particular payment ID, you can look it up:
payments PAYMENTID
You can give more than one payment ID too.
More generally, you can review incoming and outgoing payments:
show_transfers
You can give an optional height to list only recent transactions, and request
only incoming or outgoing transactions. For example,
show_transfers in 650000
will only incoming transfers after block 650000. You can also give a height
range.
If you want to mine, you can do so from the wallet:
start_mining 2
This will start mining on the daemon usin two threads. Note that this is solo mining,
and may take a while before you find a block. To stop mining:
stop_mining
{% tf resources/user-guides/monero-wallet-cli.md %}
\ No newline at end of file
resources/user-guides/monero_tools.md
+ 3
− 24
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "Monero tools"
title-pre-kick: "Monero tools "
title-kick: "for the network "
title-post-kick: ""
kick-class: "purple-kicks"
icon: "icon_userguides"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
permalink: /resources/user-guides/monero_tools.html
---
# Monero tools
These tools can be used to gain information about the Monero network or your transaction data in the blockchain.
### [Check that a recipient has received your funds](http://xmrtests.llcoins.net/checktx.html)
### [Tools for monero address generation](https://xmr.llcoins.net/)
### [Monero node count](http://moneronodes.i2p.xyz/)
### [Monero node map](https://monerohash.com/nodes-distribution.html)
### [Monero offline wallet generator](http://moneroaddress.org/)
### [Monero network statistics](http://moneroblocks.info/stats)
### [Monero.how statistics](https://www.monero.how/)
\ No newline at end of file
{% tf resources/user-guides/monero_tools.md %}
\ No newline at end of file
resources/user-guides/prove-payment.md
+ 3
− 58
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "How to prove payment"
title-pre-kick: "Prove "
title-kick: "payment"
title-post-kick: ""
kick-class: "kicks"
icon: "icon_about"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
permalink: /resources/user-guides/prove-payment.html
---
When you send money to a party who then disputes the payment was made, you need to be able to prove the payment was made.
With Bitcoin, this is typically done by looking up the transaction ID, where the origin and destination addresses are
shown, along with the amount transacted.
Monero, however, is private: that information is not available publicly on the blockchain. The steps are therefore a bit
more involved.
To prove to Charlie that she made a payment to Bob, Alice must supply Charlie three pieces of information:
- the transaction ID, as is done in Bitcoin
- Bob's address, as is done with Bitcoin
- the transaction's key, which is new with Monero and other CryptoNote currencies
When Alice made the transaction, a one time key was automatically generated just for this transaction. Alice can
query it thus in monero-wallet-cli (new name for the old simplewallet):
> get_tx_key TXID
Alice would plug in her actual transaction ID instead of this TXID placeholder. All being well, the one time transaction key
will be displayed.
Note that this will only work if monero-wallet-cli is set to save transaction keys. To double check:
> set
If it's set to 0, set it to 1:
> set store-tx-info 1
Alice can now send Charlie the transaction key along with transaction ID and Bob's address.
Note: if several transactions were made, this needs repeating for each such transaction.
---
Charlie now received those three pieces of information, and wants to check Alice is telling the truth: on an up to date
blockchain, Charlie types in monero-wallet-cli:
> check_tx_key TXID TXKEY ADDRESS
The information supplied by Alice plugs neatly instead of the placeholders. monero-wallet-cli will use the transaction
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.
{% tf resources/user-guides/prove-payment.md %}
\ No newline at end of file
resources/user-guides/remote_node_gui.md
+ 3
− 11
View file @ 82610300
---
layout: static_page
layout: user-guide
title: How to use a remote node in the GUI wallet
permalink: /resources/user-guides/remote_node_gui.html
---
## 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">
{% tf resources/user-guides/remote_node_gui.md %}
\ No newline at end of file
resources/user-guides/restore_account.md
+ 3
− 29
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "Restoring your Monero Wallet"
title-pre-kick: "Restoring your "
title-kick: "Monero "
title-post-kick: "Wallet"
kick-class: "purple-kicks"
icon: "icon_userguides"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
permalink: /resources/user-guides/restore_account.html
---
## Operating Systems: Windows, Linux, Mac
### Account Software: monero-wallet-cli
- Retrieve your 25 word @mnemonic-seed that you saved when creating your old Monero @wallet
- Open a command prompt and navigate to the drive and directory that contains monero-wallet-cli
- At the command prompt type: `monero-wallet-cli --restore-deterministic-wallet`
- Once you press enter you will be prompted for a wallet file name. Give your wallet a new name, any name will do
- Press enter again and you will be prompted for a password. Give your wallet a new and long password
- Press enter again you will be prompted to repeat the password
- Press enter again and you will be prompted for the 25 word electrum style mnemonic seed that you retrieved earlier
- You will then be prompted with "Restore from specific blockchain height (optional, default 0):" Default will start the restore process from the beginning of the Monero blockchain. If you don't know the specific blockchain height, just hit enter. (Specifying a specific blockchain height will start the restore process from that specific height. This will save a bit of time in scanning, if you know what starting blockchain height your initial funds were transacted for this specific account.)
After you have entered the 25 word mnemonic seed and have chosen your specific blockchain height, monero-wallet-cli will generate the same public address and view key as your old wallet and begin the refresh process automatically. (Please be patient as the refresh process may take a while.)
{% tf resources/user-guides/restore_account.md %}
\ No newline at end of file
resources/user-guides/restore_from_keys.md
+ 3
− 22
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "Restoring a wallet from private keys"
permalink: /resources/user-guides/restore_from_keys.html
---
Restoring a wallet from private keys (via the command line) is pretty simple. If you have the necessary information, with this guide you can completely restore your wallet. Note: you do NOT have to have your password to restore from keys.
You need to have 3 pieces of data from your wallet, or your .keys file which holds this info and the password to decrypt it. The 3 wallet components that you need are:
1. **Address**
2. **Secret Spendkey**
3. **Secret Viewkey**
Then run the wallet command:
`./monero-wallet-cli --generate-from-keys New_Wallet_Name.abc`
Next, you'll be asked for the Address, the spendkey, the viewkey, and finally the new password for the re-generated wallet.
Running this with the correct parameters will re-generate your wallet files for you and allow you to set a new password.
If you run into any trouble, running `./monero-wallet-cli --help` will show you the options available to you at wallet startup. Once you're inside your wallet, running the `help` command will list the help for the commands available to you within the wallet.
{% tf resources/user-guides/restore_from_keys.md %}
\ No newline at end of file
resources/user-guides/securely_purchase.md
+ 3
− 83
View file @ 82610300
---
layout: static_page
layout: user-guide
title: Securely purchasing and storing Monero
permalink: /resources/user-guides/securely_purchase.html
---
## How to purchase Monero and securely store it.
This is a guide to purchase and securely store Monero as of June 2017.
#### Step 1: Buy Bitcoin
There are many ways to buy Bitcoin. Two semi-reliable companies at this time are Xapo <http://www.xapo.com/> and Coinbase <http://www.coinbase.com/>. The process will involve uploading your personal identification (State ID, Passport, etc.) and will take anywhere from 2 to 10 days (or longer). Verify their reputation on Reddit before making a large purchase. Xapo uses Wire Transfer and Coinbase uses Bank Transfer (ACH in the USA). Xapo should be faster than Coinbase. Coinbase also allows small "instant" buys via a debit card but adds a large fee for this option. Once you have purchased Bitcoin, you are ready to convert it to Monero!
#### Step 2: Download and create a Paper Wallet on a secure and air-gapped computer.
Download the paper wallet generator at: https://moneroaddress.org and copy it to a USB stick (Direct link: https://github.com/moneromooo-monero/monero-wallet-generator/archive/master.zip).
Unzip and open the paper wallet generator (monero-wallet-generator.html) into a web browser on an air-gapped computer that hasn't been used before, or has had a clean installation of the OS.
Your paper wallet will have four important items:
Monero Public Address
The public address is used to receive funds to the wallet. You give this to anyone who will be sending funds to your wallet.
Monero Mnemonic Seed
The mnemonic seed is a method of storing the entire wallet that is easily recognizable to humans. This is all you need to restore your wallet at a later date.
Monero Private Spend Key
The private spend key is used to send funds from the wallet.
Monero Private View Key
The private view key is to view transactions entering the wallet. Commonly this is used to setup a view-only only wallet which can see incoming transactions live on the blockchain as they are sent to a cold storage wallet.
At this point you have many options. You can print the wallet on paper, save it as a PDF or text on a USB stick, burn it to CD/DVD, etc. Most likely you will want at least two or three copies, stored securely in different locations. If storing digitally, encrypt everything with a strong password. If storing on paper, do not show the wallet to anyone else who can memorize your 25 word key, or take a picture of the wallet without your permission. Sending someone a picture of the wallet is the same as giving away all of your funds.
Whichever method you chose, be sure there's no copy of the Monero wallet left over on the device you used. You may need to securely delete the Monero wallet if you saved it to a disk, or make sure your printer does not save a copy in memory.
*If you lose access to your Monero paper wallet the Monero will not be available to you or anyone else, ever. You wont be able to recover them!
#### Side Note
Option to encrypt an XMR mnemonic seed:
https://xmr.llcoins.net/
Download the html page and place it on your airgapped computer. Check the part "Encrypt/Decrypt Mnemonic Seed" and make sure you use "CN Add" with a decent password. Thanks manicminer5.
#### Step 3: Convert your Bitcoin to Monero and have it sent to your Monero Paper Wallet
Switch to your internet connected computer and go to www.shapeshift.io. Choose "Deposit Bitcoin" and "Receive Monero" (quick).
Press Continue.
Your Monero Address (the Monero Public Address on your Monero Paper Wallet)
Paste the Monero Public address from your paper wallet where it says "Your Monero Address". But wait, since your Monero Public Address is on an airgapped computer (right?), you can't copy and paste anything... Copy it over by hand, or get a blank USB drive and copy only the Public Address to it.
Refund Address (Bitcoin Public Address you can receive funds at)
Enter a Bitcoin address that you control where a refund can be sent in case there's a problem with the transaction. It's very important that you enter a Bitcoin Public Address you control or can receive funds at. At Xapo and Coinbase this is called a Receive Address and it may change periodically.
Payment ID
Leave Payment ID blank if you are sending to your own Monero wallet or Monero paper wallet.
Agree to the Terms and hit the slider to make this a "Reusable Address".
Press "Start Transaction".
Deposit Address (Shapeshift.io's Public Bitcoin Address created only to receive your funds)
In the new screen that pops up, copy the Deposit Address into your clipboard (select and hit ctrl+c or edit-copy). You will send Bitcoin from Xapo/Coinbase to Shapeshift.io via this address.
Go to your Xapo or Circle account, and find a Transfer or Send button. Paste the Bitcoin Deposit address into the Destination field and enter the amount of bitcoin you would like to have converted to Monero. It must be within the Deposit Min and Deposit Max range specified by Shapeshift.io. Press Send and authorize the transaction, if required.
Once the send has been initiated by Xapo/Coinbase there will be a delay while the transaction enters the Bitcoin blockchain and awaits confirmation. This may be minutes or hours. You can check if the payment has been sent by looking up the Shapeshift.io Deposit address at blockchain.info. Your transaction to Shapeshift.io will show up there.
When your Bitcoin transaction has been confirmed, Shapeshift.io will then begin exchanging Bitcoin (BTC) for Monero (XMR) at one of the exchanges and when it's complete, send the Monero to the address of your Cold Storage Paper Wallet! This can take minutes to hours. If there's an issue, contact Shapeshift.io. They have good support.
When the Shapehift.io webpage says your transaction has been completed, you should now have Monero in your Paper Wallet!
#### Notes and How to Verify Funds
Because the Monero blockchain is private and untraceable, you won't be able to lookup your Monero Public Address and confirm that the funds have arrived like you might with Bitcoin. This is good for privacy, but bad for convenience.
To securely verify the funds have arrived at your wallet, you will need to setup a View Only wallet. This is where that view-key comes in. To create a view-only wallet see the entry: @view-only
To verify the funds are *still in* your wallet and have not been spent you need to create a Cold Wallet with your mnemonic key (all your funds) on an airgapped computer with an up-to-date copy of the Monero Blockchain. When finished you will have to securely erase the wallet or connect it to the internet and it becomes a Hot Wallet.
{% tf resources/user-guides/securely_purchase.md %}
\ No newline at end of file
resources/user-guides/solo_mine_GUI.md
+ 3
− 22
View file @ 82610300
---
layout: static_page
layout: user-guide
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 -->"
permalink: /resources/user-guides/solo_mine_GUI.html
---
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.
{% tf resources/user-guides/solo_mine_GUI.md %}
\ No newline at end of file
resources/user-guides/view_only.md
+ 3
− 19
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "View Only Wallets"
title-pre-kick: "Creating a view only wallet "
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 -->"
permalink: /resources/user-guides/view_only.html
---
A view-only wallet can only see which incoming transactions belong to you. It can not spend any of your Monero, in fact it can't even see outgoing transactions from this wallet. This makes view-only wallets particularly interesting for
* Developers writing libraries to validate payments
* End users validating incoming transactions to cold wallets
### Creating A View-Only Wallet
You can create a view-only wallet from any existing wallet.
Open an existing wallet or create a new one using `monero-wallet-cli`. In the wallet, type `address` and `viewkey` to display the wallet's address and secret viewkey. Type `exit` to close the wallet.
Next, create your view-only wallet by typing `monero-wallet-cli --generate-from-view-key wallet-name`. The last argument will be your new wallet's file name. You will be prompted for `Standard address` and `View key` by the wallet. Paste in your original wallet's address and secret view key. Next, enter and confirm a password for your new wallet and you're done.
{% tf resources/user-guides/view_only.md %}
\ No newline at end of file
resources/user-guides/vps_run_node.md
+ 3
− 54
View file @ 82610300
---
layout: static_page
layout: user-guide
title: "Monero tools"
title-pre-kick: "Monero tools "
title-kick: "for the network "
title-post-kick: ""
kick-class: "purple-kicks"
icon: "icon_userguides"
attribution: "<!-- Icon is based on work by Freepik (http://www.freepik.com) and is licensed under Creative Commons BY 3.0 -->"
permalink: /resources/user-guides/vps_run_node.html
---
# monerod
`monerod` is the daemon software that ships with the Monero tree. It is a console program, and manages the blockchain. While a bitcoin wallet manages both an account and the blockchain, Monero separates these: `monerod` handles the blockchain, and `monero-wallet-cli` handles the account.
This guide assumes you have already set up your VPS account and are using SSH to tunnel into the server console.
## Linux, 64-bit (Ubuntu 16.04 LTS)
### Make sure that port 18080 is open
`monerod` uses this port to communicate with other nodes on the Monero network.
Example if using `ufw`: `sudo ufw allow 18080`
Example if using `iptables`: `sudo iptables -A INPUT -p tcp --dport 18080 -j ACCEPT`
### Download the current Monero Core binaries
wget https://downloads.getmonero.org/linux64
### Make a directory and extract the files.
mkdir monero
tar -xjvf linux64 -C monero
### Launch the daemon
cd monero
./monerod
### Options:
Show list of all options and settings:
./monerod --help
Launch the daemon as a background process:
./monerod --detach
Monitor the output of `monerod` if running as daemon:
tail -f ~/.bitmonero/bitmonero.log
Keep the VPS secure with autoupdate:
https://help.ubuntu.com/community/AutomaticSecurityUpdates
{% tf resources/user-guides/vps_run_node.md %}
\ No newline at end of file
resources/user-guides/website-blog.md
+ 3
− 31
View file @ 82610300
---
layout: static_page
layout: user-guide
title: How to make a blog post
permalink: /resources/user-guides/website-blog.html
---
### Quick Start
* Make new .md file in _posts (named whatever, no spaces)
* Front Matter (below)
* Write Blog Post
* Test/Build
* Submit PR
### Make a file
Navigate to the _posts folder of the website and make a new file. Be sure the file name has no spaces and the ending is .md
### Front Matter
```
---
layout: post
title: CHANGE TO YOUR TITLE
summary: A BRIEF ONE OR TWO SENTENCE SUMMARY
tags: [CHOOSE, RELEVANT, TAGS, AND, SEPARATE, THEM, BY, COMMAS, KEEP, THE, BRACKETS]
author: YOUR NAME OR HANDLE HERE
---
```
### Write
After the front matter is finished you are free to write the remainder of your blog post in markdown.
### Build/Test
Build your website using `jekyll serve` if it's not rebuilding automatically and test that your page appears in the 'News' section of the website, as well as the sidebars.
### Submit Pull Request
You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure to make any changes if requested.
\ No newline at end of file
{% tf resources/user-guides/website-blog.md %}
\ No newline at end of file
resources/user-guides/website-events.md
+ 3
− 35
View file @ 82610300
---
layout: static_page
layout: user-guide
title: How to add an event
permalink: /resources/user-guides/website-events.html
---
### 9.1 Edit the .yml file
Navigate to the `/_data/` folder and open `events.yml`. You will notice a list separated by hyphenated `-event` tags.
**DO NOT MESS WITH THE FORMATTING OR INDENTATION OF ANYTHING OR JEKYLL WILL NOT BUILD PROPERLY!**
Find the area that you want to update and copy the code below:
```
- event:
where:
when:
description:
link:
```
and paste it IN THE CHRONOLOGICAL ORDER that it will be in. So if there is an event happening before yours, make sure it is higher up than yours. If there is an event happening AFTER yours, make sure it is after your event.
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.
* `when:` Date and time
* `description:` Descriptoin 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.**
Save the file.
### 9.2 Build/Test
Build your website using `jekyll serve` if it's not rebuilding automatically. If the build fails and you receive an error, you may have messed up somewhere in the `events.yml` file back in 9.1. Go back to that section and check the indentation. Yes, it's stupid. Yes, it has to be perfect.
If the build is successful, go to the Events page `/community/events/` and check to see that the event is showing up in the correct place. Click their Event url link (if applicable) and make sure it redirects correctly. Test the page and let rehrar know if there are any bugs.
### 9.3 Submit a Pull Request
You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure to make any changes if requested.
\ No newline at end of file
{% tf resources/user-guides/website-events.md %}
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment