Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrating zendesk articles to docs #471

Merged
merged 34 commits into from
Feb 3, 2025
Merged
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
5010de2
added Single and multi-node Port forwarding setup
AlexeyALeonov Jan 30, 2025
88d2652
Added valid storagenode wallet address
AlexeyALeonov Jan 30, 2025
459b7a2
added PIA configuration with storagenode
AlexeyALeonov Jan 30, 2025
bbb2799
added Is account required?
AlexeyALeonov Jan 30, 2025
114a337
added Can Storj use a different blockchain for payments
AlexeyALeonov Jan 30, 2025
7f15b89
added Why not pay in fiat
AlexeyALeonov Jan 30, 2025
2cb9bb2
added redirects from zendesk articles
AlexeyALeonov Feb 1, 2025
3b8a0ad
added How do I hold STORJ?
AlexeyALeonov Feb 1, 2025
d3c3745
fixed the link
AlexeyALeonov Feb 1, 2025
a7f8460
added section about wallet address and STORJ token
AlexeyALeonov Feb 1, 2025
5587345
added "Why is my node disqualified?"
AlexeyALeonov Feb 2, 2025
890af53
added missing docId
AlexeyALeonov Feb 2, 2025
6345a84
added How to fix database: file is not a database error
AlexeyALeonov Feb 2, 2025
61e757a
added How to fix a "database disk image is malformed"
AlexeyALeonov Feb 2, 2025
61a11d5
fixed yaml error
AlexeyALeonov Feb 2, 2025
4d7c7e8
renamed tabs, fixed the link to the `docker run` command
AlexeyALeonov Feb 2, 2025
dfa1821
renumerated the list
AlexeyALeonov Feb 2, 2025
6f54912
fixed markdown types
AlexeyALeonov Feb 2, 2025
173a4af
fixed Powershell handle
AlexeyALeonov Feb 2, 2025
cfbb700
added What is the STORJ token
AlexeyALeonov Feb 3, 2025
95f5a6f
added Can we use an exchange as a wallet for STORJ tokens?
AlexeyALeonov Feb 3, 2025
7f5f794
added "Can we use an exchange as a wallet for STORJ tokens?" to the "…
AlexeyALeonov Feb 3, 2025
572dd3b
added How to change the payment address for storagenode (v3 network)
AlexeyALeonov Feb 3, 2025
ac8cb8f
added Suspension mode
AlexeyALeonov Feb 3, 2025
eac3681
added Graceful Exit Guide
AlexeyALeonov Feb 3, 2025
40c4078
added Install storagenode on Raspberry Pi3 or higher version
AlexeyALeonov Feb 3, 2025
c758218
added Set up a storagenode on Odroid HC2 (video tutorial)
AlexeyALeonov Feb 3, 2025
10120d2
added Getting started with Storj Testnet on Windows
AlexeyALeonov Feb 3, 2025
9b7e83e
added Getting started with Storj Testnet on FreeNAS (freeBSD)
AlexeyALeonov Feb 3, 2025
b25aad8
added Getting started with Storj Testnet on Linux
AlexeyALeonov Feb 3, 2025
1f708a0
fixed link
AlexeyALeonov Feb 3, 2025
dd67eba
fixed the author name
AlexeyALeonov Feb 3, 2025
145c783
replaced links to KB articles
AlexeyALeonov Feb 3, 2025
b208fab
added disqualification and suspension to FAQ
AlexeyALeonov Feb 3, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,259 @@
---
author:
name: "@Odmin"
title: Getting started with Storj Testnet on FreeNAS (freeBSD)
docId: c1df00c3-9e22-43fe-9590-6157c88d2f20
metadata:
title: Getting started with Storj Testnet on FreeNAS (freeBSD)
description: Would you like to build an app with the Storj network as backend? Let's create a local test network with Storj-Sim on your freeBSD powered FreeNAS!
redirects:
- /hc/en-us/articles/360028417332-Getting-started-with-Storj-Testnet-on-FreeNAS-freeBSD
- /hc/en-us/articles/360028417332
---
If you want to try it on Linux, you can read the article [https://github.com/storj/storj/wiki/Test-network](https://github.com/storj/storj/wiki/Test-network)

In addition, you can try it on Windows: [Getting started with Storj Testnet on Windows](docId:a1b98770-bb79-4a9d-b0e0-8d3d57106a4d).

Author: Our fellow Community member @Odmin


FreeNAS® is an embedded open-source network-attached storage (NAS) operating system based on FreeBSD and released under a [2-clause BSD license](https://opensource.org/licenses/BSD-2-Clause). A NAS has an operating system optimized for file storage and sharing.

FreeNAS® provides a browser-based, graphical configuration interface. The built-in networking protocols provide storage access to multiple operating systems. A plugin system is provided for extending the built-in features by installing additional software.

FreeNAS has independent [hardware recommendations](https://ixsystems.com/documentation/freenas/11.2/intro.html#hardware-recommendations) for newly built system, so before you begin, please make sure that you meet **at least the minimum hardware requirements**.

Once your hardware is ready you can [move forward with installation](https://ixsystems.com/documentation/freenas/11.2/install.html).

# Install Storj inside a FreeNAS Jail
We will create a ZFS dataset and create a new FreeNAS Jail to run a local Storj test network (Storj-Sim), following the steps outlined below.


## Create a new ZFS dataset for store Storj data:

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip0.png)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip1.png)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip2.png)

***Figure 1.** Creating a new dataset for storage*

### Specify options for a new dataset - see **Figure 2**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip3.png)

***Figure 2.** Options of the new dataset*

Please make sure you have the following settings configured:

* **Name** - `Stojv3_data`
* **Compression** - `lz4`
* **Share Type** - `Unix`
* **Enable atime** - `OFF`
* **ZFS Deduplication** - `OFF`

Then click on **Advanced Mode**.

Depend on your HDD pool configuration, you can see the default value for Record Size (in our case 32K) - see **Figure 3**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip4.png)

