Getting started

2024-11-08T11:46:55Z

Ps: Adjust accordions to BS4 syntax.

{{#seo:
|title=Getting started
|titlemode=replace
|keywords=Nxtwiki, Nxt documentation, blockchain, proof of stake, nxt, jelurida, development, nxt wiki, wiki
|description=Getting started with the Nxt platform
}}
__TOC__

''Nxt'' is an [https://bitbucket.org/Jelurida/nxt/src open source] second generation [[wikipedia:Block_chain_(database)|blockchain]] that provides tools for a decentralized financial platform. Coded in [[wikipedia:Java_(programming_language)|Java]] completely from scratch, Nxt was the first currency to rely purely on [[wikipedia:Proof-of-stake|proof-of-stake]] for consensus.

==Download Nxt==

Nxt is supported by all major operating systems. Before we begin, if you haven’t already done so, you may wish to check that you have the correct (usually most recent) version of [https://adoptopenjdk.net/ Java] installed on your computer. You can use any compatible Java available for your platform. The minimum required version is Java 8. The recommended version is Java 11. We usually test with OpenJDK 11.

To start with Nxt, you need to have the Nxt client software installed and up to date. You can find the download and installation instructions of the core Nxt client as follows:
:
{|
|-
| [[File:Windowslogo.jpg|100px|frameless|link=Getting_started#Windows]] || [[File:AppleLogo.jpg|100px|frameless|link=Getting_started#MacOS]] || [[File:Linuxlogo.jpg|100px|frameless|link=Getting_started#Linux]] || [[File:RaspberryPi_Logo.png|100px|frameless|link=Getting_started#Raspberry_Pi]]|| [[File:android.png|100px|frameless|link=Getting_started#Android]]
|}

==Client Installation ==

<div class="accordion" id="accordion">
<accordion parent="accordion" heading="===Windows===" class="show">
#Download the Windows installer for the latest official Nxt Client {{NRSVersion}} from {{NRSWinInstaller}}.

After downloading, [[Faq#How_to_verify_authenticity_of_Nxt_installations|verify its signature]]
#Run the installer and follow the instructions on screen. Icons will be created by default in your desktop and Start Menu.
#You can now run the Nxt software.If you already have created a Nxt account, click in 'Returning User' to introduce your passphrase. If you need to create your Nxt account, [[How_to_create_an_account|click here for instructions to Create a New Nxt Account]].
</accordion>
</div>

<div class="accordion" id="accordion">
<accordion parent="accordion" heading="===MacOS===">
#Download the Mac installer for the latest official Nxt Client {{NRSVersion}} from {{NRSMacInstaller}}.
After downloading, [[Faq#How_to_verify_authenticity_of_Nxt_installations|verify its signature]] and check the SHA256 hash of the package for security.
#Run the installer package (Nxt's Mac installer comes packaged in .dmg format) and follow the instructions on screen
## Open the nxt-installer.app and click on the "Open" button
## Select the language
## Click on 'Next' to begin with the installation
## Accept the terms of the license agreement
## Select the installation path
## Check the options
## Once installed, click on finish
#You can now run the Nxt software clicking on the "Nxt.app" in Applications. If you already have created a Nxt account, click in 'Returning User' to introduce your passphrase. If you need to create your Nxt account, [[How_to_create_an_account|click here for instructions to Create a New Nxt Account]].
</accordion>
</div>

<div class="accordion" id="accordion">
<accordion parent="accordion" heading="===Linux===">

Here is the guide to installing the Nxt Client on a Linux 64-bit platform. 32-bit installation instructions are very similar; you just might need to download the 32-bit version of Java instead of the 64-bit one.

You can use this instructions on your Linux VPS as well (but also see our [[Set_up_a_public_node_on_a_VPS|public node installation instructions]] ).

==== Set up Java ====
You can skip this step if you already have Java installed. Otherwise, you can install it via PPA repository doing the following (for Ubuntu/Debian builds):

<pre>sudo apt update
sudo apt install openjdk-11-jre-headless</pre>

==== Install and run the Nxt Client ====
Find below the instructions for installing the software.

=====Using the Universal Zip Package=====
#Change to your home folder and download the latest client (version {{NRSVersion}}):<br /><code>cd ~</code><br /><code>wget {{NRSDownload}}</code>
#* SHA256 hash - {{NRSSHA256}}
#Unzip it:<br /><code>unzip nxt-client-{{NRSVersion}}.zip</code><br /><code>cd nxt</code>

=====Using the Unix installer=====
You can execute the unix installer executable compatible with most linux distributions from [https://www.jelurida.com/nxt-client.sh nxt-client.sh] and follow the instructions.

<pre>wget https://www.jelurida.com/nxt-client.sh
sh nxt-client.sh
</pre>

=====Run the Nxt client=====

#Now it's time to start the software. You may start it by executing <code>./run.sh</code>, which you will find in the nxt directory. The server will be active as soon as you see in the window a text similar to this: <br/><code>Nxt server {{NRSVersion}} started successfully.</code> This shell window will be running the Nxt server and print all the Nxt log messages, so it needs to stay running!<br />
#Open http://localhost:7876/ from a web browser to access the Nxt Client. Please note that, if it's the first time you run Nxt in your machine, the Nxt blockchain will need to be downloaded until it is up to date. Depending on the your network connection speed, this may take a few hours. The Nxt Client will show you a progress bar as the blockchain downloads. Now you can visit the [[How_to_create_an_account|instructions to create your Nxt account!]]<br /> [[file:NxtWallet_start_small.png]] <br />
#*NOTE: If you've installed the client on a dedicated server or VPS, you should change "localhost" to your Server/VPS IP.
</accordion>
</div>

<div class="accordion" id="accordion">
<accordion parent="accordion" heading="===Raspberry Pi===">

''(Originally created by [https://nextcoin.org/index.php?action=profile;u=365 barbarosinciler] at [https://nextcoin.org/index.php/topic,359.0.html nextcoin.org] . If this is of value to you, please donate some Nxt to him at address 7121642459245273749. The Java package that installs Nxt on your Pi was written by [https://nextcoin.org/index.php?action=profile;u=2072 davethetrousers], at 14923118471272229432)''

Raspbian and the NRS client for Nxt both run very well on a Raspberry Pi. CPU usage is approximately ~15-20% with the web client open and an account unlocked. Without the web client open (still unlocked) it is less than ~10% most of the time (it occasionally peaks higher and MAY occasionally spike to full load). Memory usage is about 100MB

Once this software is installed on your Raspberry Pi, it will start automatically on boot. You can administer it using remote desktop from another PC.

This tutorial makes the following assumptions; adjust accordingly!
* your installation PC's is running Windows and has an IP of 192.168.1.20
* your network router's IP is 192.168.1.1

==== '''Basic Raspbian install guide''' ====
#download and install Raspbian
#*Download the Raspbian image from [http://downloads.raspberrypi.org/raspbian_latest]
#*Download diskimager for windows [http://sourceforge.net/projects/win32diskimager/].
#*Install image on an SD Card, and boot the Raspberry from the card. You should see a config menu.
#**Expand filesystem and change your password.
#**Enable boot to desktop.
#**Set internationalisation options (language, keyboard and timezone)
#**Under advanced options enable ssh and set a hostname like "rpi".
#**Reboot. Now you should see a desktop and the system is running

==== '''Update the system''' ====
#open the bash commandline (LXTerminal), type the following, and follow the instructions:
#*<code>sudo apt-get upgrade</code><br /><code>sudo apt-get dist-upgrade</code>
#Check your IP configuration
#*Your Pi should pick up an IP address from DHC, and this can be confirmed with the <code>ifconfig</code> command in a shell. To configure a static ip, open the bash commandline (LXTerminal) and type the following:
#**<code>sudo nano /etc/network/interfaces</code>
#*Change the following entry from:<br /><code>iface eth0 inet dhcp</code><br />To:<br /><code>iface eth0 inet static</code><br /><code>address 192.168.1.10</code><br /><code>netmask 255.255.255.0</code><br /><code>gateway 192.168.1.1</code><br /><code>network 192.168.1.0</code><br /><code>broadcast 192.168.1.255</code>
#*Press CTRL and O at the same time to save the file
#*Press CTRL and X together to exit
#*Reboot your Pi

==== '''Install XRDP (RDP server)''' ====
#Open the bash commandline (LXTerminal) and type the following, and follow the instructions:
#*<code>sudo apt-get install xrdp</code><br /><code>sudo apt-get upgrade xrdp</code>
#Now you can use Microsoft Remote Desktop and work remote on the Raspberry.
#*In windows go to start -> open -> and type "mstsc"
#*Enter your Raspberry's address (192.168.1.10), connect and sign in with your password

==== '''Router/firewall port forwarding''' ====
#Make sure to forward TCP port 7874 tcp on your network router to the IP your raspberry has (192.168.1.10)

==== '''Install NXT Client''' ====
You have two possible options here:

#Use your Raspberry Pi with the standalone package Oracle JRE included ''(all credits to the author: [https://nextcoin.org/index.php?action=profile;u=2072 davethetrousers]'' )
##Download the <code>tar.gz</code> file from davethetrousers' mirror with wget and extract it:
##*<code>wget http://109.230.224.65/~nxt/nxt_rasppi.tar.gz</code><br /><code>tar -xf nxt_rasppi.tar.gz</code>
##*To start NRS automatically on raspberry reboot edit the run_nxt.sh file in nxt folder:
##**<code>nano nxt/run_nxt.sh</code>
##*Copy the code located [[Getting_started#Raspberry_Pi|at the end of this section]], and paste it into your file.
##* Press CTRL and O at the same time to save
##*Press CTRL and X together to exit.
##* Enter: <code>crontab -e</code>
##*Insert the code at the end of the file:<br /><code>@reboot /home/pi/nxt/run_nxt.sh start</code>
##*Press CTRL and O at the same time to save
##*Press CTRL and X together to exit.
##Now the raspberry should be able to load the NRS software on boot
#Step by step installation from devs mirror with build in raspbian java
##Download the NRS client (current version: {{NRSVersion}}) {{NRSDownload}}
##* SHA256 hash - {{NRSSHA256}} (you really should [[Faq#How_to_verify_authenticity_of_Nxt_installations|check here to make sure this matches your downloaded file's checksum]] before you install anything!)
##Unzip the file:<br /><code>unzip nxt.zip</code><br />
##Now the NRS client is in your home folder (<code>/home/pi/nxt/</code>)
##Enter: <code>crontab -e</code>
##*Insert the code at the end of the file:<br /><code>@reboot /home/pi/nxt/run.sh</code>
##*Press CTRL and O at the same time to save
##*Press CTRL and X together to exit.
##Now the raspberry should be able to load the NRS software on boot

==== '''Stop script for the Nxt software''' ====
#Create a new file in the ''/home/pi/nxt/'' folder and name it something like "stop_nxt.sh":<br /><code>nano nxt/stop_nxt.sh</code>
##If you are using davethetrousers' Java package, enter this code:<br /><code>/home/pi/nxt/ejre1.7.0_45/bin/java -Xmx1024M -cp nxt.jar;lib/*;conf nxt.Nxt STOP.PORT=11111 STOP.KEY=123456 --stop</code>
##If you downloaded the Nxt software directly:<br /><code>/usr/bin/java -Xmx1024M -cp nxt.jar;lib/*;conf nxt.Nxt STOP.PORT=11111 STOP.KEY=123456 --stop</code><br />
#Press CTRL and O at the same time to save
#Press CTRL and X together to exit.
Now you can stop the client on bash command line with the following command:<br /><code>sudo bash nxt/stop_nxt.sh</code>
'''Before reboot your Pi, you should use this script to prevent a blockchain error!'''

Now you can reboot the system with:<br /><code>sudo reboot</code>

==== '''Connecting from your PC instead of localhost''' ====
#Create a <code>nxt.properties</code> file under the <code>nxt/conf/</code> folder. You can create the file from command line using the command <code>nano nxt/conf/nxt.properties</code> and write the following in it. Make sure to modify the IP accordingly to yours: <br /><code>nxt.allowedBotHosts=127.0.0.1; localhost; '''192.168.1.20;''' 0:0:0:0:0:0:0:1;</code><br /><code>nxt.allowedUserHosts=127.0.0.1; localhost; '''192.168.1.20;''' 0:0:0:0:0:0:0:1;</code><br />
#Press CTRL and O at the same time to save
#Press CTRL and X together to exit

==== '''Manually start forging with the NRS client''' ====
To start forging you will need to be logged in with your web browser once.
#Open http://192.168.1.10:7876
#Unlock your account with your passphrase (unlocking an address takes a few seconds).
#If on the left side, next to the red dot, it says "Not forging", click it to start.
#Now you can close your browser. It will keep forging.

==== '''Handling NRS and Java errors''' ====
You can check the java logfiles (nxtout.txt and nxterr.txt) in the nxt folder for errors!

==== '''Having issues?''' ====
Check the [[Faq]] and the "[[common problems and resolutions]]" pages!

==== '''Additional useful commands and tools''' ====

===== Mount your local windows hard drive remotely, for Raspberry Pi data sharing =====
<code>sudo mount -t cifs //192.168.1.20/c$ /mnt -o user=myusername</code>
Where:
*x = The IP address of your Windows PC
*myusername = your username on the windows PC

===== Start the menu changing raspbian settings (language, keyboard, timezone, hostname etc.) =====
<code>sudo raspi-config</code>

===== Check the built-in Java configuration =====
<code>sudo update-alternatives --config java</code>
(The standard location is marked with a star, and the path is something like <code>/usr/lib/jvm/jdk-7-oracle-armhf/jre/bin/java/</code> The defaults are <code>priority = 317</code> and <code>auto-modus</code>. If that is ok, confirm by pressing Enter.

===== Remote administration with putty =====
You can manage your raspberry with the tool "putty" through a command line SSL connection.
Download the tool from [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html]

==== '''run_nxt.sh file''' ====
Use the following code in your <code>run_nxt.sh</code> script:

<pre>
#!/bin/bash
### BEGIN INIT INFO
# Provides: NXTserver
# Required-Start: $local_fs $remote_fs $network $syslog $named $sshd
# Required-Stop:
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Start/stop NXT server
### END INIT INFO

if [ `id -u` != "0" ] && [ "$1" = "start" -o "$1" = "stop" ] ; then
echo "You must be root to start/stop nxt."
exit 1
fi

# Settings
nxtdir=/home/pi/nxt
nxt=nxt.jar
java=/usr/bin/java
nxtpid=/var/run/nxt.pid
nxtlog=/home/pi/nxt/nxt.log
nxtuser=pi
nxtgroup=pi
nxtnice=19
timeout=700
maxmem=120
# end Settings

# check for exist files and dirs
test -d $nxtdir || exit 0
test -f $nxtdir/$nxt || exit 0
test -f $java || exit 0

# make sure $nxtdir is ours!
chown -R $nxtuser:$nxtgroup $nxtdir

. /lib/lsb/init-functions

function status {

start-stop-daemon -T --pidfile "$nxtpid" && echo "NXT server is started." \
|| { echo "NXT server is stopped." ; return 1; }

return 0;
}

case "$1" in
start)
log_daemon_msg "Starting NXT server..." "" || true

# check if server is running
if [ -e $nxtpid ]; then
pid=`cat $nxtpid`
var=`ps -p$pid | wc -l`

if [ $var -lt "2" ]; then
# clear logfile
echo -n > $nxtlog
else
echo -n " NXT server is already running!"
log_end_msg 0 || true
exit 0
fi
fi

# Enable Debug for more info when starting NXT
if cat $nxtdir/conf/nxt.properties | grep -q "nxt.debug="; then
if cat $nxtdir/conf/nxt.properties | grep -q "nxt.debug=true"; then
# Debug is enabled, nothing todo...
echo -n ""
elif cat $nxtdir/conf/nxt.properties | grep -q "nxt.debug=false"; then
echo nxt.debug=true >> $nxtdir/conf/nxt.properties
fi
else
echo nxt.debug=true >> $nxtdir/conf/nxt.properties
fi

# n minute timeout.
sleep $timeout &
timerPid=$!

# check log file and generate status-msg; will be killed when server is started or timeout hit
tail -q -n0 -F --pid=$timerPid $nxtlog 2> /dev/null | while read line; do

if echo $line | grep -q "Scanning blockchain"; then
echo -n " Scanning blockchain"
elif echo $line | grep -q "processed block"; then
echo -n "."
fi

if echo $line | grep -q "started successfully."; then
echo -n "NXT server started successfully."
log_end_msg 0 || true
# stop the timer..
kill $timerPid > /dev/null 2>&1
$nxtdir/traffic_shaper.sh > /dev/null 2>&1
fi
done &

# start server
if start-stop-daemon --start --name nxt --nicelevel $nxtnice --chuid $nxtuser:$nxtgroup --pidfile $nxtpid -m --chdir $nxtdir --exec $java >> $nxtlog 2>&1 -- -Xmx"$maxmem"m -cp $nxt:lib/*:conf nxt.Nxt >> $nxtlog 2>&1 & then
# wait for the timer to expire (or be killed)
wait %sleep > /dev/null 2>&1
else
log_end_msg 1 || true
fi
;;
stop)
log_daemon_msg "Stopping NXT server..." || true

# check if server is running
if start-stop-daemon --stop --pidfile $nxtpid > /dev/null 2>&1; then

while status > /dev/null; do
sleep 1;
done

echo -n " NXT server stopped."
log_end_msg 0 || true
rm $nxtpid > /dev/null 2>&1
else
echo -n " NXT server is not running!"
log_end_msg 0 || true
exit 0
fi
;;
restart)
$0 stop
sleep 1
$0 start
;;
status)
status
;;
*)
echo "usage:`basename $0` start | stop | restart | status"
exit 1
;;
esac
</pre>
</accordion>
</div>

<div class="accordion" id="accordion">
<accordion parent="accordion" heading="===Android===">
Click on the [[Android_Full_Node|Android Full Node installation guide]] and follow the instructions.
</accordion>
</div>

== Start using the Nxt client ==

'' If you would prefer, you can first familiarise yourself with Nxt by playing around with the [https://testnxt.jelurida.com/index.html Demo].''

#[[How_to_create_an_account|Create a Nxt account address]]
#[[Nxt client interface|Learn how the Nxt client software works]]
#[[Secure_Your_NXT |Learn the Security Features of NXT]]
#[https://www.jelurida.com/nxt/explorers Exchanges to get or buy some NXT]
#[[Features|Explore more features of Nxt]]

==='''Need help?'''=== 

Need help during the download or development process? Contact us on the [https://ardornxt.slack.com slack] #helpdesk channel, chat with community experts on the [https://nxtforum.org Nxt Forum]. You can also reach us opening a ticket in our [https://desk.zoho.eu/portal/jelurida/home helpdesk]

You can also ask community experts in the [https://nxtforum.org Nxt Forum] or in the [https://nxtchat.slack.com Nxt Slack] (invites are [https://ardornxt.slack.com here]) or take a look at the NxtWiki [[Faq|FAQ]]

==Getting your first NXT==

The exchanges and tools where you can get NXT with CNY, EUR, USDT, BTC and other currencies are listed [https://www.jelurida.com/nxt/explorers here].

With the Nxt client installed, it is now time to start transacting. To do that, we need to get some NXT tokens. The Nxt mainnet is live and actual tokens are in circulation across numerous major exchanges.

Note the tokens we will be using in the next examples are from testnet. These tokens are not traded in exchanges and have no monetary value -- they exist only as a convenience for developers and those willing to experiment with the features.

The process for receiving testnet tokens is simple. Ask for them in the [https://nxtforum.org Nxt Forum], contact us on the [https://ardornxt.slack.com slack] channel #helpdesk. There is an external [https://www.ardor.world/faucet_nxt/ faucet] as well.

==Next steps==

Learn how to use the Nxt platform by following the [[Basic_guides|basic guides]] or start reading about Nxt's extensive built-in [[Features]].

==Feedback and errors==

If an error in this documentation is found, we would love to be aware to correct it as soon as possible. Please write a question to [mailto:info@jelurida.com info@jelurida.com] and we will take care.

MediaWiki:Tweeki.css

2024-11-08T11:27:43Z

Ps:

/* @import url('https://fonts.googleapis.com/css?family=Poppins'); */

/* poppins-regular - latin */
@font-face {
font-family: 'Poppins';
font-style: normal;
font-weight: 400;
src: url('resources/fonts/poppins-v5-latin-regular.eot'); /* IE9 Compat Modes */
src: local('Poppins Regular'), local('Poppins-Regular'),
url('resources/fonts/poppins-v5-latin-regular.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
url('resources/fonts/poppins-v5-latin-regular.woff2') format('woff2'), /* Super Modern Browsers */
url('resources/fonts/poppins-v5-latin-regular.woff') format('woff'), /* Modern Browsers */
url('resources/fonts/poppins-v5-latin-regular.ttf') format('truetype'), /* Safari, Android, iOS */
url('resources/fonts/poppins-v5-latin-regular.svg#Poppins') format('svg'); /* Legacy iOS */
}

/* Navigation */
#navbar {font-family: 'Poppins', sans-serif;}
.navbar-inner { background-color: white}
.navbar-brand img { height: 40px; margin-top: -8px;margin-right: 0em;}
.navbar-default .navbar-nav>li>a { padding-top: 20px; font-size: 16px; }

#searchInput { padding: 6px 3px; margin-top: 2px; }

nav.category-browser {background-color: white;padding-left: .5em;font-size: 16px;line-height: 1.4em;}
nav.category-browser h2 {font-size: 1.4em; border:none; margin-top: .5em;}
nav.category-browser ul {padding-left: 1em;}

/* Headings */
.page-header {
padding: 0;
margin: 0;
text-align: left;
border: none;
letter-spacing: normal;
font-weight: 500;
}

h1 {font-size: 1.9em; color: #111; font-family: 'Poppins', sans-serif;}
h2,h3,h4,h5 {color: #333; font-family: 'Poppins', sans-serif; font-weight:500;}
h2 {font-size: 1.7em; border-bottom: 1px solid #aaa; margin-bottom: .7em;}
h3 {font-size: 1.5em;}
h4 {font-size: 1.3em;}
h5 {font-size: 1.2em;}

body {
font-family: Frutiger, "Frutiger Linotype", Univers, Calibri, "Gill Sans", "Gill Sans MT", "Myriad Pro", Myriad, "DejaVu Sans Condensed", "Liberation Sans", "Nimbus Sans L", Tahoma, Geneva, "Helvetica Neue", Helvetica, Arial, sans-serif;
font-size: 18px;
line-height: 1.5em;
color: #444;
}

/* Default links */
a {
color: #077c9d;
text-decoration: none;
}
a:hover, a:focus {
color: #fd8103;
text-decoration: underline;
}
a:active, a:hover {
outline: 0;
}

/* Top navigation links */
.navbar-default .navbar-nav>li>a:focus, .navbar-default .navbar-nav>li>a:hover {
color: #333;
background-color: transparent;
color: #fd8103;
}

/* Sidebar */
#tweekiTOC #toctitle h2, #tweekiTOC .toctitle h2 {border-bottom: none; margin-top: .5em;}
#sidebar-left { padding-left: 2em; }

/* Media-queries specific adjustments */
@media (min-width: 992px) {
#sidebar-left { padding-left: 2em; font-size: .9em;line-height: 1.3em;overflow-y: auto; height: 93vh;position:sticky;}
}

@media (min-width: 768px) {
#content { padding: 1em;}
}

/* Expand anchor to header width in accordions */
.panel-title a {
display: block;
padding: 10px 15px;
margin: -10px -15px;
}

/* Change separation */
.panel { margin-bottom: .5em; width: 95%;}

/* Footer */
#catlinks {display:block;border:none; border-top: 1px solid #aaa;}

/* Geshi custom */
.mw-highlight .nt { color: #17C5D8; }
.mw-highlight .nv { color: #D90368; }
.mw-highlight .s2 { color: #888; }

Nxtwiki - User contributions [en]

Getting started

MediaWiki:Tweeki.css