From c86ed1c708ec5f44b2a9868c24e2e8cad6e91a7d Mon Sep 17 00:00:00 2001 From: Marek Date: Sun, 6 Aug 2023 12:10:35 +1000 Subject: [PATCH] Update SETUP_SYNCTHING.md --- documentation/SETUP_SYNCTHING.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/documentation/SETUP_SYNCTHING.md b/documentation/SETUP_SYNCTHING.md index 4b3518e38..053ef8028 100644 --- a/documentation/SETUP_SYNCTHING.md +++ b/documentation/SETUP_SYNCTHING.md @@ -6,16 +6,33 @@ In JELOS you may use it to: * Keep a copy of your configuration files for easier editing, * ...and lots more. -## Setup on JELOS +## Setup + +### Setup on JELOS * Make sure you are connected to a WiFi network before continuing. -* Go to "Network Settings" and set "Enable Syncthing" to "on". Make a note of your device's IP address and the root password in the Network Settings menu. +* Go to "Network Settings" and set "Enable Syncthing" to "on". Make a note of your device's IP address, as well as the root password in the System Settings menu. * On a computer or mobile device in the same network, open a browser and point it to "a.b.c.d:8384" where "a.b.c.d" is the IP address of your JELOS device. * When prompted for a user name and password, enter "root" as user and the password you noted earlier. * You should now be directed to a configuration page running on your JELOS device - we'll come back to this shortly. -## Setup on Peer(s) +### Setup on Peer(s) * Install Syncthing on the device or computer that you want to synchronize with your JELOS device. If your other device also runs JELOS, simply repeat the above steps. Otherwise go to https://syncthing.net to download Syncthing for your platform. You may also find it in your Linux distribution's package manager, the Android Play Store, etc. Generally it is not required to install the same version of Syncthing on all devices. You can synchronize a folder across any number of peers. -* (TBD) + +### Connecting Folders +1. Go to the web interface of your JELOS device (see above). Don't worry about notices about upgrading or the file system being read-only, nothing you can do. +(Note: You can also go to the web interface of any of the peers, it'll work the same - but for this documentation it is assumed that you're on a JELOS device.) +2. Under "Remote Devices", click "Add Remote Device". Enter the Device ID of the peer you want to synchronize with. If the remote is in the same network as your JELOS device the ID will be shown automatically. Otherwise, you'll find it in the remote's web interface by clicking "Actions" at the top and then "Show ID". Give the device a name if you like. +3. In the "Folders" section, click "Add Folder". In the popup window that opens, set a label and specify the path on the device (e.g. /storage/roms). This is the folder you will be sharing with other peers. +4. In the same popup window, go to the "Sharing" tab and select the remote device you just set up. Optionally, go to the "Ignore Patterns" tab and configure those. Click "Save" to close the window. +5. On the remote's interface you should receive a popup that a new device wants to connect. Click "Add Device" and then "Save" to accept. It should now show up under "Remote Devices". +6. Still on the remote, you should receive a new popup saying that the JELOS device wants to share a folder. Click "Add", then in the popup window, specify the path to an empty local folder to store the synchronized contents. Click "Save". +7. The folder should now be copied from the JELOS device to the remote. + +### Adding more Peers +* To share the folder with more peers, first follow step 2 on your JELOS device to add another remote. +* Find the folder you want to add another peer to and click "Edit". +* In the popup window, go to the "Sharing" tab. The new remote should appear as an option. Select it and then click "Save". +* Follow steps 5 and 6 on the new remote to connect the folder. ## Things to Keep in Mind @@ -38,5 +55,5 @@ RetroArch differentiates between *saves*, i.e. the battery or memory card storag * In the RetroArch settings under "Saving", you can tell RetroArch to sort saves and states into subfolders based on content directory or core name. It is highly recommended to make use of this to reduce the risk of accidentally overwriting an incompatible save or state. * Make regular backups of your save folders. -(TBD) +## Further Documentation For any questions and advanced configuration, be sure to check out the full documentation at https://docs.syncthing.net/index.html.