GOSTSec/sgminer
1
0
Fork 0
mirror of https://github.com/GOSTSec/sgminer synced 2025-01-10 23:08:07 +00:00
Code Issues Releases Wiki Activity

Update configuration.md

Browse Source
This commit is contained in:
ystarnaud 2014-06-20 08:02:59 -04:00 committed by Noel Maersk
parent bd54c59ff0
commit e7881ff9f7
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/configuration.md
View File

@ -313,7 +313,11 @@ Description placed in the API status header.
### api-groups
Sets API groups which restrict group members to only a certain set of commands. The list of groups is comma(,) delimited and each entry has its parameters colon(:) delimited. The first parameter of an entry is always the Group Identifier, which consists of one letter.
Sets API groups which restrict group members to only a certain set of commands. The list of groups is comma(,) delimited and each entry has its parameters colon(:) delimited. The first parameter of an entry is always the Group Identifier, which consists of one letter. When defining a group, you can use the asterisk (*) to refer to all non-priviledged functions.
Two groups are pre-defined and may not be used with this option:
* `R` Access to all non-priviledged functions
* `W` Access to all priviledged and non-priviledged functions
Group Members are specified in [api-allow](#api-allow) where they are associated with a group by their IP address.
@ -323,17 +327,20 @@ Group Members are specified in [api-allow](#api-allow) where they are associated
*Command Line Syntax:* `--api-groups "<value>"`
*Argument:* `comma (,) delimited list` Format: `<Group ID>:<command>:<command>[:...][,...]`
*Argument:* `comma (,) delimited list` Format: `<Group ID>:<command>:<command>[:*][:...][,...]`
*Default:* `"R"` access read-only commands `"W"` accesses all commands
*Default:* `R` Access to all non-priviledged functions `W` Access to all functions
*Example:*
```
"api-groups":"A:version:devs:summary,B:addpool:removepool:switchpool:gpurestart:gpuenable:gpudisable:save:quit",
"api-groups":"A:addpool:*,B:addpool:removepool:switchpool:gpurestart:gpuenable:gpudisable:save:quit",
"api-allow":"A:192.168.0.10,B:127.0.0.1"
```
The above example grants users of group A access to the addpool function as well as all non-priviledged functions.
Group B users only have access to the following functions: addpool, removepool, switchpool, gpurestart, gpuenable, gpudisable, save, quit.
[Top](#configuration-and-command-line-options) :: [Config-file and CLI options](#config-file-and-cli-options) :: [API Options](#api-options)
### api-listen