Skip to content

Commit

Permalink
Merge pull request #703 from threefoldtech/development
Browse files Browse the repository at this point in the history
dev to master periodic update
  • Loading branch information
mik-tf authored Dec 5, 2024
2 parents 1e551b8 + 1d9738a commit 3cdbc48
Show file tree
Hide file tree
Showing 118 changed files with 417 additions and 356 deletions.
13 changes: 9 additions & 4 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,14 @@
- [TF Token Transfer](documentation/dashboard/tfchain/tf_token_transfer.md)
- [TF Minting Reports](documentation/dashboard/tfchain/tf_minting_reports.md)
- [ThreeFold Connect](documentation/tfconnect/tfconnect_toc.md)
- [TFConnect Overview](documentation/tfconnect/tfconnect_overview.md)
- [TFConnect Authenticator](documentation/tfconnect/tfconnect_authenticator.md)
- [TFConnect Advanced](documentation/tfconnect/tfconnect_advanced.md)
- [TFConnect Troubleshooting](documentation/tfconnect/tfconnect_troubleshooting.md)
- [Overview](documentation/tfconnect/tfconnect_overview.md)
- [Installation](documentation/tfconnect/tfconnect_installation.md)
- [Verification](documentation/tfconnect/tfconnect_verification.md)
- [Wallet](documentation/tfconnect/tfconnect_wallet.md)
- [News](documentation/tfconnect/tfconnect_news.md)
- [DAO](documentation/tfconnect/tfconnect_dao.md)
- [Authenticator](documentation/tfconnect/tfconnect_authenticator.md)
- [Troubleshooting](documentation/tfconnect/tfconnect_troubleshooting.md)
- [Developers](documentation/developers/developers.md)
- [Javascript Client](documentation/developers/javascript/grid3_javascript_readme.md)
- [Installation](documentation/developers/javascript/grid3_javascript_installation.md)
Expand Down Expand Up @@ -215,6 +219,7 @@
- [Packet](documentation/system_administrators/mycelium/packet.md)
- [Data Packet](documentation/system_administrators/mycelium/data_packet.md)
- [API YAML](documentation/system_administrators/mycelium/api_yaml.md)
- [App](documentation/system_administrators/mycelium/mycelium_app.md)
- [Pulumi](documentation/system_administrators/pulumi/pulumi_readme.md)
- [Introduction to Pulumi](documentation/system_administrators/pulumi/pulumi_intro.md)
- [Installing Pulumi](documentation/system_administrators/pulumi/pulumi_install.md)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 12 additions & 8 deletions src/documentation/system_administrators/mycelium/information.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,18 @@ anyone to join the global network. These are hosted in 3 geographic regions, on
IPv4 and IPv6, and supporting both the Tcp and Quic protocols. The nodes are the
following:

