root/cherokee/trunk/doc/bundle_cherokee-admin.txt

Revision 2431, 4.7 kB (checked in by taher, 2 weeks ago)

--

Line 
1 == link:index.html[Index] -> link:bundle.html[Cherokee Bundle]
2
3 cherokee-admin
4 --------------
5
6 This is the administration interface that allows for hassle-free,
7 simple and easy configuration of the Cherokee web server. It is the
8 only administration mechanism that should be to such task and is in
9 fact the only recommended option.
10
11 image::media/images/admin_index.png[Cherokee Admin interface]
12
13 If you want to access the administration interface from the same
14 computer that you installed cherokee on, simply start the
15 administration interface by running:
16
17
18 ----
19 cherokee-admin
20 ----
21
22 You will obtain an output similar to the following one, which provides
23 the information needed to be able to access the configuration
24 interface. This information is generated randomly each time the
25 program is launche, and it can be very useful in case you need to to
26 give temporary access to a remote administrator in the confidence that
27 no future accesses will be possible.
28
29 ----
30 Login:
31   User:              admin
32   One-time Password: 72O3GRxZfTrE2zHx
33
34 Cherokee Web Server 0.11.0 (Nov 13 2008): Listening on port 9090, TLS disabled,
35 IPv6 disabled, using epoll, 1024 fds system limit, max. 505 connections,
36 single thread
37 ----
38
39 Then redirect your web browser to 127.0.0.1:9090, which is the default
40 address and port for the administration interface. The _User_ and
41 _One-time Password_ will be required initially. This is to prevent
42 other users of the local host from being able to configure the server
43 unless they have access to the password.
44
45 image::media/images/admin_launch.png[Cherokee admin interface]
46
47 If you want to access the administration interface from another
48 computer, the easiest solution is to bind the cherokee administration
49 interface to all network interfaces:
50
51 ----
52 cherokee-admin -b
53 ----
54
55 WARNING: By starting cherokee-admin listening on all interfaces,
56 everyone that can access the computer and has the password can alter
57 your cherokee configuration. Don't use this in a production
58 environment! It is much better to use 'ssh -L' in these cases.
59
60 Instead of binding it to every interface, we encourage you to use an
61 SSH tunnel. This is the recommended way. In order to do so you must
62 issue the following command:
63
64 ----
65 ssh -L 9090:localhost:9090 remote_IP
66 ----
67
68 After that you can access the remote interface through
69 http://localhost:9090 and every request will be forwarded to the
70 remote IP running cherokee-admin.
71
72 Of course these options can be combined to your heart's contempt.
73
74 .Example:
75 Make cherokee use a different configuration file, listen on port 9091
76 and grab the administration interface application from a different
77 path:
78
79 ----
80 cherokee-admin -b -p 9091 -C /etc/cherokee/cherokee2.conf \
81                  -d /path/to/svn/trunk/cherokee-admin/
82 ----
83
84 This is the full information provided by the manpage.
85 **********************************************************************
86 *NAME*::
87        `cherokee-admin` - Runs Cherokee’s administrative interface
88
89 *SYNOPSIS*::
90        `cherokee-admin` [-d DIR] [-p PORT] [-C FILE] [-a]
91
92 *DESCRIPTION*::
93        `cherokee-admin` runs the server for the administrative interface used to
94        configure Cherokee. The interface itself will be available via your Web
95        browser.
96
97 *OPTIONS*::
98        `cherokee-admin` accepts the following options:
99
100        -h, --help;;
101                Shows brief usage information
102
103        -V, --version;;
104                Show version and exit
105
106        -x, --debug;;
107
108                Print the backend errors to the terminal where it is executing.
109                If omited, this debug information is lost.
110
111        -b, --bind[=IP];;
112                By  default `cherokee-admin` binds only to 127.0.0.1 (localhost),
113                which means you can only connect to it from  the  same  system.
114                With this parameter you can specify the network address
115                to listen to. If no IP is provided, it will bind to all
116                interfaces.
117
118
119        -C, --target=PATH;;
120                Requests  a  configuration  file  different  than  the  default
121                /etc/cherokee/cherokee.conf to be used
122
123        -d, --appdir=DIR;;
124                Uses a custom admin-interface path
125
126        -p, --port=NUM;;
127                Specifies an alternative port. By default, 9090.
128
129        -u, --unsecure;;
130                Allows accessing cherokee-admin's interface without
131                requiring the user to authenticate. This disables a
132                security measure and is only meant to ease the
133                development process. The usage of this parameter is
134                strongly discouraged for regular users.
135
136 **********************************************************************
137
138 Refer to the link:config_quickstart.html[configuration section] for
139 more in-depth explanations of the usage of the interface as a
140 configuration tool.
Note: See TracBrowser for help on using the browser.