Move wiki to repo folder /wiki, add actions builds for branches "accrescent" and "fdroid" (#1508)

.github/workflows/build-app.yaml

@@ -4,6 +4,8 @@ on:
   pull_request:
   push:
     branches:
+      - accrescent
+      - fdroid
       - main
       - release
 

README.md

@@ -32,14 +32,18 @@ Switching is easier than you may think!
 - Delete the syncthing configuration backup from `backups/syncthing`.
 - Upgrade to the [latest Syncthing-Fork version](https://github.com/Catfriend1/syncthing-android/releases/latest)
 
-## Privacy Policy
+## Wiki and Useful Articles
 
-See our document on privacy: [privacy-policy.md](https://github.com/Catfriend1/syncthing-android/blob/main/privacy-policy.md).
+Our knowledge base is published [here](https://github.com/Catfriend1/syncthing-android/tree/main/wiki#readme).
 
 ## Building and Development Notes
 
 See [detailed info](https://github.com/Catfriend1/syncthing-android/blob/main/wiki/Building-and-Development.md).
 
+## Privacy Policy
+
+See our document on privacy: [privacy-policy.md](https://github.com/Catfriend1/syncthing-android/blob/main/privacy-policy.md).
+
 ## License
 
 The project is licensed under [MPLv2](LICENSE).

scripts/debug/android/testFolder/.stfolder/demo1.sh

@@ -1,3 +0,0 @@
-#!/bin/sh
-echo "[INFO] Demo 1: param1=[${1}], pwd=[$(pwd)]"
-exit 0

scripts/debug/android/testFolder/.stfolder/demo2.sh

@@ -1,3 +0,0 @@
-#!/bin/sh
-echo "[INFO] Demo 2"
-exit 0

wiki/Atom_FindAndReplace_regEx.txt

@@ -1,10 +0,0 @@
-Atom Editor - RegEx Tipps
-=========================
-
-> Find and delete lines.
-
-^\s*<string name="state_cleaning">.*</string>\n?\r?
-
-^\s*<string name="state_cleaning".*>.*</string>\n?\r?\n?
-
-^.*: https://domain.tld/\n?\r?\n?

wiki/Build-speed-AV-exceptions.txt

@@ -1 +0,0 @@
-%LocalAppData%\go-build

wiki/Building-and-Development.md

@@ -34,7 +34,16 @@ To clean up all files generated during build, use the following commands:
 
 ### Build on Windows
 
+You may want to add the following folder exceptions to your antivirus solution if the build process takes too long and you intend to develop regularly.
+
+Exception list
 ```bash
+%LocalAppData%\go-build
+```
+
+build-windows.cmd
+```bash
+@echo off
 ::
 :: Install prerequisites.
 winget install --accept-source-agreements --source winget --exact --id "Git.MinGit" --scope machine

wiki/Frequently-Asked-Questions.md

@@ -1,6 +1,6 @@
 ### How can I access the config and key files?
 
-Use the import/export items in the app settings. This will use the folder `/sdcard/backups/syncthing/` for files. The actual files are stored in `/data/data/com.github.catfriend1.syncthingandroid/files/` which can only be accessed with root.
+Use the import/export items in the app settings. This will use the folder `/storage/emulated/0/backups/syncthing/config.zip` for files.
 
 ### Persistent notification - required or optional?
 The persistent notification is necessary to run a so called foreground service to avoid the app being put asleep by Android and missing run condition changes or synchronization activity. See [#333](https://github.com/Catfriend1/syncthing-android/issues/333) and [#327](https://github.com/Catfriend1/syncthing-android/issues/327) for details. While some users reported a foreground service necessary since Android 8+ and others reported it's working without we are in the same mess here in-between differently behaving, manufacturer specific Android versions that we cannot ensure it working for all users when we would remove the persistent notification. That's why it's required and cannot be configured in Syncthing-Fork as we want the app to work out of the box for all users out there. Other popular apps, like Linphone and Telegram FOSS use the same technique to ensure not being interrupted by the Android OS.
@@ -11,7 +11,7 @@ See [SD card write access](SD-card-write-access) for instructions on how to prop
 
 ### Where are the logs?
 
-You can find the Syncthing logs in the app settings ("Debug" section). Additionally, logs are saved to the primary storage, under `Android/data/com.github.catfriend1.syncthingandroid/files/syncthing.log`.
+You can find the Syncthing logs in the app "Settings" - "Troubleshooting" section.
 
 ### How to access the web interface from a browser?
 
@@ -24,15 +24,9 @@ Misconfigured sync folders pointing to Android's system paths may brick your pho
 
 You should not attempt to sync the following files or folders:
 - /data *1)
-- /storage/abcd-efgh/Android *1)
-- /storage/abcd-efgh/Android/com.github.catfriend1.syncthingandroid/files/syncthing.log *2)
-- /storage/abcd-efgh/WhatsApp *2)
+- /storage/emulated/0/Android *1)
+- /storage/emulated/0/WhatsApp *2)
 
 *1) If you'd like to backup app data, you can use third-party apps like TitaniumBackup or oandrbackup. Syncthing is not designed to replace an os specific backup utility.
 
 *2) Syncing constantly changing files like logs or databases is not supported.
-
-
-### How can I automate Syncthing?
-
-Syncthing-Android can be started and stopped by other apps with intents. See [Remote Control by Broadcast Intents](Remote-Control-by-Broadcast-Intents) for instructions.

wiki/README.md

@@ -0,0 +1,7 @@
+## Welcome to the Syncthing-Fork for Android wiki!
+
+If you are a new user, we suggest you read the [getting started guide](https://docs.syncthing.net/intro/getting-started.html#getting-started).
+
+You can also check the [FAQ](https://github.com/Catfriend1/syncthing-android/blob/main/wiki/Frequently-Asked-Questions.md).
+
+You can see all available wiki articles [here](https://github.com/Catfriend1/syncthing-android/tree/main/wiki)

wiki/Run-scripts-after-a-folder-completed-sync.md

@@ -0,0 +1,41 @@
+## Run scripts after a folder completed its sync progress
+
+This is an expert option to run scripts after a folder changes its sync state. Scripts at '.stfolder/*.sh' will be executed, other locations are not supported for security considerations.
+
+Example script call:
+>  cd /storage/emulated/0/DCIM/Camera/.stfolder/..; sh /storage/emulated/0/DCIM/Camera/.stfolder/rename-files.sh sync_complete
+
+Demo scripts:
+- demo1.sh
+``` bash
+#!/bin/sh
+echo "[INFO] Demo 1: param1=[${1}], pwd=[$(pwd)]"
+exit 0
+```
+
+- demo2.sh
+``` bash
+#!/bin/sh
+echo "[INFO] Demo 2"
+exit 0
+```
+
+Demo push to AVD:
+```
+adb push ".stfolder" /storage/emulated/0/DCIM/
+```
+
+Test:
+```
+2025-05-13 17:54:50.162 21622-21622 RestApi  D  setRemoteCompletionInfo: Completed folder=[android_sdk_built_for_x86_64_u3dz-photos]
+2025-05-13 17:54:50.168 21622-21622 Util  D  runScriptSet: Exec [sh "/storage/emulated/0/DCIM/.stfolder/demo1.sh" "sync_complete"]
+2025-05-13 17:54:50.173 21622-21622 Util  D  runShellCommandGetOutput: sh "/storage/emulated/0/DCIM/.stfolder/demo1.sh" "sync_complete"
+2025-05-13 17:54:50.188 21622-21622 Util  I  runShellCommandGetOutput: Exited with code 1
+2025-05-13 17:54:50.188 21622-21622 Util  V  runScriptSet: Exec result [[INFO] Demo 1]
+2025-05-13 17:54:50.188 21622-21622 Util  D  runScriptSet: Exec [sh "/storage/emulated/0/DCIM/.stfolder/demo2.sh" "sync_complete"]
+2025-05-13 17:54:50.191 21622-21622 Util  D  runShellCommandGetOutput: sh "/storage/emulated/0/DCIM/.stfolder/demo2.sh" "sync_complete"
+2025-05-13 17:54:50.207 21622-21622 Util  I  runShellCommandGetOutput: Exited with code 1
+2025-05-13 17:54:50.207 21622-21622 Util  V  runScriptSet: Exec result [[INFO] Demo 2]
+2025-05-13 18:18:25.876 22547-22547 Util  V  runScriptSet: No script files found within folder: /storage/emulated/0/DCIM/.stfolder
+2025-05-13 18:18:51.140 22547-22547 Util  V  runScriptSet: No script files found within folder: /storage/emulated/0/Pictures/.stfolder
+```

wiki/SD-card-write-access.md

@@ -1,5 +1,5 @@
-### UPDATE 2020/07/08
-Android 11 is being expected to be the first version since 4.4 that supports writing to external SD card again using Syncthing. Stay tuned.
+### TL;DR
+Android 11 is the first version since 4.4 that supports writing to external SD card again using Syncthing. That's why the app requests the  "access all files and manage external storage" permission on first usage.
 
 ### Why SD card use together with Syncthing requires special attention
 According to Google's document: