2021-09-22 20:48:01 +02: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.
|
|
|
|
//
|
|
|
|
// This file has been modified by Informatyka Boguslawski sp. z o.o. sp.k.
|
|
|
|
|
|
|
|
package server
|
|
|
|
|
|
|
|
import (
|
2022-06-01 20:06:27 +02:00
|
|
|
"crypto"
|
2021-09-22 20:48:01 +02:00
|
|
|
"time"
|
|
|
|
|
2022-07-25 03:09:35 +02:00
|
|
|
"github.com/woodpecker-ci/woodpecker/server/cache"
|
2022-11-05 01:35:06 +02:00
|
|
|
"github.com/woodpecker-ci/woodpecker/server/forge"
|
2021-09-23 22:29:09 +02:00
|
|
|
"github.com/woodpecker-ci/woodpecker/server/logging"
|
2021-09-27 19:51:55 +02:00
|
|
|
"github.com/woodpecker-ci/woodpecker/server/model"
|
2022-06-01 20:06:27 +02:00
|
|
|
"github.com/woodpecker-ci/woodpecker/server/plugins/config"
|
2021-09-23 22:29:09 +02:00
|
|
|
"github.com/woodpecker-ci/woodpecker/server/pubsub"
|
|
|
|
"github.com/woodpecker-ci/woodpecker/server/queue"
|
2021-09-22 20:48:01 +02:00
|
|
|
)
|
|
|
|
|
|
|
|
var Config = struct {
|
|
|
|
Services struct {
|
2022-06-01 20:06:27 +02:00
|
|
|
Pubsub pubsub.Publisher
|
|
|
|
Queue queue.Queue
|
|
|
|
Logs logging.Log
|
|
|
|
Secrets model.SecretService
|
|
|
|
Registries model.RegistryService
|
|
|
|
Environ model.EnvironService
|
2022-11-05 01:35:06 +02:00
|
|
|
Forge forge.Forge
|
2023-02-01 19:53:19 +02:00
|
|
|
Timeout time.Duration
|
2022-07-25 03:09:35 +02:00
|
|
|
Membership cache.MembershipService
|
2022-06-01 20:06:27 +02:00
|
|
|
ConfigService config.Extension
|
|
|
|
SignaturePrivateKey crypto.PrivateKey
|
|
|
|
SignaturePublicKey crypto.PublicKey
|
2021-09-22 20:48:01 +02:00
|
|
|
}
|
|
|
|
Storage struct {
|
|
|
|
// Users model.UserStore
|
|
|
|
// Repos model.RepoStore
|
|
|
|
// Builds model.BuildStore
|
|
|
|
// Logs model.LogStore
|
2022-10-28 17:38:53 +02:00
|
|
|
Steps model.StepStore
|
2021-09-22 20:48:01 +02:00
|
|
|
// Registries model.RegistryStore
|
|
|
|
// Secrets model.SecretStore
|
|
|
|
}
|
|
|
|
Server struct {
|
2022-05-12 19:07:33 +02:00
|
|
|
Key string
|
|
|
|
Cert string
|
|
|
|
OAuthHost string
|
|
|
|
Host string
|
2023-06-18 14:47:40 +02:00
|
|
|
WebhookHost string
|
2022-05-12 19:07:33 +02:00
|
|
|
Port string
|
2023-05-11 06:11:10 +02:00
|
|
|
PortTLS string
|
2023-01-28 15:13:04 +02:00
|
|
|
AgentToken string
|
2022-05-12 19:07:33 +02:00
|
|
|
Docs string
|
|
|
|
StatusContext string
|
|
|
|
StatusContextFormat string
|
|
|
|
SessionExpires time.Duration
|
2023-08-07 16:05:18 +02: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 12:46:35 +02:00
|
|
|
CustomCSSFile string
|
|
|
|
CustomJsFile string
|
2023-06-12 22:43:14 +02:00
|
|
|
Migrations struct {
|
|
|
|
AllowLong bool
|
|
|
|
}
|
2023-08-03 02:42:30 +02:00
|
|
|
EnableSwagger bool
|
2021-09-22 20:48:01 +02:00
|
|
|
// Open bool
|
|
|
|
// Orgs map[string]struct{}
|
|
|
|
// Admins map[string]struct{}
|
|
|
|
}
|
|
|
|
Prometheus struct {
|
|
|
|
AuthToken string
|
|
|
|
}
|
|
|
|
Pipeline struct {
|
2022-05-09 11:26:09 +02:00
|
|
|
AuthenticatePublicRepos bool
|
|
|
|
DefaultCancelPreviousPipelineEvents []model.WebhookEvent
|
|
|
|
DefaultCloneImage string
|
|
|
|
Limits model.ResourceLimit
|
|
|
|
Volumes []string
|
|
|
|
Networks []string
|
|
|
|
Privileged []string
|
2023-03-19 21:24:43 +02:00
|
|
|
DefaultTimeout int64
|
|
|
|
MaxTimeout int64
|
2023-08-07 21:13:26 +02:00
|
|
|
Proxy struct {
|
|
|
|
No string
|
|
|
|
HTTP string
|
|
|
|
HTTPS string
|
|
|
|
}
|
2021-09-22 20:48:01 +02:00
|
|
|
}
|
|
|
|
}{}
|