felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

Figures are in fact images

Browse Source
This commit is contained in:
Jakob Borg
2015-06-01 09:04:14 +02:00
parent 70d0b9d201
commit 033286ab6f
4 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
index.rst
+6 -1
View File
@@ -20,17 +20,22 @@ Contact
* If you're looking for specific people to talk to, check out the * If you're looking for specific people to talk to, check out the
:ref:`project-presentation`. :ref:`project-presentation`.
* To report bugs or request features, please use the `issue tracker`_ Before you * To report bugs or request features, please use the `issue tracker`_ Before you
do so, make sure you are running the `latest version`_, and please do a do so, make sure you are running the `latest version`_, and please do a
quick search to see if the issue has already been reported. quick search to see if the issue has already been reported.
.. figure:: issues.png .. image:: issues.png
* To report security issues, please follow the instructions on the * To report security issues, please follow the instructions on the
`Security page`_. `Security page`_.
* To get help and support, to discuss scenarios, or just connect with other * To get help and support, to discuss scenarios, or just connect with other
users and developers you can head over to the `friendly forum`_. users and developers you can head over to the `friendly forum`_.
* For a more real time experience, there's also an IRC channel ``#syncthing`` on * For a more real time experience, there's also an IRC channel ``#syncthing`` on
`Freenode <https://freenode.net/>`_. `Freenode <https://freenode.net/>`_.
* For other concerns you may reach out to members of the core team, currently * For other concerns you may reach out to members of the core team, currently
:user:`calmh`, :user:`AudriusButkevicius` and :user:`Zillode`. :user:`calmh`, :user:`AudriusButkevicius` and :user:`Zillode`.
intro/getting-started.rst
+5 -10
View File
@@ -80,8 +80,7 @@ Configuring
The admin GUI starts automatically and remains available on The admin GUI starts automatically and remains available on
``http://localhost:8384/``. It should look something like this: ``http://localhost:8384/``. It should look something like this:
.. figure:: gs1.png .. image:: gs1.png
:alt: gs1.png
On the left is the list of "folders", or directories to synchronize. You On the left is the list of "folders", or directories to synchronize. You
can see the ``default`` folder was created for you, and it's currently can see the ``default`` folder was created for you, and it's currently
@@ -107,30 +106,26 @@ should also select the folder(s) that you want to share with this
device. The device name is optional, but you can set it to something device. The device name is optional, but you can set it to something
that makes sense for you to remember what device this is. that makes sense for you to remember what device this is.
.. figure:: gs2.png .. image:: gs2.png
:alt: gs2.png
Once you click "Save" the new device will appear on right side of the Once you click "Save" the new device will appear on right side of the
GUI (although disconnected) and a prompt will be shown to indicate the GUI (although disconnected) and a prompt will be shown to indicate the
need for a restart. need for a restart.
.. figure:: gs3.png .. image:: gs3.png
:alt: gs3.png
Syncthing needs to be restarted for some configuration changes to take Syncthing needs to be restarted for some configuration changes to take
effect (such as sharing folders with new devices). When you click effect (such as sharing folders with new devices). When you click
"Restart" Syncthing will first restart: "Restart" Syncthing will first restart:
.. figure:: gs4.png .. image:: gs4.png
:alt: gs4.png
and then come back up and after a while (up to a minute) connect to the and then come back up and after a while (up to a minute) connect to the
other device. Remember though that you need to do the above process on other device. Remember though that you need to do the above process on
both devices, and only once you've done this on both devices will they both devices, and only once you've done this on both devices will they
be able to connect. be able to connect.
.. figure:: gs5.png .. image:: gs5.png
:alt: gs5.png
At this point the two devices share an empty directory. Adding files to At this point the two devices share an empty directory. Adding files to
the Sync directory on either device will synchronize those files to the the Sync directory on either device will synchronize those files to the
intro/gui.rst
+7 -7
View File
@@ -9,26 +9,26 @@ folders. Clicking the folder name makes that section expand to show more
detailed folder information, and buttons for editing the configuration or detailed folder information, and buttons for editing the configuration or
forcing a rescan. forcing a rescan.
.. figure:: gui1.png .. image:: gui1.png
A folder can be in any one of these states: A folder can be in any one of these states:
- *Unknown* while the GUI is loading. - *Unknown* while the GUI is loading.
- *Unshared* when you have not shared this folder, - *Unshared* when you have not shared this folder,
- *Stopped* when the folder has experienced an error, - *Stopped* when the folder has experienced an error,
- *Scanning* while the folder is looking for local changes, - *Scanning* while the folder is looking for local changes,
- *Up to Date* when the folder is in sync with the rest of the cluster, - *Up to Date* when the folder is in sync with the rest of the cluster,
- *Syncing* when this device is downloading changes from the network. - *Syncing* when this device is downloading changes from the network.
Among the folder details, you can see the current "Global State" and "Local State" summaries, as well as the amount of "Out of Sync" data if the the folder state is not up to date. Among the folder details, you can see the current "Global State" and "Local State" summaries, as well as the amount of "Out of Sync" data if the the folder state is not up to date.
- *Global State* indicates how much data the fully up to date folder contains - this is basically the sum of the newest versions of all files from all connected devices. This is the size of the folder on your computer when it is fully in sync with the cluster. - *Global State* indicates how much data the fully up to date folder contains - this is basically the sum of the newest versions of all files from all connected devices. This is the size of the folder on your computer when it is fully in sync with the cluster.
- *Local State* shows how much data the folder actually contains right now. This can be more or less than the global state, if the folder is currently synchronizing with other devices. - *Local State* shows how much data the folder actually contains right now. This can be more or less than the global state, if the folder is currently synchronizing with other devices.
- *Out of Sync* shows how much data that needs to be synchronized from other devices. Note that this is the sum of all out of sync *files* - if you already have parts of such a file, or an older version of the file, less data than this will need to be transferred over the network. - *Out of Sync* shows how much data that needs to be synchronized from other devices. Note that this is the sum of all out of sync *files* - if you already have parts of such a file, or an older version of the file, less data than this will need to be transferred over the network.
users/foldermaster.rst
+2 -2
View File
@@ -3,7 +3,7 @@ Folder Master
A folder can be set in "master mode" among the folder settings. A folder can be set in "master mode" among the folder settings.
.. figure:: foldermaster.png .. image:: foldermaster.png
The intention is for this to be used on devices where a "master copy" of The intention is for this to be used on devices where a "master copy" of
files are kept - where the files are not expected to be changed on other files are kept - where the files are not expected to be changed on other
@@ -16,7 +16,7 @@ sync", but no changes will be applied.
When a master folder becomes out of sync, a red "Override Changes" When a master folder becomes out of sync, a red "Override Changes"
button is shown at the bottom of the folder details. button is shown at the bottom of the folder details.
.. figure:: override.png .. image:: override.png
Clicking this button will make enforce the master's current state on the Clicking this button will make enforce the master's current state on the
rest of the cluster. Any changes made to files will be overwritten by rest of the cluster. Any changes made to files will be overwritten by