Skip to content

Fix documentation of workwebui. #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Lavode wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix documentation of workwebui. #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,9 +251,13 @@ go install github.com/gocraft/work/cmd/workwebui

Then, you can run it:
```bash
workwebui -redis="redis:6379" -ns="work" -listen=":5040"
workwebui -redis="redis://127.0.0.1:6379" -ns="work" -listen=":5040"
```

For the `-redis` parameter, any Redis URI conforming to the
[specification](https://www.iana.org/assignments/uri-schemes/prov/redis) is
allowed - see its ABNF notation or example section for further details.

Navigate to ```http://localhost:5040/```.

You'll see a view that looks like this:
Expand Down
2 changes: 1 addition & 1 deletion cmd/workwebui/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (
)

var (
redisHostPort = flag.String("redis", ":6379", "redis hostport")
redisHostPort = flag.String("redis", "redis://:6379", "redis URI")
redisDatabase = flag.String("database", "0", "redis database")
redisNamespace = flag.String("ns", "work", "redis namespace")
webHostPort = flag.String("listen", ":5040", "hostport to listen for HTTP JSON API")
Expand Down