***Figure 3.** Record Size for the Pool*

## Create a new FreeNAS Jail
To activate Pool for Jail Manager, just click **CONFIG**. See **Figure 4**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip5.png) ![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip6.png)

***Figure 4.** Creation of a new Jail*

Then click **ADD**. Fill in a new Jail name and select the latest FreeBSD release (**Figure 5**)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip7.png)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip8.png) ![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip9.png)

***Figure 5.** Adding a new Jail with parameters*

Select both options - **DHCP Autoconfiguration IPv4** and **VNET** (**Figure 6**)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip10.png)

***Figure 6.** DHCP Autoconfiguration IPv4 and VNET*

Check configuration and click **SUBMIT** (**Figure 7**)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip11.png)

***Figure 7.** Submit configuration of a new Jail*

Wait until the new Jail has been created, then click the three dots on the right side and specify the mount point inside a Jail to store data (**Figure 8**)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip12.png)
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip13.png) ![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip14.png) ![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip15.png)

***Figure 8.** Mount point*

Select our dataset (we created it earlier with name `Storjv3_data`) as a source and mount point inside a Jail (which will be `storj_data`) as a destination - see **Figure 9**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip16.png)

***Figure 9.** Options of mountpoint*

Here is an example - see **Figure 10**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip17.png)

***Figure 10.** Example of options for the mountpoint*

Now you can start a Jail - see **Figure 11**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip18.png) ![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip19.png)

***Figure 11.** Starting a Jail*

## Configure the FreeNAS Jail
Select the three dots on the right side and select **Shell** to access the Jail console - see **Figure 12**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip20.png)

***Figure 12.** Starting a Jail shell*

Let’s enable SSH access and allow connections to the Jail for your favorite SSH client. See example on **Figure 13**.

```shell
sysrc sshd_enable="YES"
```

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip21.png)

***Figure 13.** Example of the command execution*

## Install useful packages

```shell
pkg install nano git bash
```

Set `PermitRootLogin` to `yes` in the `/etc/ssh/sshd_config`:

```shell
nano /etc/ssh/sshd_config
```

Uncomment `PermitRootLogin` and set to `yes` (see **Figure 14**), then save the file (Press **Ctrl+X** for exit and **Y** for save changes).

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip22.png)

***Figure 14.** Changing PermitRootLogin option in the text editor*

Start the SSH service:

```shell
service sshd start
```

Set a new password for root user:

```shell
passwd
```

Now you can log in via SSH using login: `root` and **your password** (check the Jail section for the IP address) - see **Figure 15**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip23.png) ![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip24.png)

***Figure 15.** IP address for connections to the Jail*

## Install the latest Go package

```shell
pkg install go
```

Check Go version (**Figure 16**)

```shell
go version
```

***Figure 16.** Check Go version*

```shell
go env
```

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip25.png)

***Figure 17.** Example of environment variables for Go*

Add a new user for Storj with Username `storj` and set shell: `bash` - see **Figure 18**.

```shell
adduser storj
```

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip26.png)

***Figure 18.** Adding a new storj user*

Become a storj user:

```shell
sudo su storj
```

### Setup Go Environment
Open your `.profile` file and add a global variables as follows at the end of the file. See **Figure 19**.

```shell
nano /home/storj/.profile
```

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip27.png)

***Figure 19.** Adding a global variables to the `.profile`*

Press **Ctrl+X** for exit and **Y** for save changes

### Update the current shell session

```shell
source ~/.profile
```

# Compile Storj from Source
Connect to the Jail shell and execute:

```shell
git clone https://github.com/storj/storj.git storj
cd storj
go install -race -v storj.io/storj/cmd/storj-sim storj.io/storj/cmd/bootstrap storj.io/storj/cmd/satellite storj.io/storj/cmd/storagenode storj.io/storj/cmd/uplink storj.io/storj/cmd/gateway storj.io/storj/cmd/identity storj.io/storj/cmd/certificates
```

check the binary folder

```shell
ls /home/storj/go/bin/
```

Let´s create a local test network, containing the Satellite, Uplink, S3 gateway and 10 storage nodes and run it.

```shell
storj-sim network setup
storj-sim network run
```

Now the test network is ready and you can see the output like this - see **Figure 20**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-sim/freeBSD/mceclip28.png)

***Figure 20.** Example of the output of a local test network*

More information - [Test network](https://github.com/storj/storj/wiki/Test-network)

# See also
* [S3 Gateway](docId:EGM8O-1xt2Az03eBWT8Rf)
* [Uplink CLI](docId:TbMdOGCAXNWyPpQmH6EOq)
* [Libuplink Walkthrough](https://github.com/storj/storj/wiki/Libuplink-Walkthrough)
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Getting started with Storj Testnet on Linux
docId:
metadata:
title: Getting started with Storj Testnet on Linux
description: Would you like to build an app with the Storj network as backend? Let's create a local test network with Storj-Sim on Linux!
redirects:
- /hc/en-us/articles/360031331031-Getting-started-with-Storj-Testnet-on-Linux
- /hc/en-us/articles/360031331031
---
See [https://github.com/storj/storj/wiki/Test-network](https://github.com/storj/storj/wiki/Test-network)
Loading