| Node ID | Region | IPv4 | IPv6 | Tcp port | Quic port |
| --- | --- | --- | --- | --- | --- |
| 01 | DE | 188.40.132.242 | 2a01:4f8:221:1e0b::2 | 9651 | 9651 |
| 02 | DE | 136.243.47.186 | 2a01:4f8:212:fa6::2 | 9651 | 9651 |
| 03 | BE | 185.69.166.7 | 2a02:1802:5e:0:8478:51ff:fee2:3331 | 9651 | 9651 |
| 04 | BE | 185.69.166.8 | 2a02:1802:5e:0:8c9e:7dff:fec9:f0d2 | 9651 | 9651 |
| 05 | FI | 65.21.231.58 | 2a01:4f9:6a:1dc5::2 | 9651 | 9651 |
| 06 | FI | 65.109.18.113 | 2a01:4f9:5a:1042::2 | 9651 | 9651 |
| Node ID | Region | IPv4 | IPv6 | Tcp port | Quic port | Mycelium IP |
| --- | --- | --- | --- | --- | --- | --- |
| 01 | DE | 188.40.132.242 | 2a01:4f8:221:1e0b::2 | 9651 | 9651 | 54b:83ab:6cb5:7b38:44ae:cd14:53f3:a907 |
| 02 | DE | 136.243.47.186 | 2a01:4f8:212:fa6::2 | 9651 | 9651 | 40a:152c:b85b:9646:5b71:d03a:eb27:2462 |
| 03 | BE | 185.69.166.7 | 2a02:1802:5e:0:ec4:7aff:fe51:e80d | 9651 | 9651 | 597:a4ef:806:b09:6650:cbbf:1b68:cc94 |
| 04 | BE | 185.69.166.8 | 2a02:1802:5e:0:ec4:7aff:fe51:e36b | 9651 | 9651 | 549:8bce:fa45:e001:cbf8:f2e2:2da6:a67c |
| 05 | FI | 65.21.231.58 | 2a01:4f9:6a:1dc5::2 | 9651 | 9651 | 410:2778:53bf:6f41:af28:1b60:d7c0:707a |
| 06 | FI | 65.109.18.113 | 2a01:4f9:5a:1042::2 | 9651 | 9651 | 488:74ac:8a31:277b:9683:c8e:e14f:79a7 |
| 07 | US-EAST | 209.159.146.190 | 2604:a00:50:17b:9e6b:ff:fe1f:e054 | 9651 | 9651 | 4ab:a385:5a4e:ef8f:92e0:1605:7cb6:24b2 |
| 08 | US-WEST | 5.78.122.16 | 2a01:4ff:1f0:8859::1 | 9651 | 9651 | 4de:b695:3859:8234:d04c:5de6:8097:c27c |
| 09 | SG | 5.223.43.251 | 2a01:4ff:2f0:3621::1 | 9651 | 9651 | 5eb:c711:f9ab:eb24:ff26:e392:a115:1c0e |
| 10 | IND | 142.93.217.194 | 2400:6180:100:d0::841:2001 | 9651 | 9651 | 445:465:fe81:1e2b:5420:a029:6b0:9f61 |

These nodes are all interconnected, so 2 peers who each connect to a different node
(or set of disjoint nodes) will still be able to reach each other. For optimal performance,
Expand Down
46 changes: 46 additions & 0 deletions src/documentation/system_administrators/mycelium/mycelium_app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Mycelium App

The Mycelium app is available on Android and iOS.

## Download Links

You can download the Mycelium app with the following links:

