Backups/multi-user
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: orthographic pass

Browse Source
This commit is contained in:
Swann
2020-06-23 17:59:56 +02:00
parent 9d8e3a3e7b
commit 59bfcede97
1 changed files with 13 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/tutorials/hosting_guide.rst
View File

@ -10,7 +10,7 @@ Hosting on internet
This tutorial aims to guide you to host a collaborative Session on internet. This tutorial aims to guide you to host a collaborative Session on internet.
Hosting a session can be done is several ways: 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. - :ref:`host-dedicated`: hosting a session directly from the command line interface on a computer without blender.
.. _host-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 Using a connection sharing solution
----------------------------------- -----------------------------------
Many different third party software like `ZEROTIER <https://www.zerotier.com/download/>`_ (Free) or `HAMACHI <https://vpn.net/>`_ (Free until 5 users) allow you to share your private network with other peole. Many third party software like `ZEROTIER <https://www.zerotier.com/download/>`_ (Free) or `HAMACHI <https://vpn.net/>`_ (Free until 5 users) allow you to share your private network with other people.
For the example For the example I'm gonna use ZeroTier because its free and open source.
I'm gonna use ZeroTier because its free and open soure.
1. Installation 1. Installation
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
@ -45,9 +43,6 @@ Once installed, launch it.
2. Network creation 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 <https://my.zerotier.com/login>`_ To create a ZeroTier private network you need to register a ZeroTier account `on my.zerotier.com <https://my.zerotier.com/login>`_
(click on **login** then register on the bottom) (click on **login** then register on the bottom)
@ -75,7 +70,7 @@ Make sure that the field **Access Control** is set to **PRIVATE**.
.. hint:: .. hint::
If you set the Access Control to PUBLIC, anyone will be able to join without 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 .. figure:: img/hosting_guide_network_settings.png
:align: center :align: center
@ -101,9 +96,9 @@ For each user you want to add, do the following step:
:align: center :align: center
:width: 450px :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 .. figure:: img/hosting_guide_add_node.png
:align: center :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. 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. 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: .. _port-forwarding:
Using port-forwarding Using port-forwarding
--------------------- ---------------------
To setup port forwarding for each ports you can follow this `guide <https://www.wikihow.com/Set-Up-Port-Forwarding-on-a-Router>`_ for example. To set up port forwarding for each port you can follow this `guide <https://www.wikihow.com/Set-Up-Port-Forwarding-on-a-Router>`_ for example.
To know which port are used by the addon, check the :ref:`port-setup` section. 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: .. _host-dedicated:
@ -181,7 +176,7 @@ From the dedicated server
.. _port-setup: .. _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: 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] * Commands: command transmission (such as **snapshots**, **change_rights**, etc.) [given port]
* Subscriber : pull data [Commands port + 1] * Subscriber : pull data [Commands port + 1]
* Publisher : push data [Commands port + 2] * 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. 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) * Publisher: 5557 (**5555** +2)
* TTL: 5558 (**5555** +3) * TTL: 5558 (**5555** +3)
Those four ports needs to be accessible from the client otherwise it wont work at all ! Those four ports need to be accessible from the client otherwise it won't work at all !