summaryrefslogtreecommitdiff
path: root/fml/doc/en/tutorial/setup/cgi.sgml
blob: 27c7f5f3a8cd5466f65c53202e6a7bc439e25f59 (plain)
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
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
<!--
   $FML: cgi.sgml,v 1.2 2005/07/23 01:57:36 fukachan Exp $
   $jaFML: cgi.sgml,v 1.4 2003/04/15 14:51:43 fukachan Exp $
-->

<chapter id="setupcgi">
	<title>
	Configure CGI
	</title>


<warning>

<para>
See the section
<link linkend="cgi.internal.method">
<xref linkend="cgi.internal.method">
</link>
for CGI Internal details.
</para>

<para>
We assumes 
<link linkend="setup.apache.suexec">
you use suexec under apache.
</link>
</para>

<para>
Now &fml8; provides both the master cgi to control all ML's in one
domain and a cgi for each ML.
You can add and remove a user, or view member list et.al. by this interface.
Editing of configuration on this cgi is incomplete.
</para>

<para>
If you use postfix and qmail, you do not need to modify MTA
configuration for cgi specific reason.
</para>

</warning>


<sect1 id="setupcgi.install">
	<title>
	"makefml newml" Creates CGI Script Always
	</title>

<para>
"makefml newml" sets up CGI scripts such as config.cgi under 
~fml/public_html/... directory.
There are two types of cgi scripts.
One is for the whole domain, one for each ML. 
</para>

<para>
In creating elena@fml.org ML, makefml creates the following cgi
<screen>
http://lists.fml.org/~fml/cgi-bin/fml/$domain/admin/config.cgi

[Example]
http://lists.fml.org/~fml/cgi-bin/fml/fml.org/admin/config.cgi
</screen>
for all ML's of fml.org.
</para>

<para>
To control only elena ML, please use 
<screen>
http://lists.fml.org/~fml/cgi-bin/fml/$domain/ml-admin/${ml_name}/config.cgi

[Example]
http://lists.fml.org/~fml/cgi-bin/fml/fml.org/ml-admin/elena/config.cgi
</screen>
</para>

<para>
<graphic entityref="image.cgi.newml"></graphic>
</para>

</sect1>


<sect1 id="setupcgi.htaccess">
	<title>
	Edit .htaccess
	</title>

<para>
.htaccess is created but it is configured to deny all.
<screen>
http://lists.fml.org/~fml/cgi-bin/fml/$domain/.htaccess

[Example]
http://lists.fml.org/~fml/cgi-bin/fml/fml.org/.htaccess
</screen>
</para>

<para>
The default .htaccess is a dummy like this:
<screen>
AuthName ByPassword
AuthType Basic
require valid-user
</screen>
Please edit .htaccess properly.
</para>

<para>
Apache does not support ~user style access by default.
Please set up apache to enable it.
</para>

</sect1>


<sect1 id="setupcgi.admin.cgi.overview">
	<title>
	Example: Master Cgi
	</title>

<para>
The role of this cgi is same as limited makefml (CUI).
Though this cgi permits ML creation and destruction,
all functions makefml has are not supported.
The function is limited.
</para>

<para>
<screen>
Eample: TOP MENU

                     @home.fml.org CGI for configuration

fml admin menu             fml CGI interface for @home.fml.org ML's
mailing list:
[elena]              
command:             	.. help message ...
[subscribe  ]        
[submit][reset]
                     subscribe   
                     unsubscribe 
                     addadmin    
                     byeadmin    
options Language:    list        
[Japanese] [change]  log         
                     newml       
                     rmml        
</screen>
</para>

<para>
<graphic entityref="image.cgi.top"></graphic>
</para>


</sect1>


<sect1 id="setupcgi.admin.cgi.newml">
	<title>
	CGI Example: Create ML
	</title>

<para>
Select newml and push "submit".
No need to select ML name in this stage.
</para>

<para>
You find another menu at the center.
Specify the ML name you create and push "submit" at the center.
</para>

<para>
<graphic entityref="image.cgi.newml"></graphic>
</para>

</sect1>


<sect1 id="setupcgi.admin.cgi.subscribe">
	<title>
	CGI Example: subscribe
	</title>

<para>
Specify the ML name and select "subscribe", push "submit".
</para>

<para>
You find another menu at the center.
Specify the address to subscribe and push "submit" at the center.
</para>

<para>
<graphic entityref="image.cgi.useradd"></graphic>
</para>

</sect1>


<sect1 id="setupcgi.admin.cgi.skin">
	<title>
	CGI Skin Selection
	</title>	

<para>
config.cgi is TABLE and SELECT based.
If you use old style menu, use menu.cgi.
<screen>
for a whole domain
~fml/public_html/fml/DOMAIN/admin/menu.cgi

for a ml
~fml/public_html/fml/DOMAIN/ml-admin/menu.cgi
</screen>
</para>

</sect1>


</chapter>