- Added a proper Makefile.PL to SCST::SCST so now we have a also a
[mirror/scst/.git] / scstadmin / README
1 SCST Configuration/Administration scripts. Here you'll find scstadmin which reads
2 a configuration file /etc/scst.conf, or one if your choosing. With it you can manually
3 or automatically configure every aspect of SCST incuding enabling/disabling target mode
4 on your target SCSI controller. The old directory contains scst_db which uses a mysql
5 backend database to configure SCST but doesn't handle all the things scstadmin handles.
6 The perl module SCST::SCST is very generic and tries to handle error checking as well.
7
8 The init script was written for debian but should work on most distributions.
9
10         scst-0.7.4      This is the SCST Perl module required by scstadmin and scst_db.
11
12         scstadmin       Script which can accept operations on a command line or from
13                         a configuration file. See scst.conf. For command help,
14                                 #> scstadmin
15
16         old             Script which configures SCST using configurations
17                         found in a database. See the examples directory database
18                         schema and example data. You will need to edit the
19                         config file scst_db.conf to refect your environment.
20
21         scst.conf       Configuration file for scst script. Usually stored
22                         in /etc.
23
24         examples        Configuration examples.
25
26         init.d/scst     Init script to start SCST on boot which uses scstadmin.
27
28
29 Installation:
30 =============
31
32 Installation is simple.
33
34   #> make
35   #> make install
36
37 This installs scstadmin, the init.d script and the perl module.
38
39
40 Getting Started:
41 ================
42
43 The scstadmin script is much more functional than scst_db at this point but uses a
44 standard text-based config file. The original thought behind scst_db was to write
45 a daemon process which would except network connections and issue SCST commands. A
46 client app would then connect to that port. 
47
48 Copy scst.conf to /etc and edit it to your liking. if you have an existing configuration
49 then have scstadmin write it out to a config file for you:
50
51   #> scstadmin -WriteConfig /etc/scst.conf
52
53 When removing devices, users or groups from the config file keep in mind that
54 "scstadmin -config" will NOT remove those configurations from the running system unless
55 you use the -ForceConfig flag. Also, using the init script to reload the configuration
56
57   #> /etc/init.d/scst reload-config
58
59 will also not remove configurations from a running system.
60
61
62 Mark.Buechler@gmail.com
63