Commit 8afac201 authored by docs's avatar docs Committed by GitSync

(Grav GitSync) Automatic Commit from docs

parents
---
title: 'About nodl'
media_order: nodl_dark_logo_800.png
---
nodl is an open-source project aimed at providing users with the tools to be financially sovereign through the use of hardware and software that respects your privacy.
If you have any questions about nodl or it's ethos, please visit our Telegram or Slack channels and we will be happy to discuss these with you.
If you encounter any issues while navigating through this documentation or using your nodl, please file an issue on our Gitlab so that we can look into the matter.
![](nodl_dark_logo_800.png)
\ No newline at end of file
---
title: 'Useful Links'
---
# Official nodl
* [website](https://nodl.it)
* [store](https://shop.lightning-solutions.eu)
# Telegram
* Come chat with us on our [General Telegram](https://t.me/nodl_it) channel
* You have technical questions? head to the [Telegram Support](https://t.me/nodl_support) channel
# Our Twitter Accounts
* The [nodl Twitter](https://twitter.com/nodl_it) account
* [ketominer](https://twitter.com/Ketominer)
* [askuwheteau](https://twitter.com/IAskuwheteau)
# Slack
We are also on [Slack](https://lightning-solutions.slack.com)
---
title: Welcome
media_order: nodl_light_transparent_800.png
---
![](nodl_light_transparent_800.png)
---
title: 'Initial setup'
media_order: autoon.jpg
visible: true
---
## Thank you for purchasing our product!
Below are a few instructions to help you setup the device.
## What’s in the box?
* The nodl
* A power supply (model may vary depending on your region)
* A blue USB 3 type A to type A cable (aka “fast sync” cable)
* A small white USB type A to micro USB (you can use if for powering a ColdCard for example, they like short wires!)
* An Ethernet cable
* Some stickers and/or other stuff
### Step 1: Connecting all the things & powering on
Your network has to have an available Ethernet port and run DHCP (automatic address assignment). This is most probably the case.
1. Connect the Ethernet wire to your router or switch and to the nodl. If you don’t like the length, color or both, you can use any wire you have.
_You can optionaly replace the small “USB” marked bridge on the back of the device by the blue USB 3 “fast sync” cable. It will slightly improve the speed between the main board and the SSD inside the nodl. Useful if you have a fast Internet connection but not mandatory._
2. Connect the power supply to the nodl.
3. Press the button. The blinkenlichts should start, well, blinking.
### Step 2: Setting the password
Point your favorite browser to [http://nodl.local:8338/](http://nodl.local:8338/)
_If you're running Windows (shit happens), you may have to go to your router's web interface to find nodl's IP address and use http://ipaddress:8338/ instead._
Click on the nodl logo.
Enter a password (twice). The only requirement is the length (8 characters minimum) but use something strong as this password will allow you to reveal the connection information for the lightning node (and allow to transfer funds out of it).
Click on “click here”, you should see the status page with application tiles.
### Step 3: Installing bitcoind and lnd
On the status screen, enter the password defined at step 2 in the password field on top.
__Click on “Schedule update” to make sure you’re running the latest software.__
After the update is done (you’ll know because the button will be back), click on the “schedule install” button on the bitcoind tile.
After some time, you should see a “start service” button.
Do the same with lnd (if you want to run lnd, that is, but who doesn't) and Ride The Lightning.
### Additional optional and recommended steps
#### Connect Zap Desktop and Joule
Once lnd is installed, instructions for connecting Zap Desktop and Joule will automagically appear on in the lnd tile on the nodl interface.
#### Optional: Install BTCPay Server
After your nodl is fully synced, you can proceed with installing BTCPay using the same method. BTCPay is built from source and it takes some time (up to 20 minutes).
#### Recommended: Join our support channel on Telegram or Slack or both
* [nodl support on Telegram](https://t.me/nodl_support)
* [nodl slack](https://join.slack.com/t/lightning-solutions/shared_invite/enQtNTA5MzE0MjY3NjcxLTUyODYzYjdjZWZhYTUxNTNkYTRmYjM4MjQ2Mzk2OWFjNmY3YTYwNjc2MWVlM2JjOGEwODVjMjZmYzhjYjk1NGE)
#### Appreciated: Shill the nodl on twitter
Take a picture and tag our Twitter account :)
#### Recommended: Set the SSH password
The nodl has a default (and very insecure) ssh password. Any person connected to your local network can connect to the device as an administrator and break something (or steal the contents of your lightning node).
This will be possible through the web interface in the near future, but for now you have to use a SSH client to change the password.
On Linux/MacOS/Unix, you can use the “ssh” command:
`ssh root@nodl.local`
On Windows, you can use putty.
The default password is “nodl1234”.
Once connected to the device, type
`passwd`
then enter your new password (twice).
Then change the install account password by running
`passwd install`
and entering your new password (twice).
You can use the same password for both accounts.
__WARNING WARNING WARNING__ You need to remember at least either the SSH password, either the web interface password. Without one of them, resetting passwords to regain access to your device will be difficult (but not impossible). __WARNING WARNING WARNING__
#### Recommended: Keeping the software up to date
For privacy reasons, we don’t push updates and there is no auto-update mechanism. It’s up to you to keep your nodl updated by pressing the “Schedule update” button from time to time.
The nodl will then retrieve the latest software from a git repository and run its update script.
#### Optional: Make it turn on automatically after a power outage
If you want, you can set the nodl to power on automatically when power is applied instead of having to press the button.
1. Disconnect all the wires and the USB bridge (if installed).
2. Remove the four black screws on the back of the device.
3. Carefully remove the top cover. The small fan has a short wire, be careful to not pull on it. You can disconnect it if you want.
4. Set the “auto on” jumper according to this picture.
![](autoon.jpg)
5. Put the cover back again.
6. Put the four screws back (it’s easier if you plug back the USB bridge before screwing).
7. Reconnect all the wires (finishing with the power supply), the nodl should turn on.
#Happy nodl-ing !
\ No newline at end of file
---
title: 'Update My nodl'
media_order: 'GUI_Home.png,GUI_Admin.png'
published: true
---
Once in a while you might want to update your nodl in order to run the latest version of the software and make sure you benefit from all of its latest features.
In order to do so you need to log into the nodl.
### Steps
Open your favorite browser to your nodl homepage and log in as the administrator
![](GUI_Home.png)
If the login is succesful, the nodl will tell you so and you will have access to more information on the various apps you are running (url, macaroons, passwords and so on) .
All you need to do is click on the **schedule install** button
![](GUI_Admin.png)
once you have clicked on **schedule install** the button will be replaced with **update requested** and nodl will go fetch for any new version of the software available and install it automatically.
You will know when the install is completed as the original **schedule install** reappear.
If you would like to know what version of the software you are running at any time, just look to the very bottom of the nodl home screen.
\ No newline at end of file
---
title: 'Pimp My nodl'
media_order: Pimp_it_600.jpg
published: true
---
Thinking about pimping your nodl
Feeling like you want to represent
Just pimp your nodl !
![](Pimp_it_600.jpg)
\ No newline at end of file
---
title: 'Run BTCPayServer'
published: true
---
One of the great features on the nodl is that you can self host your own instance of BTCPayServer.
In order to do so, you must first ensure that you have correctly synced **bitcoind** and that the status under the bitcoind button on your nodl's home screen says **Running**.
You can then proceed to **install** BTCPayServer by clicking on the blue install button under BTCPay.
_note:_ the BTCPayServer install can take 20 to 30 minutes, as it compiles from source and installs the dotnet framework.
Once the install is completed, you should see the status under the BTCPayServer menu indicate **Running**.
You are now ready to setup your shop! Click on the **Open BTCPay Server** link on your nodl's home page.
At this stage, we would advise you to head over to the excellent documentation of BTCPay which contains a detailed walkthrough of setups and customization. Documentation can be found at : [BTCPay Docs](https://docs.btcpayserver.org)
---
title: 'find the download path when I''m on Chrome/Windows'
media_order: 'Screenshot 2019-02-12 at 22.55.43.png,Screenshot 2019-02-12 at 22.55.54.png,Screenshot 2019-02-12 at 22.57.01.png,Screenshot 2019-02-12 at 22.56.53.png'
---
If you're running Chrome on Windows, here's how you can easily find the paths for tls.cert and lnd-admin.macaroon to use with Zap Desktop. Pleast note that this will not be necessary soon as next version of Zap will allow you to browse and find the file with a graphical interface.
When you download the files, you get this in the bottom of the window (depending on the browser it may look different, this is from a french version of Chrome)
![](Screenshot%202019-02-12%20at%2022.55.43.png)
Click on the button on the right. This will open the details of the downloaded files.
![](Screenshot%202019-02-12%20at%2022.55.54.png)
Click on Display folder (or whatever that is in your language)
You should see the tls.cert file and lnd-admin.macaroon if you have downloaded that one too.
![](Screenshot%202019-02-12%20at%2022.56.53.png)
Click in the path bar, it will turn into something starting with C:\Users
![](Screenshot%202019-02-12%20at%2022.57.01.png)
Copy this.
Then paste it in Zap Desktop. Add /tls.cert in the TLS field and /lnd-admin.macaroon in the other one.
That should do it, you're awesome.
---
title: 'Connect Zap'
media_order: 'Zap_1.png,Zap_3.png,LND_Details_and_Settings.700.png,LND_Details_and_Settings2.700.png'
published: true
---
Zap is a beautiful lightning wallet which you can use to send or receive lightning payments and manage channels. Best of all, you can chose to have Zap, check all information by pointing it to your nodl.
First you will need to install Zap by downloading the application from Github: [Zap install page](https://github.com/LN-Zap/zap-desktop#install)
Upon opening Zap, you will be asked to chose how you wish to run it. You can either:
1. create a new wallet and lightning node,
2. import an existing wallet with its recovery seed,
3. connect to an already existing node,
4. connect to your existing BTCPayServer.
To use the full power of your nodl, choose option three.
![](Zap_1.png)
Go to the nodl admin page and make sure you are logged in as the administrator. [logged in as admin](https://docs.lightning-solutions.eu/nodl-box/quick-start/update-my-nodl).
Under the LND tile, you will see a "Details and settings button". Click on it to open the LND configuration page.
![](LND_Details_and_Settings.700.png)
There you will find all the necessary information you need to connect Zap to your nodl:
* the gRPC API address:
* one click-download of the TLS certificate
* one click-download of the Admin macaroon
![](LND_Details_and_Settings2.700.png)
In the Zap application, enter :
* in the host name field : the gRPC provided by nodl
* in the TLS certificate field : the full path to where you downloaded the TLS certificate
* in the Macaroon field: the full path to where you downloaded the Macaroon. _please note the macaroon you download from nodl is call lnd-admin.macaroon and not admin.macaroon as shown in the zap example._
![](Zap_3.png)
Then click next
You will be asked to confirm the host you wish to connect to.
Check that the IP provided is the same as your nodl's
Then click next
**Congratulations!**
you've just connected Zap to your nodl.
Now go buy yourself some nice [Stickers](https://shop.lightning-solutions.eu)with Lightning !
You can learn more about Zap on its official website : [Zap by Jack Mallers](https://zap.jackmallers.com/)
---
title: 'Connect Joule'
media_order: 'Joule_1.png,Joule_2.png,Joule_3.png,Joule_4.png,Joule_5.png,Joule_6.png,Joule_7.png,Joule_8.png,LND_Details_and_Settings.700.png'
published: true
---
[Joule](https://lightningjoule.com/) is a browser extension wallet for [Firefox](https://addons.mozilla.org/en-US/firefox/addon/lightning-joule/), [Chrome](https://chrome.google.com/webstore/detail/joule/aejmoogjdllanidlpfjmmmmimfaficio), [Opera](https://github.com/wbobeirne/joule-extension/releases) and [Brave](https://chrome.google.com/webstore/detail/joule/aejmoogjdllanidlpfjmmmmimfaficio). **Install** and **confirm** it in your browser in a click.
![](Joule_1.png)
A small **pink diamond** will be added to the top right of your tool bar, click on it and **get started**.
![](Joule_2.png)
Click on **Remote Node** to connect ot the nodl.
![](Joule_3.png)
Go to the nodl admin page and make sure you are logged in as the administrator. [logged in as admin](https://docs.lightning-solutions.eu/nodl-box/quick-start/update-my-nodl).
Under the LND tile, you will see a "Details and settings button". Click on it to open the LND configuration page.
![](LND_Details_and_Settings.700.png)
Copy the Joule quick connect REST API address: **http://192.168.0.xx.8080** into the Node URL field in Joule, click **connect** and **allow** access.
![](Joule_4.png)
![](Joule_5.png)
Download the **Admin macaroon** and **Readonly macaroon** in the nodl admin page lnd panel and upload them to Joule and click **continue**.
![](Joule_6.png)
Then **confirm** the setup.
![](Joule_7.png)
Declare a secure password, which you will have to type in every time you send a payment and click **continue**.
![](Joule_8.png)
**Congratulations!**
you've just connected Joule to your nodl.
Now go buy yourself some nice [Stickers](https://shop.lightning-solutions.eu)with Lightning !
You can learn more about Joule on its official website : [Joule by Will O'Beirne](https://lightningjoule.com)
---
title: 'Ride the Lightning'
published: false
---
We suggest you Ride the Lightning with [style](https://youtu.be/QLBCs2xuelU?t=137)
---
title: 'How do I...'
---
---
title: 'Gain Root Access To My nodl'
media_order: tenor.gif
published: true
---
Some operations you might want to carry out on the nodl require you to gain **root** access to it.
_For those unfamiliar with the term, it pretty much means gaining super user type of access to it, you have more rights. This means you can do more things but also more damage if anything goes wrong. So please keep that in mind, and as always, passwords should remain unique and private._
## Steps:
Open your command line interface
Then type in the following commands:
ssh root@nodl.local
you will be asked for your password
Type it in, _and don't be surprised if you can't see what you are typing_, and hit enter
If you did everything right up to here, this is what you should see.
It also means you've just gained root access to your nodl.
![](tenor.gif)
Repeat this step anytime one of the steps in our documentation tells you to type certain commands as a root user.
---
title: 'Change My Passwords'
published: false
---
There are two passwords for the nodl:
1. the SSH password
2. the admin password
The nodl has a default (and very insecure) ssh password. Any person connected to your local network can connect to the device as an administrator and break something (or steal the contents of your lightning node).
In order to change the SSH password you need to connect to the nodl as root user:
On Linux/MacOS/Unix, you can use the “ssh” command:
ssh root@nodl.local
On Windows, you can use putty.
The default password is “nodl1234”.
Once connected to the device, type
passwd
then enter your new password (twice).
Then change the install account password by running
passwd install
and entering your new password (twice).
You can use the same password for both accounts.
In order to change the admin password, once again you have to log in using SSH and then use the following command:
reset-admin-password
**WARNING WARNING WARNING** You need to remember at least either the SSH password, either the web interface password. Without one of them, resetting passwords to regain access to your device will be difficult (but not impossible). **WARNING WARNING WARNING**
\ No newline at end of file
---
title: 'Ping My nodl'
published: true
---
You want to know your nodl's ip address?
Or maybe you just want to check that nodl is responding.
Why don't you ping your nodl and see what he has to say.
### steps
open your command line interface and type the following command:
ping nodl.local
_Mac users can access the command line through the terminal app
Windows users can use putty_
\ No newline at end of file
---
title: 'Obtain the Debug Log'
published: true
---
sometimes you might encounter errors that require you to go look into bitcoin core's debug log. Here is how you do that.
SSH root into your nodl
then type in
tail -f /opt/bitcoin/.bitcoin/debug.log
if you wish to stop the debug log running then type
ctrl + C
\ No newline at end of file
---
title: 'Reset TLS Certificate'
published: true
---
In certain cases you might need to reset your LND tls certificate.
This would be necessary if your node's IP adress has changed for example.
connect to the nodl through ssh then type in very carefully :
reset-lnd-tls
in the web interface, stop and start lnd again
then download the new tls.cert
_note: If you wish to connect Zap to the nodl, you will be required to type in the path for the newly donwloaded tls certificate.
_
---
title: 'Use Tor'
published: false
---
---
title: 'Submit System Logs To Lightning Solutions For Assistance'
media_order: SysLog.png
published: false
---
**We do not maintain ANY log of user activity**
However, you might want in certain circumstances to provide us with logs if you need assistance.
In order to do so, you need to gain root access to your node.
Then type :
transfer /var/log/syslog
Wait a few seconds and you should obtain the following type of message
![](SysLog.png)
---
title: 'Turn Auto Power On'
media_order: autoon.jpg
---
This optional feature enables you to set the hardware on your nodl so that it turns back on automatically after a power outage.
Disconnect all the wires and the USB bridge (if installed).
Remove the four black screws on the back of the device.
Carefully remove the top cover. The small fan has a short wire, be careful to not pull on it. You can disconnect it if you want.
Set the “auto on” jumper according to this picture.
![](autoon.jpg)
Put the cover back again.
Put the four screws back (it’s easier if you plug back the USB bridge before screwing).
Reconnect all the wires (finishing with the power supply), the nodl should turn on.
\ No newline at end of file
---
title: 'How to access bitcoin-cli and lncli'
---
You can discover the power of the nodl through the use of graphical user interfaces (GUI) such as RTL (Ride the Lightning), software wallets such as [Zap](https://docs.lightning-solutions.eu/nodl-box/how-do-i/connect-zap) or [Joule](https://docs.lightning-solutions.eu/nodl-box/how-do-i/connect-joule) or payment processing applications such as [BTCPay](https://docs.lightning-solutions.eu/nodl-box/how-do-i/run-btcpayserver). However, should you wish to go even further, you may want to access the command line interface [cli] for either bitcoind or lnd.
### [Gain root access to your nodl](https://docs.lightning-solutions.eu/nodl-box/advanced/gain-root-access-to-my-nodl)
Open your command line interface and type
`ssh root@nodl.local` or `ssh root@<insert your IP>`
and confirm with your ssh password.
### Enter the bitcoin interface
In order to manage bitcoind and lnd, execute as root user:
`root@nodl:~# su - bitcoin`
### Use RPC
Now you can use both `bitcoin@nodl:~$ bitcoin-cli` and `bitcoin@nodl:~$ lncli` commands, find a complete list of possible commands by executing `bitcoin@nodl:~$ bitcoin-cli hel` and `bitcoin@nodl:~$ lncli help`
Here is the full documentation of the [Bitcoin RPC](https://bitcoin.org/en/developer-reference#remote-procedure-calls-rpcs) and [LND gRPC API](https://api.lightning.community/).
\ No newline at end of file
---
title: Advanced
---
The pages under the advanced section are destined for users who are more familiar with the command line interface.
---
title: 'nodl box'
media_order: Chrome_nodl_800.jpeg
published: true
---
![](Chrome_nodl_800.jpeg)
\ No newline at end of file
---
title: FAQ
published: false
---
Q: Power Consumption
A: 5W low powered node makes it much cheaper than running a node on a personal computer. (We need to simulate the calculation though)
Q: Can I pay using a Credit Card
A: No. While we do understand that credit cards are by far the most common payment option for most individuals, we have chosen not to accept FIAT payments. This isn't necessarily an easy decision to make nor is it definitive, but we feel it gives us a better understanding of the advantages and disadvantages of implementing a world where Bitcoin is widely used.
Q: I sometimes have to save seed words when using other services or hardware. Where do i find then in the nodl?
A: There is no BTC wallet in the nodl, so there are no backup seeds
A: there is a seed for lnd though, but you should never consider that as a backup. Please remember that the Lightning Network is still very experimental at this stage and you should only use funds that you are willing to lose on the network.