Skip to content

Commit

Permalink
Merge pull request #553 from threefoldtech/development_pictures
Browse files Browse the repository at this point in the history
updated apps screenshots
  • Loading branch information
khaledyoussef24 committed May 28, 2024
2 parents 189e2bc + 3d52aeb commit 1877d4c
Show file tree
Hide file tree
Showing 34 changed files with 71 additions and 39 deletions.
1 change: 0 additions & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
- [Mattermost](documentation/dashboard/solutions/mattermost.md)
- [Nextcloud](documentation/dashboard/solutions/nextcloud.md)
- [Node Pilot](documentation/dashboard/solutions/nodepilot.md)
- [ownCloud](documentation/dashboard/solutions/owncloud.md)
- [Peertube](documentation/dashboard/solutions/peertube.md)
- [Presearch](documentation/dashboard/solutions/presearch.md)
- [Static Website](documentation/dashboard/solutions/static_website.md)
Expand Down
1 change: 0 additions & 1 deletion src/documentation/dashboard/deploy/applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Easily deploy your favourite applications on the ThreeFold grid with a click of
- [Mattermost](../solutions/mattermost.md)
- [Nextcloud](../solutions/nextcloud.md)
- [Node Pilot](../solutions/nodepilot.md)
- [ownCloud](../solutions/owncloud.md)
- [Peertube](../solutions/peertube.md)
- [Presearch](../solutions/presearch.md)
- [Static Website](../solutions/static_website.md)
Expand Down
52 changes: 30 additions & 22 deletions src/documentation/dashboard/solutions/algorand.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,61 +25,69 @@

### Algorand Structure

