Doc updates clarifying developer workflow, updating hosting instructions
This commit is contained in:
@ -171,26 +171,28 @@ From the dedicated server
|
|||||||
run it at home for LAN but for internet hosting you need to follow the :ref:`port-forwarding` setup first.
|
run it at home for LAN but for internet hosting you need to follow the :ref:`port-forwarding` setup first.
|
||||||
|
|
||||||
The dedicated server allow you to host a session with simplicity from any location.
|
The dedicated server allow you to host a session with simplicity from any location.
|
||||||
It was developed to improve intaernet hosting performance.
|
It was developed to improve internet hosting performance.
|
||||||
|
|
||||||
The dedicated server can be run in tow ways:
|
The dedicated server can be run in two ways:
|
||||||
|
|
||||||
- :ref:`cmd-line`
|
- :ref:`cmd-line`
|
||||||
- :ref:`docker`
|
- :ref:`docker`
|
||||||
|
|
||||||
|
Note, there are shell scripts to conveniently start a dedicated server via either of these approaches available in the gitlab repository: :ref:`serverstartscripts`
|
||||||
|
|
||||||
.. _cmd-line:
|
.. _cmd-line:
|
||||||
|
|
||||||
Using a regular command line
|
Using a regular command line
|
||||||
----------------------------
|
----------------------------
|
||||||
|
|
||||||
You can run the dedicated server on any platform by following those steps:
|
You can run the dedicated server on any platform by following these steps:
|
||||||
|
|
||||||
1. Firstly, download and intall python 3 (3.6 or above).
|
1. Firstly, download and intall python 3 (3.6 or above).
|
||||||
2. Install the replication library:
|
2. Install the latest version of the replication library:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
python -m pip install replication
|
python -m pip install replication==0.0.21a15
|
||||||
|
|
||||||
4. Launch the server with:
|
4. Launch the server with:
|
||||||
|
|
||||||
@ -199,17 +201,20 @@ You can run the dedicated server on any platform by following those steps:
|
|||||||
replication.serve
|
replication.serve
|
||||||
|
|
||||||
.. hint::
|
.. hint::
|
||||||
You can also specify a custom **port** (-p), **timeout** (-t), **admin password** (-pwd), **log level(ERROR, WARNING, INFO or DEBUG)** (-l) and **log file** (-lf) with the following optionnal argument
|
You can also specify a custom **port** (-p), **timeout** (-t), **admin password** (-pwd), **log level(ERROR, WARNING, INFO or DEBUG)** (-l) and **log file** (-lf) with the following optional arguments
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
replication.serve -p 5555 -pwd toto -t 1000 -l INFO -lf server.log
|
replication.serve -p 5555 -pwd admin -t 1000 -l INFO -lf server.log
|
||||||
|
|
||||||
|
Here, for example, a server is instantiated on port 5555, with password 'admin', a 1 second timeout, and logging enabled.
|
||||||
|
|
||||||
|
As soon as the dedicated server is running, you can connect to it from blender by following :ref:`how-to-join`.
|
||||||
|
|
||||||
As soon as the dedicated server is running, you can connect to it from blender (follow :ref:`how-to-join`).
|
|
||||||
|
|
||||||
|
|
||||||
.. hint::
|
.. hint::
|
||||||
Some commands are available to manage the session. Check :ref:`dedicated-management` to learn more.
|
Some commands are available to enable an administrator to manage the session. Check :ref:`dedicated-management` to learn more.
|
||||||
|
|
||||||
|
|
||||||
.. _docker:
|
.. _docker:
|
||||||
@ -217,7 +222,7 @@ As soon as the dedicated server is running, you can connect to it from blender (
|
|||||||
Using a pre-configured image on docker engine
|
Using a pre-configured image on docker engine
|
||||||
---------------------------------------------
|
---------------------------------------------
|
||||||
|
|
||||||
Launching the dedicated server from a docker server is simple as:
|
Launching the dedicated server from a docker server is simple as running:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
@ -226,13 +231,30 @@ Launching the dedicated server from a docker server is simple as:
|
|||||||
-e port=5555 \
|
-e port=5555 \
|
||||||
-e password=admin \
|
-e password=admin \
|
||||||
-e timeout=1000 \
|
-e timeout=1000 \
|
||||||
registry.gitlab.com/slumber/multi-user/multi-user-server:0.0.3
|
registry.gitlab.com/slumber/multi-user/multi-user-server:0.1.0
|
||||||
|
|
||||||
As soon as the dedicated server is running, you can connect to it from blender.
|
As soon as the dedicated server is running, you can connect to it from blender by following :ref:`how-to-join`.
|
||||||
You can check the :ref:`how-to-join` section.
|
|
||||||
|
|
||||||
|
.. _serverstartscripts:
|
||||||
|
|
||||||
|
Server startup scripts
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
Convenient scripts are available in the Gitlab repository: https://gitlab.com/slumber/multi-user/scripts/startup_scripts/
|
||||||
|
|
||||||
|
Simply run the relevant script in a shell on the host machine to start a server via replication or docker with one line of code. Choose between the two methods above:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
./start-server.sh
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
./run-dockerfile.sh
|
||||||
|
|
||||||
.. hint::
|
.. hint::
|
||||||
Some commands are available to manage the session. Check :ref:`dedicated-management` to learn more.
|
Once your server is up and running, some commands are available to manage the session :ref:`dedicated-management`
|
||||||
|
|
||||||
.. _dedicated-management:
|
.. _dedicated-management:
|
||||||
|
|
||||||
|
@ -35,8 +35,21 @@ Here are some useful information you should provide in a bug report:
|
|||||||
Contributing code
|
Contributing code
|
||||||
=================
|
=================
|
||||||
|
|
||||||
1. Fork it (https://gitlab.com/yourname/yourproject/fork)
|
1. Fork the project into a new repository: https://gitlab.com/yourname/multi-user
|
||||||
2. Create your feature branch (git checkout -b feature/fooBar)
|
2. Clone the new repository locally:
|
||||||
3. Commit your changes (git commit -am 'Add some fooBar')
|
.. code-block:: bash
|
||||||
4. Push to the branch (git push origin feature/fooBar)
|
git clone https://gitlab.com/yourname/multi-user.git
|
||||||
5. Create a new Pull Request
|
3. Create your own feature branch from the develop branch, using the syntax:
|
||||||
|
.. code-block:: bash
|
||||||
|
git checkout -b feature/yourfeaturename
|
||||||
|
where 'feature/' designates a feature branch, and 'yourfeaturename' is a name of your choosing
|
||||||
|
4. Pull any recent changes from the 'develop' branch:
|
||||||
|
.. code-block:: bash
|
||||||
|
git pull
|
||||||
|
5. Add and commit your changes, including a commit message:
|
||||||
|
.. code-block:: bash
|
||||||
|
git commit -am 'Add fooBar'
|
||||||
|
6. Push committed changes to the remote feature branch you created
|
||||||
|
.. code-block:: bash
|
||||||
|
git push origin feature/yourfeaturename
|
||||||
|
7. Create a new Pull Request on Gitlab to merge the changes into the develop branch
|
Reference in New Issue
Block a user