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

Revision 1844, 4.0 kB (checked in by taher, 4 months ago)

--

Line 
1 == link:index.html[Index] -> link:bundle.html[Cherokee Bundle]
2
3 Cherokee Bundle: cherokee-tweak
4 -------------------------------
5
6 This command-line tool is also not as well known as it would. Again
7 this is not by lack of merits, which in fact are considerable. Its
8 intended audience are also system administrators and developers.
9
10 `cherokee-tweak` is a swiss army knife that allows to perform several
11 administrative tasks from the command line. It can connect to a
12 running Cherokee instance, be it in the local computer or at a remote
13 location, and request it to perform several actions.
14
15 These actions are:
16
17   * Log rotation: `logrotate`.
18
19   * Live tracing: `trace`.
20
21   * Provide information: `info`.
22
23
24 This is the full information provided by the manpage.
25 **********************************************************************
26 *NAME*::
27        cherokee-tweak  - Command-line interface to the Cherokee administrative
28        interface
29
30 *SYNOPSIS*::
31        cherokee-tweak -c command -a url [options]
32
33 *DESCRIPTION*::
34        cherokee-tweak connects to running cherokee instance, either  local  or
35        remote, and requests it to perform one of several actions.
36
37 *OPTIONS*::
38        cherokee-tweak accepts the following options:
39
40        -h, --help;;
41                Shows brief usage information
42
43        -V, --version;;
44                Prints version and exits
45
46        -u, --user= STRING;;
47                Specifies the user name with which to identify to the server
48
49        -p, --password=STRING;;
50                Specifies the password with which to identify to the server
51
52        -c, --command=STRING;;
53                Required option. Command to execute: logrotate, trace or info
54
55        -a, --url=URL;;
56                Required  option. URL where the administrative interface can be
57                found.  This target must be  defined  previously  in  cherokee-
58                admin, enabling a "Remote Administration" type handler (Virtual
59                Servers->Behaviour->Add new  rule,  and  then  Handler->"Remote
60                Administration").  The  deffinition of a security mechanisim is
61                highly encouraged.
62
63        -l, --log=PATH;;
64                Log file to be rotated (Only to be used when -c is logrotate)
65
66        -t, --trace=STRING;;
67                Modules to be traced (Only to be used when -c is trace). Chero‐
68                kee must have been compiled with the --enable-trace for this to
69                work. Everything traceable  with  CHEROKEE_TRACE  can  also  be
70                traced this way.
71 **********************************************************************
72
73 To use `cherokee-tweak`, an administrative interface must be defined
74 within link:bundle_cherokee-admin.html[cherokee-admin]. That is, you
75 must define a path managed by the handler `Remote
76 Administration`. This can be done through the 'Virtual Servers' option,
77 in 'Behaviour' and using the 'Add new rule' option.
78
79 image::media/images/admin_handler_admin.png[Setting up an admin interface]
80
81 Please note that while you are at it, the deffinition of a security
82 (through the 'Security' tab) is highly encouraged. Although you have
83 the choice to, you should never use 'None' as security mechanisim
84 since this would leave your system exposed to third parties using
85 `cherokee-tweak`.
86
87 Also note that the usage of the `trace` command has no effect unless
88 Cherokee is compiled with the `--enable-trace`. This is a debugging
89 option and it is unlikely to be present in binary version of Cherokee
90 not specifically compiled with this in mind.
91
92 Every module traceable with CHEROKEE_TRACE can also be traced this
93 way. Refer to the link:dev_debug.html["Debugging"] section of the
94 documentation for more information on this matter.
95
96 Keep in mind one important thing: when the `-t` option is specificed,
97 `cherokee-tweak` activates the tracing functionality within the
98 `cherokee` instance. It does not provide tracing of its own. This
99 means the debugging information will appear in the machine that is
100 actually running the `cherokee` instance. This may or may not be the
101 same that is running the `cherokee-tweak` process.
Note: See TracBrowser for help on using the browser.