Skip to content

Commit 9a12634

Browse files
author
daGscheid
committed
2 parents f438443 + e99b399 commit 9a12634

File tree

117 files changed

+411
-202
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+411
-202
lines changed

docs/00-intro.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ Stereum simplifies the complexity of running Ethereum nodes, making it accessibl
2828
The Stereum project thrives on community feedback and contributions. We welcome you to join our efforts in making Ethereum more decentralized and accessible:
2929

3030
- **Stereum Websites**:
31-
- [stereum.com](https://stereum.com/)
32-
- [stereum.net](https://stereum.net/)
31+
- [stereum.com](https://stereum.com/?utm_source=stereum-documentation&utm_medium=intro-link&utm_id=0)
32+
- [stereum.net](https://stereum.net/?utm_source=stereum-documentation&utm_medium=intro-link&utm_id=0)
33+
- [stereumplus.com](https://stereumplus.com/?utm_source=stereum-documentation&utm_medium=intro-link&utm_id=0)
3334
- **GitHub Repository**: [stereum-dev/ethereum-node](https://github.com/stereum-dev/ethereum-node)
3435
- **Discord Server**: [Stereum Server](https://discord.gg/DzAwgnSXtB)
3536

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
3+
4+
5+
# Intial Node Server Setup
6+
7+
## Cloud Server Setup
8+
9+
<Tabs
10+
defaultValue="stereumplus"
11+
values={[
12+
{label: 'StereumPlus', value: 'stereumplus'}
13+
]}>
14+
15+
<TabItem value="stereumplus">
16+
17+
### Get started with [StereumPlus](https://stereumplus.com/)
18+
19+
#### Step 1
20+
Begin by clicking **"Buy Server"** in the top menu to start your journey toward becoming a node runner with StereumPlus.
21+
22+
![Step 1 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP1.png)
23+
24+
#### Step 2
25+
Select your preferred **provider** from the dropdown list. This step ensures you choose a service suited to your blockchain needs.
26+
27+
![Step 2 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP2.png)
28+
29+
#### Step 3
30+
Choose a **plan** based on your server requirements. Compare the options for cores, RAM, and storage to pick what fits best.
31+
32+
![Step 3 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP3.png)
33+
34+
#### Step 4
35+
Enter a unique **server name** to identify your node and click "Continue" to proceed.
36+
37+
![Step 4 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP4.png)
38+
39+
#### Step 5
40+
Review your selected plan details, including price and specifications. Once satisfied, click **"Subscribe"** to continue.
41+
42+
![Step 5 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP5.png)
43+
44+
### Payment Process
45+
46+
#### Step 6
47+
Select your preferred **cryptocurrency** (e.g., Ethereum, USDC, or USDT) for payment, then click **"Choose"**.
48+
49+
![Step 6 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP6.png)
50+
51+
#### Step 7
52+
A wallet address and payment amount will appear. Use the **QR code** or copy the wallet address to initiate the transaction.
53+
54+
![Step 7 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP7.png)
55+
56+
#### Step 8
57+
Open your crypto wallet, select **"Send"**, and paste the wallet address provided by StereumPlus.
58+
59+
![Step 8 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP8.png)
60+
61+
#### Step 9
62+
Copy the wallet address displayed on the StereumPlus payment page to ensure it matches what you paste into your crypto wallet.
63+
64+
![Step 9 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP9.png)
65+
66+
#### Step 10
67+
Enter the exact amount shown on the payment screen in your wallet and confirm the transaction.
68+
69+
![Step 10 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP10.png)
70+
71+
### Verification and Final Steps
72+
73+
#### Step 11
74+
After initiating the transaction, confirm the payment in your crypto wallet. Review the transaction details and finalize the payment by clicking "Confirm" in your wallet interface.
75+
76+
![Step 11 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP11.png)
77+
78+
#### Step 12
79+
Once the payment is sent, return to the Stereum payment screen and click "Click here after payment" to confirm and finalize the payment process.
80+
81+
![Step 12 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP12.png)
82+
83+
#### Step 13
84+
Congrats! This indicates the payment was processed successfully, and your server is being set up. Click on "My Servers" to proceed.
85+
86+
![Step 13 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP13.png)
87+
88+
#### Step 14
89+
In the My Servers section, you can view your active servers. Verify that your new Ethereum node server is listed and ready to be used.
90+
91+
![Step 14 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP14.png)
92+
93+
#### Step 15
94+
You will receive your **server login credentials** via email. Use the provided information to log in securely.
95+
96+
![Step 15 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP15.png)
97+
98+
#### Step 16
99+
Open the Stereum Launcher, input the **IP address, username, and password**, and log in to your server to access it.
100+
101+
![Step 16 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP16.png)
102+
103+
#### Step 17
104+
Upon first login, you'll be prompted to change your password. Choose a secure password and save it securely.
105+
106+
![Step 17 Screenshot](../../static/screenshots/guides/stereumplus/order-process/SP17.png)
107+
108+
</TabItem>
109+
</Tabs>
110+
111+
## Local Server Setup
112+
113+
### Create a Bootable USB Stick {#create-bootable-usb}
114+
115+
<Tabs
116+
defaultValue="windows"
117+
values={[
118+
{label: 'Windows', value: 'windows'},
119+
{label: 'macOS', value: 'mac'},
120+
{label: 'Linux', value: 'linux'},
121+
]}>
122+
123+
<TabItem value="windows">
124+
125+
1. Visit the Ubuntu Server download page: [Ubuntu Server](https://ubuntu.com/download/server). Click on the version labeled 'Ubuntu Server 22.04 LTS' to download it.
126+
127+
![Server Setup Step 1 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_1.png)
128+
129+
2. Download Rufus to create a bootable USB drive from this page: [Rufus](https://rufus.ie/).
130+
131+
![Server Setup Step 2 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_2.png)
132+
133+
3. Open Rufus once it has downloaded.
134+
135+
![Server Setup Step 3 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_3.png)
136+
137+
4. Insert your USB stick (minimum 4 GB) into the computer. Rufus should detect your USB stick automatically. If it doesn't appear, select it manually from the 'Device' dropdown menu in Rufus.
138+
139+
![Server Setup Step 4 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_4.png)
140+
141+
5. In Rufus, next to 'Boot selection', click on the 'SELECT' button. Navigate to where you saved your Ubuntu Server download (the ISO file) and select it.
142+
143+
![Server Setup Step 5 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_5.png)
144+
145+
6. Leave all other settings in Rufus at their default values. Press 'START' to begin creating your bootable USB.
146+
147+
![Server Setup Step 6 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_6.png)
148+
149+
7. A warning may pop up about Rufus changing the ISO image mode. Confirm that you want to continue in 'ISO Image mode' by clicking 'OK'.
150+
151+
![Server Setup Step 7 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_7.png)
152+
153+
8. The creation of the bootable USB will begin. This process may take around 10 minutes, depending on your computer's capabilities.
154+
155+
![Server Setup Step 8 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_8.png)
156+
157+
9. Once Rufus confirms that the process is complete, you can close Rufus and remove your USB stick.
158+
159+
![Server Setup Step 9 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_9.png)
160+
161+
10. Your Ubuntu Server bootable USB stick is now ready. Move on to the server setup by following the guide in Part 2 below.
162+
163+
![Server Setup Step 10 Screenshot](../../static/screenshots/guides/server-setup-windows/serverprep_10.png)
164+
165+
</TabItem>
166+
167+
<TabItem value="mac">
168+
169+
1. Go to the Ubuntu Server download page: [Ubuntu Server](https://ubuntu.com/download/server) and download the version labeled 'Ubuntu Server 22.04 LTS'.
170+
2. Insert the USB stick into your Mac. Check that it has at least 2 GB of space available.
171+
3. Open the 'Disk Utility' application found in the 'Utilities' folder within your 'Applications' folder.
172+
4. In 'Disk Utility', select your USB stick from the devices listed on the left, then click on the 'Erase' button at the top of the window.
173+
5. Name your USB stick something memorable, select 'Mac OS Extended (Journaled)' as the format, and then click 'Erase' to start the process.
174+
6. Once the erasure is complete, close 'Disk Utility'.
175+
7. Open the 'Terminal' application, also found in the 'Utilities' folder.
176+
8. Convert your downloaded ISO file to an IMG format by typing the following command in Terminal: `hdiutil convert -format UDRW -o /path/to/your_new.img /path/to/downloaded.iso`. Replace '/path/to/your_new.img' and '/path/to/downloaded.iso' with the actual paths to where you want the new IMG file saved and where your downloaded ISO file is located.
177+
9. Find the device identifier for your USB stick by typing `diskutil list` in Terminal.
178+
10. Unmount your USB device with: `diskutil unmountDisk /dev/diskN`. Replace 'diskN' with the identifier from step 9.
179+
11. Write the IMG file to your USB stick with the following command: `sudo dd if=/path/to/your_new.img of=/dev/rdiskN bs=1m`. Again, replace '/path/to/your_new.img' and '/dev/rdiskN' with the appropriate paths and identifiers.
180+
12. When the process is complete, you can remove your USB stick.
181+
13. Your bootable USB stick with Ubuntu Server is ready. Proceed to the next setup phase in Part 2 below.
182+
183+
</TabItem>
184+
185+
<TabItem value="linux">
186+
ToDo: Detailed instructions for creating a bootable USB stick on Linux will be added here.
187+
</TabItem>
188+
189+
</Tabs>
190+
191+
192+
### Booting from USB and Installing Ubuntu {#booting-and-installing}
193+
194+
1. With the machine off, insert your bootable USB.
195+
2. Turn on the machine and immediately press the F11/F12 or Delete key to open the boot menu.
196+
3. Choose your USB as the primary boot option and save your changes.
197+
4. At the Ubuntu boot screen, select 'Try to install Ubuntu Server'.
198+
5. Follow the on-screen instructions to set your language, keyboard layout, and network settings.
199+
6. Accept all defaults for proxy and mirror settings.
200+
7. Verify that the displayed storage matches your server's specs before continuing with the installation.
201+
8. Complete the forms for server name, username, and password. Skip Ubuntu Pro upgrade and additional snaps installation.
202+
9. After installation, select 'Reboot Now'. Once rebooted, use `hostname -i` to note your server's IP address.
203+

docs/02-guides/01-node-server-management.md renamed to docs/03-installation/00-node-server-management.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,19 +66,19 @@ When you launch Stereum, the main window is split into two panels:
6666

6767
When you start Stereum for the first time or to set up a new node, you'll encounter the Welcome Screen, which presents you with three primary installation options:
6868

69-
### [One Click Installation](docs/02-guides/02-installation/00-installation-options/01-one-click-installation.md)
69+
### [One Click Installation](../03-installation/01-installation-options/01-one-click-installation.md)
7070

7171
- This option is designed for users who want a quick and hassle-free node setup.
7272
- It will install a preset of the Stereum server with default settings, which are suitable for most users.
7373
- To proceed with this installation, simply click the `One Click Installation` button, and follow the prompts to select your desired options and configurations.
7474

75-
### [Custom Installation](docs/02-guides/02-installation/00-installation-options/02-custom-installation.md)
75+
### [Custom Installation](../03-installation/01-installation-options/02-custom-installation.md)
7676

7777
- For users with specific requirements or those who wish to configure advanced settings.
7878
- Custom Installation allows you to select different components, configure network settings, and set up monitoring tools according to your preferences.
7979
- To start, click on `Custom Installation`. After installation, you can customize the node settings via the "Edit Node" page.
8080

81-
### [Config Import](docs/02-guides/02-installation/00-installation-options/03-config-import.md)
81+
### [Config Import](../03-installation/01-installation-options/03-config-import.md)
8282

8383
- If you have a pre-existing configuration file from another Stereum setup, you can import it to replicate the same settings.
8484
- This is ideal when moving to a new machine or restoring a setup.

docs/02-guides/02-installation/00-installation-options/01-one-click-installation.md renamed to docs/03-installation/01-installation-options/01-one-click-installation.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,28 @@ The One Click Installation process for Stereum is designed to facilitate a seaml
1818
During the One-Click Installation process, you will choose your use case based on the available options:
1919

2020
- **Staking (Ethereum)**: Set up a node designed for Ethereum staking purposes.
21-
- [Ethereum Solo Staking Guide](../01-use-case-guides/01-staking/00-ethereum/01-ethereum-solo-staking.md)
21+
- [Ethereum Solo Staking Guide](../02-use-case-guides/01-staking/00-ethereum/01-ethereum-solo-staking.md)
2222

2323
- **Staking (Gnosis)**: Set up a node designed for Gnosis staking purposes.
24-
- [Gnosis Staking Guide](../01-use-case-guides/01-staking/01-gnosis/01-gnosis-staking.md)
24+
- [Gnosis Staking Guide](../02-use-case-guides/01-staking/01-gnosis/01-gnosis-staking.md)
2525

2626
- **MEV-Boosted Staking (Ethereum)**: Configure a Ethereum node optimized for maximizing MEV (Miner Extractable Value) opportunities.
27-
- [MEV-Boosted Guide](../01-use-case-guides/01-staking/00-ethereum/03-ethereum-solo-staking-with-mev-boost.md)
27+
- [MEV-Boosted Guide](../02-use-case-guides/01-staking/00-ethereum/03-ethereum-solo-staking-with-mev-boost.md)
2828

2929
- **SSV Network**: Deploy an SSV (Secret Shared Validators) network node.
30-
- [SSV Network Guide](../01-use-case-guides/03-node-operator/ssv-network/01-ssv-network-node-operator.md)
30+
- [SSV Network Guide](../02-use-case-guides/03-node-operator/ssv-network/01-ssv-network-node-operator.md)
3131

3232
- **Archive**: Create an archive node that maintains the complete history of the Ethereum blockchain - **Guide is currently work in progress**
33-
- [Archive Node Guide](../01-use-case-guides/02-blockchain-data/01-installation-archive-node.md)
33+
- [Archive Node Guide](../02-use-case-guides/02-blockchain-data/01-installation-archive-node.md)
3434

3535
- **Obol**: Install a node to participate in the Obol Network, designed for distributed validator technology - **Guide is currently work in progress**
36-
- [Obol Network Guide](../01-use-case-guides/01-staking/00-ethereum/04-obol-clustered-ethereum-solo-staking.md)
36+
- [Obol Network Guide](../02-use-case-guides/01-staking/00-ethereum/04-obol-clustered-ethereum-solo-staking.md)
3737

3838
- **ARM**: Specialized installation for ARM architecture hardware, typically used for lower-power devices - **Guide is currently work in progress**
39-
- [ARM Architecture Guide](../01-use-case-guides/01-staking/00-ethereum/02-ethereum-solo-staking-on-ARM.md)
39+
- [ARM Architecture Guide](../02-use-case-guides/01-staking/00-ethereum/02-ethereum-solo-staking-on-ARM.md)
4040

4141
- **Lido x Obol SDVTM (Testnet)**: Take part in the testnet & install a node that combines Lido and Obol technologies to decentralize the Staking Pool's Node Operator set.
42-
- [Lido x Obol SDVTM Guide](../01-use-case-guides/03-node-operator/lido/01-lido-sdvtm-obol.md)
42+
- [Lido x Obol SDVTM Guide](../02-use-case-guides/03-node-operator/lido/01-lido-sdvtm-obol.md)
4343

4444

4545
After selecting your use case and pressing `Start`, a random client selection will be taken to serve your use case.

0 commit comments

Comments
 (0)