Skip to content

Commit 5d5ac56

Browse files
authored
Merge pull request #1997 from jhiemstrawisc/issue-1803
Update Server.XYZ docs to include all server components
2 parents 8dbab66 + c9bdf66 commit 5d5ac56

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/parameters.yaml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2062,6 +2062,7 @@ description: |+
20622062
A list of modules to enable when running pelican in `pelican serve` mode.
20632063
type: stringSlice
20642064
default: []
2065+
hidden: true
20652066
components: ["*"]
20662067
---
20672068
name: Server.UIActivationCodeFile
@@ -2070,14 +2071,14 @@ description: |+
20702071
contain the activation code necessary to turn it on.
20712072
type: filename
20722073
default: $ConfigBase/server-web-activation-code
2073-
components: ["origin", "cache", "registry", "director"]
2074+
components: ["cache", "director", "origin", "registry"]
20742075
---
20752076
name: Server.UIPasswordFile
20762077
description: |+
20772078
A filepath specifying where the server's web UI password file should be stored.
20782079
type: filename
20792080
default: $ConfigBase/server-web-passwd
2080-
components: ["origin", "cache", "registry", "director"]
2081+
components: ["cache", "director", "origin", "registry"]
20812082
---
20822083
name: Server.SessionSecretFile
20832084
description: |+
@@ -2088,30 +2089,30 @@ description: |+
20882089
type: filename
20892090
default: $ConfigBase/session-secret
20902091
The default content of the file is the hash of the concatenation of "pelican" and the DER form of ${IssuerKey}
2091-
components: ["registry", "director"]
2092+
components: ["cache", "director", "origin", "registry"]
20922093
---
20932094
name: Server.RegistrationRetryInterval
20942095
description: |+
20952096
The duration of delay in origin/cache registration retry attempts if the initial registration call to registry
20962097
was failed.
20972098
type: duration
20982099
default: 10s
2099-
components: ["origin", "cache"]
2100+
components: ["cache", "origin"]
21002101
---
21012102
name: Server.UILoginRateLimit
21022103
description: |+
21032104
The maximum number of requests a user can be made under the same IP address per second against the login endpoint
21042105
type: int
21052106
default: 1
2106-
components: ["*"]
2107+
components: ["cache", "director", "origin", "registry"]
21072108
---
21082109
name: Server.WebConfigFile
21092110
description: |+
21102111
A filepath to the file where web-based configuration changes are stored
21112112
type: filename
21122113
root_default: /etc/pelican/web-config.yaml
21132114
default: "$ConfigBase/web-config.yaml"
2114-
components: ["*"]
2115+
components: ["cache", "director", "origin", "registry"]
21152116
---
21162117
name: Server.UIAdminUsers
21172118
description: |+
@@ -2121,22 +2122,22 @@ description: |+
21212122
The "subject" claim should be the "CILogon User Identifier" from CILogon user page: https://cilogon.org/
21222123
type: stringSlice
21232124
default: []
2124-
components: ["registry", "origin", "cache"]
2125+
components: ["cache", "director", "origin", "registry"]
21252126
---
21262127
name: Server.StartupTimeout
21272128
description: |+
21282129
The amount of time the pelican server will wait for its components and services to startup.
21292130
If the timeout is hit while waiting on a component, the server will shutdown.
21302131
type: duration
21312132
default: 10s
2132-
components: ["origin", "cache", "registry", "director"]
2133+
components: ["cache", "director", "origin", "registry"]
21332134
---
21342135
name: Server.EnablePprof
21352136
description: |+
21362137
A boolean to enable or disable the [pprof](https://pkg.go.dev/runtime/pprof) endpoints for debugging.
21372138
type: bool
21382139
default: false
2139-
components: ["*"]
2140+
components: ["cache", "director", "origin", "registry"]
21402141
---
21412142
################################
21422143
# Issuer's Configurations #

0 commit comments

Comments
 (0)