sushitrain

<p align="center" width="100%">
<img src="./Docs/logo.png" />
</p>

<p align="center" width="100%">
<h1 align="center">Sushitrain</h1>
</p>

<p align="center" width="100%">
Securely synchronize files on-demand using Syncthing on iOS and macOS.
</p>

[Download on the App Store](https://apps.apple.com/nl/app/synctrain/id6553985316) | [Test beta versions through TestFlight](https://testflight.apple.com/join/2f54I4CM)

Sushitrain brings Syncthing to iOS and macOS. In addition to the very powerful file synchronization features offered by Syncthing, this app has some extra tricks up it
sleeve:

- **Selective file synchronization**: only keep specific files or subdirectories from a larger folder on your device.
- **On-demand access to files**: download or stream files that are not available locally from another peer through the Syncthing protocol. This allows access to your files, from your own devices, without setting up a VPN.
- [**Remote thumbnails**](./Docs/thumbnails.md): the app can generate thumbnails for files on other devices (images or videos). You can even synchronize thumbnails between devices, so previews can be generated on a device that has all the files for use on other devices.
- **Photo back-up** (automatically export photos from the system album to a folder) as well as [**photo folders**](./Docs/photo-fs.md) (directly synchronize a system photo album as a send-only folder, without exporting).
- **Tight iOS/macOS integration** to enable background synchronization (to the extent possible), as well as Shortcuts integration and Continuity support.

## Building

The app consists of a framework in Go and front-end code in Swift.

To build the app, you need a macOS computer with the following:

- XCode with the iOS 17.5 or higher SDK installed
- Developer certificates
- Go (see [go.mod](./SushitrainCore/go.mod) for the version used)

First, verify the Go framework builds correctly. Open a terminal and do the following:

```bash
cd SushitrainCore
make
```

This should not show any errors and lead to a built framework in the `build` directory.

Note that the Makefile assumes you installed Go through Homebrew in `/opt/homebrew`. Change accordingly if your environment
is different.

When the framework is succesfully built, open XCode and follow the following steps:

1. Remove the `com.apple.developer.device-information.user-assigned-device-name` entitlement from the project configuration
   for iOS. This entitlement allows the app to set the Syncthing device name to match the device's actual hostname. The
   entitlement can only be obtained from Apple and for distributed apps only. Without the entitlement, the app will receive
   `localhost` from iOS as host name and will set that as peer name upon first startup. You can of course change the device
   name from the settings screen or in the configuration.
2. Set up signing (change the 'team ID' in the project settings you a team or developer ID you have access to, then let
   XCode autoamtically