Skip to content

Commit 02bf1be

Browse files
committed
clarify protected calls definition
1 parent 2025fc8 commit 02bf1be

2 files changed

Lines changed: 13 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@
66

77
### Configuration
88

9-
| Command line | Environment | Default | Description |
10-
|--------------|-----------------|----------------|--------------------------------------------|
11-
| address | UKEEPER_ADDRESS | all interfaces | web server listening address |
12-
| port | UKEEPER_PORT | `8080` | web server port |
13-
| mongo_uri | MONGO_URI | none | MongoDB connection string, _required_ |
14-
| frontend_dir | FRONTEND_DIR | `/srv/web` | directory with frontend files |
15-
| token | TOKEN | none | token for /content/v1/parser endpoint auth |
16-
| mongo-delay | MONGO_DELAY | `0` | mongo initial delay |
17-
| mongo-db | MONGO_DB | `ureadability` | mongo database name |
18-
| creds | CREDS | none | credentials for protected calls |
19-
| dbg | DEBUG | `false` | debug mode |
9+
| Command line | Environment | Default | Description |
10+
|--------------|-----------------|----------------|-------------------------------------------------------|
11+
| address | UKEEPER_ADDRESS | all interfaces | web server listening address |
12+
| port | UKEEPER_PORT | `8080` | web server port |
13+
| mongo_uri | MONGO_URI | none | MongoDB connection string, _required_ |
14+
| frontend_dir | FRONTEND_DIR | `/srv/web` | directory with frontend files |
15+
| token | TOKEN | none | token for /content/v1/parser endpoint auth |
16+
| mongo-delay | MONGO_DELAY | `0` | mongo initial delay |
17+
| mongo-db | MONGO_DB | `ureadability` | mongo database name |
18+
| creds | CREDS | none | credentials for protected calls (POST, DELETE /rules) |
19+
| dbg | DEBUG | `false` | debug mode |
2020

2121
### API
2222

@@ -85,6 +85,7 @@ on master (dev version) prefix /ureadability should be added
8585
"user": ""
8686
}
8787
]
88+
8889
</details>
8990

9091
## Development

backend/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ var opts struct {
2121
Address string `long:"address" env:"UKEEPER_ADDRESS" default:"" description:"listening address"`
2222
Port int `long:"port" env:"UKEEPER_PORT" default:"8080" description:"port"`
2323
FrontendDir string `long:"frontend_dir" env:"FRONTEND_DIR" default:"/srv/web" description:"directory with frontend files"`
24-
Credentials map[string]string `long:"creds" env:"CREDS" description:"credentials for protected calls"`
24+
Credentials map[string]string `long:"creds" env:"CREDS" description:"credentials for protected calls (POST, DELETE /rules)"`
2525
Token string `long:"token" env:"UKEEPER_TOKEN" description:"token for /content/v1/parser endpoint auth"`
2626
MongoURI string `short:"m" long:"mongo_uri" env:"MONGO_URI" required:"true" description:"MongoDB connection string"`
2727
MongoDelay time.Duration `long:"mongo-delay" env:"MONGO_DELAY" default:"0" description:"mongo initial delay"`

0 commit comments

Comments
 (0)