I code on a MacBook and a Windows PC, and I want to keep my coding projects in sync between them. Here are my wishes in decreasing priority:
Code changes on my MacBook should magically update my PC, and vice versa. (Think Dropbox.)
Some files should not sync, like host-specific dependencies and targets. I want to ignore these files via patterns, a la gitignore.
Ideally, this sync extends to both a headless Linux server I use for remote development, and to WSL on my Windows PC.
After experimenting with other solutions (outlined below) I discovered that Syncthing meets every requirement.
What I tried first
1. OneDrive
I use OneDrive to sync most of my files. It’d be nice to just add my coding projects to OneDrive, but it doesn’t work in practice: ignoring files is awkward, and seemingly only works on Windows. Additionally, OneDrive doesn’t run on Linux without somehelp.
If the issue is syncing files across computers, why don’t I just work on one computer? Well, developing on a remote machine has its own issues:
Blips in internet connectivity become big problems. At best, you wait for keystrokes to appear over SSH. At worst, you can’t code at all. (And while file sync also requires connectivity, a few seconds is enough to sync changes.)
Waiting for my dinky free-tier Oracle Cloud VM to compile a complex Rust project is frustrating. Sure, I could rent a better VM, but it’s silly to pay for that additional power when I have a more than capable computer in front of me.
Some development doesn’t work well in a remote environment. Web dev is fine, but what if I want to play around with game or mobile dev?
3. Git
Can’t I just use Git to stay up to date?
No – version control is different than file sync. I don’t want to track personal config files in version control, but I do want to sync them. And I don’t always want to check in work in progress – for example, I don’t want to check in changes that cause builds or tests to fail.
Using Syncthing
Syncthing is amazing. It does everything I outlined at the top – it syncs my projects, it ignores files based on patterns, and it runs everywhere I code (Windows, MacOS, and Linux.)
I resisted using it because of its high barrier to entry. It uses peer-to-peer file syncing, so you need to set it up on a server to ensure each computer sees the latest changes. And its configuration is more involved than something like Dropbox.
But it’s still worth it for me because it solves all my original problems. (And I want to sync these files to a server anyway.) If you’re struggling with the same issues I ran into, and you’re willing to set up a server, give Syncthing a shot.
Addendum: Syncing your ignore patterns
Syncthing does not keep your ignore patterns in sync across hosts, but there’s a way around it:
Create a text file with the patterns you want to ignore.
Save it to your Syncthing folder.
Add #include name-of-that-file to each host’s ignore patterns.
I recently set up a new Windows machine for gaming, but I’m actually using it more to play around with Linux via WSL.
I set up NixOS on WSL using the aptly named NixOS on WSL project, but ran into a few issues during setup that
bricked my environment1. Below are the steps that ended up working for me in the end:
Goals
Set up NixOS in WSL 2 on a new Windows 11 install (version 22H2.)
Reuse my flake-based configuration from my other NixOS 22.11 installations.
Move the file where you want your NixOS installation to live. I put it in
C:\Users\<my username>\AppData\Local\NixOS, which I think follows Windows’s conventions.
Open PowerShell as a normal user, change to the directory you just made, and run
wsl --import NixOS . nixos-wsl-installer.tar.gz --version 2
Run wsl -d NixOS to start NixOS. It’ll run through initial setup, then hang on “Starting systemd…” Press
Ctrl + C to get back to PowerShell, and then run wsl --shutdown followed by wsl -d NixOS
to get back into NixOS.
Step 3: Configure NixOS
At this point you should have a basic NixOS 22.05 installation! Let’s finish up by setting a username, switching over to
flakes, updating to NixOS 22.11, and enabling native systemd:
Edit /etc/nixos/configuration.nix and make the following changes. Use sudo or some such to edit the file as
root. You may want to nix-shell -p your favorite editor at this point – maybe Helix?
Change wsl.defaultUser to your desired username, and add something like
users.users.<your username>.isNormalUser = true;
Remove references to ./nixos-wsl since we’ll set NixOS-WSL as a flake input:
{ lib, pkgs, config, modulesPath, ... }:
-
- with lib;
- let
- nixos-wsl = import ./nixos-wsl;
- in
{
imports = [
"${modulesPath}/profiles/minimal.nix"
-
- nixos-wsl.nixosModules.wsl
];
Add wsl.nativeSystemd = true;
Add networking.hostName, and set it to your Windows 11 “Device name.” You can find this in the Windows Settings
app under System > About.
Add /etc/nixos/flake.nix as root with contents like the following. Replace <host-name> with your actual host
name from configuration.nix.
I think I changed the default user without actually setting up that user? Or I switched to native
systemd before upgrading to a version of NixOS on WSL that supports it? ↩︎
Thanks to this Stack Exchange answer for pointing me in the
right direction. You don’t have to follow the instructions in this post – NixOS on WSL already mounts Windows’s drives
with the necessary options. ↩︎