document new archive host ASA extension
[BackupPC.git] / init.d / README
1 This directory contains some scripts for auto-starting BackupPC
2 on boot.
3
4 The subdirectory src contains source versions of these scripts (before
5 various absolute paths have been filled in).
6
7 Here are instrcutions for different OSs.  Please submit additions
8 or improvements to this list!
9
10 RedHat Linux:
11 ============
12
13 When configure.pl is run, the script linux-backuppc is created. It
14 should be copied to /etc/init.d/backuppc:
15
16     cp linux-backuppc /etc/init.d/backuppc
17
18 After copying it, you can test it by running these commands as root:
19
20     /etc/init.d/backuppc start
21     /etc/init.d/backuppc status
22     /etc/init.d/backuppc stop
23
24 You should then run the following commands as root:
25
26     chkconfig --add backuppc
27     chkconfig --level 345 backuppc on
28     chkconfig --list backuppc
29
30 This will auto-start backuppc at run levels 3, 4 and 5.
31
32 Debian Linux:
33 ============
34
35 When configure.pl is run, the script debian-backuppc is created.
36
37 Copy the debian startup script:
38
39     cp debian-backuppc /etc/init.d/backuppc
40
41 Run the following command to install in rc.d:
42
43     update-rc.d backuppc defaults
44
45 Set the correct init.d rights:
46
47     chmod 755 /etc/init.d/backuppc
48
49 Usage: /etc/init.d/backuppc {start|stop|restart|reload}
50
51 Suse Linux:
52 ==========
53
54 When configure.pl is run, the script suse-backuppc is created.
55
56 Using Suse 9.0 "chkconfig --level" doesn't work, so you should run:
57
58     chkconfig backuppc 345
59     chkconfig --list backuppc
60
61 Gentoo Linux:
62 ============
63
64 When configure.pl is run, the script gentoo-backuppc and the init conf files
65 gentoo-backuppc.conf are created. They should be copied to the following
66 locations:
67
68     cp gentoo-backuppc /etc/init.d/backuppc
69     cp gentoo-backuppc.conf /etc/conf.d/backuppc
70
71 You can test it by running these commands as root:
72
73     /etc/init.d/backuppc start
74     /etc/init.d/backuppc status
75     /etc/init.d/backuppc stop
76
77 After copying these files, run the following  as root to make BackupPC to
78 start automatically at boot (at the default run level):
79
80     rc-update add backuppc default
81
82 FreeBSD:
83 =======
84
85 When configure.pl is run, the script freebsd-backuppc is created.
86 An alternative more compact script is freebsd-backuppc2, submitted
87 by Dan Niles.
88
89 Copy one of these scripts to /usr/local/etc/rc.d/backuppc and make
90 execuatble.
91
92 Add the following line to /etc/rc.conf to enable BackupPC:
93
94 backuppc_enable=(bool):   Set to "NO" by default.
95                           Set it to "YES" to enable BackupPC.
96
97 Example:
98
99     backuppc_enable="YES"
100
101 The script accepts: start, stop, restart, reload, status
102
103 Slackware:
104 =========
105
106 When configure.pl is run, the script slackware-backuppc is created.
107
108 Install it by running these commands as root:
109
110     cp slackware-backuppc /etc/rc.d/rc.backuppc
111     chmod 755 /etc/rc.d/rc.backuppc
112
113 then use an editor to add /etc/rc.d/rc.backuppc to /etc/rc.d/rc.local
114
115 Solaris:
116 =======
117
118 When configure.pl is run the shell script solaris-backuppc is created.
119 This should be copied to /etc/init.d and links made in /etc/rc3.d
120 and /etc/rc0.d.
121
122     cp solaris-backuppc /etc/init.d/backuppc
123     ln -s /etc/init.d/backuppc /etc/rc3.d/S85backuppc
124     ln -s /etc/init.d/backuppc /etc/rc0.d/K85backuppc
125
126 This will auto-start backuppc at run level 3 and stop it at run level 0.
127
128 (Can a Solaris user please tell me if these instructions are correct?)