mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-12-12 08:23:48 +02:00
2c1fc4b500
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.  ### 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.
95 lines
2.9 KiB
Go
95 lines
2.9 KiB
Go
// 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 (
|
|
"crypto"
|
|
"time"
|
|
|
|
"github.com/woodpecker-ci/woodpecker/server/cache"
|
|
"github.com/woodpecker-ci/woodpecker/server/forge"
|
|
"github.com/woodpecker-ci/woodpecker/server/logging"
|
|
"github.com/woodpecker-ci/woodpecker/server/model"
|
|
"github.com/woodpecker-ci/woodpecker/server/plugins/config"
|
|
"github.com/woodpecker-ci/woodpecker/server/pubsub"
|
|
"github.com/woodpecker-ci/woodpecker/server/queue"
|
|
)
|
|
|
|
var Config = struct {
|
|
Services struct {
|
|
Pubsub pubsub.Publisher
|
|
Queue queue.Queue
|
|
Logs logging.Log
|
|
Secrets model.SecretService
|
|
Registries model.RegistryService
|
|
Environ model.EnvironService
|
|
Forge forge.Forge
|
|
Timeout time.Duration
|
|
Membership cache.MembershipService
|
|
ConfigService config.Extension
|
|
SignaturePrivateKey crypto.PrivateKey
|
|
SignaturePublicKey crypto.PublicKey
|
|
}
|
|
Storage struct {
|
|
// Users model.UserStore
|
|
// Repos model.RepoStore
|
|
// Builds model.BuildStore
|
|
// Logs model.LogStore
|
|
Steps model.StepStore
|
|
// Registries model.RegistryStore
|
|
// Secrets model.SecretStore
|
|
}
|
|
Server struct {
|
|
Key string
|
|
Cert string
|
|
OAuthHost string
|
|
Host string
|
|
WebhookHost string
|
|
Port string
|
|
PortTLS string
|
|
AgentToken string
|
|
Docs string
|
|
StatusContext string
|
|
StatusContextFormat string
|
|
SessionExpires time.Duration
|
|
RootURL string
|
|
CustomCSSFile string
|
|
CustomJsFile string
|
|
Migrations struct {
|
|
AllowLong bool
|
|
}
|
|
// Open bool
|
|
// Orgs map[string]struct{}
|
|
// Admins map[string]struct{}
|
|
}
|
|
Prometheus struct {
|
|
AuthToken string
|
|
}
|
|
Pipeline struct {
|
|
AuthenticatePublicRepos bool
|
|
DefaultCancelPreviousPipelineEvents []model.WebhookEvent
|
|
DefaultCloneImage string
|
|
Limits model.ResourceLimit
|
|
Volumes []string
|
|
Networks []string
|
|
Privileged []string
|
|
DefaultTimeout int64
|
|
MaxTimeout int64
|
|
}
|
|
}{}
|