Go to file
_ 814fee2bd5 🚧 2021-12-09 15:46:00 +00:00
.github/workflows Create rust.yml 2021-12-05 18:33:50 -06:00
docs 🚧 2021-12-09 15:46:00 +00:00
src add `--timeout-ms` for client 2021-12-09 15:34:42 +00:00
.gitignore 🐣 so that's how multicast groups work 2021-11-26 21:46:27 +00:00
COPYING 📝 preparing to publish 2021-12-05 23:53:32 +00:00
Cargo.lock bump to v0.1.5 2021-12-08 21:53:27 -06:00
Cargo.toml bump to v0.1.5 2021-12-08 21:53:27 -06:00
README.md 🚧 2021-12-09 15:46:00 +00:00
ideas.md add `--timeout-ms` for client 2021-12-09 15:34:42 +00:00
issues.md 🐛 bug: fix server crashing when you send it a packet of ":V\n" 2021-12-09 01:46:03 +00:00

README.md

LookAround

"I want to SSH into my laptop, but I keep forgetting its IP!!"

Has this ever happened to you?

$ lookaround client

Found 3 peers:
11:11:11:11:11:11 = 192.168.1.101 `laptop`
22:22:22:22:22:22 = 192.168.1.102 `desktop`
33:33:33:33:33:33 = 192.168.1.103 `old-laptop`

LookAround is a Rust program for looking up your computers' MAC and IP addresses within a LAN. There's no central server, so it's not a look-up, it's a look-around.

The client uses IP multicast to find servers within the same multicast domain, similar to Avahi and Bonjour.

Systems self-identify by MAC address and nicknames. Public keys with TOFU semantics are intended before v1.0.0.

Installation

Use the Cargo package manager from Rust to install LookAround.

cargo install lookaround

To run the server as a normal user all the time, put this systemd unit in ~/.config/systemd/user/lookaround.service:

[Unit]
Description=LookAround

[Service]
ExecStart=/home/user/.cargo/bin/lookaround server --nickname my-desktop

[Install]
WantedBy=default.target

Then start the service, check that it's running okay, and enable it for auto-start:

systemctl --user start lookaround
systemctl --user status lookaround
systemctl --user enable lookaround

Usage

Run the server manually: (If you haven't installed it with systemd yet)

lookaround server --nickname my-desktop

Run a client to ping all servers in the same multi-cast domain:

lookaround client

Use a longer timeout if some servers need longer than 500 ms to respond:

lookaround client --timeout-ms 1000

For less common uses, see the command-line documentation.

Contributing

Pull requests are welcome. This is a hobby project, so I may reject contributions that are too big to review.

Use the kazupon Git commit message convention

License

AGPL-3.0

This Git repo

This repo's upstream is https://six-five-six-four.com/git/reactor/lookaround. It's mirrored on my GitHub, https://github.com/ReactorScram/lookaround

I don't use GitHub issues, so issues are in issues.md in the repo.