- Algorand has two main [types](https://developer.algorand.org/docs/run-a-node/setup/types/#:~:text=The%20Algorand%20network%20is%20comprised,%2C%20and%20non%2Drelay%20nodes.) of nodes (Relay or Participant) you can run also a 4 networks you can run your node against. Combining the types you can get:
- Defualt:
This is a Non-relay and Non-participant
It can run on (Devnet, Testnet, Betanet, Mainnet)
- Algorand has two main [types](https://developer.algorand.org/docs/run-a-node/setup/types/#:~:text=The%20Algorand%20network%20is%20comprised,%2C%20and%20non%2Drelay%20nodes.) of nodes (Relay or Participant). You can also run those nodes on 4 different networks. Combining the types you can get:
- Default:
- This is a Non-relay and Non-participant
- It can run on Devnet, Testnet, Betanet and Mainnet.
- Relay:
Relay node Can't be participant.
It can run only on (Testnet, Mainnet)
- A relay node can't be participant.
- It can run only on Testnet and Mainnet
- Participant:
Can run on any of the four nets.
- Can run on any of the four networks.
- Indexer:
It is a default node but with Archival Mode enbled which will make you able to query the data of the blockchain.
- It is a default node but with Archival Mode enabled which will make you able to query the data of the blockchain.

## Run Default Node

The basic type. you select any network you want. and for the node type select Default.
You can select any network you want and for the node type select Default.

If you have more than one SSH keys set, you can click on `Manage SSH keys` to select which one to use for this deployment.

![defaultdep](./img/solutions_algorand.png)

after the deployment is done. `ssh` to the node and run `goal node status`
After the deployment is done, SSH into the node and run `goal node status`.

Here you see your node runs on mainnet.

![defaulttest](./img/algorand_defaulttest.png)
here you see your node run against mainnet.

## Run Relay Node

Relay nodes are where other nodes connect. Therefore, a relay node must be able to support a large number of connections and handle the processing load associated with all the data flowing to and from these connections. Thus, relay nodes require significantly more power than non-relay nodes. Relay nodes are always configured in archival mode.

The relay node must be publicaly accessable. so it must have public ip.
The relay node must be publicaly accessable, so it must have a public ip.
![relaydep](./img/algorand_relaydep.png)

after the deployment is done. `ssh` to the node and run `goal node status` to see the status of the node. and also you can check if the right port is listening (:4161 for testnet, and :4160 for mainnet)
Once the deployment is done, SSH into the node and run `goal node status` to see the status of the node. You can also check if the right port is listening (:4161 for testnet, and :4160 for mainnet).

![relaytest](./img/algorand_relaytest.png)

The next step accourding to the [docs](https://developer.algorand.org/docs/run-a-node/setup/types/#relay-node) is to register your `ip:port` on Algorand Public SRV.

## Run Participant Node

Participation means participation in the Algorand consensus protocol. An account that participates in the Algorand consensus protocol is eligible and available to be selected to propose and vote on new blocks in the Algorand blockchain.

Participation node is responsible for hosting participation keys for one or more online accounts.

What you need?
- Account mnemonics on the network you deploy on (offline) you can check the status for you account on the AlgoExplorer. search by your account id.
- What do you need?
- Account mnemonics on the network you deploy on (offline) you can check the status for you account on the AlgoExplorer. Search using your account id.

The account needs to have some microAlgo to sign the participation transaction.
- [Main net explorer](https://algoexplorer.io/)
- [Test net explorer](https://testnet.algoexplorer.io/)

- First Round: is the first block you need your participaiton node to validate from. you can choose the last block form the explorer.
- First Round: is the first block you need your participaiton node to validate from. You can choose the last block form the explorer.
![partexp](./img/algorand_partexp.png)
- Last Round: is the final block your node can validate. let's make it 30M
- Last Round: is the final block your node can validate. Let's make it 30M

![partdep](./img/algorand_partdep.png)

after the deployment is done. `ssh` to the node and run `goal node status` to see the status of the node. you see it do catchup. and the fast catchup is to make the node sync with the latest block faster by only fetch the last 1k blocks. after it done it will start create the participation keys.
Once the deployment is done, SSH into the node and run `goal node status` to see the status of the node. You can see it doing catchup and the fast catchup is to make the node synchronize with the latest block faster by only fetching the last 1k blocks. After this is done, it will start to create the participation keys.
![partstatus](./img/algorand_partstatus.png)

now if you check the explorer you can see the status of the account turned to Online
Now if you check the explorer, you can see the status of the account turned to `Online`:

![partonl](./img/algorand_partonl.png)

## Run Indexer Node
Expand All @@ -88,10 +96,10 @@ The primary purpose of this Indexer is to provide a REST API interface of API ca

![indexernode](./img/algorand_indexernode.png)

After it finish you can access the indexer API at port `8980` and here are the [endpoint](https://developer.algorand.org/docs/rest-apis/indexer/) you can access.
Once it's done, you can access the indexer API at port `8980` and here are the [endpoint](https://developer.algorand.org/docs/rest-apis/indexer/) you can access.

## Select Capacity

The default scinario the capacity is computed based on the node (network/type) accourding to this [reference](https://howbigisalgorand.com/).
But you still can change this only to higher values by selecting the option `Set Custom Capacity`
The default scenario capacity is computed based on the node (network/type) accourding to this [reference](https://howbigisalgorand.com/).
But you can still change this to higher values by selecting the option `Set Custom Capacity`.

2 changes: 2 additions & 0 deletions src/documentation/dashboard/solutions/caprover.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ It has following benefits :
- Enter domain for you Caprover instance, Be very careful about the domain name: it needs to be a wildcard domain name you can configure in your chosen domain name system.
- Enter password for you Caprover instance.

If you have more than one SSH keys set, you can click on `Manage SSH keys` to select which one to use for this deployment.

## Admin and Workers Tabs

![ ](./img/solutions_caprover_leader.png)
Expand Down
2 changes: 2 additions & 0 deletions src/documentation/dashboard/solutions/casper.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ __Process__ :
- `Custom Domain` flag lets the user to use a custom domain
- Choose a gateway node to deploy your Casperlab instance on.

If you have more than one SSH keys set, you can click on `Manage SSH keys` to select which one to use for this deployment.

After that is done you can see a list of all of your deployed instances

![ ](./img/casper4.png)
Expand Down
10 changes: 8 additions & 2 deletions src/documentation/dashboard/solutions/fullVm.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,24 @@ Deploy a new full virtual machine on the Threefold Grid
- `Country`
- `Farm Name`
- Choose the node to deploy the Full Virtual Machine on


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

- If you have more than one SSH keys set, you can click on `Manage SSH keys` to select which one to use for this deployment.

You can attach one or more disks to the Virtual Machine by clicking on the Disks tab and the plus `+` sign and specify the following parameters

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

- Disk name
- Disk size

in the bottom of the page you can see a list of all of the virtual machines you deployed. you can click on `Show details` for more details
At the bottom of the page, you can see a list of all of the virtual machines you deployed. You can click on `Show details` for more details:

![ ](./img/new_vm5.png)
You can also go to JSON tab for full details
You can also go to JSON tab for full details:

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

## Difference Between Full VM and Micro VM
Expand Down
7 changes: 6 additions & 1 deletion src/documentation/dashboard/solutions/funkwhale.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Deployment](#deployment)
- [Troubleshooting](#troubleshooting)

***

Expand Down Expand Up @@ -56,4 +57,8 @@ After that is done you can see a list of all of your deployed instances

Click on ***Visit*** to go to the homepage of your Funkwhale instance!

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

## Troubleshooting

If you get a `Bad Gateway` while connecting to the website, you might simply need to wait for the deployment to complete.
Binary file modified src/documentation/dashboard/solutions/img/discourse5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/funkwhale2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/mattermost4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/new_vm5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/new_vm6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/nodeP_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/node_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/nxios-micro1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/presearch4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/solutions_caprover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/solutions_k8s.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/subsquid_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/taiga5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/umbrel2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/vm_json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/vm_list.png
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.
Binary file modified src/documentation/dashboard/solutions/img/wp2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/wp3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/documentation/dashboard/solutions/img/wp4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/documentation/dashboard/solutions/k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ On the TF grid, Kubernetes clusters can be deployed out of the box. We have impl
- `Name`: Your Kubernetes Cluster name.
- `Cluster Token`: It's used for authentication between your worker nodes and master node. You could use the auto-generated one or type your own.

If you have more than one SSH keys set, you can click on `Manage SSH keys` to select which one to use for this deployment.

## Master and Workers tabs

Expand Down
7 changes: 6 additions & 1 deletion src/documentation/dashboard/solutions/peertube.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Deployment](#deployment)
- [Troubleshooting](#troubleshooting)

***

Expand Down Expand Up @@ -56,4 +57,8 @@ Click on ***Visit*** to go to the homepage of your Peertube instance!

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

> Please note it may take sometime to be ready
> Please note it may take sometime to be ready
## Troubleshooting

If you get a `Bad Gateway` while connecting to the website, you might simply need to wait for the deployment to complete.
7 changes: 1 addition & 6 deletions src/documentation/dashboard/solutions/presearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
- [Migrate an Existing Presearch Node to the TFGrid](#migrate-an-existing-presearch-node-to-the-tfgrid)
- [Verify if a 3Node Already Runs a Presearch Workload](#verify-if-a-3node-already-runs-a-presearch-workload)
- [Learn More About Presearch](#learn-more-about-presearch)
- [Questions and Feedback](#questions-and-feedback)

***

Expand Down Expand Up @@ -91,8 +90,4 @@ You can do the following to verify if a Presearch workload deployed without a pu

## Learn More About Presearch

To learn more about Presearch, you can read the [Presearch documentation](https://docs.presearch.io/).

## Questions and Feedback

If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](http://forum.threefold.io/) or on the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) on Telegram.
To learn more about Presearch, you can read the [Presearch documentation](https://docs.presearch.io/).
5 changes: 5 additions & 0 deletions src/documentation/dashboard/solutions/taiga.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Deployment](#deployment)
- [Troubleshooting](#troubleshooting)

***

Expand Down Expand Up @@ -55,3 +56,7 @@ After that is done you can see a list of all of your deployed instances
Click on ***Visit*** to go to the homepage of your Taiga instance!

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

## Troubleshooting

If you get a `Bad Gateway` while connecting to the website, you might simply need to wait for the deployment to complete.
7 changes: 5 additions & 2 deletions src/documentation/dashboard/solutions/umbrel.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,13 @@ You can see a list of all of your deployed instances

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

- you can click on `Show details` for more details about the Umbrel deployment.
- You can click on `Show details` for more details about the Umbrel deployment

![ ](./img/umbrel3.png)
and for more detailed information switch to `JSON` tap.

- For more detailed information, you can switch to `JSON` tab
![ ](./img/umbrel4.png)

- Click on ***Admin Panel*** to go to the dashboard of your Umbrel instance!
- Enter the ***Password*** that you provided in `config` section to login into Umbrel dashboard.
> Forget the credentials? You can find them with `Show details` button.
Expand Down
2 changes: 2 additions & 0 deletions src/documentation/dashboard/solutions/vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,7 @@ __Process__ :
in the bottom of the page you can see a list of all of the virual machines you deployed. you can click on `Show details` for more details

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

You can also go to JSON tab for full details

![ ](./img/vm_json.png)
6 changes: 3 additions & 3 deletions src/documentation/dashboard/solutions/wordpress.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
- [WordPress Instance Website](#wordpress-instance-website)
- [WordPress Instance Admin Page](#wordpress-instance-admin-page)
- [WordPress Instance Credentials](#wordpress-instance-credentials)
- [Questions and Feedback](#questions-and-feedback)
- [Troubleshooting](#troubleshooting)

***

Expand Down Expand Up @@ -142,6 +142,6 @@ At any time, you can find the credentials of your WordPress instance by clicking

![ ](img/wp8.png)

# Questions and Feedback
# Troubleshooting

If you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](http://forum.threefold.io/) or on the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) on Telegram.
If you get a `Bad Gateway` while connecting to the website, you might simply need to wait for the deployment to complete.

0 comments on commit 1877d4c

Please sign in to comment.