Documentation ¶
Index ¶
- Variables
- type Addr
- type StdioConn
- func (s *StdioConn) Close() error
- func (s *StdioConn) LocalAddr() net.Addr
- func (s *StdioConn) Read(p []byte) (int, error)
- func (s *StdioConn) RemoteAddr() net.Addr
- func (s *StdioConn) SetDeadline(t time.Time) error
- func (s *StdioConn) SetReadDeadline(t time.Time) error
- func (s *StdioConn) SetWriteDeadline(t time.Time) error
- func (s *StdioConn) Write(p []byte) (int, error)
- type TestRequest
Constants ¶
This section is empty.
Variables ¶
View Source
var Command = &cobra.Command{ Use: "restic remote:path", Short: `Serve the remote for restic's REST API.`, Long: `rclone serve restic implements restic's REST backend API over HTTP. This allows restic to use rclone as a data storage mechanism for cloud providers that restic does not support directly. [Restic](https://restic.net/) is a command line program for doing backups. The server will log errors. Use -v to see access logs. --bwlimit will be respected for file transfers. Use --stats to control the stats printing. ### Setting up rclone for use by restic ### First [set up a remote for your chosen cloud provider](/docs/#configure). Once you have set up the remote, check it is working with, for example "rclone lsd remote:". You may have called the remote something other than "remote:" - just substitute whatever you called it in the following instructions. Now start the rclone restic server rclone serve restic -v remote:backup Where you can replace "backup" in the above by whatever path in the remote you wish to use. By default this will serve on "localhost:8080" you can change this with use of the "--addr" flag. You might wish to start this server on boot. ### Setting up restic to use rclone ### Now you can [follow the restic instructions](http://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server) on setting up restic. Note that you will need restic 0.8.2 or later to interoperate with rclone. For the example above you will want to use "http://localhost:8080/" as the URL for the REST server. For example: $ export RESTIC_REPOSITORY=rest:http://localhost:8080/ $ export RESTIC_PASSWORD=yourpassword $ restic init created restic backend 8b1a4b56ae at rest:http://localhost:8080/ Please note that knowledge of your password is required to access the repository. Losing your password means that your data is irrecoverably lost. $ restic backup /path/to/files/to/backup scan [/path/to/files/to/backup] scanned 189 directories, 312 files in 0:00 [0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 duration: 0:00 snapshot 45c8fdd8 saved #### Multiple repositories #### Note that you can use the endpoint to host multiple repositories. Do this by adding a directory name or path after the URL. Note that these **must** end with /. Eg $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user1repo/ # backup user1 stuff $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ # backup user2 stuff #### Private repositories #### The "--private-repos" flag can be used to limit users to repositories starting with a path of "/<username>/". ` + httplib.Help, Run: func(command *cobra.Command, args []string) { cmd.CheckArgs(1, 1, command, args) f := cmd.NewFsSrc(args) cmd.Run(false, true, command, func() error { s := newServer(f, &httpflags.Opt) if stdio { if terminal.IsTerminal(int(os.Stdout.Fd())) { return errors.New("Refusing to run HTTP2 server directly on a terminal, please let restic start rclone") } conn := &StdioConn{ stdin: os.Stdin, stdout: os.Stdout, } httpSrv := &http2.Server{} opts := &http2.ServeConnOpts{ Handler: http.HandlerFunc(s.handler), } httpSrv.ServeConn(conn, opts) return nil } err := s.Serve() if err != nil { return err } s.Wait() return nil }) }, }
Command definition for cobra
Functions ¶
This section is empty.
Types ¶
type StdioConn ¶
type StdioConn struct {
// contains filtered or unexported fields
}
StdioConn implements a net.Conn via stdin/stdout.
func (*StdioConn) SetDeadline ¶
SetDeadline sets the read/write deadline.
func (*StdioConn) SetReadDeadline ¶
SetReadDeadline sets the read/write deadline.
func (*StdioConn) SetWriteDeadline ¶
SetWriteDeadline sets the read/write deadline.
type TestRequest ¶
type TestRequest struct {
// contains filtered or unexported fields
}
TestRequest is a sequence of HTTP requests with (optional) tests for the response.
Click to show internal directories.
Click to hide internal directories.