Skip to content

Commit

Permalink
docs: add section about network admins
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremylvln committed Nov 2, 2023
1 parent 1bdac2f commit 471960c
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/src/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ const sidebar = {
text: 'Overriding pod properties',
link: '/guide/recipes/overriding-pod-properties',
},
{
text: 'Defining network administrators',
link: '/guide/recipes/defining-network-administrators',
},
],
},
],
Expand Down
26 changes: 26 additions & 0 deletions docs/src/guide/recipes/defining-network-administrators.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Defining Network administrators

You can define a list of player UUIDs to consider _Network
Administrators_. These players will be granted all permissions
on the proxies and servers. This is mostly to ease maintainance
on the entire cluster.

:::danger

These players will be granted the most rights possible, please
act wisely when adding players to this list!

:::

To set the list of network administrators, set the `networkAdmins`
option in your cluster:

```yaml
apiVersion: shulkermc.io/v1alpha1
kind: MinecraftCluster
metadata:
name: cluster
spec:
networkAdmins: // [!code focus]
- 29b2b527-1b59-45df-b7b0-d5ab20d8731a // [!code focus]
```
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ spec:
items:
type: string
type: array
uniqueItems: true
redis:
description: Redis configuration to use as a synchronization backend for the different Shulker components
nullable: true
Expand Down

0 comments on commit 471960c

Please sign in to comment.