|
18 | 18 |
|
19 | 19 | ## Installation |
20 | 20 |
|
| 21 | +Running a node with Bitping is easy, be sure to have an account created [here](https://app.bitping.com/register) |
| 22 | + |
| 23 | +Then navigate to the node Install/Update page in the [Bitping Dashboard](https://app.bitping.com/update) |
| 24 | + |
| 25 | +You can then follow the step by step instructions below dependent on your operating system and install method. |
| 26 | + |
21 | 27 | ### Bitping Desktop |
22 | | -- **MacOS 11.0+**: |
23 | | - 1. Download the DMG from the [GitHub releases page](https://github.com/BitpingApp/Bitping-Node/releases). |
24 | | - 2. Open Bitping Desktop from your Applications folder |
25 | 28 |
|
26 | | -- **Windows 10+**: |
27 | | - 1. Download the MSI from the [GitHub releases page](https://github.com/BitpingApp/Bitping-Node/releases). |
28 | | - 2. Follow the installation steps. |
| 29 | +#### MacOS 11.0+ Desktop |
| 30 | + 1. Navigate to the [Bitping Install page](https://app.bitping.com/update). |
| 31 | + 2. Based on which chipset you have, choose either Intel or Apple Silicon and click the download button. |
| 32 | + 3. Navigate to your Downloads folder in Finder and double click on the Bitping Desktop DMG |
| 33 | + 4. Drag the Bitping Desktop icon to your Applications folder |
| 34 | + 5. Open Bitping Desktop from your Applications folder |
| 35 | + |
| 36 | +#### Windows 10+ Desktop |
| 37 | + 1. Navigate to the [Bitping Install page](https://app.bitping.com/update). |
| 38 | + 2. Click on the Download button for the Desktop application. |
| 39 | + 3. Open your downloads folder and double click on the MSI and follow the installation steps. |
29 | 40 | 3. After installation, go to your start menu and click Bitping Desktop |
30 | 41 |
|
31 | | -### bitpingd (CLI version) |
32 | | -- For **MacOS or Linux**, simply run: |
33 | | - ```bash |
34 | | - curl https://bitping.com/install.sh | bash |
35 | | - ``` |
36 | | - - To run the node with a display: |
| 42 | +### Bitpingd |
| 43 | + |
| 44 | +#### Linux CLI |
| 45 | +1. Install the bitpingd binary with the following script: |
| 46 | + ```bash |
| 47 | + curl https://bitping.com/install.sh | bash |
| 48 | + ``` |
| 49 | +2. Login to the Bitping network: |
| 50 | + ```bash |
| 51 | + bitpingd login |
| 52 | + ``` |
| 53 | +3. To run the node with a display: |
37 | 54 | ```bash |
38 | 55 | bitpingd |
39 | 56 | ``` |
40 | | - - To run the node in the background: |
| 57 | +4. If you are setting up the bitpingd service as **root/sudo**, you will need to run: |
| 58 | + ```bash |
| 59 | + bitpingd service install --system && bitpingd service start --system |
| 60 | + ``` |
| 61 | +5. To run the node in the background as an unpriveliged user: |
41 | 62 | - ```bash |
42 | 63 | bitpingd service install && bitpingd service start |
43 | 64 | ``` |
44 | 65 | - This command will keep your node running in the background when you log out |
45 | 66 | ```bash |
46 | 67 | sudo loginctl enable-linger $(whoami) |
47 | 68 | ``` |
48 | | - - If you are setting up bitpingd as root, you will need to run: |
| 69 | + |
| 70 | +#### MacOS CLI |
| 71 | +1. Install the bitpingd binary with the following script: |
| 72 | + ```bash |
| 73 | + curl https://bitping.com/install.sh | bash |
| 74 | + ``` |
| 75 | +2. Login to the Bitping network: |
| 76 | + ```bash |
| 77 | + bitpingd login |
| 78 | + ``` |
| 79 | +3. To run the node with a display: |
| 80 | + ```bash |
| 81 | + bitpingd |
| 82 | + ``` |
| 83 | +4. If you are setting up the bitpingd service as **root/sudo**, you will need to run: |
| 84 | + ```bash |
| 85 | + bitpingd service install --system && bitpingd service start --system |
| 86 | + ``` |
| 87 | +5. To run the node in the background as an unpriveliged user: |
49 | 88 | - ```bash |
50 | | - bitpingd service install --system && bitpingd service start --system |
| 89 | + bitpingd service install && bitpingd service start |
51 | 90 | ``` |
52 | | -- For Bitpingd on **Docker**: |
53 | | - - To run the container in interactive mode: |
54 | | - - ```bash |
55 | | - docker run -it --mount type=volume,source="bitpingd-volume",target=/root/.bitpingd bitping/bitpingd:latest |
56 | | - ``` |
57 | | - - To run the container and pass email and password via CLI instead of an interactive session run: |
58 | | - - ```bash |
59 | | - docker run -it --mount type=volume,source="bitpingd-volume",target=/root/.bitpingd --entrypoint /app/bitpingd bitping/bitpingd:latest login --email "YOUR_BITPING_EMAIL" --password "YOUR_BITPING_PASSWORD" |
| 91 | + |
| 92 | +#### Docker |
| 93 | +1. To run the container in interactive mode: |
| 94 | + ```bash |
| 95 | + docker run -it --mount type=volume,source="bitpingd-volume",target=/root/.bitpingd bitping/bitpingd:latest |
| 96 | + ``` |
| 97 | +2. To run the container and pass email and password via CLI instead of an interactive session run: |
| 98 | + - ```bash |
| 99 | + docker run -it --mount type=volume,source="bitpingd-volume",target=/root/.bitpingd --entrypoint /app/bitpingd bitping/bitpingd:latest login --email "YOUR_BITPING_EMAIL" --password "YOUR_BITPING_PASSWORD" |
60 | 100 | ``` |
61 | 101 | - ```bash |
62 | | - docker run -it --mount type=volume,source="bitpingd-volume",target=/root/.bitpingd bitping/bitpingd:latest |
| 102 | + docker run -it --mount type=volume,source="bitpingd-volume",target=/root/.bitpingd bitping/bitpingd:latest |
63 | 103 | ``` |
64 | 104 |
|
65 | 105 | ## Support |
|
0 commit comments