{"id":18295496,"url":"https://github.com/riverqueue/riverui","last_synced_at":"2026-01-03T21:15:55.884Z","repository":{"id":245127228,"uuid":"789588769","full_name":"riverqueue/riverui","owner":"riverqueue","description":"A web interface for River, fast and reliable background jobs in Go.","archived":false,"fork":false,"pushed_at":"2025-03-25T15:46:18.000Z","size":7402,"stargazers_count":153,"open_issues_count":11,"forks_count":17,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-28T17:10:00.577Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://ui.riverqueue.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/riverqueue.png","metadata":{"files":{"readme":"docs/README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-21T01:27:06.000Z","updated_at":"2025-03-25T15:46:20.000Z","dependencies_parsed_at":"2025-02-24T01:01:16.228Z","dependency_job_id":"04c3100f-109e-4d43-bbc2-6416a5ffbf13","html_url":"https://github.com/riverqueue/riverui","commit_stats":null,"previous_names":["riverqueue/riverui"],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riverqueue%2Friverui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riverqueue%2Friverui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riverqueue%2Friverui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riverqueue%2Friverui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/riverqueue","download_url":"https://codeload.github.com/riverqueue/riverui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247226215,"owners_count":20904465,"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":[],"created_at":"2024-11-05T14:36:01.645Z","updated_at":"2026-01-03T21:15:55.878Z","avatar_url":"https://github.com/riverqueue.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# River UI [![Go Reference](https://pkg.go.dev/badge/riverqueue.com/riverui.svg)](https://pkg.go.dev/riverqueue.com/riverui)\n\nRiver UI is a graphical user interface for the [River job queue](https://github.com/riverqueue/river). It lets users view and manage jobs without having to resort to querying the database or the command line.\n\nA [live demo of River UI](https://ui.riverqueue.com) is available to see what it looks like.\n\n## Installation\n\nA working River database is required for the UI to start up properly. See [running River migrations](https://riverqueue.com/docs/migrations), and make sure a `DATABASE_URL` is exported to env.\n\n```sh\n$ go install github.com/riverqueue/river/cmd/river@latest\n$ river migrate-up --database-url \"$DATABASE_URL\"\n```\n\n### From binary\n\nRiver UI [releases](https://github.com/riverqueue/riverui/releases) include a set of static binaries for a variety of architectures and operating systems. Use one of these links:\n\n* [Linux AMD64](https://github.com/riverqueue/riverui/releases/latest/download/riverui_linux_amd64.gz)\n* [Linux ARM64](https://github.com/riverqueue/riverui/releases/latest/download/riverui_linux_arm64.gz)\n* [macOS AMD64](https://github.com/riverqueue/riverui/releases/latest/download/riverui_darwin_amd64.gz)\n* [macOS ARM64](https://github.com/riverqueue/riverui/releases/latest/download/riverui_darwin_arm64.gz)\n\nOr fetch a binary with cURL:\n\n```sh\n$ RIVER_ARCH=arm64 # either 'amd64' or 'arm64'\n$ RIVER_OS=darwin  # either 'darwin' or 'linux'\n$ curl -L https://github.com/riverqueue/riverui/releases/latest/download/riverui_${RIVER_OS}_${RIVER_ARCH}.gz | gzip -d \u003e riverui\n$ chmod +x riverui\n$ export DATABASE_URL=...\n$ ./riverui\n```\n\n### From container image\n\nRiver UI ships [container images](https://github.com/riverqueue/riverui/pkgs/container/riverui) with each release. Pull and run the latest with:\n\n```sh\n$ docker pull ghcr.io/riverqueue/riverui:latest\n$ docker run -p 8080:8080 --env DATABASE_URL ghcr.io/riverqueue/riverui:latest\n```\n\n## Health Checks\nSee [health checks](health_checks.md).\n\n## Configuration\n\n### Custom path prefix\n\nThe `riverui` command accepts a `-prefix` arg to set a path prefix on both the API and static assets. When executing the Docker image, this is accepted as a `PATH_PREFIX` env.\n\n### Hiding job list arguments by default\n\nThe `RIVER_JOB_LIST_HIDE_ARGS_BY_DEFAULT` environment variable controls whether, by default, the job list UI shows job arguments. By default job arguments are always shown. If `RIVER_JOB_LIST_HIDE_ARGS_BY_DEFAULT=true` or `RIVER_JOB_LIST_HIDE_ARGS_BY_DEFAULT=1` is set, job args will not be shown in the job list by default.\n\nIndividual users may still override this preference using the settings screen in the UI. A user's saved preference takes precedence over any default setting.\n\n### HTTP Authentication\n\nThe `riverui` supports HTTP basic authentication to protect access to the UI.\nTo enable it, set the `RIVER_BASIC_AUTH_USER` and `RIVER_BASIC_AUTH_PASS` environment variables.\n\nAlternatively, if embedding River UI into another Go app, you can wrap its `http.Handler` with any custom authentication logic.\n\n### Logging Configuration\n\nThe `riverui` command utilizes the `RIVER_LOG_LEVEL` environment variable to configure its logging level. The following values are accepted:\n\n* `debug`\n* `info` (default)\n* `warn`\n* `error`\n\nBy default logs are written with the [`slog.TextHandler`](https://pkg.go.dev/log/slog#TextHandler) `key=value` format. For JSON output with [`slog.JSONHandler`](https://pkg.go.dev/log/slog#JSONHandler), set `RIVER_LOG_FORMAT=json`.\n\n## Development\n\nSee [developing River UI](./development.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friverqueue%2Friverui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Friverqueue%2Friverui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friverqueue%2Friverui/lists"}