River UI is a graphical user interface for the River job queue. It lets users view and manage jobs without having to resort to querying the database or the command line.
A live demo of River UI is available to see what it looks like.
A working River database is required for the UI to start up properly. See running River migrations, and make sure a DATABASE_URL
is exported to env.
$ go install github.com/riverqueue/river/cmd/river@latest
$ river migrate-up --database-url "$DATABASE_URL"
River UI releases include a set of static binaries for a variety of architectures and operating systems. Use one of these links:
Or fetch a binary with cURL:
$ RIVER_ARCH=arm64 # either 'amd64' or 'arm64'
$ RIVER_OS=darwin # either 'darwin' or 'linux'
$ curl -L https://github.com/riverqueue/riverui/releases/latest/download/riverui_${RIVER_OS}_${RIVER_ARCH}.gz | gzip -d > riverui
$ chmod +x riverui
$ export DATABASE_URL=...
$ ./riverui
River UI ships container images with each release. Pull and run the latest with:
$ docker pull ghcr.io/riverqueue/riverui:latest
$ docker run -p 8080:8080 --env DATABASE_URL ghcr.io/riverqueue/riverui:latest
The 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.
The riverui
command utilizes the RIVER_LOG_LEVEL
environment variable to configure its logging level. The following values are accepted:
debug
info
(default)warn
error
The riverui
supports basic HTTP authentication to protect access to the UI.
To enable it, set the RIVER_BASIC_AUTH_USER
and RIVER_BASIC_AUTH_PASS
environment variables.
See developing River UI.