README
¶
FestivalsApp Server Tools
The festivals server tools repository contains server functions shared between server components of the FestivalsApp.
Development • Deployment • Engage
Development
This repository serves as a toolkit for shared functionality among the server components of the FestivalsApp.
It consolidates common tasks like sending a heartbeat to the festivals-gateway,
updating server binaries from GitHub, responding to client requests, and more. By centralizing these functions,
the repository reduces code duplication, simplifies maintenance, and makes refactoring easier.
See the DOCUMENTATION for more information about the components of the servertools package.
The development of festivals-server-tools is closely tied to the specific functionality it supports.
For example, the heartbeat sender implementation relies heavily on the festivals-gateway
implementation, whereas the response tools are designed to operate independently of other project components.
Each task is designed to minimize dependencies, ensuring the tools remain lightweight and efficient.
However, direct imports from any other FestivalsApp components are strictly prohibited.
Requirements
- Golang Version 1.24.1+
- Visual Studio Code 1.99.2+
- Plugin recommendations are managed via workspace recommendations.
- Bash script friendly environment
Deployment
Add the festivals-server-tools to your go project by running this command
go get github.com/festivals-app/festivals-server-tools
Engage
I welcome every contribution, whether it is a pull request or a fixed typo. The best place to discuss questions and suggestions regarding the festivals-server-tools is the issues section. More general information and a good starting point if you want to get involved is the festival-documentation repository.
The following channels are available for discussions, feedback, and support requests:
| Type | Channel |
|---|---|
| General Discussion |  |
| Other Requests |  |
Licensing
Copyright (c) 2023-2025 Simon Gaus. Licensed under the GNU Lesser General Public License v3.0
Documentation
¶
Index ¶
- func ContainerPathArgument() string
- func DebugArgument() bool
- func ExpandTilde(path string) string
- func FileExists(filename string) bool
- func GetFileContentType(file *os.File) (string, error)
- func HeartbeatClient(clientCert string, clientKey string, serverCA string) (*http.Client, error)
- func InitializeGlobalLogger(logfile string, console bool)
- func LatestVersion(organisation string, repository string) (string, error)
- func Middleware(traceLogger *zerolog.Logger) func(next http.Handler) http.Handler
- func NewRollingFile(file string) (io.Writer, error)
- func RespondCode(w http.ResponseWriter, code int)
- func RespondError(w http.ResponseWriter, code int, message string)
- func RespondFile(w http.ResponseWriter, file *os.File)
- func RespondJSON(w http.ResponseWriter, status int, payload interface{})
- func RespondString(w http.ResponseWriter, code int, message string)
- func RunUpdate(currentVersion string, organisation string, repository string, ...) (string, error)
- func SendHeartbeat(client *http.Client, endpoint string, serviceKey string, beat *Heartbeat) error
- func TraceLogger(logfile string) *zerolog.Logger
- func UnauthorizedResponse(w http.ResponseWriter)
- type Heartbeat
- type Service
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ContainerPathArgument ¶ added in v0.0.6
func ContainerPathArgument() string
Checks if the binary was executed with the --container="/path/to/container" argument and returns the specified path or an empty string.
func DebugArgument ¶ added in v0.0.7
func DebugArgument() bool
Checks if the binary was executed with the --debug argument.
func ExpandTilde ¶ added in v0.0.7
ExpandTilde expands a leading tilde (~) to the user's home directory who runs the binary.
func FileExists ¶
Checks if a file exists and isn't a directory. see: https://golangcode.com/check-if-a-file-exists/
func HeartbeatClient ¶
func InitializeGlobalLogger ¶
func LatestVersion ¶ added in v0.0.2
func RespondCode ¶
func RespondCode(w http.ResponseWriter, code int)
func RespondError ¶
func RespondError(w http.ResponseWriter, code int, message string)
func RespondFile ¶ added in v0.0.10
func RespondFile(w http.ResponseWriter, file *os.File)
respondFile makes the response with payload as json format
func RespondJSON ¶
func RespondJSON(w http.ResponseWriter, status int, payload interface{})
func RespondString ¶
func RespondString(w http.ResponseWriter, code int, message string)
func SendHeartbeat ¶
func TraceLogger ¶
func UnauthorizedResponse ¶ added in v0.0.3
func UnauthorizedResponse(w http.ResponseWriter)
Source Files