|
|
||
|---|---|---|
| .github | ||
| api | ||
| device | ||
| dns | ||
| olm | ||
| peers | ||
| websocket | ||
| .dockerignore | ||
| .gitignore | ||
| .go-version | ||
| API.md | ||
| config.go | ||
| CONTRIBUTING.md | ||
| create_test_creds.py | ||
| docker-compose.yml | ||
| Dockerfile | ||
| entrypoint.sh | ||
| get-olm.sh | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| main.go | ||
| Makefile | ||
| namespace.sh | ||
| olm.iss | ||
| README.md | ||
| SECURITY.md | ||
| service_unix.go | ||
| service_windows.go | ||
Olm
Olm is being phased out in favor of the Pangolin CLI and is only meant for advanced use cases.
Olm is a WireGuard tunnel client designed to securely connect your computer to Newt sites running on remote networks.
Installation and Documentation
Olm is used with Pangolin and Newt as part of the larger system. See documentation below:
Key Functions
Registers with Pangolin
Using the Olm ID and a secret, the olm will make HTTP requests to Pangolin to receive a session token. Using that token, it will connect to a websocket and maintain that connection. Control messages will be sent over the websocket.
Receives WireGuard Control Messages
When Olm receives WireGuard control messages, it will use the information encoded (endpoint, public key) to bring up a WireGuard tunnel on your computer to a remote Newt. It will ping over the tunnel to ensure the peer is brought up.
Hole Punching
In the default mode, olm uses both relaying through Gerbil and NAT hole punching to connect to Newt. Hole punching attempts to orchestrate a NAT traversal between the two sites so that traffic flows directly, which can save data costs and improve speed. If hole punching fails, traffic will fall back to relaying through Gerbil.
Build
Binary
Make sure to have Go 1.25 installed.
make
Licensing
Olm is dual licensed under the AGPLv3 and the Fossorial Commercial license. For inquiries about commercial licensing, please contact us.
Contributions
Please see CONTRIBUTIONS in the repository for guidelines and best practices.