pufferpanel

package module

Go to main page

Versions in this module

v2

v2.7.1

Mar 30, 2024

v2.7.0

Mar 27, 2024

Changes in this version

+ func DetermineKernelSupport()

+ func UseOpenat2() bool

+ type FileServer interface

+ Close func() error

+ Mkdir func(path string, mode os.FileMode) error

+ MkdirAll func(path string, mode os.FileMode) error

+ OpenFile func(path string, flags int, mode os.FileMode) (*os.File, error)

+ Prefix func() string

+ Remove func(path string) error

+ RemoveAll func(path string) error

+ Rename func(source, target string) error

+ Stat func(name string) (fs.FileInfo, error)

+ func NewFileServer(prefix string) (FileServer, error)

v2.6.10

Nov 1, 2023

v2.6.9

Jul 30, 2023

v2.6.8

Jul 24, 2023

Changes in this version

type MemoryCache

+ Lock sync.Locker

v2.6.7

Jun 29, 2023

v2.6.6

Mar 1, 2023

v2.6.5

Feb 21, 2023

v2.6.4

Feb 21, 2023

v2.6.3

Feb 20, 2023

v2.6.2

Jan 6, 2023

v2.6.1

Jan 5, 2023

v2.6.0

Jan 3, 2023

Changes in this version

+ func ExtractDeb(stream io.ReaderAt, directory string) error

+ func ExtractTar(stream io.Reader, directory string) error

+ func ExtractTarGz(gzipStream io.Reader, directory string) error

+ func ExtractZip(name, directory string) error

+ func Http() *http.Client

+ func HttpDownloadDeb(link, folder string) error

+ func HttpGet(url string) (*http.Response, error)

+ func HttpGetTarGz(url, directory string) error

+ func HttpGetZip(url, directory string) error

type BaseEnvironment

+ ServerId string

+ func (e *BaseEnvironment) Log(l *log.Logger, format string, obj ...interface{})

+ type DaemonRunning struct

+ Message string

type Scope

+ func (s Scope) Matches(string string) bool

+ func (s Scope) String() string

v2.5.2

Oct 25, 2022

v2.5.1

Jun 29, 2022

v2.5.0

May 26, 2022

Changes in this version

+ var ErrDockerNotSupported = CreateError("docker not supported", "ErrDockerNotSupported")

+ var ErrMissingBinary = func(expected string) *Error

+ var ErrUnsupportedArch = func(actual, expected string) *Error

+ var ErrUnsupportedOS = func(actual, expected string) *Error

+ func GetHostname(requestHost string) string

+ type Requirements struct

+ Arch string

+ Binaries []string

+ OS string

+ func (r Requirements) Test(server Server) error

type Server

+ Requirements Requirements

+ SupportedEnvironments []interface{}

+ func (s Server) DataToMap() map[string]interface{}

v2.4.0

Dec 8, 2021

Changes in this version

+ func GenerateRandomString(n int) (string, error)

v2.3.2

Sep 20, 2021

Changes in this version

+ var ErrNotImplemented = CreateError("not implemented", "ErrNotImplemented")

+ var ErrTaskNotFound = CreateError("task not found", "ErrTaskNotFound")

type Server

+ func (s *Server) CopyFrom(replacement *Server)

+ type ServerTasks struct

+ Tasks map[string]Task

type Task

+ Name string

v2.3.1

Jul 19, 2021

Changes in this version

+ var ErrFactoryError = func(operatorName string, err error) *Error

type Server

+ Tasks []Task

+ type Task struct

+ CronSchedule string

+ Operations []interface{}

v2.3.0

Jul 19, 2021

Changes in this version

+ const ScopeSettings

+ var ErrFileExists = CreateError("file exists where there should be none", "ErrFileExists")

+ var ErrFileNotFound = CreateError("file not found", "ErrFileNotFound")

+ var ErrInvalidSession = CreateError("invalid session", "ErrInvalidSession")

+ var ErrSessionExpired = CreateError("session expired", "ErrSessionExpired")

+ var ServerFolder string

+ func InitEnvironment()

+ func UserInGroup(groups ...string) bool — darwin/amd64

type Execution

+ WorkingDirectory string

v2.2.0

Apr 6, 2021

Changes in this version

+ type Scopes []Scope

v2.1.3

Dec 17, 2020

v2.1.2

Dec 5, 2020

v2.1.1

Oct 16, 2020

v2.1.0

Sep 7, 2020

Changes in this version

