adminapi

package

Go to main page

Versions in this module

v0

v0.16.0

Oct 25, 2026

Changes in this version

+ const SettingShareLinksEnabled

v0.15.0

Oct 21, 2026

v0.14.7

Oct 21, 2026

v0.14.6

Oct 21, 2026

v0.14.5

Oct 21, 2026

v0.14.4

Oct 21, 2026

v0.14.3

Oct 21, 2026

v0.14.2

Oct 21, 2026

v0.14.1

Oct 20, 2026

v0.14.0

Oct 20, 2026

Changes in this version

+ const ActionShareLinkCreate

+ const ActionShareLinkRevoke

+ const SettingShareDescription

+ const SettingSharePageTitle

+ const SharePath

+ func ClientServerSettings(cfg *config.Config, r *http.Request) clientdl.ServerSettings

+ func RegisterSharePublic(r chi.Router, d Deps, webFS fs.FS)

v0.13.4

Oct 20, 2026

v0.13.3

Oct 20, 2026

v0.13.2

Oct 20, 2026

v0.13.1

Oct 20, 2026

v0.13.0

Oct 20, 2026

Changes in this version

+ type ClientDownloads interface

+ Open func(ctx context.Context, id string) (*os.File, clientdl.Asset, error)

+ Release func(ctx context.Context) clientdl.Result

type Deps

+ Clients ClientDownloads

v0.12.2

Oct 20, 2026

v0.12.1

Oct 20, 2026

v0.12.0

Oct 20, 2026

v0.11.0

Oct 20, 2026

Changes in this version

type Deps

+ WebSessions *websessions.Registry

type RelayManager

+ GeoIP func() *relays.GeoIPEngine

v0.10.7

Oct 20, 2026

v0.10.6

Oct 20, 2026

v0.10.5

Oct 20, 2026

v0.10.4

Oct 20, 2026

v0.10.3

Oct 20, 2026

v0.10.2

Oct 20, 2026

v0.10.1

Oct 20, 2026

v0.10.0

Oct 20, 2026

v0.9.0

Oct 19, 2026

v0.8.1

Oct 19, 2026

v0.8.0

Oct 19, 2026

v0.7.0

Oct 19, 2026

Changes in this version

type Deps

+ LDAP *ldap.Service

type UserDTO

+ IsLDAP bool

v0.6.0

Oct 19, 2026

Changes in this version

type Deps

+ Federation *federation.Service

v0.5.9

Oct 19, 2026

Changes in this version

type RelayManager

+ ImportCountryRules func(ctx context.Context, countryCode, relayHost, customComment string) (*relays.ImportCountryRulesResult, error)

v0.5.8

Oct 19, 2026

v0.5.7

Oct 18, 2026

Changes in this version

type RelayManager

+ CreatePrefixRule func(ctx context.Context, rule *relays.PrefixRule) error

+ DeletePrefixRule func(ctx context.Context, id int64) error

+ ListPrefixRules func(ctx context.Context) ([]relays.PrefixRule, error)

v0.5.6

Oct 18, 2026

v0.5.5

Oct 18, 2026

v0.5.4

Oct 18, 2026

Changes in this version

type RelayManager

+ Traffic func(ctx context.Context, id int64, since time.Time) ([]relays.TrafficSample, error)

v0.5.3

Oct 18, 2026

v0.5.2

Oct 18, 2026

v0.5.1

Oct 18, 2026

v0.5.0

Oct 18, 2026

Changes in this version

+ func DecodeRustdeskConfig(s string) (host, relay, api, key string, err error)

+ func EncodeRustdeskConfig(host, relay, api, key string) (string, error)

v0.4.1

Oct 16, 2026

v0.4.0

Oct 16, 2026

Changes in this version

type SessionInfo

+ APIToken *store.APIToken

v0.3.1

Oct 16, 2026

v0.3.0

Oct 16, 2026

Changes in this version

+ const LogCaptureFiles

+ const LogCaptureOff

+ const LogCapturePanel

type Deps

+ ClientOptions *clientopts.Service

+ LogCapture string

+ LogSources []string

+ Logs *logs.Buffer

+ Relays RelayManager

