{"id":13581434,"url":"https://github.com/release-argus/Argus","last_synced_at":"2025-04-06T10:32:30.243Z","repository":{"id":36996227,"uuid":"480057906","full_name":"release-argus/Argus","owner":"release-argus","description":"Argus is a lightweight monitor to notify of new software releases via Gotify/Slack/other messages and/or WebHooks.","archived":false,"fork":false,"pushed_at":"2025-01-27T21:49:22.000Z","size":13106,"stargazers_count":323,"open_issues_count":14,"forks_count":14,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-29T06:48:25.818Z","etag":null,"topics":["go","golang","react"],"latest_commit_sha":null,"homepage":"https://release-argus.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/release-argus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-10T15:25:45.000Z","updated_at":"2025-01-27T21:49:25.000Z","dependencies_parsed_at":"2023-10-16T09:06:23.607Z","dependency_job_id":"55a3cd68-fae7-470d-9f9d-4a371d8d4388","html_url":"https://github.com/release-argus/Argus","commit_stats":null,"previous_names":["hymenaios-io/hymenaios"],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-argus%2FArgus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-argus%2FArgus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-argus%2FArgus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-argus%2FArgus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/release-argus","download_url":"https://codeload.github.com/release-argus/Argus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247470345,"owners_count":20944146,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["go","golang","react"],"created_at":"2024-08-01T15:02:01.657Z","updated_at":"2025-04-06T10:32:30.224Z","avatar_url":"https://github.com/release-argus.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"\u003ch1 align=\"center\" style=\"border-bottom: none\"\u003e\n    \u003ca href=\"//release-argus.io\" target=\"_blank\"\u003e\u003cimg alt=\"Argus\" src=\"/web/ui/react-app/public/favicon.svg\" height=128\u003e\u003c/a\u003e\u003cbr\u003eArgus\n\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n  Keeping an eye on releases.\n\n  [![GitHub](https://img.shields.io/github/license/release-argus/argus)](https://github.com/release-argus/Argus/blob/master/LICENSE)\n  [![Go Report Card](https://goreportcard.com/badge/github.com/release-argus/Argus)](https://goreportcard.com/report/github.com/release-argus/Argus)\n  [![GitHub go.mod Go version (subdirectory of monorepo)](https://img.shields.io/github/go-mod/go-version/release-argus/argus?filename=go.mod)](https://go.dev/dl/)\n  [![GitHub package.json dependency version (subfolder of monorepo)](https://img.shields.io/github/package-json/dependency-version/release-argus/argus/react?filename=web%2Fui%2Freact-app%2Fpackage.json)](https://reactjs.org/)\n  [![Codecov](https://img.shields.io/codecov/c/github/release-argus/argus)](https://app.codecov.io/gh/release-argus/Argus)\n  \u003cbr\u003e\n  [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/release-argus/Argus/build-binary.yml)](https://github.com/release-argus/Argus/actions/workflows/build-binary.yml)\n  [![GitHub release (latest by date)](https://img.shields.io/github/v/release/release-argus/argus)](https://github.com/release-argus/Argus/releases)\n  [![GitHub all releases](https://img.shields.io/github/downloads/release-argus/argus/total)](https://github.com/release-argus/Argus/releases)\n  [![GitHub release (latest by SemVer)](https://img.shields.io/github/downloads/release-argus/argus/latest/total)](https://github.com/release-argus/Argus/releases/latest)\n  \u003cbr\u003e\n  [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/release-argus/Argus/build-docker.yml)](https://github.com/release-argus/Argus/actions/workflows/build-docker.yml)\n  [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/releaseargus/argus?sort=semver)](https://hub.docker.com/r/releaseargus/argus/tags)\n  [![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/releaseargus/argus?sort=semver)](https://hub.docker.com/r/releaseargus/argus/tags)\n  [![Docker Pulls](https://img.shields.io/docker/pulls/releaseargus/argus)](https://hub.docker.com/r/releaseargus/argus)\n\n\u003c/div\u003e\n\nArgus will query websites at a user defined interval for new software releases and then trigger Gotify/Slack/Other notification(s) and/or WebHook(s) when one has been found.\nFor example, you could set it to monitor the Argus repo ([release-argus/argus](https://github.com/release-argus/Argus)). This will query the [GitHub API](https://api.github.com/repos/release-argus/argus/releases) and track the \"tag_name\" variable. When this variable changes from what it was on a previous query, a GitHub-style WebHook could be sent that triggers something (like AWX) to update Argus on your server.\n\n##### Table of Contents\n\n- [Demo](#demo)\n- [Command-line arguments](#command-line-arguments)\n- [Building from source](#building-from-source)\n  - [Prerequisites](#prerequisites)\n  - [Go changes](#go-changes)\n  - [React changes](#react-changes)\n- [Getting started](#config-formatting)\n  - [Config formatting](#getting-started)\n\n## Demo\n\nA demo of Argus can be seen on our website [here](https://release-argus.io/demo).\n\n## Command-line arguments\n\n```bash\n$ argus -h\nUsage of /usr/local/bin/argus:\n  -config.check\n        Print the fully-parsed config.\n  -config.file string\n        Argus configuration file path. (default \"config.yml\")\n  -log.level string\n        ERROR, WARN, INFO, VERBOSE or DEBUG (default \"INFO\")\n  -log.timestamps\n        Enable timestamps in CLI output.\n  -test.notify string\n        Put the name of the Notify service to send a test message.\n  -test.service string\n        Put the name of the Service to test the version query.\n  -web.basic-auth.password string\n        Password for basic auth\n  -web.basic-auth.username string\n        Username for basic auth\n  -web.cert-file string\n        HTTPS certificate file path.\n  -web.listen-host string\n        IP address to listen on for UI, API, and telemetry. (default \"0.0.0.0\")\n  -web.listen-port string\n        Port to listen on for UI, API, and telemetry. (default \"8080\")\n  -web.pkey-file string\n        HTTPS private key file path.\n  -web.route-prefix string\n        Prefix for web endpoints (default \"/\")\n```\n\n## Building from source\n\n### Prerequisites\n\nThe backend of Argus is built with [Go](https://go.dev/), and the frontend with [React](https://reactjs.org/). The React frontend is built and then [embedded](https://pkg.go.dev/embed) into the Go binary so that those web files can be served.\n\n- [Go 1.23+](https://go.dev/dl/)\n- [NodeJS 22](https://nodejs.org/en/download/)\n\n### Go changes\n\nTo see the changes you've made by modifying any of the `.go` files, you must compile Argus. Run `make build` the first time to ensure the web components are available locally. Any future builds that don't need the web-ui to be rebuilt can be done with `make go-build` (faster than `make build`). (Running either of these in the root dir will produce an `argus` binary)\n\n### React changes\n\nTo see the changes after modifying anything in `web/ui/react-app`, you must recompile both the Go backend and the React frontend. This can be done by running `make build`. (Running this in the root dir will produce the `argus` binary)\n\n## Getting started\n\nTo get started with Argus, simply download the binary from the [releases page](https://github.com/release-argus/Argus/releases), and set up the config for that binary.\n\nFor further help, check out the [Getting Started](https://release-argus.io/docs/getting-started/) page on our website.\n\n### Config formatting\n\nThe config can be broken down into 5 key areas. ([Further help](https://release-argus.io/docs/config/))\n\n- [defaults](https://release-argus.io/docs/config/defaults/) - This is broken down into areas with defaults for [services](https://release-argus.io/docs/config/defaults/#service-portion), [notify](https://release-argus.io/docs/config/defaults/#notify-portion) and [webhooks](https://release-argus.io/docs/config/defaults/#webhook-portion).\n- [settings](https://release-argus.io/docs/config/settings/) - Settings for the Argus server.\n- [service](https://release-argus.io/docs/config/service/) - A dictionary mapping of all the services to monitor as well as what to notify when a new release is found.\n- [notify](https://release-argus.io/docs/config/notify/) - A dictionary mapping of targets for Notify messages.\n- [webhook](https://release-argus.io/docs/config/webhook/) - A dictionary mapping of targets for WebHooks.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelease-argus%2FArgus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frelease-argus%2FArgus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelease-argus%2FArgus/lists"}