+ const MaxRecursivePath

+ const ScopeNodesDeploy

+ const ScopeNodesEdit

+ const ScopeNodesView

+ const ScopeNone

+ const ScopeOAuth2Auth

+ const ScopeServersAdmin

+ const ScopeServersConsole

+ const ScopeServersConsoleSend

+ const ScopeServersCreate

+ const ScopeServersDelete

+ const ScopeServersEdit

+ const ScopeServersEditAdmin

+ const ScopeServersEditUsers

+ const ScopeServersFilesGet

+ const ScopeServersFilesPut

+ const ScopeServersInstall

+ const ScopeServersSFTP

+ const ScopeServersStart

+ const ScopeServersStat

+ const ScopeServersStop

+ const ScopeServersUpdate

+ const ScopeServersView

+ const ScopeTemplatesEdit

+ const ScopeTemplatesView

+ const ScopeUsersEdit

+ const ScopeUsersView

+ var Display string

+ var Engine *gin.Engine

+ var ErrCannotValidateToken = CreateError("could not validate access token", "ErrCannotValidateToken")

+ var ErrClientNotFound = CreateError("client not found", "ErrClientNotFound")

+ var ErrContainerRunning = CreateError("container already running", "ErrContainerRunning")

+ var ErrDatabaseNotAvailable = CreateError("database not available", "ErrDatabaseNotAvailable")

+ var ErrEmailNotConfigured = CreateError("email not configured", "ErrEmailNotConfigured")

+ var ErrFieldEqual = func(fieldName1, fieldName2 string) *Error

+ var ErrFieldHasURICharacters = func(fieldName string) *Error

+ var ErrFieldIsInvalidHost = func(fieldName string) *Error

+ var ErrFieldIsInvalidIP = func(fieldName string) *Error

+ var ErrFieldLength = func(fieldName string, min int, max int) *Error

+ var ErrFieldMustBePrintable = func(fieldName string) *Error

+ var ErrFieldNotBetween = func(fieldName string, min, max int64) *Error

+ var ErrFieldNotEmail = func(fieldName string) *Error

+ var ErrFieldNotEqual = func(fieldName1, fieldName2 string) *Error

+ var ErrFieldRequired = func(fieldName string) *Error

+ var ErrFieldTooLarge = func(fieldName string, value int64) *Error

+ var ErrFieldTooSmall = func(fieldName string, value int64) *Error

+ var ErrIllegalFileAccess = CreateError("invalid file access", "ErrIllegalFileAccess")

+ var ErrImageDownloading = CreateError("image downloading", "ErrImageDownloading")

+ var ErrInvalidCredentials = CreateError("invalid credentials", "ErrInvalidCredentials")

+ var ErrInvalidTokenState = CreateError("invalid token state", "ErrInvalidTokenState")

+ var ErrInvalidUnixTime = CreateError("time provided is not a valid UNIX time", "ErrInvalidUnixTime")

+ var ErrKeyNotECDSA = CreateError("key is not ECDSA key", "ErrKeyNotECDSA")

+ var ErrKeyNotPEM = CreateError("key is not in PEM format", "ErrKeyNotPEM")

+ var ErrLoginNotPermitted = CreateError("login not permitted", "ErrLoginNotPermitted")

+ var ErrMissingAccessToken = CreateError("access token not provided", "ErrMissingAccessToken")

+ var ErrMissingFactory = CreateError("missing factory", "ErrMissingFactory")

+ var ErrMissingScope = CreateError("missing scope", "ErrMissingScope")

+ var ErrNoPermission = CreateError("no permission to perform action", "ErrNoPermission")

+ var ErrNoTemplate = func(template string) *Error

+ var ErrNodeHasServers = CreateError("node has servers associated", "ErrNodeHasServers")

+ var ErrNodeInvalid = CreateError("node is invalid", "ErrNodeInvalid")

+ var ErrNotBearerToken = CreateError("access token must be a Bearer token", "ErrNotBearerToken")

+ var ErrProcessRunning = CreateError("process already running", "ErrProcessRunning")

+ var ErrServerAlreadyExists = CreateError("server already exists", "ErrServerAlreadyExists")

+ var ErrServerDisabled = CreateError("server is disabled", "ErrServerDisabled")

+ var ErrServerNotFound = CreateError("server not found", "ErrServerNotFound")

+ var ErrServerOffline = CreateError("server offline", "ErrServerOffline")

+ var ErrServiceInvalidProvider = func(service, provider string) *Error

