{
  "schema_version": 1,
  "generated_at": "2026-10-22T00:00:00.000Z",
  "canonical_url": "https://openlogs.fyi/tools/ntfy",
  "slug": "ntfy",
  "name": "ntfy",
  "tagline": "A small server that turns an HTTP request into a push notification on your phone or desktop.",
  "replaces": {
    "summary": "Paid push-notification services, such as Pushover.",
    "products": [
      {
        "slug": "pushover",
        "name": "Pushover",
        "vendor": null,
        "url": "https://openlogs.fyi/alternatives/pushover"
      }
    ]
  },
  "stack": [
    {
      "kind": "language",
      "name": "Go"
    },
    {
      "kind": "database",
      "name": "SQLite"
    }
  ],
  "deployment_methods": [
    "docker_compose"
  ],
  "requirements": {
    "min_ram_mb": null,
    "min_cpu_cores": null,
    "source_url": null
  },
  "license": {
    "spdx": "Apache-2.0 OR GPL-2.0-only",
    "class": "osi",
    "source_url": "https://github.com/binwiederhier/ntfy/blob/5e11f4fc344202eb4c9310bf67f17ca121815290/README.md#license"
  },
  "business_model": {
    "value": "unknown",
    "notes": "The README says the author sells paid plans for the hosted service at ntfy.sh. It does not say whether those plans add features that the open-source server lacks, so the business model stays unknown.",
    "source_url": "https://github.com/binwiederhier/ntfy/blob/5e11f4fc344202eb4c9310bf67f17ca121815290/README.md",
    "checked_at": "2026-10-21"
  },
  "difficulty": {
    "value": "easy",
    "reason": "One container. It mounts /var/cache/ntfy and /etc/ntfy from the host, and the user: UID:GID line is a placeholder that you replace or remove."
  },
  "repository": {
    "owner": "binwiederhier",
    "name": "ntfy",
    "url": "https://github.com/binwiederhier/ntfy"
  },
  "compose_check": {
    "status": "config_ok",
    "validated_at": "2026-10-21",
    "summary": "config_ok on 2026-10-21"
  },
  "recipe": {
    "version": 1,
    "source_path": "docker-compose.yml",
    "source_repo": "binwiederhier/ntfy",
    "source_commit_sha": "5e11f4fc344202eb4c9310bf67f17ca121815290",
    "source_kind": "app_repo",
    "source_url": "https://github.com/binwiederhier/ntfy/blob/5e11f4fc344202eb4c9310bf67f17ca121815290/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.",
      "source_url": "https://github.com/binwiederhier/ntfy/blob/5e11f4fc344202eb4c9310bf67f17ca121815290/docker-compose.yml",
      "validation_status": "unvalidated"
    },
    {
      "order": 2,
      "kind": "compose",
      "language": "yaml",
      "label": "Save the compose file as docker-compose.yml",
      "body": "services:\n  ntfy:\n    image: binwiederhier/ntfy\n    container_name: ntfy\n    command:\n      - serve\n    environment:\n      - TZ=UTC    # optional: Change to your desired timezone\n    user: UID:GID # optional: Set custom user/group or uid/gid\n    volumes:\n      - /var/cache/ntfy:/var/cache/ntfy\n      - /etc/ntfy:/etc/ntfy\n    ports:\n      - 80:80\n    restart: unless-stopped\n",
      "source_url": "https://github.com/binwiederhier/ntfy/blob/5e11f4fc344202eb4c9310bf67f17ca121815290/docker-compose.yml",
      "validation_status": "config_ok"
    },
    {
      "order": 3,
      "kind": "env",
      "language": "text",
      "label": "Fix the user line",
      "body": "The compose file has the line \"user: UID:GID\" marked optional. UID:GID is a placeholder, not a valid value. Replace it with a real user and group id, or delete the line.",
      "source_url": "https://github.com/binwiederhier/ntfy/blob/5e11f4fc344202eb4c9310bf67f17ca121815290/docker-compose.yml",
      "validation_status": "unvalidated"
    },
    {
      "order": 4,
      "kind": "shell",
      "language": "bash",
      "label": "Start it",
      "body": "docker compose up -d",
      "source_url": "https://github.com/binwiederhier/ntfy/blob/5e11f4fc344202eb4c9310bf67f17ca121815290/docker-compose.yml",
      "validation_status": "unvalidated"
    },
    {
      "order": 5,
      "kind": "verify",
      "language": "text",
      "label": "Check that it answers",
      "body": "The compose file publishes host port 80 to container port 80. Open http://localhost/ in a browser.",
      "source_url": "https://github.com/binwiederhier/ntfy/blob/5e11f4fc344202eb4c9310bf67f17ca121815290/docker-compose.yml",
      "validation_status": "unvalidated"
    }
  ],
  "notes": [
    {
      "kind": "gotcha",
      "title": "The user line is a placeholder",
      "body": "The compose file sets \"user: UID:GID\". That is not a valid value until it is replaced or removed.",
      "source_url": "https://github.com/binwiederhier/ntfy/blob/5e11f4fc344202eb4c9310bf67f17ca121815290/docker-compose.yml",
      "checked_at": "2026-10-21"
    },
    {
      "kind": "gotcha",
      "title": "State lives in two host folders and port 80 is used",
      "body": "The compose file mounts /var/cache/ntfy and /etc/ntfy from the host and publishes host port 80. Both folders must exist and be writable by the container user.",
      "source_url": "https://github.com/binwiederhier/ntfy/blob/5e11f4fc344202eb4c9310bf67f17ca121815290/docker-compose.yml",
      "checked_at": "2026-10-21"
    },
    {
      "kind": "maintenance",
      "title": "Install and self-hosting docs are on the project site",
      "body": "The README links the project install and self-hosting documentation for configuration and upgrades.",
      "source_url": "https://ntfy.sh/docs/install/",
      "checked_at": "2026-10-21"
    }
  ],
  "signals": {
    "captured_at": "2026-10-21",
    "stars": 34951,
    "forks": 1666,
    "open_issues": 353,
    "last_push": "2026-10-20",
    "days_since_push": 1,
    "latest_release": "v2.32.0",
    "latest_release_date": "2026-10-18",
    "days_since_release": 3
  },
  "links": {
    "html": "https://openlogs.fyi/tools/ntfy",
    "markdown": "https://openlogs.fyi/tools/ntfy.md",
    "json": "https://openlogs.fyi/tools/ntfy.json"
  },
  "updated_at": "2026-10-22"
}