vmario/fabaccess-docs
1
0
Fork 0
mirror of https://gitlab.com/fabinfra/fabaccess/docs.git synced 2024-12-22 20:13:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update Get it Running - Step by Step.md

Browse Source
This commit is contained in:
Joris 2021-12-23 14:03:45 +00:00
parent c7f3f32ed2
commit 47aa65b98b
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
source/usage/Get it Running - Step by Step.md
View File

@ -175,11 +175,11 @@ The simple Shellies (1, 1pm, 2.5) have an internal timer "AUTO-OFF" which can be
Go to "Timer" and set the "AUTO-OFF" to e.g. 3 seconds.<br> Go to "Timer" and set the "AUTO-OFF" to e.g. 3 seconds.<br>
Define a machine called "door" in the bffh.dhall<br> Define a machine called "door" in the bffh.dhall<br>
-define the actor:<br> - define the actor:<br>
`shelly1-123456789ABC = { module = "Shelly", params = {=}}`<br> `shelly1-123456789ABC = { module = "Shelly", params = {=}}`<br>
-define the machine:<br> - define the machine:<br>
`{ machine = "door", actor = "shelly1-123456789ABC" }` <br> `{ machine = "door", actor = "shelly1-123456789ABC" }` <br>
-set permissions for the machine:<br> - set permissions for the machine:<br>
`door =` <br> `door =` <br>
` { description = Some "close it firmly"`<br> ` { description = Some "close it firmly"`<br>
` , disclose = "lab.door.disclose"`<br> ` , disclose = "lab.door.disclose"`<br>
@ -188,7 +188,7 @@ Define a machine called "door" in the bffh.dhall<br>
` , read = "lab.door.read"`<br> ` , read = "lab.door.read"`<br>
` , write = "lab.door.write"`<br> ` , write = "lab.door.write"`<br>
` },`<br> ` },`<br>
-create a role having ALL permissions to the door - create a role having ALL permissions to the door
`DoorUser =`<br> `DoorUser =`<br>
`{ permissions = `<br> `{ permissions = `<br>
`[ "lab.door.write"` - allows the user to use the door<br> `[ "lab.door.write"` - allows the user to use the door<br>
@ -196,4 +196,7 @@ Define a machine called "door" in the bffh.dhall<br>
`, "lab.door.disclose"` - allows the user to see the machine in the machine overview<br> `, "lab.door.disclose"` - allows the user to see the machine in the machine overview<br>
`, "lab.door.admin"`<br> `, "lab.door.admin"`<br>
`]`<br> `]`<br>
-assign the role DoorUser to all users - assign the role DoorUser/internal to all users
It is imporatant all users have admin aka manage permissions, as the request to open the door by a user, thet the door "in Use" by this user. The door can only be re-activated when the previous user "un-uses" the door or if an othe user can "force free" the door prior to using the door hin/herself
**Note** in this special case, where all users will need admin capabilities the role could also contain only the permission `lab.door.use` and all permissions (disclos, manage, read, write) assigned to the machine would simply match `lab.door.use` (e.g. disclose = "lab.door.use"`).