types

Documentation

Index

• type ApiKey
• type ApiKeyType
• type Empty
• type FRPSConfig
• type GitProvider
• type GitUserData
• type NetworkKey
• type Project
• type ProjectInfo
• type Repository
• type ServerConfig
• type Workspace
• type WorkspaceInfo

Types

type ApiKey

type ApiKey struct {
	KeyHash string     `json:"keyHash"`
	Type    ApiKeyType `json:"type"`
	// Project or client name
	Name string `json:"name"`

} // @name ApiKey

type ApiKeyType

type ApiKeyType string

const (
	ApiKeyTypeClient  ApiKeyType = "client"
	ApiKeyTypeProject ApiKeyType = "project"
)

type Empty

type Empty struct {
}

type FRPSConfig

type FRPSConfig struct {
	Domain   string `json:"domain"`
	Port     uint32 `json:"port"`
	Protocol string `json:"protocol"`

} // @name FRPSConfig

type GitProvider

type GitProvider struct {
	Id         string `json:"id"`
	Username   string `json:"username"`
	Token      string `json:"token"`
	BaseApiUrl string `json:"baseApiUrl"`

} // @name GitProvider

type GitUserData

type GitUserData struct {
	Name  string
	Email string

} // @name GitUserData

type NetworkKey

type NetworkKey struct {
	Key string `json:"key"`

} // @name NetworkKey

type Project

type Project struct {
	Name        string            `json:"name"`
	Repository  *Repository       `json:"repository"`
	WorkspaceId string            `json:"workspaceId"`
	ApiKey      string            `json:"-"`
	Target      string            `json:"target"`
	EnvVars     map[string]string `json:"-"`

} // @name Project

type ProjectInfo

type ProjectInfo struct {
	Name             string `json:"name"`
	Created          string `json:"created"`
	Started          string `json:"started"`
	Finished         string `json:"finished"`
	IsRunning        bool   `json:"isRunning"`
	ProviderMetadata string `json:"providerMetadata,omitempty"`
	WorkspaceId      string `json:"workspaceId"`

} // @name ProjectInfo

type Repository

type Repository struct {
	Id          string       `json:"id,omitempty"`
	Url         string       `json:"url"`
	Name        string       `json:"name"`
	Branch      string       `json:"branch,omitempty"`
	Sha         string       `json:"sha"`
	Owner       string       `json:"owner"`
	PrNumber    uint32       `json:"prNumber,omitempty"`
	Source      string       `json:"source"`
	Path        string       `json:"path,omitempty"`
	GitUserData *GitUserData `json:"-"`

} // @name Repository

type ServerConfig

type ServerConfig struct {
	ProvidersDir      string        `json:"providersDir"`
	RegistryUrl       string        `json:"registryUrl"`
	GitProviders      []GitProvider `json:"gitProviders"`
	Id                string        `json:"id"`
	ServerDownloadUrl string        `json:"serverDownloadUrl"`
	Frps              *FRPSConfig   `json:"frps,omitempty"`
	ApiPort           uint32        `json:"apiPort"`
	HeadscalePort     uint32        `json:"headscalePort"`
	TargetsFilePath   string        `json:"targetsFilePath"`
	BinariesPath      string        `json:"binariesPath"`

} // @name ServerConfig

type Workspace

type Workspace struct {
	Id       string     `json:"id"`
	Name     string     `json:"name"`
	Projects []*Project `json:"projects"`
	Target   string     `json:"target"`

} // @name Workspace

type WorkspaceInfo

type WorkspaceInfo struct {
	Name             string         `json:"name"`
	Projects         []*ProjectInfo `json:"projects"`
	ProviderMetadata string         `json:"providerMetadata,omitempty"`

} // @name WorkspaceInfo