+ var ErrServiceNotAvailable = CreateError("service not available", "ErrServiceNotAvailable")

+ var ErrSettingNotConfigured = func(name string) *Error

+ var ErrTokenInvalid = CreateError("token is invalid", "ErrTokenInvalid")

+ var ErrUnknownError = CreateError("unknown error", "ErrUnknownError")

+ var ErrUserNotFound = CreateError("user not found", "ErrUserNotFound")

+ var Hash = "unknown"

+ var Version = "nightly"

+ func Close(closer io.Closer)

+ func CloseResponse(response *http.Response)

+ func ContainsScope(arr []Scope, value Scope) bool

+ func ContainsString(arr []string, value string) bool

+ func Convert(val interface{}, target interface{}) (interface{}, error)

+ func CopyFile(src, dest string) error

+ func EnsureAccess(source string, prefix string) bool

+ func GenerateValidationMessage(err error) error

+ func GetBooleanOrDefault(data map[string]interface{}, key string, def bool) bool

+ func GetMapOrNull(data map[string]interface{}, key string) map[string]interface

+ func GetObjectArrayOrNull(data map[string]interface{}, key string) []interface

+ func GetStringArrayOrNull(data map[string]interface{}, key string) []string

+ func GetStringOrDefault(data map[string]interface{}, key string, def string) string

+ func JoinPath(paths ...string) string

+ func LoadConfig(path string) error

+ func Recover()

+ func RemoveInvalidSymlinks(files []os.FileInfo, sourceFolder, prefix string) []os.FileInfo

+ func ReplaceTokens(msg string, mapping map[string]interface{}) string

+ func ReplaceTokensInArr(msg []string, mapping map[string]interface{}) []string

+ func ReplaceTokensInMap(msg map[string]string, mapping map[string]interface{}) map[string]string

+ func SplitArguments(source string) (cmd string, arguments []string)

+ func ToString(v interface{}) string

+ func UnmarshalTo(source, target interface{}) error

+ func UserInGroup(groups ...string) bool — linux/amd64, windows/amd64

+ func Write(c *Socket, msg messages.Message) error

+ type BaseEnvironment struct

+ ConsoleBuffer Cache

+ ExecutionFunction ExecutionFunction

+ RootDirectory string

+ Type string

+ WSManager *Tracker

+ Wait *sync.WaitGroup

+ WaitFunction func() (err error)

+ func (e *BaseEnvironment) AddListener(ws *Socket)

+ func (e *BaseEnvironment) CreateWrapper() io.Writer

+ func (e *BaseEnvironment) Delete() (err error)

+ func (e *BaseEnvironment) DisplayToConsole(daemon bool, msg string, data ...interface{})

+ func (e *BaseEnvironment) Execute(steps ExecutionData) error

+ func (e *BaseEnvironment) ExecuteAsync(steps ExecutionData) (err error)

+ func (e *BaseEnvironment) GetBase() *BaseEnvironment

+ func (e *BaseEnvironment) GetConsole() (console []string, epoch int64)

+ func (e *BaseEnvironment) GetConsoleFrom(time int64) (console []string, epoch int64)

+ func (e *BaseEnvironment) GetRootDirectory() string

+ func (e *BaseEnvironment) Update() error

+ func (e *BaseEnvironment) WaitForMainProcess() (err error)

+ type Cache interface

+ Read func() (cache []string, epoch int64)

+ ReadFrom func(startTime int64) (cache []string, epoch int64)

+ Write func(b []byte) (n int, err error)

+ type Claim struct

+ PanelClaims PanelClaims

+ type CreateOperation struct

+ DataMap map[string]interface{}

+ EnvironmentVariables map[string]string

+ OperationArgs map[string]interface{}

+ type Environment interface

+ AddListener func(ws *Socket)

+ Create func() error

+ Delete func() error

+ DisplayToConsole func(prefix bool, msg string, data ...interface{})

+ Execute func(steps ExecutionData) error

+ ExecuteAsync func(steps ExecutionData) error

+ ExecuteInMainProcess func(cmd string) error

+ GetBase func() *BaseEnvironment

+ GetConsole func() (console []string, epoch int64)

+ GetConsoleFrom func(time int64) (console []string, epoch int64)

+ GetRootDirectory func() string

+ GetStats func() (*ServerStats, error)

+ IsRunning func() (isRunning bool, err error)

+ Kill func() error

+ SendCode func(code int) error

+ Update func() error

