Handle hostnames with upper-case letters
[webmin.git] / README
1 Webmin Version 1.570
2 --------------------
3 Webmin is a web-based interface for system administration for Unix. 
4 Using any browser that supports tables and forms, you can setup user
5 accounts, Apache, internet services, DNS, file sharing and so on. 
6
7 Webmin consists of a simple web server, and a number of CGI programs
8 which directly update system files like /etc/inetd.conf and /etc/passwd.
9 The web server and all CGI programs are written in Perl version 5, and use
10 only the standard perl modules. 
11
12 Webmin can be installed in two different ways :
13
14 1) By just running the setup.sh script in the same directory as this README
15    file, with no arguments. You will be asked a series of questions such as
16    the configuration directory, your chosen login name and password, and
17    possibly your operating system. For questions where a default is shown
18    in square brackets, you can just hit enter to accept the default (which
19    is usually correct).
20
21    If the configuration directory you enter is the same as that used by
22    a previous install of Webmin, it will be automatically upgraded with all
23    configurable settings preserved.
24
25    This will set up Webmin to run directly from this directory. After running
26    setup.sh, do not delete the directory as it contains all the scripts and
27    programs that will be used by Webmin when it is running. Unlike in the second
28    installation method, the Webmin scripts do not get copied to another
29    location when installing.
30
31 2) By running the setup.sh script in this directory, but with a command-line
32    argument such as /usr/local/webmin . When a directory like this is provided,
33    Webmin's scripts will be copied to the chosen directory and it will be
34    configured to run from that location.
35
36    The exact same questions will be asked by setup.sh when it is run with
37    a directory argument, and upgrading will work in the same way. If you
38    are upgrading an old install, you should enter the same directory argument
39    so that the new files overwrite the old in order to save disk space.
40
41    After Webmin has been installed to a specific directory using this method,
42    the directory extracted from the tar.gz file can be safely deleted.
43
44 If you are installing Webmin on a Windows system, you must run the command
45 perl setup.pl instead, as shell scripts will not typically run on a Windows
46 system. The Windows version depends on several programs and modules that may
47 not be part of the standard distribution. You will need the process.exe
48 commmand, the sc.exe command and the Win32::Daemon Perl module.
49
50 For more information, see http://www.webmin.com/
51
52 Jamie Cameron
53 jcameron@webmin.com
54