- [Android](https://play.google.com/store/apps/details?id=tech.threefold.mycelium)
- [iOS](https://apps.apple.com/app/id6504277565)

## Start Mycelium

To start Mycelium, simply open the app and click on `Start`.

![](./img/mycelium_1.png)

## Stop or Restart Mycelium

To stop or restart Mycelium, click on the appropriate button.

![](./img/mycelium_2.png)

## Add Peers

You can add different Mycelium peers in the `Peers` window.

Simply add peers and then either start or restart the app.

![](./img/mycelium_3.png)

You can consult the [Mycelium hosted public nodes](./information.md#hosted-public-nodes) to find more peers.

For example, if you want to add the node with the IPv4 address `5.78.122.16` with the tcp port `9651`, simply add the following line then start or restart the app.

```
tcp://5.78.122.16:9651
```

## Mycelium Address

When you use the Mycelium app, you are assigned a unique Mycelium address.

To copy the Mycelium address, click on the button on the right of the address.

![](./img/mycelium_4.png)
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ In this section, we present [Mycelium](https://github.com/threefoldtech/mycelium
- [Message](./message.md)
- [Packet](./packet.md)
- [Data Packet](./data_packet.md)
- [API YAML](./api_yaml.md)
- [API YAML](./api_yaml.md)
- [App](./mycelium_app.md)
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ terraform {
}
}

variable "mnemonics" {
variable "mnemonic" {
type = string
}

Expand Down Expand Up @@ -134,7 +134,7 @@ variable "memory" {
}

provider "grid" {
mnemonics = var.mnemonics
mnemonic = var.mnemonic
network = "main"
}

Expand Down Expand Up @@ -241,7 +241,7 @@ In this guide, the virtual IP for `vm1` is 10.1.3.2 and the virtual IP for `vm2`
* Copy the `credentials.auto.tfvars` content and save the file.
* ```
mnemonics = "..."
mnemonic = "..."
SSH_KEY = "..."
tfnodeid1 = "..."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ terraform {
}
}

variable "mnemonics" {
variable "mnemonic" {
type = string
}

Expand Down Expand Up @@ -147,7 +147,7 @@ variable "memory" {
}

provider "grid" {
mnemonics = var.mnemonics
mnemonic = var.mnemonic
network = "main"
}

Expand Down Expand Up @@ -254,7 +254,7 @@ In this guide, the virtual IP for `vm1` is 10.1.3.2 and the virtual IP for `vm2`
* Copy the `credentials.auto.tfvars` content and save the file.
* ```
mnemonics = "..."
mnemonic = "..."
SSH_KEY = "..."
tfnodeid1 = "..."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ terraform {
}
}

variable "mnemonics" {
variable "mnemonic" {
type = string
}

Expand All @@ -137,7 +137,7 @@ variable "memory" {
}

provider "grid" {
mnemonics = var.mnemonics
mnemonic = var.mnemonic
network = "main"
}

Expand Down Expand Up @@ -205,7 +205,7 @@ In this file, we name the full VM as `vm1`.
* Copy the `credentials.auto.tfvars` content and save the file.
* ```
mnemonics = "..."
mnemonic = "..."
SSH_KEY = "..."
tfnodeid1 = "..."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ For this example, we will be deploying the Nextcloud instance with a ThreeFold g
* Copy the following content and save the file under the name `credentials.auto.tfvars`:

```
mnemonics = "..."
mnemonic = "..."
SSH_KEY = "..."
network = "main"
Expand Down Expand Up @@ -60,9 +60,9 @@ Obviously, you can decide to increase or modify the quantity for the CPU, memory
* Copy the following content and save the file under the name `main.tf`:

```
variable "mnemonics" {
variable "mnemonic" {
type = string
default = "your mnemonics"
default = "your mnemonic"
}
variable "network" {
Expand Down Expand Up @@ -129,7 +129,7 @@ terraform {
}
provider "grid" {
mnemonics = var.mnemonics
mnemonic = var.mnemonic
network = var.network
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ terraform {
}
}

variable "mnemonics" {
variable "mnemonic" {
type = string
}

Expand All @@ -93,7 +93,7 @@ variable "memory" {
}

provider "grid" {
mnemonics = var.mnemonics
mnemonic = var.mnemonic
network = "main"
}

Expand Down Expand Up @@ -246,7 +246,7 @@ We create a credentials file that will contain the environment variables. This f
* Copy the `credentials.auto.tfvars` content and save the file
* ```
mnemonics = "..."
mnemonic = "..."
SSH_KEY = "..."
tfnodeid = "..."
Expand All @@ -256,7 +256,7 @@ We create a credentials file that will contain the environment variables. This f
memory = "1024"
```
Make sure to replace the three dots by your own information for `mnemonics` and `SSH_KEY`. You will also need to find a suitable node for your deployment and set its node ID (`tfnodeid`). Feel free to adjust the parameters `size`, `cpu` and `memory` if needed.
Make sure to replace the three dots by your own information for `mnemonic` and `SSH_KEY`. You will also need to find a suitable node for your deployment and set its node ID (`tfnodeid`). Feel free to adjust the parameters `size`, `cpu` and `memory` if needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ terraform {
}
}
provider "grid" {
mnemonics = "FROM THE CREATE TWIN STEP"
mnemonic = "FROM THE CREATE TWIN STEP"
network = grid network, one of: dev test qa main
key_type = key type registered on substrate (ed25519 or sr25519)
relay_url = example: "wss://relay.dev.grid.tf"
Expand All @@ -30,7 +30,7 @@ provider "grid" {

should be recognizable as Env variables too

- `MNEMONICS`
- `MNEMONIC`
- `NETWORK`
- `SUBSTRATE_URL`
- `KEY_TYPE`
Expand All @@ -43,4 +43,4 @@ The *_URL variables can be used to override the dafault urls associated with the

- Grid terraform provider is hosted on terraform registry [here](https://registry.terraform.io/providers/threefoldtech/grid/latest/docs?pollNotifications=true)
- All provider input variables and their description can be found [here](https://github.com/threefoldtech/terraform-provider-grid/blob/development/docs/index.md)
- Capitalized environment variables can be used instead of writing them in the provider (e.g. MNEMONICS)
- Capitalized environment variables can be used instead of writing them in the provider (e.g. MNEMONIC)
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ terraform {
}
}

variable "mnemonics" {
variable "mnemonic" {
type = string
}

Expand All @@ -111,7 +111,7 @@ variable "memory" {
}

provider "grid" {
mnemonics = var.mnemonics
mnemonic = var.mnemonic
network = "main"
}

Expand Down Expand Up @@ -165,9 +165,9 @@ output "node1_zmachine1_ip" {
nano credentials.auto.tfvars
```
* Copy the `credentials.auto.tfvars` content, set the node ID as well as your mnemonics and SSH public key, then save the file.
* Copy the `credentials.auto.tfvars` content, set the node ID as well as your mnemonic and SSH public key, then save the file.
* ```
mnemonics = "..."
mnemonic = "..."
SSH_KEY = "..."
tfnodeid1 = "..."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ terraform {
}
}

variable "mnemonics" {
variable "mnemonic" {
type = string
}

Expand Down Expand Up @@ -118,7 +118,7 @@ variable "memory" {
}

provider "grid" {
mnemonics = var.mnemonics
mnemonic = var.mnemonic
network = "main"
}

Expand Down Expand Up @@ -223,7 +223,7 @@ In this guide, the virtual IP for `vm1` is 10.1.3.2 and the virtual IP for `vm2`
* Copy the `credentials.auto.tfvars` content and save the file.
* ```
mnemonics = "..."
mnemonic = "..."
SSH_KEY = "..."
tfnodeid1 = "..."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ to create your twin please check [grid substrate getting started](grid_substrate
```bash
./msgbusd --twin <TWIN_ID> #run message bus with your twin id
cd examples/resources
export MNEMONICS="<mnemonics words>"
export MNEMONIC="<mnemonic words>"
terraform init && terraform apply
```
## Destroying deployment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Here’s a link to CapRover's open source repository on [GitHub](https://github.
Note that you can use CapRover without a domain too. But you won't be able to setup HTTPS or add `Self hosted Docker Registry`.
- TerraForm installed to provision, adjust and tear down infrastructure using the tf configuration files provided here.
- Yggdrasil installed and enabled for End-to-end encrypted IPv6 networking.
- account created on [Polkadot](https://polkadot.js.org/apps/?rpc=wss://tfchain.dev.threefold.io/ws#/accounts) and got an twin id, and saved you mnemonics.
- account created on [Polkadot](https://polkadot.js.org/apps/?rpc=wss://tfchain.dev.threefold.io/ws#/accounts) and got an twin id, and saved your mnemonic.
- TFTs in your account balance (in development, Transferer some test TFTs from ALICE account).

## How to Run CapRover on ThreeFold Grid 3
Expand Down Expand Up @@ -57,7 +57,7 @@ terraform {
}
provider "grid" {
mnemonics = "<your-mnemonics>"
mnemonic = "<your-mnemonic>"
network = "dev" # or test to use testnet
}
Expand Down Expand Up @@ -135,7 +135,7 @@ cd freeflow_caprover/terraform/leader/
vim main.tf
```

- In `provider` Block, add your `mnemonics` and specify the grid network to deploy on.
- In `provider` Block, add your `mnemonic` and specify the grid network to deploy on.
- In `resource` Block, update the disks size, memory size, and cores number to fit your needs or leave as it is for testing.
- In the `PUBLIC_KEY` env var value put your ssh public key .
- In the `CAPROVER_ROOT_DOMAIN` env var value put your root domain, this is optional and you can add it later from the dashboard put it will save you the extra step and allow you to access your dashboard using your domain name directly after the deployment.
Expand Down Expand Up @@ -355,7 +355,7 @@ terraform {
}
provider "grid" {
mnemonics = "<your-mnemonics>"
mnemonic = "<your-mnemonic>"
network = "dev" # or test to use testnet
}
Expand Down Expand Up @@ -426,7 +426,7 @@ cd freeflow_caprover/terraform/worker/
vim main.tf
```
- In `provider` Block, add your `mnemonics` and specify the grid network to deploy on.
- In `provider` Block, add your `mnemonic` and specify the grid network to deploy on.
- In `resource` Block, update the disks size, memory size, and cores number to fit your needs or leave as it is for testing.
- In the `PUBLIC_KEY` env var value put your ssh public key.
- In the `SWMTKN` env var value put the previously generated token.
Expand Down
Loading

0 comments on commit 3cdbc48

Please sign in to comment.