Class ServerBuilder

Constructors

constructor

new ServerBuilder(): ServerBuilder
Returns ServerBuilder
- Defined in src/builder/ServerBuilder.ts:44

Methods

addAdditionalAllocation

addAdditionalAllocation(allocation): ServerBuilder
Add a allocation id to this server
Parameters
- allocation: NodeAllocation
Returns ServerBuilder
Optional
- Defined in src/builder/ServerBuilder.ts:174

addAdditionalAllocationId

addAdditionalAllocationId(id): ServerBuilder
Add a allocation id to this server
Parameters
- id: number
Returns ServerBuilder
Optional
- Defined in src/builder/ServerBuilder.ts:165

addEnvironmentVariable

addEnvironmentVariable(key, value): ServerBuilder
Add environment vars with which the server will start
Parameters
- key: string
- value: string
Returns ServerBuilder
Default
```
environment This will use the default environment if you set the egg via .setEgg(egg: PanelEgg)
```
- Defined in src/builder/ServerBuilder.ts:371

enableOOM

enableOOM(enabled): ServerBuilder
Enable the OOM killer
This will kill the server if it exceeds the memory limit
This may cause the server processes to exit unexpectedly
This CAN cause to data corruption
Parameters
- enabled: boolean
Returns ServerBuilder
Default
```
false
```
- Defined in src/builder/ServerBuilder.ts:281

setAdditionalAllocationIds

setAdditionalAllocationIds(allocationIds): ServerBuilder
Add additional allocation ids to this server
Parameters
- allocationIds: number[]
Returns ServerBuilder
Optional
- Defined in src/builder/ServerBuilder.ts:155

setAdditionalAllocations

setAdditionalAllocations(allocations): ServerBuilder
Add additional allocations to this server
Parameters
- allocations: NodeAllocation[]
Returns ServerBuilder
Optional
- Defined in src/builder/ServerBuilder.ts:145

setAllocation

setAllocation(allocation): ServerBuilder
The default allocation for this server
Parameters
- allocation: NodeAllocation
  The allocation you want to assign
Returns ServerBuilder
- Defined in src/builder/ServerBuilder.ts:127

setAllocationId

setAllocationId(allocation_id): ServerBuilder
The default allocation for this server
Parameters
- allocation_id: number
  The allocation id you want to assign
Returns ServerBuilder
- Defined in src/builder/ServerBuilder.ts:136

setAllocationLimit

setAllocationLimit(maxAllocations): ServerBuilder
Set how many allocations can be created for this server
Parameters
- maxAllocations: number
Returns ServerBuilder
Default
```
0
```
- Defined in src/builder/ServerBuilder.ts:192

setBackupLimit

setBackupLimit(maxBackups): ServerBuilder
Set how many backups can be created for this server
Parameters
- maxBackups: number
Returns ServerBuilder
Default
```
0
```
- Defined in src/builder/ServerBuilder.ts:201

setCpuLimit

setCpuLimit(cpuLimit): ServerBuilder
Set the maximum cpu usage for this server
Set this to 0 for no cpu limit
If you have 4 cores and want to allow to use all of them you'll need to use 400
Example: 4 * 100 = 400 | Cores * 100 = Max for this node
Parameters
- cpuLimit: number
  in %
Returns ServerBuilder
Default
```
0
```
- Defined in src/builder/ServerBuilder.ts:216

setCpuPinning

setCpuPinning(pinning): ServerBuilder
Set which cores can be used by a server
Example: 0; 1-3; 4,5,6;
Parameters
- pinning: string | (string | number)[]
Returns ServerBuilder
Optional
Default
```
undefined
```
- Defined in src/builder/ServerBuilder.ts:227

setCustomImage

setCustomImage(custom_image): ServerBuilder
Set a custom docker image
Parameters
- custom_image: string
Returns ServerBuilder
Default
```
custom_image undefined
```
- Defined in src/builder/ServerBuilder.ts:343

setDatabaseLimit

setDatabaseLimit(maxDatabases): ServerBuilder
Set how many databases can be created for this server
Parameters
- maxDatabases: number
Returns ServerBuilder
Default
```
0
```
- Defined in src/builder/ServerBuilder.ts:183

setDescription

setDescription(description): ServerBuilder
Parameters
- description: string
  Set the description for this server
Returns ServerBuilder
Optional
- Defined in src/builder/ServerBuilder.ts:82

