mirror of
https://github.com/fosrl/olm.git
synced 2026-02-13 08:26:43 +00:00
Compare commits
24 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
35b48cd8e5 | ||
|
|
15bca53309 | ||
|
|
898b599db5 | ||
|
|
c07bba18bb | ||
|
|
4c24d3b808 | ||
|
|
ad4ab3d04f | ||
|
|
e21153fae1 | ||
|
|
41c3360e23 | ||
|
|
1960d32443 | ||
|
|
74b83b3303 | ||
|
|
c2c3470868 | ||
|
|
2bda3dc3cc | ||
|
|
52573c8664 | ||
|
|
0d3c34e23f | ||
|
|
891df5c74b | ||
|
|
6f3f162d2b | ||
|
|
f6fa5fd02c | ||
|
|
8f4e0ba29e | ||
|
|
32b7dc7c43 | ||
|
|
78d2ebe1de | ||
|
|
014f8eb4e5 | ||
|
|
cd42803291 | ||
|
|
5c5b303994 | ||
|
|
cdf6a31b67 |
5
.github/dependabot.yml
vendored
5
.github/dependabot.yml
vendored
@@ -33,3 +33,8 @@ updates:
|
|||||||
minor-updates:
|
minor-updates:
|
||||||
update-types:
|
update-types:
|
||||||
- "minor"
|
- "minor"
|
||||||
|
|
||||||
|
- package-ecosystem: "github-actions"
|
||||||
|
directory: "/"
|
||||||
|
schedule:
|
||||||
|
interval: "weekly"
|
||||||
|
|||||||
22
.github/workflows/cicd.yml
vendored
22
.github/workflows/cicd.yml
vendored
@@ -12,16 +12,28 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v5
|
||||||
|
|
||||||
|
- name: Set up QEMU
|
||||||
|
uses: docker/setup-qemu-action@v3
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
|
||||||
|
- name: Log in to Docker Hub
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
username: ${{ secrets.DOCKER_HUB_USERNAME }}
|
||||||
|
password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
|
||||||
|
|
||||||
- name: Extract tag name
|
- name: Extract tag name
|
||||||
id: get-tag
|
id: get-tag
|
||||||
run: echo "TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
|
run: echo "TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
|
||||||
|
|
||||||
- name: Install Go
|
- name: Install Go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: 1.24
|
go-version: 1.25
|
||||||
|
|
||||||
- name: Update version in main.go
|
- name: Update version in main.go
|
||||||
run: |
|
run: |
|
||||||
@@ -32,6 +44,10 @@ jobs:
|
|||||||
else
|
else
|
||||||
echo "main.go not found"
|
echo "main.go not found"
|
||||||
fi
|
fi
|
||||||
|
- name: Build and push Docker images
|
||||||
|
run: |
|
||||||
|
TAG=${{ env.TAG }}
|
||||||
|
make docker-build-release tag=$TAG
|
||||||
|
|
||||||
- name: Build binaries
|
- name: Build binaries
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
9
.github/workflows/test.yml
vendored
9
.github/workflows/test.yml
vendored
@@ -11,15 +11,18 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Go
|
- name: Set up Go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: '1.24'
|
go-version: 1.25
|
||||||
|
|
||||||
- name: Build go
|
- name: Build go
|
||||||
run: go build
|
run: go build
|
||||||
|
|
||||||
|
- name: Build Docker image
|
||||||
|
run: make build
|
||||||
|
|
||||||
- name: Build binaries
|
- name: Build binaries
|
||||||
run: make go-build-release
|
run: make go-build-release
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
1.24
|
1.25
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
FROM golang:1.24-alpine AS builder
|
FROM golang:1.25-alpine AS builder
|
||||||
|
|
||||||
# Set the working directory inside the container
|
# Set the working directory inside the container
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
@@ -16,9 +16,9 @@ COPY . .
|
|||||||
RUN CGO_ENABLED=0 GOOS=linux go build -o /olm
|
RUN CGO_ENABLED=0 GOOS=linux go build -o /olm
|
||||||
|
|
||||||
# Start a new stage from scratch
|
# Start a new stage from scratch
|
||||||
FROM ubuntu:24.04 AS runner
|
FROM alpine:3.22 AS runner
|
||||||
|
|
||||||
RUN apt-get update && apt-get install ca-certificates -y && rm -rf /var/lib/apt/lists/*
|
RUN apk --no-cache add ca-certificates
|
||||||
|
|
||||||
# Copy the pre-built binary file from the previous stage and the entrypoint script
|
# Copy the pre-built binary file from the previous stage and the entrypoint script
|
||||||
COPY --from=builder /olm /usr/local/bin/
|
COPY --from=builder /olm /usr/local/bin/
|
||||||
|
|||||||
11
Makefile
11
Makefile
@@ -1,9 +1,20 @@
|
|||||||
|
|
||||||
all: go-build-release
|
all: go-build-release
|
||||||
|
|
||||||
|
docker-build-release:
|
||||||
|
@if [ -z "$(tag)" ]; then \
|
||||||
|
echo "Error: tag is required. Usage: make docker-build-release tag=<tag>"; \
|
||||||
|
exit 1; \
|
||||||
|
fi
|
||||||
|
docker buildx build --platform linux/arm/v7,linux/arm64,linux/amd64 -t fosrl/olm:latest -f Dockerfile --push .
|
||||||
|
docker buildx build --platform linux/arm/v7,linux/arm64,linux/amd64 -t fosrl/olm:$(tag) -f Dockerfile --push .
|
||||||
|
|
||||||
local:
|
local:
|
||||||
CGO_ENABLED=0 go build -o olm
|
CGO_ENABLED=0 go build -o olm
|
||||||
|
|
||||||
|
build:
|
||||||
|
docker build -t fosrl/olm:latest .
|
||||||
|
|
||||||
go-build-release:
|
go-build-release:
|
||||||
CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -o bin/olm_linux_arm64
|
CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -o bin/olm_linux_arm64
|
||||||
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o bin/olm_linux_amd64
|
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o bin/olm_linux_amd64
|
||||||
|
|||||||
71
README.md
71
README.md
@@ -48,8 +48,9 @@ All CLI arguments can also be set via environment variables:
|
|||||||
- `PING_INTERVAL`: Equivalent to `--ping-interval`
|
- `PING_INTERVAL`: Equivalent to `--ping-interval`
|
||||||
- `PING_TIMEOUT`: Equivalent to `--ping-timeout`
|
- `PING_TIMEOUT`: Equivalent to `--ping-timeout`
|
||||||
- `HOLEPUNCH`: Set to "true" to enable hole punching (equivalent to `--holepunch`)
|
- `HOLEPUNCH`: Set to "true" to enable hole punching (equivalent to `--holepunch`)
|
||||||
|
- `CONFIG_FILE`: Set to the location of a JSON file to load secret values
|
||||||
|
|
||||||
Example:
|
Examples:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
olm \
|
olm \
|
||||||
@@ -58,6 +59,67 @@ olm \
|
|||||||
--endpoint https://example.com
|
--endpoint https://example.com
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You can also run it with Docker compose. For example, a service in your `docker-compose.yml` might look like this using environment vars (recommended):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
services:
|
||||||
|
olm:
|
||||||
|
image: fosrl/olm
|
||||||
|
container_name: olm
|
||||||
|
restart: unless-stopped
|
||||||
|
network_mode: host
|
||||||
|
devices:
|
||||||
|
- /dev/net/tun:/dev/net/tun
|
||||||
|
environment:
|
||||||
|
- PANGOLIN_ENDPOINT=https://example.com
|
||||||
|
- OLM_ID=31frd0uzbjvp721
|
||||||
|
- OLM_SECRET=h51mmlknrvrwv8s4r1i210azhumt6isgbpyavxodibx1k2d6
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also pass the CLI args to the container:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
services:
|
||||||
|
olm:
|
||||||
|
image: fosrl/olm
|
||||||
|
container_name: olm
|
||||||
|
restart: unless-stopped
|
||||||
|
network_mode: host
|
||||||
|
devices:
|
||||||
|
- /dev/net/tun:/dev/net/tun
|
||||||
|
command:
|
||||||
|
- --id 31frd0uzbjvp721
|
||||||
|
- --secret h51mmlknrvrwv8s4r1i210azhumt6isgbpyavxodibx1k2d6
|
||||||
|
- --endpoint https://example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
**Docker Configuration Notes:**
|
||||||
|
|
||||||
|
- `network_mode: host` brings the olm network interface to the host system, allowing the WireGuard tunnel to function properly
|
||||||
|
- `devices: - /dev/net/tun:/dev/net/tun` is required to give the container access to the TUN device for creating WireGuard interfaces
|
||||||
|
|
||||||
|
## Loading secrets from files
|
||||||
|
|
||||||
|
You can use `CONFIG_FILE` to define a location of a config file to store the credentials between runs.
|
||||||
|
|
||||||
|
```
|
||||||
|
$ cat ~/.config/olm-client/config.json
|
||||||
|
{
|
||||||
|
"id": "spmzu8rbpzj1qq6",
|
||||||
|
"secret": "f6v61mjutwme2kkydbw3fjo227zl60a2tsf5psw9r25hgae3",
|
||||||
|
"endpoint": "https://pangolin.fossorial.io",
|
||||||
|
"tlsClientCert": ""
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This file is also written to when newt first starts up. So you do not need to run every time with --id and secret if you have run it once!
|
||||||
|
|
||||||
|
Default locations:
|
||||||
|
|
||||||
|
- **macOS**: `~/Library/Application Support/olm-client/config.json`
|
||||||
|
- **Windows**: `%PROGRAMDATA%\olm\olm-client\config.json`
|
||||||
|
- **Linux/Others**: `~/.config/olm-client/config.json`
|
||||||
|
|
||||||
## Hole Punching
|
## Hole Punching
|
||||||
|
|
||||||
In the default mode, olm "relays" traffic through Gerbil in the cloud to get down to newt. This is a little more reliable. Support for NAT hole punching is also EXPERIMENTAL right now using the `--holepunch` flag. This will attempt to orchestrate a NAT hole punch between the two sites so that traffic flows directly. This will save data costs and speed. If it fails it should fall back to relaying.
|
In the default mode, olm "relays" traffic through Gerbil in the cloud to get down to newt. This is a little more reliable. Support for NAT hole punching is also EXPERIMENTAL right now using the `--holepunch` flag. This will attempt to orchestrate a NAT hole punch between the two sites so that traffic flows directly. This will save data costs and speed. If it fails it should fall back to relaying.
|
||||||
@@ -97,15 +159,14 @@ olm.exe debug
|
|||||||
olm.exe help
|
olm.exe help
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Note running the service requires credentials in `%PROGRAMDATA%\olm\olm-client\config.json`.
|
||||||
|
|
||||||
### Service Configuration
|
### Service Configuration
|
||||||
|
|
||||||
When running as a service, Olm will read configuration from environment variables or you can modify the service to include command-line arguments:
|
When running as a service, Olm will read configuration from environment variables or you can modify the service to include command-line arguments:
|
||||||
|
|
||||||
1. Install the service: `olm.exe install`
|
1. Install the service: `olm.exe install`
|
||||||
2. Configure the service with your credentials using Windows Service Manager or by setting system environment variables:
|
2. Set the credentials in `%PROGRAMDATA%\olm\olm-client\config.json`. Hint: if you run olm once with --id and --secret this file will be populated!
|
||||||
- `PANGOLIN_ENDPOINT=https://example.com`
|
|
||||||
- `OLM_ID=your_olm_id`
|
|
||||||
- `OLM_SECRET=your_secret`
|
|
||||||
3. Start the service: `olm.exe start`
|
3. Start the service: `olm.exe start`
|
||||||
|
|
||||||
### Service Logs
|
### Service Logs
|
||||||
|
|||||||
@@ -372,7 +372,7 @@ func keepSendingUDPHolePunchToMultipleExitNodes(exitNodes []ExitNode, olmID stri
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
serverAddr := host + ":21820"
|
serverAddr := net.JoinHostPort(host, "21820")
|
||||||
remoteAddr, err := net.ResolveUDPAddr("udp", serverAddr)
|
remoteAddr, err := net.ResolveUDPAddr("udp", serverAddr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logger.Error("Failed to resolve UDP address for %s: %v", exitNode.Endpoint, err)
|
logger.Error("Failed to resolve UDP address for %s: %v", exitNode.Endpoint, err)
|
||||||
@@ -442,7 +442,7 @@ func keepSendingUDPHolePunch(endpoint string, olmID string, sourcePort uint16, s
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
serverAddr := host + ":21820"
|
serverAddr := net.JoinHostPort(host, "21820")
|
||||||
|
|
||||||
// Create the UDP connection once and reuse it
|
// Create the UDP connection once and reuse it
|
||||||
localAddr := &net.UDPAddr{
|
localAddr := &net.UDPAddr{
|
||||||
@@ -613,7 +613,7 @@ func ConfigurePeer(dev *device.Device, siteConfig SiteConfig, privateKey wgtypes
|
|||||||
// Set up peer monitoring
|
// Set up peer monitoring
|
||||||
if peerMonitor != nil {
|
if peerMonitor != nil {
|
||||||
monitorAddress := strings.Split(siteConfig.ServerIP, "/")[0]
|
monitorAddress := strings.Split(siteConfig.ServerIP, "/")[0]
|
||||||
monitorPeer := fmt.Sprintf("%s:%d", monitorAddress, siteConfig.ServerPort+1) // +1 for the monitor port
|
monitorPeer := net.JoinHostPort(monitorAddress, strconv.Itoa(int(siteConfig.ServerPort+1))) // +1 for the monitor port
|
||||||
logger.Debug("Setting up peer monitor for site %d at %s", siteConfig.SiteId, monitorPeer)
|
logger.Debug("Setting up peer monitor for site %d at %s", siteConfig.SiteId, monitorPeer)
|
||||||
|
|
||||||
primaryRelay, err := resolveDomain(endpoint) // Using global endpoint variable
|
primaryRelay, err := resolveDomain(endpoint) // Using global endpoint variable
|
||||||
|
|||||||
15
docker-compose.yml
Normal file
15
docker-compose.yml
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
services:
|
||||||
|
olm:
|
||||||
|
image: fosrl/olm:latest
|
||||||
|
container_name: olm
|
||||||
|
restart: unless-stopped
|
||||||
|
environment:
|
||||||
|
- PANGOLIN_ENDPOINT=https://example.com
|
||||||
|
- OLM_ID=vdqnz8rwgb95cnp
|
||||||
|
- OLM_SECRET=1sw05qv1tkfdb1k81zpw05nahnnjvmhxjvf746umwagddmdg
|
||||||
|
cap_add:
|
||||||
|
- NET_ADMIN
|
||||||
|
- SYS_MODULE
|
||||||
|
devices:
|
||||||
|
- /dev/net/tun:/dev/net/tun
|
||||||
|
network_mode: host
|
||||||
2
go.mod
2
go.mod
@@ -1,6 +1,6 @@
|
|||||||
module github.com/fosrl/olm
|
module github.com/fosrl/olm
|
||||||
|
|
||||||
go 1.24
|
go 1.25
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/fosrl/newt v0.0.0-20250730062419-3ccd755d557a
|
github.com/fosrl/newt v0.0.0-20250730062419-3ccd755d557a
|
||||||
|
|||||||
3
main.go
3
main.go
@@ -537,7 +537,8 @@ func runOlmMainWithArgs(ctx context.Context, args []string) {
|
|||||||
close(stopHolepunch)
|
close(stopHolepunch)
|
||||||
|
|
||||||
// wait 10 milliseconds to ensure the previous connection is closed
|
// wait 10 milliseconds to ensure the previous connection is closed
|
||||||
time.Sleep(10 * time.Millisecond)
|
logger.Debug("Waiting 500 milliseconds to ensure previous connection is closed")
|
||||||
|
time.Sleep(500 * time.Millisecond)
|
||||||
|
|
||||||
// if there is an existing tunnel then close it
|
// if there is an existing tunnel then close it
|
||||||
if dev != nil {
|
if dev != nil {
|
||||||
|
|||||||
Reference in New Issue
Block a user