2021-09-22 18:48:01 +00:00
|
|
|
// Copyright 2018 Drone.IO Inc.
|
|
|
|
// Copyright 2021 Informatyka Boguslawski sp. z o.o. sp.k., http://www.ib.pl/
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
|
|
|
package server
|
|
|
|
|
|
|
|
import (
|
|
|
|
"time"
|
|
|
|
|
2024-12-22 09:44:34 +00:00
|
|
|
"go.woodpecker-ci.org/woodpecker/v3/server/cache"
|
|
|
|
"go.woodpecker-ci.org/woodpecker/v3/server/logging"
|
|
|
|
"go.woodpecker-ci.org/woodpecker/v3/server/model"
|
|
|
|
"go.woodpecker-ci.org/woodpecker/v3/server/pubsub"
|
|
|
|
"go.woodpecker-ci.org/woodpecker/v3/server/queue"
|
|
|
|
"go.woodpecker-ci.org/woodpecker/v3/server/services"
|
|
|
|
"go.woodpecker-ci.org/woodpecker/v3/server/services/log"
|
|
|
|
"go.woodpecker-ci.org/woodpecker/v3/server/services/permissions"
|
2021-09-22 18:48:01 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
var Config = struct {
|
|
|
|
Services struct {
|
2024-02-11 17:42:33 +00:00
|
|
|
Pubsub *pubsub.Publisher
|
|
|
|
Queue queue.Queue
|
|
|
|
Logs logging.Log
|
|
|
|
Membership cache.MembershipService
|
2024-04-16 06:04:55 +00:00
|
|
|
Manager services.Manager
|
2024-06-06 12:34:57 +00:00
|
|
|
LogStore log.Service
|
2021-09-22 18:48:01 +00:00
|
|
|
}
|
|
|
|
Server struct {
|
2024-06-27 14:52:09 +00:00
|
|
|
JWTSecret string
|
2022-05-12 17:07:33 +00:00
|
|
|
Key string
|
|
|
|
Cert string
|
|
|
|
OAuthHost string
|
|
|
|
Host string
|
2023-06-18 12:47:40 +00:00
|
|
|
WebhookHost string
|
2022-05-12 17:07:33 +00:00
|
|
|
Port string
|
2023-05-11 04:11:10 +00:00
|
|
|
PortTLS string
|
2023-01-28 13:13:04 +00:00
|
|
|
AgentToken string
|
2022-05-12 17:07:33 +00:00
|
|
|
StatusContext string
|
|
|
|
StatusContextFormat string
|
|
|
|
SessionExpires time.Duration
|
2023-08-07 14:05:18 +00:00
|
|
|
RootPath string
|
support custom .JS and .CSS files for custom banner messages (white-labeling) (#1781)
This PR introduces two new server configuration options, for providing a
custom .JS and .CSS file.
These can be used to show custom banner messages, add
environment-dependent signals, or simply a corporate logo.
### Motivation (what problem I try to solve)
I'm operating Woodpecker in multiple k8s clusters for different
environments.
When having multiple browser tabs open, I prefer strong indicators for
each environment.
E.g. a red "PROD" banner, or just a blue "QA" banner.
Also, we sometimes need to have the chance for maintenance, and instead
of broadcasting emails,
I prefer a banner message, stating something like: "Heads-up: there's a
planned downtime, next Friday, blabla...".
Also, I like to have the firm's logo visible, which makes Woodpecker
look more like an integral part of our platform.
### Implementation notes
* Two new config options are introduced ```WOODPECKER_CUSTOM_CSS_FILE```
and ```WOODPECKER_CUSTOM_JS_FILE```
* I've piggy-bagged the existing handler for assets, as it seemed to me
a minimally invasive approach
* the option along with an example is documented
* a simple unit test for the Gin-handler ensures some regression safety
* no extra dependencies are introduced
### Visual example
The documented example will look like this.
![Screenshot 2023-05-27 at 17 00
44](https://github.com/woodpecker-ci/woodpecker/assets/1189394/8940392e-463c-4651-a1eb-f017cd3cd64d)
### Areas of uncertainty
This is my first contribution to Woodpecker and I tried my best to align
with your conventions.
That said, I found myself uncertain about these things and would be glad
about getting feedback.
* The handler tests are somewhat different than the other ones because I
wanted to keep them simple - I hope that still matches your coding
guidelines
* caching the page sometimes will let the browser not recognize changes
and a user must reload. I'm not fully into the details of how caching is
implemented and neither can judge if it's a real problem. Another pair
of eyes would be good.
2023-07-10 10:46:35 +00:00
|
|
|
CustomCSSFile string
|
|
|
|
CustomJsFile string
|
2023-12-27 21:16:15 +00:00
|
|
|
}
|
2024-11-11 17:51:14 +00:00
|
|
|
Agent struct {
|
|
|
|
DisableUserRegisteredAgentRegistration bool
|
|
|
|
}
|
2023-12-27 21:16:15 +00:00
|
|
|
WebUI struct {
|
|
|
|
EnableSwagger bool
|
|
|
|
SkipVersionCheck bool
|
2021-09-22 18:48:01 +00:00
|
|
|
}
|
|
|
|
Prometheus struct {
|
|
|
|
AuthToken string
|
|
|
|
}
|
|
|
|
Pipeline struct {
|
2022-05-09 09:26:09 +00:00
|
|
|
AuthenticatePublicRepos bool
|
|
|
|
DefaultCancelPreviousPipelineEvents []model.WebhookEvent
|
2024-11-14 21:23:42 +00:00
|
|
|
DefaultWorkflowLabels map[string]string
|
2024-09-01 18:41:10 +00:00
|
|
|
DefaultClonePlugin string
|
|
|
|
TrustedClonePlugins []string
|
2022-05-09 09:26:09 +00:00
|
|
|
Volumes []string
|
|
|
|
Networks []string
|
2024-08-31 17:04:47 +00:00
|
|
|
PrivilegedPlugins []string
|
2023-03-19 19:24:43 +00:00
|
|
|
DefaultTimeout int64
|
|
|
|
MaxTimeout int64
|
2023-08-07 19:13:26 +00:00
|
|
|
Proxy struct {
|
|
|
|
No string
|
|
|
|
HTTP string
|
|
|
|
HTTPS string
|
|
|
|
}
|
2021-09-22 18:48:01 +00:00
|
|
|
}
|
2023-11-12 13:39:41 +00:00
|
|
|
Permissions struct {
|
|
|
|
Open bool
|
|
|
|
Admins *permissions.Admins
|
|
|
|
Orgs *permissions.Orgs
|
|
|
|
OwnersAllowlist *permissions.OwnersAllowlist
|
|
|
|
}
|
2021-09-22 18:48:01 +00:00
|
|
|
}{}
|