mirror of
https://github.com/kopia/kopia.git
synced 2026-01-24 14:28:06 -05:00
2e9a57f0b4
This adds new set of APIs `/api/v1/control/*` which can be used to administratively control a running server. Once the server is started, the administrative user can control it using CLI commands: export KOPIA_SERVER_ADDRESS=... export KOPIA_SERVER_CERT_FINGERPRINT=... export KOPIA_SERVER_PASSWORD=... * `kopia server status` - displays status of sources managed by the server * `kopia server snapshot` - triggers server-side upload of snapshots for managed sources * `kopia server cancel` - cancels upload of snapshots for managed sources * `kopia server pause` - pauses scheduled snapshots for managed sources * `kopia server resume` - resumes scheduled snapshots for managed sources * `kopia server refresh` - causes server to resynchronize with externally-made changes, such as policies or new sources * `kopia server flush` - causes server to flush all pending writes * `kopia server shutdown` - graceful shutdown of the server Authentication uses new user `server-control` and is disabled by default. To enable it when starting the server, provide the password using one of the following methods: * `--server-control-password` * `--random-server-control-password` * `.htpasswd` file * `KOPIA_SERVER_CONTROL_PASSWORD` environment variable This change allows us to tighten the API security and remove some methods that UI user was able to call, but which were not needed.
87 lines
2.9 KiB
Go
87 lines
2.9 KiB
Go
package cli
|
|
|
|
import (
|
|
"github.com/alecthomas/kingpin"
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/kopia/kopia/internal/apiclient"
|
|
)
|
|
|
|
type commandServer struct {
|
|
acl commandServerACL
|
|
user commandServerUser
|
|
cancel commandServerCancel
|
|
flush commandServerFlush
|
|
pause commandServerPause
|
|
refresh commandServerRefresh
|
|
resume commandServerResume
|
|
start commandServerStart
|
|
status commandServerStatus
|
|
upload commandServerUpload
|
|
shutdown commandServerShutdown
|
|
}
|
|
|
|
type serverFlags struct {
|
|
serverAddress string
|
|
serverUsername string
|
|
serverPassword string
|
|
}
|
|
|
|
func (c *serverFlags) setup(cmd *kingpin.CmdClause) {
|
|
cmd.Flag("address", "Server address").Default("http://127.0.0.1:51515").StringVar(&c.serverAddress)
|
|
cmd.Flag("server-username", "HTTP server username (basic auth)").Envar("KOPIA_SERVER_USERNAME").Default("kopia").StringVar(&c.serverUsername)
|
|
cmd.Flag("server-password", "HTTP server password (basic auth)").Envar("KOPIA_SERVER_PASSWORD").StringVar(&c.serverPassword)
|
|
}
|
|
|
|
type serverClientFlags struct {
|
|
serverAddress string
|
|
serverUsername string
|
|
serverPassword string
|
|
serverCertFingerprint string
|
|
}
|
|
|
|
func (c *serverClientFlags) setup(cmd *kingpin.CmdClause) {
|
|
c.serverUsername = "server-control"
|
|
|
|
cmd.Flag("address", "Address of the server to connect to").Envar("KOPIA_SERVER_ADDRESS").Default("http://127.0.0.1:51515").StringVar(&c.serverAddress)
|
|
cmd.Flag("server-control-username", "Server control username").Envar("KOPIA_SERVER_USERNAME").StringVar(&c.serverUsername)
|
|
cmd.Flag("server-control-password", "Server control password").PlaceHolder("PASSWORD").Envar("KOPIA_SERVER_PASSWORD").StringVar(&c.serverPassword)
|
|
|
|
// aliases for backwards compat
|
|
cmd.Flag("server-username", "Server control username").Hidden().StringVar(&c.serverUsername)
|
|
cmd.Flag("server-password", "Server control password").Hidden().StringVar(&c.serverPassword)
|
|
|
|
cmd.Flag("server-cert-fingerprint", "Server certificate fingerprint").PlaceHolder("SHA256-FINGERPRINT").Envar("KOPIA_SERVER_CERT_FINGERPRINT").StringVar(&c.serverCertFingerprint)
|
|
}
|
|
|
|
func (c *commandServer) setup(svc advancedAppServices, parent commandParent) {
|
|
cmd := parent.Command("server", "Commands to control HTTP API server.")
|
|
|
|
c.start.setup(svc, cmd)
|
|
c.acl.setup(svc, cmd)
|
|
c.user.setup(svc, cmd)
|
|
|
|
c.status.setup(svc, cmd)
|
|
c.refresh.setup(svc, cmd)
|
|
c.flush.setup(svc, cmd)
|
|
c.shutdown.setup(svc, cmd)
|
|
|
|
c.upload.setup(svc, cmd)
|
|
c.cancel.setup(svc, cmd)
|
|
c.pause.setup(svc, cmd)
|
|
c.resume.setup(svc, cmd)
|
|
}
|
|
|
|
func (c *serverClientFlags) serverAPIClientOptions() (apiclient.Options, error) {
|
|
if c.serverAddress == "" {
|
|
return apiclient.Options{}, errors.Errorf("missing server address")
|
|
}
|
|
|
|
return apiclient.Options{
|
|
BaseURL: c.serverAddress,
|
|
Username: c.serverUsername,
|
|
Password: c.serverPassword,
|
|
TrustedServerCertificateFingerprint: c.serverCertFingerprint,
|
|
}, nil
|
|
}
|