+ type RelayManager interface

+ Approve func(ctx context.Context, id int64, by *int64) (relays.View, error)

+ Create func(ctx context.Context, in relays.CreateInput) (relays.View, *relays.Enrollment, error)

+ Delete func(ctx context.Context, id int64) error

+ Get func(ctx context.Context, id int64) (relays.View, error)

+ GetOptions func(ctx context.Context) (relays.Options, error)

+ HBBSKeyFingerprint func() string

+ List func(ctx context.Context) ([]relays.View, relays.Rotation, error)

+ Observed func(ctx context.Context) ([]string, error)

+ ProbeNow func(ctx context.Context, id int64) (relays.View, error)

+ ResetEnrollment func(ctx context.Context, id int64) (*relays.Enrollment, error)

+ Revoke func(ctx context.Context, id int64) (relays.View, error)

+ SaveSettings func(ctx context.Context, id int64, ov reconcile.Settings, by *int64) (relays.SettingsView, error)

+ SetOptions func(ctx context.Context, o relays.Options, by *int64) error

+ Settings func(ctx context.Context, id int64) (relays.SettingsView, error)

+ Update func(ctx context.Context, id int64, p relays.Patch) (relays.View, error)

+ Usage func(ctx context.Context, id int64) ([]control.RelayUsage, error)

v0.2.0

Oct 16, 2026

Changes in this version

+ const ActionServerCommand

+ const ActionServerConsole

+ const AppName

+ const CSRFCookie

+ const CSRFHeader

+ const DefaultBrandingTitle

+ const LogoPath

+ const MFAPath

+ const MinPasswordChars

+ const PunchCollectorActor

+ const SessionCookie

+ func CurrentUser(ctx context.Context) *store.User

+ func OIDCWebLogin(d Deps) oidc.WebLoginFunc

+ func Register(r chi.Router, d Deps)

+ func RequireAdmin(next http.Handler) http.Handler

+ func RequireUser(next http.Handler) http.Handler

+ func SampleOnline(ctx context.Context, st *store.Store, p PresenceReader) error

+ func SessionMiddleware(d Deps) func(http.Handler) http.Handler

+ func WithSession(ctx context.Context, s *SessionInfo) context.Context

+ type ChannelStatus struct

+ Known bool

+ LastError string

+ RTT time.Duration

+ Reachable bool

+ Since time.Time

+ type CommandAudit struct

+ Log *slog.Logger

+ Store *store.Store

+ func NewCommandAudit(st *store.Store, log *slog.Logger) *CommandAudit

+ func (a *CommandAudit) RecordCommand(ctx context.Context, rec control.CommandRecord)

+ type Deps struct

+ AEAD *crypto.AEAD

+ Config *config.Config

+ ConsoleLimit int

+ Control ServerControl

+ DeviceRate DeviceRateInfo

+ Events EventPublisher

+ Hasher *auth.Hasher

+ JWT *auth.ClientJWT

+ Kicks DeviceKicker

+ Limiter auth.Limiter

+ Log *slog.Logger

+ LoginEvents loginlog.Recorder

+ Mail *mailauth.Service

+ Metrics prometheus.Registerer

+ OIDC *oidc.Service

+ Presence PresenceReader

+ PresenceSrc PresenceSource

+ Reconciler SettingsReconciler

+ Schema SchemaInfo

+ Servers ServerStatusReader

+ StartedAt time.Time

+ Store *store.Store

+ TOTP *TOTPService

+ Telemetry *metrics.Panel

+ Updates UpdateChecker

+ type DeviceKicker interface

+ Kick func(rustdeskID string, connIDs ...int32)

+ type DeviceRateInfo struct

+ Burst int

+ Rate float64

+ type EventPublisher interface

+ Publish func(t events.Type, data any, aud events.Audience)

+ type IdentityDTO struct

+ AvatarURL string

+ CreatedAt time.Time

+ DisplayName string

+ Email *string

+ EmailVerified bool

+ ID int64

+ LastLoginAt *time.Time

+ ProviderID int64

+ ProviderKind string

+ ProviderName string

+ ProviderSlug string

+ Subject string

+ Username *string

