Commit 9e1f1cdc authored by ketominer's avatar ketominer
Browse files

Initial commit

parents
Pipeline #47 passed with stages
in 2 minutes and 57 seconds
node_modules
public
yarn.lock
image: node:12
stages:
- build
- deploy
build:
stage: build
cache:
paths:
- node_modules/
script:
- yarn install
- yarn docs:build
artifacts:
paths:
- public
only:
- master
deploy:
stage: deploy
image: alpine:latest
before_script:
- apk update && apk add openssh-client bash rsync
script:
- eval $(ssh-agent -s)
- bash -c 'ssh-add <(echo "${SSH_PRIVATE_KEY}")'
- mkdir -p ~/.ssh
- echo "${SSH_HOST_KEY}" > ~/.ssh/known_hosts
- scp -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -r public/* "${SSH_USER_HOST_LOCATION}"
only:
- master
MIT License
Copyright (c) 2020-2021 nodl
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
module.exports = {
title: "nodl docs",
description: "nodl documentation",
dest: "public",
themeConfig: {
nav: [
{
text: "Website",
link: "https://www.nodl.it/"
},
{
text: "Store",
link: "https://store.nodl.it/"
},
{
text: "nodl cloud",
link: "https://nodl.cloud/"
},
{
text: "Twitter",
link: "https://twitter.com/nodl_it",
rel: "noopener noreferrer twitter"
}
],
sidebar: [
"/",
{
path: "/guides/",
title: "Guides",
collapsable: false,
children: [
//["/guides/nodl-og/", "nodl OG quick start"],
"/guides/nodl-qsg.md",
"/guides/nodl-og-qsg.md",
"/guides/upgrade-nodl.md",
"/guides/pimp-nodl.md"
]
},
"useful-links.md"
]
}
}
# About nodl
Welcome to the nodl documentation website.
## What it is
[nodl](https://www.nodl.it) is a set of hardware and services to run bitcoin and related software.
## Before reading
Each article / page contains a header with the list of devices or services it applies to. Please check first that the documentation applies to yours!
## Contribute
If you want to raise an issue or contribute to this documentation, feel free to [go on the repository](https://gitlab.lightning-solutions.eu/nodl/nodl-docs).
# nodl box
## Identify your box model
We are currently supporting 3 different nodls.
* nodl "OG" - the original box, either with 500GB or 1000GB (1TB) storage - easiest way to distinguish it is the power switch on the front side of the device
TODO: add picture here
* nodl One - black box with nodl logo etched on top
TODO: add picture here
* nodl Dojo - red box with Samourai logo etched on top
TODO: add picture here
::: tip
When reading the documentations, check which model it applies to!
:::
---
Title: nodl OG quick start (old)
---
# nodl OG quick start guide (old)
::: warning Applies to:
nodl "OG"
:::
### 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)
#### 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.
![](./images/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: 'nodl box quick start guide'
---
# nodl box quick start guide
::: warning Applies to:
nodl One (black, etched logo) and nodl Dojo (red, etched logo)
:::
### Thank you for purchasing our product!
Below are a few instructions to help you setup the device.
### What’s in the box?
* A piece of paper with very important passwords on it, as well as your nodl's unique name - DO NOT TRASH (optionnaly sent by PGP encrypted email if you selected this option)
* The nodl
* A power supply (4A for nodl One, 6A for nodl Dojo)
* A European/American/British/Australian (Dojo only) plug (depending on your region)
* A set of rubber feet and a micro SD reader (Dojo only)
* 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.
2. Connect the power supply to the nodl.
3. You should see lights. Depending on your device, you'll see a backlit logo on top (red for Dojo, blue for One - only if kill switch option is installed).
4. Check that the lights near the Ethernet (network) cable blink. Green (left) should be steady or slowly blinking, orange (right) should blinking with the traffic going in and out.
### Step 2: Setting the password
Point your favorite browser to the address written on the included welcome paper.
Sometimes, computers can't resolve ".local" addresses. This happens mostly with Windows but also with some very custom Linux distributions.
_In this case, you may have to go to your router's web interface to find nodl's IP address and use https://ipaddress/ instead._
If you can't find the address or nothing happens when you enter the address, check that your nodl is properly connected to the same network as your computer and not a secondary switch / router.
Click on the nodl logo.
Enter a password (twice). The only requirement is the length (12 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.
The nodl performs an automatic upgrade as soon as you define the password to make sure that you're running the latest version of the software.
### Step 3: Syncing up
The device is kept synced to the blockchain until it leaves our kitchen. Depending on the time it stays in the box, it will require more or less time to be synced again. If the % of sync doesn't move after 10-15 minutes, check the troubleshooting guide.
To access settings, enter the password defined at step 2 in the password field on top.
While syncing, you can install additional services (Tor, Bitcoin core, Dojo and Electrs come pre-installed and pre-synced).
### Additional optional and recommended steps
#### Connect Zap Desktop, Zeus, ...
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)
#### Appreciated: Shill the nodl on twitter
Take a picture and tag our Twitter account :)
#### Recommended: Keeping the software up to date
For privacy reasons, we don’t push updates and there is no auto-update mechanism (yet). It’s up to you to keep your nodl updated by pressing the “Upgrade nodl” button from time to time.
The nodl will then retrieve the latest software from a git repository and run its update script.
#Happy nodl-ing !
\ No newline at end of file
---
title: 'Pimp my nodl'
---
Thinking about pimping your nodl
Feeling like you want to represent
Just pimp your nodl !
![](./images/Pimp_it_600.jpg)
\ No newline at end of file
---
title: 'Upgrade my nodl (old)'
---
::: warning
This is an old version pending rewriting
:::
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
![](./images/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
![](./images/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: 'Useful Links'
---
# Official nodl
* [website](https://nodl.it)
* [cloud](https://nodl.cloud)
* [store](https://shop.nodl.it)
# 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)
# Keybase
You can also find us on keybase.
{
"name": "nodl-docs",
"version": "0.1.0",
"description": "nodl documentation website",
"main": "index.js",
"license": "MIT",
"devDependencies": {
"vuepress": "^1.5.1"
},
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
},
"dependencies": {
"yarn": "^1.22.4"
}
}
Markdown is supported
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