setDiskLimit

setDiskLimit(diskLimit): ServerBuilder
Set the disk limit for this server
Parameters
- diskLimit: number
  in MiB
Returns ServerBuilder
Default
```
0
```
- Defined in src/builder/ServerBuilder.ts:257

setDockerImage

setDockerImage(image): ServerBuilder
Set the docker image to in which the server will start
Parameters
- image: string
Returns ServerBuilder
Default
```
image This will use the default image if you set the egg via .setEgg(egg: PanelEgg)
```
- Defined in src/builder/ServerBuilder.ts:334

setEgg

setEgg(egg): ServerBuilder
Set the egg for this server
When not set as id this will also set the docker image, the startup command and the variables to their default values
Parameters
- egg: number | Egg
  The egg id or the egg as object
Returns ServerBuilder
- Defined in src/builder/ServerBuilder.ts:300

setEggId

setEggId(egg): ServerBuilder
Manually set the egg id
Parameters
- egg: number
Returns ServerBuilder
- Defined in src/builder/ServerBuilder.ts:315

setEnvironment

setEnvironment(environment): ServerBuilder
Set the environment vars with which the server will start
Parameters
- environment: {
  [environment: string]: string;
  }
  - [environment: string]: string
Returns ServerBuilder
Default
```
environment This will use the default environment if you set the egg via .setEgg(egg: PanelEgg)
```
- Defined in src/builder/ServerBuilder.ts:362

setIoLimit

setIoLimit(ioLimit): ServerBuilder
[ADVANCED]
Set the io limit for this server
Documentation: https://docs.docker.com/engine/reference/run/#block-io-bandwidth-blkio-constraint
Parameters
- ioLimit: number
  between 10 and 1000
Returns ServerBuilder
Default
```
0
```
- Defined in src/builder/ServerBuilder.ts:269

setMemoryLimit

setMemoryLimit(memoryLimit): ServerBuilder
Set the memory limit for this server
Parameters
- memoryLimit: number
  in MiB
Returns ServerBuilder
Default
```
0
```
- Defined in src/builder/ServerBuilder.ts:237

setName

setName(name): ServerBuilder
Parameters
- name: string
  The name for this server
Returns ServerBuilder
- Defined in src/builder/ServerBuilder.ts:74

setNestId

setNestId(nest_id): ServerBuilder
Set the nest id for this server
Parameters
- nest_id: number
Returns ServerBuilder
Deprecated
This will be set by the egg (id)
- Defined in src/builder/ServerBuilder.ts:290

setNodeId

setNodeId(node_id): ServerBuilder
Set the node for this server
Parameters
- node_id: number
Returns ServerBuilder
Optional
Deprecated
You'll set the node by the allocation (id)
- Defined in src/builder/ServerBuilder.ts:118

setOwner

setOwner(user): ServerBuilder
Parameters
- user: PanelUser
  The user that will own this server
Returns ServerBuilder
- Defined in src/builder/ServerBuilder.ts:90

setOwnerId

setOwnerId(user): ServerBuilder
Parameters
- user: number
  The user's id that will own this server
Returns ServerBuilder
- Defined in src/builder/ServerBuilder.ts:98

setSkipInstall

setSkipInstall(skip): ServerBuilder
Should the server skip the install process
Using this will likely prevent the server from starting after the creation
Parameters
- skip: boolean
Returns ServerBuilder
Default
```
false
```
- Defined in src/builder/ServerBuilder.ts:325

setStartup

setStartup(startup): ServerBuilder
Set the startup command with which the server will start
This can include environment vars via {{ VAR_NAME }}
Parameters
- startup: string
Returns ServerBuilder
Default
```
startup This will use the default startup command if you set the egg via .setEgg(egg: PanelEgg)
```
- Defined in src/builder/ServerBuilder.ts:353

setSwapLimit

setSwapLimit(swapLimit): ServerBuilder
Set the swap limit for this server
Parameters
- swapLimit: number
  in MiB
Returns ServerBuilder
Default
```
0
```
- Defined in src/builder/ServerBuilder.ts:247

startServerWhenInstalled

startServerWhenInstalled(start): ServerBuilder
Should the server autostart when the server is done with the install process
Parameters
- start: boolean
Returns ServerBuilder
Optional
Default
```
start true
```
- Defined in src/builder/ServerBuilder.ts:108