+ func IdentitiesOf(ctx context.Context, st *store.Store, userID int64) ([]IdentityDTO, error)

+ type PasskeyDTO struct

+ BackupEligible bool

+ CloneWarning bool

+ CreatedAt time.Time

+ ID int64

+ LastUsedAt *time.Time

+ Name string

+ Synced bool

+ Transports []string

+ type PresenceHealth struct

+ LastError string

+ LastOK time.Time

+ Polls uint64

+ RTT time.Duration

+ Reachable bool

+ Since time.Time

+ type PresenceReader interface

+ DevicePresence func(rustdeskID string) (online bool, since time.Time, known bool)

+ OnlineIDs func() []string

+ PresenceHealth func() PresenceHealth

+ type PresenceSource interface

+ Health func() presence.Health

+ IsOnline func(rustdeskID string) bool

+ type ProviderDTO struct

+ AutoRegister bool

+ CallbackURL string

+ ClientID string

+ CreatedAt time.Time

+ DisplayName string

+ Enabled bool

+ HasClientSecret bool

+ ID int64

+ Issuer *string

+ Kind string

+ LinkByVerifiedEmail bool

+ PKCEEnabled bool

+ PKCEMethod string

+ Scopes []string

+ Slug string

+ SortOrder int

+ UpdatedAt time.Time

+ type SchemaInfo interface

+ LatestSchemaVersion func() (int64, error)

+ SchemaVersion func(ctx context.Context) (int64, error)

+ type ServerControl interface

+ Addr func(t control.Target) string

+ ExecLine func(ctx context.Context, t control.Target, line string) (string, error)

+ IPBlocker func(ctx context.Context, start int) (control.IPBlockerPage, error)

+ IPBlockerLookup func(ctx context.Context, ip string, remove bool) (*control.IPBlockerEntry, error)

+ IPChanges func(ctx context.Context, start int) (control.IPChangesPage, error)

+ IPChangesLookup func(ctx context.Context, id string, remove bool) (*control.IPChange, error)

+ Usage func(ctx context.Context) ([]control.RelayUsage, error)

+ type ServerHealthDTO struct

+ HBBR componentHealthDTO

+ HBBS componentHealthDTO

+ Presence presenceHealthDTO

+ SettingsInSync *bool

+ type ServerStatusReader interface

+ ChannelStatus func() (hbbs, hbbr ChannelStatus)

+ SettingsInSync func(ctx context.Context) (bool, error)

+ type SessionInfo struct

+ MFAPending bool

+ MustEnrollTOTP bool

+ TOTPEnabled bool

+ Token *store.AuthToken

+ User *store.User

+ func CurrentSession(ctx context.Context) *SessionInfo

+ type SettingsReconciler interface

+ Apply func(ctx context.Context, s reconcile.Settings, updatedBy *int64) error

+ Current func(ctx context.Context) (reconcile.Observed, error)

+ Desired func(ctx context.Context) (reconcile.Settings, error)

+ KeyStatus func(ctx context.Context) ([]reconcile.KeyStatus, error)

+ Reconcile func(ctx context.Context) error

+ Status func() reconcile.Status

+ type TOTPService struct

+ func NewTOTPService(st *store.Store, aead *crypto.AEAD) *TOTPService

+ func (t *TOTPService) Enrolled(ctx context.Context, userID uint32) (bool, error)

+ func (t *TOTPService) ResetUser(ctx context.Context, userID int64) error

+ func (t *TOTPService) Verify(ctx context.Context, userID uint32, code string) (bool, error)

+ type UpdateChecker interface

+ Latest func(ctx context.Context) updatecheck.Result

+ type UserDTO struct

+ AvatarURL string

+ CreatedAt time.Time

+ DisplayName string

+ Email *string

+ Email2FAEnabled bool

+ EmailVerified bool

+ HasPassword bool

+ ID int64

+ LastLoginAt *time.Time

+ Note string

+ Role store.Role

+ Status string

+ TOTPEnabled bool

+ TOTPRequired bool

+ UpdatedAt time.Time

+ UserGroupID *int64

+ Username string

+ func NewUserDTO(u *store.User, totpEnabled bool) UserDTO

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