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

update domains and add domain page with new UI #709

Merged
merged 3 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file not shown.
37 changes: 18 additions & 19 deletions src/documentation/dashboard/solutions/add_domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,17 @@ We cover the overall process to add a domain to a virtual machine running on the
- Deploy a virtual machine
- Click on the button **Manage Domains** under **Actions**

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

- Open the **Add New Domain** tab

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

## Add New Domain

We cover the different domain parameters presented in the **Add New Domain** tab.
There are different parameters to fill in to add a new domain.

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

- **Subdomain**
- The subdomain is used to reference to the complete domain name. It is randomly generated, but the user can write a specific subdomain name.
Expand All @@ -26,13 +28,11 @@ We cover the different domain parameters presented in the **Add New Domain** tab
- Twin ID (e.g. **3748**)
- Deployment name (e.g. **domainguide**)
- The complete subdomain is thus composed of the subdomain prefix mentioned above and the subdomain entered in the **Subdomain** field.
- **Custom domain name**
- **Custom Domain**
- You can also use a custom domain.
- In this case, instead of having a gateway subdomain and a gateway name as your domain, the domain will be the custom domain entered in this field.
- If you select **Custom domain**, make sure to set a DNS A record pointing to the gateway IP address on your domain name registrar.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will support all the network interfaces provided.
which mean it will depend on your choice when you created the VM, if you choose only mycelium so only mycelium will be there in the drop down menu.
if you choose all network when deployed a VM you can see all the network in the drop down menu.

Ex. for all network selected:
Screenshot from 2024-12-11 15-50-01

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK thanks for the clarification. LMK if what I just committed works now.

![Custom Domain Name](../img/add_domain_8.png)

- **Select domain**
- Choose a gateway for your domain.

Expand All @@ -44,21 +44,24 @@ We cover the different domain parameters presented in the **Add New Domain** tab
- Disabling TLS passthrough will let the gateway terminate the traffic.
- Enabling TLS passthrough will let the backend service terminate the traffic.

- **Network Name**
- This is the name of the WireGuard interface network (read-only field).
- **Supported Interfaces**
- You can select the network interface. Note that you will only see the network(s) provided when you deployed the VM.
- `WireGuard`
- `Public IPv4`
- `Planetary`
- `Mycelium`
- `Public IPv6`

- **IP Address**
- This is the WireGuard IP address (read-only field).

Once you've filled the domain parameters, click on the **Add** button. The message **Successfully deployed gateway** will be presented once the domain is properly added.

![Success Domain](../img/add_new_domain_success.png)
![Success Domain](./img/add_new_domain_success.png)

## Domains List

Once your domain is set, you can access the **Domains List** tab to consult its parameters. To visit the domain, simply click on the **Visit** button under **Actions**.

![List Domain For VM](../img/add_domain_9.png)
![List Domain For VM](./img/add_domain_9.png)

* **Name**
* The name is the subdomain (without the prefix)
Expand All @@ -75,7 +78,7 @@ Once your domain is set, you can access the **Domains List** tab to consult its
* **TLS Passthrough**
* The TLS passthrough status can be either **Yes** or **No**.
* **Backend**
* The WireGuard IP and the chosen port of the domain (e.g. `http://10.20.4.2:80`).
* The network IP and the chosen port of the domain.
* **Status**
* **OK** is displayed when the domain is properly set.
* **Actions**
Expand All @@ -87,10 +90,6 @@ At all time, you can click on **Reload** to reload the Domains List parameters.

To delete a domain, open the **Manage Domains** window, in the tab **Domains lists** select the domain you wish to delete and click **Delete**.

![Select To Delete Domain](../img/add_domain_11.png)

By clicking the **Delete** button, the deletion will start and the domain will be deleted from this virtual machine.

## Questions and Feedback
![Select To Delete Domain](./img/add_domain_11.png)

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.
By clicking the **Delete** button, the deletion will start and the domain will be deleted from this virtual machine.
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/domains.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/domains_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.