Wiki source code of Serveur de documents FTP(S)

Last modified by jhurst on 2021/04/21 10:01
Show last authors
1 {{ddtoc/}}
2
3 = Prerequisites =
4
5 * A FTP(S) server (example : FileZilla Server)
6 * Check your server configuration to apply it on Digdash’s FTP(S) Client
7 * Open the necessary ports so that Digdash can connect to your FTP(S) server
8 * An external IP address visible from outside for a FTP connection in passive mode (see below)
9 * In this document :
10 ** P refers to the port of the FTP server (21 by default)
11 ** PE refers to the port if Explicit FTP over TLS is used (by default: P = PE = 21)
12 ** PI refers to the port if Implicit FTP over TLS is used (990 by default)(((
13 You need to adapt according to your ports, if default ones are not used.
14 )))
15
16 = Server configuration =
17
18 * Via the browser
19
20 [[image:ftp(s)_en_html_1e0029baac8fe94a.png||height="253" width="472"]]
21
22
23 [[image:ftp(s)_en_html_a7642093cc4034e8.png||height="291" width="486"]]
24 //__Screenshot: Creation of a new FTP(S) document server via the browser__//
25
26
27 * Via Digdash’s Enterprise Studio
28
29 Open Digdash’s Enterprise Studio > **Tools** > **Server URL manager…** > **New...**
30
31 [[image:ftp(s)_en_html_716ce981812a4b9b.gif||height="184" width="458"]]
32 \\
33
34 [[image:ftp(s)_en_html_94926f384710c402.gif||height="131" width="508"]]
35 \\
36
37 |[[image:ftp(s)_en_html_86628059d2cdcec9.png||height="359" width="361"]]
38 |[[image:ftp(s)_en_html_3066cf35bae4faaa.png||height="359" width="362"]]
39
40 |//__Screenshot: Creation of a new FTP document server__//|//__Screenshot: Creation of a FTPS document server__//
41
42 __**OR**__
43
44 The browser version is also available through a tab in Digdash’s Enterprise Studio
45
46 [[image:ftp(s)_en_html_19a297fe23bebe2b.png||height="356" width="554"]]
47 \\
48
49 //__Screenshot: creating a new FTP(S) document server via Digdash’s Enterprise Studio__//
50
51 |[[image:ftp(s)_en_html_293f8f00819019e8.png||height="309" width="281"]]
52 |[[image:ftp(s)_en_html_ddc3c0a41052c180.png||height="303" width="296"]]
53
54 |//__Screenshot : new FTP document server__//|//__Screenshot : new FTPS document server__//
55
56 == Server name ==
57
58 Give a name to your FTP(S) document server.
59
60 == URL ==
61
62 Enter the IP address of your FTP(S) server.
63
64 == Path (documents path for a user) ==
65
66 It is from this path on the server that Digdash will start the exploration of your documents. If empty, Digdash will start the exploration from root.
67
68 == Exploration of subfolders ==
69
70 You have the possibility to set the level of exploration of the subfolders from your document path.
71
72 By default, Digdash seeks for all your documents, recursively, and explores all the subfolders.
73
74 |Fields|//Explore subfolders//|(% colspan="2" %)//Level of subfolders//
75 |(% rowspan="2" %)Values|Selected|(((
76 Empty
77
78 Default value, exploration in all subfolders
79 )))|(((
80 N > 0
81
82
83 Exploration in the N subfolders
84 )))
85 |Deselected|(% colspan="2" %)(((
86 0
87
88 No exploration in the subfolders, only in the current directory
89 )))
90
91 __//Table for the different levels of exploration of subfolders//__
92
93 == Read only ==
94
95 Only the lecture is possible when this option is selected.
96
97 == Login ==
98
99 Enter the user’s login.
100
101 == Password ==
102
103 Enter the user’s password.
104
105 = Active mode / Passive mode =
106
107 The notion of active/passive mode is really important when using FTP with firewalls :
108
109 //Source : [[www.slacksite.com>>www.slacksite.com]]
110 Source : [[https:~~/~~/wiki.filezilla-project.org/Network_Configuration>>https://wiki.filezilla-project.org/Network_Configuration]]//
111
112
113 * //Active mode//
114
115 From the __**server-side firewall's standpoint**__, to support active mode FTP the following communication channels need to be opened:
116
117 * FTP server's port P (21) from anywhere (Client initiates connection)
118 * FTP server's port P (21) to ports > 1023 (Server responds to Client's control port)
119 * FTP server's port P-1 (20) to ports > 1023 (Server initiates data connection to Client's data port)
120 * FTP server's port P (20) from ports > 1023 (Client sends ACKs to Server's data port)
121
122 Active mode options
123
124 By default, the Client asks the operating system for the machine's IP address and for the number of a free port. This configuration can only work if you are connected to the internet directly without any NAT router, and if you have set your firewall to allow incoming connections on all ports > 1024.
125
126 If you have a NAT router, you need to tell the Client your external IP address in order for active mode connections to work with servers outside your local network.
127
128 You also can limit the number of communication ports in active mode.
129
130 |[[image:ftp(s)_en_html_1cad732a93492c0b.png||height="269" width="264"]]
131 |[[image:ftp(s)_en_html_264e5e81a56f0a8f.png||height="264" width="260"]]
132
133 |//__Screenshot : active mode option for FTP__ __(web)__//|//__Screenshot : active mode options for FTPS__ __(web)__//
134
135 |[[image:ftp(s)_en_html_d88758c0fa7c6718.png||height="295" width="316"]]
136 |[[image:ftp(s)_en_html_21876852ae7c5814.png||height="296" width="305"]]
137
138 |//__Screenshot : active mode option for FTP__ __(studio)__//|//__Screenshot : active mode options for FTPS__ __(studio)__//
139
140 * //Passive mode (recommended)//
141
142 From the __**server-side firewall's standpoint**__, to support passive mode FTP the following communication channels need to be opened:
143
144 * FTP server's port P (21) from anywhere (Client initiates connection)
145 * FTP server's port P (21) to ports > 1023 (Server responds to client's control port)
146 * FTP server's ports > 1023 from anywhere (Client initiates data connection to random port specified by server)
147 * FTP server's ports > 1023 to remote ports > 1023 (Server sends ACKs (and data) to client's data port)
148
149 Particularly, for the passive mode, the FTP Client only sees the local IP address of the server, that is not reachable from outside.
150
151 You will need to configure the passive mode settings of your FTP server to mention an IP address visible from outside. Let’s take a FTP Filezilla server as an example to illustrate :
152
153 [[image:ftp(s)_en_html_8243987a602d08e6.png||height="386" width="554"]]
154
155
156 __//Screenshot : Use of an external IP address for a FTP connection in passive mode//__
157
158 = Explicit FTP over TLS mode / Implicit FTP over TLS mode (only FTPS) =
159
160 To work with a secured FTP server (FTPS), you have to configure the protocol in the settings :
161
162 //Source : [[www.attachmate.com>>www.attachmate.com]]//
163
164 * //Explicit FTP over TLS mode//
165
166 By default the FTP Client makes SSL/TLS connections using Explicit security. In order to establish the SSL connection, explicit security requires that the FTP client issue a specific command (AUTH TLS) to the FTP server after establishing a connection. If the server gives a success response, the client begins the TLS negotiation. The default FTP server port (21) is used.
167
168
169 * //Implicit FTP over TLS mode//
170
171 When you select Implicit SSL/TLS Connection, the FTP Client uses Implicit security. Implicit security automatically begins with an SSL connection as soon as the FTP client connects to the server; no AUTH TLS command is sent prior to the TLS negotiation.
172
173 By default, the FTP Client uses PI port = 990 for Implicit connections.
174
175
176 = Possible actions =
177
178 Via the browser version of the document manager, you can proceed many actions on your documents on your FTP(S) server.
179
180 == Downloading ==
181
182 [[image:ftp(s)_en_html_cb99eed390a6fb2f.png||height="294" width="438"]]
183
184
185 //__Screenshot: Downloading a file from__ __FTP(S) server__//
186
187 It is a basic action. Every connected Digdash user is at least able to read any documents on the server.
188
189 This action is possible via this icon:[[image:ftp(s)_en_html_814415e769e4e78a.png]] .
190
191
192 == Uploading ==
193
194 [[image:ftp(s)_en_html_7f0e1bd3574a6b3b.png||height="376" width="615"]]
195 \\//__Screenshot: Uploading a document on FTP(S) server__//
196
197
198 (% class="box infomessage" %)
199 (((
200 __**Note:**__ In Digdash, it is preferable to upload documents with explicit extensions.
201 )))
202
203 Three options are possible:
204
205 * **Choose a local file**: click on **Browse...  **to select the document to add. Click **OK**.**  **The dialog **Open** shows.
206 * **Enter a URL**: Enter the URL of your document. If the checkbox **Only add the URL link to the Documents server **is deselected, the content pointed by the URL is downloaded only just once. If the checkbox **Only add the URL link to the Documents server** is selected, the content will be downloaded by the server every time it needs to (for a data source or required by the user). If required by the user, the URL must be reachable by the server. You can also insert user variables in the URL (${user.uid}, etc. Cf documentation). You can use a URL starting with « file:~/~/ » but in that case, the option **Only add the URL link to the Documents server** is selected by default. This kind of URL should refer to a file on the disk of the server. The link name must end with the extension of the file (.csv, .html, etc.).
207 * **Create a new link**: Create a new link to a document on the server. The pointed file is the last document (alphabetically) corresponding to the link. For example, a link like “document*.csv” will refer to the last CSV file starting with “document”.
208
209 == Updating ==
210
211 [[image:ftp(s)_en_html_ca7f22ae75036c0c.png||height="246" width="624"]]
212
213
214 //__Screenshot: Updating a document on FTP(S) server__//
215
216
217 This action is possible via this icon:[[image:ftp(s)_en_html_64558e71f36001ee.png]] .
218
219 Here are the possible actions:
220
221 === Updating a document content ===
222
223 You are able to update the content of an existing document selecting another file on their file system.
224
225 (% class="box warningmessage" %)
226 (((
227 [[image:ftp(s)_en_html_adf402587d43fa67.jpg]] This unique action will not alter the document name.
228 )))
229
230 === Renaming ===
231
232 You are able to rename a document. You will specify in the text field the new name without any extension (it remains the same).
233
234 == Deleting ==
235
236 You are able to delete one or several existing documents in the directory specified during the server configuration.
237
238 If the user wants to delete more than one document, they can do it thanks to the check boxes.
239
240 This action is possible via this icon: [[image:ftp(s)_en_html_98f66c55bdffcaac.png]] .
241
242
243