+ WaitForMainProcess func() error

+ WaitForMainProcessFor func(timeout int) error

+ type EnvironmentFactory interface

+ Create func(id string) Environment

+ Key func() string

+ type Error struct

+ Code string

+ Message string

+ Meta map[string]interface{}

+ func CreateErrMissingScope(scope Scope) *Error

+ func CreateError(msg, code string) *Error

+ func FromError(err error) *Error

+ func (ge *Error) Error() string

+ func (ge *Error) GetCode() string

+ func (ge *Error) GetMessage() string

+ func (ge *Error) Is(err *Error) bool

+ func (ge *Error) Metadata(metadata map[string]interface{}) *Error

+ type Execution struct

+ AutoRestartFromCrash bool

+ AutoRestartFromGraceful bool

+ AutoStart bool

+ Command string

+ Disabled bool

+ EnvironmentVariables map[string]string

+ LegacyArguments []string

+ LegacyRun string

+ PostExecution []interface{}

+ PreExecution []interface{}

+ StopCode int

+ StopCommand string

+ type ExecutionData struct

+ Arguments []string

+ Callback func(graceful bool)

+ Command string

+ Environment map[string]string

+ WorkingDirectory string

+ type ExecutionFunction func(steps ExecutionData) (err error)

+ type GithubFile struct

+ Mode string

+ Path string

+ Sha string

+ Size uint64

+ Type string

+ Url string

+ type GithubFileList struct

+ Sha string

+ Tree []GithubFile

+ Url string

+ type MemoryCache struct

+ Buffer []Message

+ Capacity int

+ func CreateCache() *MemoryCache

+ func (c *MemoryCache) Read() (msg []string, lastTime int64)

+ func (c *MemoryCache) ReadFrom(startTime int64) (msg []string, lastTime int64)

+ func (c *MemoryCache) Write(b []byte) (n int, err error)

+ type Message struct

+ type MetadataType struct

+ Metadata map[string]interface{}

+ Type string

+ func (t *MetadataType) MarshalJSON() ([]byte, error)

+ func (t *MetadataType) ParseMetadata(target interface{}) (err error)

+ func (t *MetadataType) UnmarshalJSON(bs []byte) (err error)

+ type Operation interface

+ Run func(env Environment) error

+ type OperationFactory interface

+ Create func(CreateOperation) Operation

+ Key func() string

+ type PanelClaims struct

+ Scopes map[string][]Scope

+ type PufferdRunning struct

+ Message string

+ type SFTPAuthorization interface

+ Validate func(username, password string) (perms *ssh.Permissions, err error)

+ type Scope string

+ type Server struct

+ Display string

+ Environment interface{}

+ Execution Execution

+ Identifier string

+ Installation []interface{}

+ Type string

+ Uninstallation []interface{}

+ Variables map[string]Variable

+ type ServerData struct

+ Variables map[string]Variable

+ type ServerDataAdmin struct

+ type ServerIdResponse struct

+ Id string

+ type ServerLogs struct

+ Epoch int64

+ Logs string

+ type ServerRunning struct

+ Running bool

+ type ServerStats struct

+ Cpu float64

+ Memory float64

+ type Socket struct

+ func Create(ws *websocket.Conn) *Socket

+ func (s *Socket) Close() error

+ func (s *Socket) ReadMessage() (messageType int, p []byte, err error)

+ func (s *Socket) WriteJSON(data interface{}) error

+ func (s *Socket) WriteMessage(data []byte) error

+ type Template struct

+ SupportedEnvironments []interface{}

+ type Token struct

+ Claims *Claim

+ func ParseToken(publicKey *ecdsa.PublicKey, token string) (*Token, error)

+ type Tracker struct

+ func CreateTracker() *Tracker

+ func (ws *Tracker) Register(conn *Socket)

+ func (ws *Tracker) Write(source []byte) (n int, e error)

+ func (ws *Tracker) WriteMessage(msg messages.Message) error

+ type Type struct

+ Type string

+ type Variable struct

+ Description string

+ Display string

+ Internal bool

+ Options []VariableOption

+ Required bool

+ Type string

+ UserEditable bool

+ Value interface{}

+ type VariableOption struct

+ Display string

+ Value interface{}

v2.0.0-alpha.3

May 16, 2020

v2.0.0-alpha.2

Apr 27, 2020

v2.0.0-alpha.1

Feb 1, 2020

Other modules containing this package

github.com/pufferpanel/pufferpanel/v3

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL