{
  "schema_version": 1,
  "generated_at": "2026-10-23T00:00:00.000Z",
  "canonical_url": "https://openlogs.fyi/tools/wg-easy",
  "slug": "wg-easy",
  "name": "wg-easy",
  "tagline": "WireGuard VPN server with a web interface for adding and removing clients.",
  "replaces": {
    "summary": "Paid VPN services, such as NordVPN.",
    "products": [
      {
        "slug": "nordvpn",
        "name": "NordVPN",
        "vendor": null,
        "url": "https://openlogs.fyi/alternatives/nordvpn"
      }
    ]
  },
  "stack": [
    {
      "kind": "language",
      "name": "TypeScript"
    }
  ],
  "deployment_methods": [
    "docker_compose"
  ],
  "requirements": {
    "min_ram_mb": null,
    "min_cpu_cores": null,
    "source_url": null
  },
  "license": {
    "spdx": "AGPL-3.0",
    "class": "osi",
    "source_url": "https://github.com/wg-easy/wg-easy/blob/a9ee47497905564d56938f8fc1a072f6591bf8fb/LICENSE"
  },
  "business_model": {
    "value": "unknown",
    "notes": "The README at the pinned commit does not state a business model, so it stays unknown.",
    "source_url": "https://github.com/wg-easy/wg-easy/blob/a9ee47497905564d56938f8fc1a072f6591bf8fb/README.md",
    "checked_at": "2026-10-22"
  },
  "difficulty": {
    "value": "easy",
    "reason": "1 service, 2 volume mounts, no env values to set, host access: cap_add. Heuristic score 2 of 11: easy."
  },
  "repository": {
    "owner": "wg-easy",
    "name": "wg-easy",
    "url": "https://github.com/wg-easy/wg-easy"
  },
  "compose_check": {
    "status": "config_ok",
    "validated_at": "2026-10-22",
    "summary": "config_ok on 2026-10-22"
  },
  "recipe": {
    "version": 1,
    "source_path": "docker-compose.yml",
    "source_repo": "wg-easy/wg-easy",
    "source_commit_sha": "a9ee47497905564d56938f8fc1a072f6591bf8fb",
    "source_kind": "app_repo",
    "source_url": "https://github.com/wg-easy/wg-easy/blob/a9ee47497905564d56938f8fc1a072f6591bf8fb/docker-compose.yml"
  },
  "install_steps": [
    {
      "order": 1,
      "kind": "prerequisite",
      "language": "text",
      "label": "Docker with the Compose plugin",
      "body": "A host with Docker and the Docker Compose plugin. This entry runs from a compose file.",
      "source_url": "https://github.com/wg-easy/wg-easy/blob/a9ee47497905564d56938f8fc1a072f6591bf8fb/docs/content/examples/tutorials/basic-installation.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 2,
      "kind": "compose",
      "language": "yaml",
      "label": "Save the compose file as docker-compose.yml",
      "body": "volumes:\n  etc_wireguard:\n\nservices:\n  wg-easy:\n    #environment:\n    #  Optional:\n    #  - PORT=51821\n    #  - HOST=0.0.0.0\n    #  - INSECURE=false\n\n    image: ghcr.io/wg-easy/wg-easy:15\n    container_name: wg-easy\n    networks:\n      wg:\n        ipv4_address: 10.42.42.42\n        ipv6_address: fdcc:ad94:bacf:61a3::2a\n    volumes:\n      - etc_wireguard:/etc/wireguard\n      - /lib/modules:/lib/modules:ro\n    ports:\n      - \"51820:51820/udp\"\n      - \"51821:51821/tcp\"\n    restart: unless-stopped\n    cap_add:\n      - NET_ADMIN\n      - SYS_MODULE\n      # - NET_RAW # ⚠️ Uncomment if using Podman\n    sysctls:\n      - net.ipv4.ip_forward=1\n      - net.ipv4.conf.all.src_valid_mark=1\n      - net.ipv6.conf.all.disable_ipv6=0\n      - net.ipv6.conf.all.forwarding=1\n      - net.ipv6.conf.default.forwarding=1\n\nnetworks:\n  wg:\n    driver: bridge\n    enable_ipv6: true\n    ipam:\n      driver: default\n      config:\n        - subnet: 10.42.42.0/24\n        - subnet: fdcc:ad94:bacf:61a3::/64\n",
      "source_url": "https://github.com/wg-easy/wg-easy/blob/a9ee47497905564d56938f8fc1a072f6591bf8fb/docker-compose.yml",
      "validation_status": "config_ok"
    },
    {
      "order": 3,
      "kind": "note",
      "language": "text",
      "label": "What the compose file check ran with",
      "body": "The compose file check ran on this file alone. The folder held only this file. The basic installation guide tells the reader to download docker-compose.yml from the repository and run docker compose up -d in the same folder.",
      "source_url": "https://github.com/wg-easy/wg-easy/blob/a9ee47497905564d56938f8fc1a072f6591bf8fb/docs/content/examples/tutorials/basic-installation.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 4,
      "kind": "shell",
      "language": "bash",
      "label": "Start it",
      "body": "docker compose up -d",
      "source_url": "https://github.com/wg-easy/wg-easy/blob/a9ee47497905564d56938f8fc1a072f6591bf8fb/docs/content/examples/tutorials/basic-installation.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 5,
      "kind": "verify",
      "language": "text",
      "label": "Open the app",
      "body": "Open http://localhost:51821. The compose file publishes host port 51821 for the wg-easy service.",
      "source_url": "https://github.com/wg-easy/wg-easy/blob/a9ee47497905564d56938f8fc1a072f6591bf8fb/docker-compose.yml",
      "validation_status": "unvalidated"
    }
  ],
  "notes": [
    {
      "kind": "gotcha",
      "title": "The compose file publishes host ports",
      "body": "Host ports: 51820/udp (wg-easy), 51821 (wg-easy). A port without a host address listens on all host network interfaces.",
      "source_url": "https://github.com/wg-easy/wg-easy/blob/a9ee47497905564d56938f8fc1a072f6591bf8fb/docker-compose.yml",
      "checked_at": "2026-10-22"
    },
    {
      "kind": "gotcha",
      "title": "The compose file mounts host folders",
      "body": "Host paths mounted into containers: /lib/modules at /lib/modules (wg-easy).",
      "source_url": "https://github.com/wg-easy/wg-easy/blob/a9ee47497905564d56938f8fc1a072f6591bf8fb/docker-compose.yml",
      "checked_at": "2026-10-22"
    },
    {
      "kind": "gotcha",
      "title": "Some services get elevated host access",
      "body": "wg-easy adds Linux capabilities.",
      "source_url": "https://github.com/wg-easy/wg-easy/blob/a9ee47497905564d56938f8fc1a072f6591bf8fb/docker-compose.yml",
      "checked_at": "2026-10-22"
    }
  ],
  "signals": {
    "captured_at": "2026-10-22",
    "stars": 27235,
    "forks": 2593,
    "open_issues": 51,
    "last_push": "2026-10-22",
    "days_since_push": 0,
    "latest_release": "v15.4.0",
    "latest_release_date": "2026-08-14",
    "days_since_release": 69
  },
  "links": {
    "html": "https://openlogs.fyi/tools/wg-easy",
    "markdown": "https://openlogs.fyi/tools/wg-easy.md",
    "json": "https://openlogs.fyi/tools/wg-easy.json"
  },
  "updated_at": "2026-10-22"
}