ecommun / owncloud_ynh

Blame view

sources/apps/user_external/README.md 2.47 KB
edit raw normal view history
6d9380f96   Cédric Dupont   Update sources OC... 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
  External user authentication
  ============================
  Authenticate user login against FTP, IMAP or SMB.
  
  Passwords are not stored locally; authentication always happens against
  the remote server.
  
  It stores users and their display name in its own database table
  `users_external`.
  When modifying the `user_backends` configuration, you need to
  update the database table's `backend` field, or your users will lose
  their configured display name.
  
  If something does not work, check the log file at `owncloud/data/owncloud.log`.
  
  
  FTP
  ---
  Authenticate ownCloud users against a FTP server.
  
  
  ### Configuration
  You only need to supply the FTP host name or IP.
  
  The second - optional - parameter determines if SSL should be used or not.
  
  Add the following to `config.php`:
  
      'user_backends' => array(
          array(
              'class' => 'OC_User_FTP',
              'arguments' => array('127.0.0.1'),
          ),
      ),
  
  To enable SSL connections via `ftps`, append a second parameter `true`:
  
      'user_backends' => array(
          array(
              'class' => 'OC_User_FTP',
              'arguments' => array('127.0.0.1', true),
          ),
      ),
  
  
  ### Dependencies
  PHP automatically contains basic FTP support.
  
  For SSL-secured FTP connections via ftps, the PHP [openssl extension][0]
  needs to be activated.
  
  [0]: http://php.net/openssl
  
  
  
  IMAP
  ----
  Authenticate ownCloud users against an IMAP server.
  IMAP user and password need to be given for the ownCloud login
  
  
  ### Configuration
  Add the following to your `config.php`:
  
      'user_backends' => array(
          array(
              'class' => 'OC_User_IMAP',
              'arguments' => array(
                  '{127.0.0.1:143/imap/readonly}',
              ),
          ),
      ),
  
  This connects to the IMAP server on IP `127.0.0.1`, in readonly mode.
  
  Read the [imap_open][0] PHP manual page to learn more about the allowed
  parameters.
  
  [0]: http://php.net/imap_open#refsect1-function.imap-open-parameters
  
  
  ### Dependencies
  The PHP [IMAP extension][1] has to be activated.
  
  [1]: http://php.net/imap
  
  
  
  Samba
  -----
  Utilizes the `smbclient` executable to authenticate against a windows
  network machine via SMB.
  
  
  ### Configuration
  The only supported parameter is the hostname of the remote machine.
  
  Add the following to your `config.php`:
  
      'user_backends' => array(
          array(
              'class' => 'OC_User_SMB',
              'arguments' => array('127.0.0.1'),
          ),
      ),
  
  
  ### Dependencies
  The `smbclient` executable needs to be installed and accessible within `$PATH`.