1ssh_sftpd(3)               Erlang Module Definition               ssh_sftpd(3)
2
3
4

NAME

6       ssh_sftpd - Specifies the channel process to handle an SFTP subsystem.
7

DESCRIPTION

9       Specifies a channel process to handle an SFTP subsystem.
10

EXPORTS

12       subsystem_spec(Options) -> Spec
13
14              Types:
15
16                 Options =
17                     [{cwd, string()} |
18                      {file_handler, CallbackModule :: string()} |
19                      {max_files, integer()} |
20                      {root, string()} |
21                      {sftpd_vsn, integer()}]
22                 Spec = {Name, {CbMod, Options}}
23                 Name = string()
24                 CbMod = atom()
25
26              Is to be used together with ssh:daemon/[1,2,3]
27
28              The  Name  is  "sftp" and CbMod is the name of the Erlang module
29              implementing  the   subsystem   using   the   ssh_server_channel
30              (replaces ssh_daemon_channel) behaviour.
31
32              Options:
33
34                cwd:
35                  Sets the initial current working directory for the server.
36
37                file_handler:
38                  Determines  which  module  to  call  for  accessing the file
39                  server. The default value is ssh_sftpd_file, which uses  the
40                  file  and  filelib  APIs  to  access  the  standard OTP file
41                  server. This option can  be  used  to  plug  in  other  file
42                  servers.
43
44                max_files:
45                  The  default  value is 0, which means that there is no upper
46                  limit. If supplied, the number of filenames returned to  the
47                  SFTP  client  per  READDIR request is limited to at most the
48                  given value.
49
50                root:
51                  Sets the SFTP root directory. Then the user cannot  see  any
52                  files  above  this root. If, for example, the root directory
53                  is set to /tmp, then the user sees this directory as  /.  If
54                  the user then writes cd /etc, the user moves to /tmp/etc.
55
56                sftpd_vsn:
57                  Sets  the  SFTP  version to use. Defaults to 5. Version 6 is
58                  under development and limited.
59
60
61
62Ericsson AB                         ssh 4.8                       ssh_sftpd(3)