From 59bfcede97315513ebff6641fbbd79e81df4a46c Mon Sep 17 00:00:00 2001 From: Swann Date: Tue, 23 Jun 2020 17:59:56 +0200 Subject: [PATCH] doc: orthographic pass --- docs/tutorials/hosting_guide.rst | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/docs/tutorials/hosting_guide.rst b/docs/tutorials/hosting_guide.rst index 3d18140..719f351 100644 --- a/docs/tutorials/hosting_guide.rst +++ b/docs/tutorials/hosting_guide.rst @@ -10,7 +10,7 @@ Hosting on internet This tutorial aims to guide you to host a collaborative Session on internet. Hosting a session can be done is several ways: -- :ref:`host-blender`: hosting a session directly from the blender addon pannel. +- :ref:`host-blender`: hosting a session directly from the blender add-on panel. - :ref:`host-dedicated`: hosting a session directly from the command line interface on a computer without blender. .. _host-blender: @@ -29,10 +29,8 @@ In order grant server access to people from internet you have tow main option: Using a connection sharing solution ----------------------------------- -Many different third party software like `ZEROTIER `_ (Free) or `HAMACHI `_ (Free until 5 users) allow you to share your private network with other peole. -For the example - -I'm gonna use ZeroTier because its free and open soure. +Many third party software like `ZEROTIER `_ (Free) or `HAMACHI `_ (Free until 5 users) allow you to share your private network with other people. +For the example I'm gonna use ZeroTier because its free and open source. 1. Installation ^^^^^^^^^^^^^^^ @@ -45,9 +43,6 @@ Once installed, launch it. 2. Network creation ^^^^^^^^^^^^^^^^^^^ -Before trying to connect to any network we need to create one. -Only the host need to do this step. - To create a ZeroTier private network you need to register a ZeroTier account `on my.zerotier.com `_ (click on **login** then register on the bottom) @@ -75,7 +70,7 @@ Make sure that the field **Access Control** is set to **PRIVATE**. .. hint:: If you set the Access Control to PUBLIC, anyone will be able to join without - your confirmation. Its easier to setup but less secure. + your confirmation. It is easier to set up but less secure. .. figure:: img/hosting_guide_network_settings.png :align: center @@ -101,9 +96,9 @@ For each user you want to add, do the following step: :align: center :width: 450px - Get the zerotier client id + Get the ZeroTier client id -2. Go to the network settings in the Member section and paste the Node ID into the Manualy Add Member field. +2. Go to the network settings in the Member section and paste the Node ID into the Manually Add Member field. .. figure:: img/hosting_guide_add_node.png :align: center @@ -151,17 +146,17 @@ Let's check the connection status. Right click on the tray icon and click on **S The network status must be **OK** (like in the picture above) otherwise it means that you are not connected to the network. If you see something like **ACCESS_DENIED**, it means that you were not authorized to join the network. Please check the :ref:`network-authorization` section. -This is it for the ZeroTier network setup. Now everything should be setup to use the multi-user addon over internet ! You can now follow the :ref:`quickstart` guide to start using the multi-user addon ! +This is it for the ZeroTier network setup. Now everything should be setup to use the multi-user add-on over internet ! You can now follow the :ref:`quickstart` guide to start using the multi-user add-on ! .. _port-forwarding: Using port-forwarding --------------------- -To setup port forwarding for each ports you can follow this `guide `_ for example. -To know which port are used by the addon, check the :ref:`port-setup` section. +To set up port forwarding for each port you can follow this `guide `_ for example. +To know which port are used by the add-on, check the :ref:`port-setup` section. -Once you have setup the network you can follow the :ref:`quickstart` guide to start using the multi-user addon ! +Once you have set up the network you can follow the :ref:`quickstart` guide to start using the multi-user add-on ! .. _host-dedicated: @@ -181,7 +176,7 @@ From the dedicated server .. _port-setup: ----------------------- -Port setup (optionnal) +Port setup (optional) ----------------------- The multi-user network architecture is based on a clients-server model. The communication protocol use four ports to communicate with client: @@ -189,7 +184,7 @@ The multi-user network architecture is based on a clients-server model. The comm * Commands: command transmission (such as **snapshots**, **change_rights**, etc.) [given port] * Subscriber : pull data [Commands port + 1] * Publisher : push data [Commands port + 2] -* TTL (time to leave) : used to ping each clients [Commands port + 3] +* TTL (time to leave) : used to ping each client [Commands port + 3] To know which ports will be used, you just have to read the port in your preference. @@ -206,4 +201,4 @@ In the picture below we have setup our port to **5555** so it will be: * Publisher: 5557 (**5555** +2) * TTL: 5558 (**5555** +3) -Those four ports needs to be accessible from the client otherwise it wont work at all ! \ No newline at end of file +Those four ports need to be accessible from the client otherwise it won't work at all ! \ No newline at end of file