Module: Yast::FtpServerHelpsInclude

Defined in:
../../src/include/ftp-server/helps.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) DialogHelpText(identification)



286
287
288
289
290
291
292
# File '../../src/include/ftp-server/helps.rb', line 286

def DialogHelpText(identification)
  Ops.get_string(
    @HELPS,
    identification,
    Builtins.sformat("Help for '%1' is missing!", identification)
  )
end

- (Object) initialize_ftp_server_helps(include_target)



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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
# File '../../src/include/ftp-server/helps.rb', line 11

def initialize_ftp_server_helps(include_target)
  textdomain "ftp-server"

  # All helps are here
  @HELPS = {
    # Read dialog help 1/2
    "read"              => _(
      "<p><b><big>Initializing FTP Server Configuration</big></b><br>\n</p>\n"
    ) +
      # Read dialog help 2/2
      _(
        "<p><b><big>Aborting Initialization:</big></b><br>\nSafely abort the configuration utility by pressing <b>Abort</b> now.</p>\n"
      ),
    # Write dialog help 1/2
    "write"             => _(
      "<p><b><big>Saving FTP Server Configuration</big></b><br>\n</p>\n"
    ) +
      # Write dialog help 2/2
      _(
        "<p><b><big>Aborting Saving:</big></b><br>\n" +
          "Abort the save procedure by pressing <b>Abort</b>.\n" +
          "An additional dialog informs whether it is safe to do so.\n" +
          "</p>\n"
      ),
    #-----------================= START_UP SCREEN =============----------
    #


    #Start widget switching daemons help 1/1
    "selected_services" => _(
      "<p><b>Selected Service</b><br>\n" +
        "     The frame shows which daemon is currently configured: <b>vsftpd, pure-ftpd,   \n" +
        "     </b>. If you have installed both daemons you can switch between them.\n" +
        "</p>\n"
    ),
    #-----------================= GENERAL SCREEN =============----------
    #

    # general welcome message help 1/1
    "Banner"            => _(
      "<p><b>Welcome Message</b><br>\n" +
        "Specify the name of a file containing the\n" +
        "text to display when someone connects to the server.\n" +
        "</p>\n"
    ),
    # general chroot  help 1/1
    "ChrootEnable"      => _(
      "<p><b>Chroot</b><br>\n" +
        "When enabled, local users will be (by default) placed in a \n" +
        "chroot() jail in their home directory after login.\n" +
        "<b>Warning:</b> This option has security implications, \n" +
        "especially if users have upload permission\n" +
        "or shell access. Only enable Chroot if you know what you are doing.\n" +
        "</p>\n"
    ),
    # general logging  help 1/1
    "VerboseLogging"    => _(
      "<p><b>Verbose Logging</b><br>\n" +
        "When enabled, all FTP requests and responses are logged.\n" +
        "</p>\n"
    ),
    # general umask  help - only pure-ftpd 1/1
    "Umask"             => _(
      "<p><b>Umask</b><br>\n" +
        "File creation mask. (umask for files):(umask for dirs). \n" +
        "177:077 if you feel paranoid.\n" +
        "</p>\n"
    ),
    # general umask for anonymous  help - only vsftpd 1/1
    "UmaskAnon"         => _(
      "<p><b>Umask for Anonymous:</b><br>\n" +
        "The value to which the umask for file creation is set for anonymous users. \n" +
        "If you want to specify octal values, remember the \"0\" prefix, otherwise \n" +
        "the value will be treated as a base 10 integer.\n" +
        "</p>\n"
    ),
    # general umask for authenticated users  help - only vsftpd 1/1
    "UmaskLocal"        => _(
      "<p><b>Umask for Authenticated Users:</b><br>\n" +
        "The value to which the umask for file creation is set for authenticated users. \n" +
        "If you want to specify octal values, remember the \"0\" prefix, otherwise \n" +
        "the value will be treated as a base 10 integer.\n" +
        "</p>\n"
    ),
    # general FTP dir for anonymous help 1/1
    "FtpDirAnon"        => _(
      "<p><b>FTP Directory for Anonymous Users:</b><br>\n" +
        "Specify a directory which is used for FTP anonymous users. \n" +
        "Press <b>Browse</b> to select a directory from the local filesystem.\n" +
        "</p>\n"
    ),
    # general FTP dir for authenticated help 1/1
    "FtpDirLocal"       => _(
      "<p><b>FTP Directory for Authenticated Users:</b><br>\n" +
        "Specify a directory which is used for FTP authenticated users. \n" +
        "Press <b>Browse</b> to select a directory from the local filesystem.\n" +
        "</p>\n"
    ),
    #-----------================= PERFORMANCE SCREEN =============----------
    #

    # performance  Max Idle Time  help 1/1
    "MaxIdleTime"       => _(
      "<p><b>Max Idle Time:</b><br>\n" +
        "The maximum time (timeout) a remote client \n" +
        "may wait between FTP commands.\n" +
        "</p>\n"
    ),
    # performance max clients per IP  help 1/1
    "MaxClientsPerIP"   => _(
      "<p><b>Max Clients for One IP:</b><br>\n" +
        "The maximum number of clients allowed to connect\n" +
        "from the same source internet address. \n" +
        "</p>\n"
    ),
    # performance max clients help 1/1
    "MaxClientsNumber"  => _(
      "<p><b>Max Clients:</b><br>\n" +
        "The maximum number of clients allowed to connect. \n" +
        "Any additional clients trying to connect will get an error message.\n" +
        "</p>\n"
    ),
    # performance local max rate help 1/1
    "LocalMaxRate"      => _(
      "<p><b>Local Max Rate:</b><br>\n" +
        "The maximum data transfer rate permitted for local authenticated users.\n" +
        "</p>"
    ),
    # performance  anonymous max rate help 1/1
    "AnonMaxRate"       => _(
      "<p><b>Anonymous Max Rate:</b><br>\nThe maximum data transfer rate permitted for anonymous clients.</p>\n"
    ),
    #-----------================= Authentication SCREEN =============----------
    #

    # authentication  Enable/Disable Anonymous and Local help 1/1
    "AnonAuthen"        => _(
      "<p><b>Enable/Disable Anonymous and Local Users</b><br>\n" +
        "<b>Anonymous Only</b>: If enabled, only anonymous logins are permitted.\n" +
        "<b>Authenticated Users Only</b>: If enabled, only authenticated users are permitted.\n" +
        "<b>Both</b> If enabled, authenticated users and anonymous users are permitted.\n" +
        "</p>\n"
    ),
    # authentication  Enable Upload help 1/1
    "EnableUpload"      => _(
      "<p><b>Enable Upload</b><br>\n" +
        "If enabled, FTP users can upload. To allow anonymous users \n" +
        "to upload, enable <b>Anonymous Can Upload</b>.\n" +
        "</p>\n"
    ),
    # authentication Anonymous Can Upload help 1/1
    "AnonReadOnly"      => _(
      "<p><b>Anonymous Can Upload</b><br>\n" +
        "If enabled anonymous users will be permitted to upload.\n" +
        "<i>vsftpd only: </i>If you want to allow anonymous users to upload, you \n" +
        "need an existing directory with write permission in the home directory after login.\n" +
        "</p>\n"
    ),
    # authentication Anonymous Can Create Dirs help 1/1
    "AnonCreatDirs"     => _(
      "<p><b>Anonymous Can Create Dirs</b><br>\n" +
        "If enabled, anonymous users can create directories.\n" +
        "<i>vsftpd only:</i> If you want to allow anonymous users to create directories,\n" +
        "you need an existing directory with write permission in the home directory after login.</p>\n"
    ),
    #-----------================= EXPERT SETTINGS SCREEN =============----------
    #


    # expert settings Enable Passive Mode help 1/1
    "PassiveMode"       => _(
      "<p><b>Enable Passive Mode</b><br>\n" +
        "If enabled, the FTP server will allow passive mode for connections.   \n" +
        "</p>\n"
    ),
    # expert settings Min Port for Pas. Mode help 1/1
    "PasMinPort"        => _(
      "<p><b>Min Port for Passive Mode</b><br>\n" +
        "Minimum value for a port range for passive connection replies.\n" +
        "This is used for protection by means of a firewall. \n" +
        "</p>\n"
    ),
    # expert settings Max Port for Pas. Mode help 1/1
    "PasMaxPort"        => _(
      "<p><b>Max Port for Pas. Mode</b><br>\n" +
        "Maximum value for a port range for passive connection replies.\n" +
        " This is used for protection by means of a firewall. \n" +
        "</p>\n"
    ),
    # expert settings  Enable SSL help 1/1
    "SSLEnable"         => _(
      "<p><b>Enable SSL</b><br>\n" +
        "If enabled, SSL connections are allowed.\n" +
        "</p>\n"
    ),
    # expert settings  Enable SSL v2 help 1/1
    "SSLv2"             => _(
      "<p><b>Enable SSL v2</b><br>\n" +
        "If enabled, SSL version 2 connections are allowed.\n" +
        "</p>\n"
    ),
    # expert settings  Enable SSL v3 help 1/1
    "SSLv3"             => _(
      "<p><b>Enable SSL v3</b><br>\n" +
        "If enabled, SSL version 3 connections are allowed.\n" +
        "</p>\n"
    ),
    # expert settings Enable TLS  help 1/1
    "TLS"               => _(
      "<p><b>Enable TLS</b><br>\n" +
        "If enabled, TLS connections are allowed.\n" +
        "</p>\n"
    ),
    # expert settings DSA Certificate to Use for SSL Encrypted Connections help 1/1
    "CertFile"          => _(
      "<p><b>DSA Certificate to Use for SSL-encrypted Connections</b><br>\n" +
        "This option specifies the location of the DSA certificate to \n" +
        "use for SSL-encrypted connections. Select a file by pressing <b>Browse</b>.\n" +
        "</p>\n"
    ),
    # expert settings Disable Downloading Unvalidated Data help 1/1
    "AntiWarez"         => _(
      "<p><b>Disable Downloading Unvalidated Data</b><br>\n" +
        "Disallow downloading of files that were uploaded \n" +
        "but not validated by a local admin.\n" +
        "</p>\n"
    ),
    # expert settings Security Settings help 1/1
    "SSL"               => _(
      "<p><b>Security Settings</b><br>\n" +
        "<i>Disable SSL/TLS</i> Disable SSL/TLS encryption layer.\n" +
        "<i>Accept SSL and TLS</i> Accept both, traditional and encrypted sessions.\n" +
        "<i>Refuse Connections Without SSL/TLS</i> Refuse connections that do not use SSL/TLS security mechanisms, including anonymous sessions.\n" +
        "</p>"
    ),
    #-----------================= SUMMARY =============----------
    #


    # Summary dialog help 1/3
    "summary"           => _(
      "<p><b><big>FTP Server Configuration</big></b><br>\nConfigure the FTP server.<br></p>\n"
    ) +
      # Summary dialog help 2/3
      _(
        "<p><b><big>Adding an FTP Server:</big></b><br>\n" +
          "Choose an FTP server from the list of detected FTP servers.\n" +
          "If your FTP server was not detected, use <b>Other (not detected)</b>.\n" +
          "Then press <b>Configure</b>.</p>\n"
      ) +
      # Summary dialog help 3/3
      _(
        "<p><b><big>Editing or Deleting</big></b><br>\n" +
          "If you press <b>Edit</b>, an additional dialog in which to change\n" +
          "the configuration opens.</p>\n"
      ),
    # Ovreview dialog help 1/3
    "overview"          => _(
      "<p><b><big>FTP Server Configuration Overview</big></b><br>\n" +
        "Obtain an overview of the installed FTP servers. Additionally,\n" +
        "edit their configurations.<br></p>\n"
    ) +
      # Ovreview dialog help 2/3
      _(
        "<p><b><big>Adding a FTP Server</big></b><br>\nPress <b>Add</b> to configure a FTP server.</p>\n"
      ) +
      # Ovreview dialog help 3/3
      _(
        "<p><b><big>Editing or Deleting</big></b><br>\n" +
          "Choose a FTP server to change or remove.\n" +
          "Then press <b>Edit</b> or <b>Delete</b> respectively.</p>\n"
      )
  }
end