Add documentation of all server configuration options (#666)

* Added documentation of all configuration options. * sort some flags * adjust config docs to current flags Co-authored-by: 6543 <[email protected]> Co-authored-by: Anton Bracke <[email protected]>
woodpecker-ci · Feb 6, 2022 · 5f79739 · 5f79739
1 parent 6bb9649
commit 5f79739
Show file tree

Hide file tree

Showing 2 changed files with 440 additions and 16 deletions.
diff --git a/cmd/server/flags.go b/cmd/server/flags.go
@@ -60,17 +60,17 @@ var flags = []cli.Flag{
 		Name:    "server-key",
 		Usage:   "server ssl key path",
 	},
+	&cli.BoolFlag{
+		EnvVars: []string{"WOODPECKER_LETS_ENCRYPT"},
+		Name:    "lets-encrypt",
+		Usage:   "enable let's encrypt",
+	},
 	&cli.StringFlag{
 		EnvVars: []string{"WOODPECKER_GRPC_ADDR"},
 		Name:    "grpc-addr",
 		Usage:   "grpc address",
 		Value:   ":9000",
 	},
-	&cli.BoolFlag{
-		EnvVars: []string{"WOODPECKER_LETS_ENCRYPT"},
-		Name:    "lets-encrypt",
-		Usage:   "enable let's encrypt",
-	},
 	&cli.StringSliceFlag{
 		EnvVars: []string{"WOODPECKER_ADMIN"},
 		Name:    "admin",
@@ -130,6 +130,11 @@ var flags = []cli.Flag{
 		Name:    "agent-secret",
 		Usage:   "server-agent shared password",
 	},
+	&cli.DurationFlag{
+		EnvVars: []string{"WOODPECKER_KEEPALIVE_MIN_TIME"},
+		Name:    "keepalive-min-time",
+		Usage:   "server-side enforcement policy on the minimum amount of time a client should wait before sending a keepalive ping.",
+	},
 	&cli.StringFlag{
 		EnvVars: []string{"WOODPECKER_SECRET_ENDPOINT"},
 		Name:    "secret-service",
@@ -163,6 +168,12 @@ var flags = []cli.Flag{
 		Usage:   "token to secure prometheus metrics endpoint",
 		Value:   "",
 	},
+	&cli.StringFlag{
+		EnvVars: []string{"WOODPECKER_STATUS_CONTEXT", "WOODPECKER_GITHUB_CONTEXT", "WOODPECKER_GITEA_CONTEXT"},
+		Name:    "status-context",
+		Usage:   "status context prefix",
+		Value:   "ci/woodpecker",
+	},
 	//
 	// resource limit parameters
 	//
@@ -199,12 +210,6 @@ var flags = []cli.Flag{
 	//
 	// Github
 	//
-	&cli.StringFlag{
-		EnvVars: []string{"WOODPECKER_STATUS_CONTEXT", "WOODPECKER_GITHUB_CONTEXT", "WOODPECKER_GITEA_CONTEXT"},
-		Name:    "status-context",
-		Usage:   "status context prefix",
-		Value:   "ci/woodpecker",
-	},
 	&cli.BoolFlag{
 		EnvVars: []string{"WOODPECKER_GITHUB"},
 		Name:    "github",
@@ -445,11 +450,6 @@ var flags = []cli.Flag{
 		Name:    "coding-skip-verify",
 		Usage:   "coding skip ssl verification",
 	},
-	&cli.DurationFlag{
-		EnvVars: []string{"WOODPECKER_KEEPALIVE_MIN_TIME"},
-		Name:    "keepalive-min-time",
-		Usage:   "server-side enforcement policy on the minimum amount of time a client should wait before sending a keepalive ping.",
-	},
 	//
 	// development flags
 	//