upward link
[ikiwiki.git] / docs / newhandbook / environmentquickstart / index.mdwn
1 # DragonFly BSD Quick Start
2
3 This QuickStart is part of the [[NewHandbook|/docs/newhandbook/]].
4
5 This document describes the DragonFly environment one will find on a newly installed system.  While you are getting started please pay careful attention to the version or level of DragonFly that the documentation was written for.  Some documentation on this site may be out of date. Watch for the marker `(obsolete)` on items that are out of date or need updating.
6
7 [[!toc levels=3 ]]
8 ## Some Unix and BSD Fundamentals
9
10 If you have used another Unix flavor, another BSD or Linux before, you may need to spend some time learning basic subjects.  If you have never used any flavor of Unix, BSD or otherwise, and have only used Windows before, please be prepared for a lengthy period of learning.
11
12 If you already know your way around a Unix filesystem, and already know what the `/etc` folder is, how to use `vi` or `vim` to edit a file, how to use a shell like `tcsh` or `bash`, how to configure that shell, or change what shell you're using, how `su` and `sudo` work, and what a `root` account is, then you may get a lot farther in using any BSD variant (like Dragonfly BSD) then the rest of this page may be enough to orient you to your surroundings.
13
14 You should understand everything in the [[Unix Basics|/docs/newhandbook/UnixBasics/]] section before you proceed with trying to use your new system.
15
16
17 ## Disk layout
18
19 If you chose to install on the HAMMER file system during installation you will be left with a system with the following disk configuration:
20
21     # df -h
22     Filesystem                Size   Used  Avail Capacity  Mounted on
23     ROOT                      288G    12G   276G     4%    /
24     devfs                     1.0K   1.0K     0B   100%    /dev
25     /dev/serno/9VMBWDM1.s1a   756M   138M   558M    20%    /boot
26     /pfs/@@-1:00001           288G    12G   276G     4%    /var
27     /pfs/@@-1:00002           288G    12G   276G     4%    /tmp
28     /pfs/@@-1:00003           288G    12G   276G     4%    /usr
29     /pfs/@@-1:00004           288G    12G   276G     4%    /home
30     /pfs/@@-1:00005           288G    12G   276G     4%    /usr/obj
31     /pfs/@@-1:00006           288G    12G   276G     4%    /var/crash
32     /pfs/@@-1:00007           288G    12G   276G     4%    /var/tmp
33     procfs                    4.0K   4.0K     0B   100%    /proc
34
35 In this example
36
37 * `/dev/serno/9VMBWDM1` is the hard disk specified with serial number,
38 * `/dev/serno/9VMBWDM1.s1` is the first slice on the hard disk.
39
40 The disklabel looks at follows
41
42     # disklabel /dev/serno/9VMBWDM1.s1
43
44     # /dev/serno/9VMBWDM1.s1:
45     #
46     # Informational fields calculated from the above
47     # All byte equivalent offsets must be aligned
48     #
49     # boot space:    1044992 bytes
50     # data space:  312567643 blocks # 305241.84 MB (320069266944 bytes)
51     #
52     # NOTE: If the partition data base looks odd it may be
53     #       physically aligned instead of slice-aligned
54     #
55     diskid: e67030af-d2af-11df-b588-01138fad54f5
56     label:
57     boot2 data base:      0x000000001000
58     partitions data base: 0x000000100200
59     partitions data stop: 0x004a85ad7000
60     backup label:         0x004a85ad7000
61     total size:           0x004a85ad8200    # 305242.84 MB
62     alignment: 4096
63     display block size: 1024        # for partition display only
64
65     16 partitions:
66     #          size     offset    fstype   fsuuid
67       a:     786432          0    4.2BSD    #     768.000MB
68       b:    8388608     786432      swap    #    8192.000MB
69       d:  303392600    9175040    HAMMER    #  296281.836MB
70       a-stor_uuid: eb1c8aac-d2af-11df-b588-01138fad54f5
71       b-stor_uuid: eb1c8aec-d2af-11df-b588-01138fad54f5
72       d-stor_uuid: eb1c8b21-d2af-11df-b588-01138fad54f5
73
74
75 The slice has 3 partitions:
76
77 * `a` - for `/boot`
78 * `b` - for swap
79 * `d` - for `/`, a HAMMER file system labeled ROOT
80
81 When you create a HAMMER file system you must give it a label, here the installer labeled it as "ROOT" and mounted it as
82
83     ROOT                      288G    12G   276G     4%    /
84
85 A PFS is a Pseudo File System inside a HAMMER file system. The HAMMER file system in which the PFSes are created is referred to as the root file system. You should not confuse the "root" file system with the Label "ROOT", the label can be anything. It is just that the installer labeled it as ROOT because it is mounted as `/`.
86
87 Now inside the ROOT HAMMER file system you find the installed created 7 PFSes from the `df -h` output above, let us see how they are mounted in `/etc/fstab`:
88
89     # cat /etc/fstab
90
91     # Device                Mountpoint      FStype  Options         Dump    Pass#
92     /dev/serno/9VMBWDM1.s1a         /boot           ufs     rw      1       1
93     /dev/serno/9VMBWDM1.s1b         none            swap    sw      0       0
94     /dev/serno/9VMBWDM1.s1d         /               hammer  rw      1       1
95     /pfs/var                /var            null    rw              0       0
96     /pfs/tmp                /tmp            null    rw              0       0
97     /pfs/usr                /usr            null    rw              0       0
98     /pfs/home               /home           null    rw              0       0
99     /pfs/usr.obj    /usr/obj                null    rw              0       0
100     /pfs/var.crash  /var/crash              null    rw              0       0
101     /pfs/var.tmp    /var/tmp                null    rw              0       0
102     proc                    /proc           procfs  rw              0       0
103
104
105 The PFSes are mounted using a NULL mount because they are also HAMMER file systems. You can read more on NULL mounts here [mount_null(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=mount_null&section=8).
106
107 You don't need to specify a size for the PFSes like you do for logical volumes inside a volume group for LVM. All the free space in the root HAMMER file system is available to all the PFSs. That is the reason in the `df -h` output above you saw free space is same for all PFSes and the root HAMMER file system.
108
109 Now if you look in `/var`
110
111     # cd /var/
112     # ls
113     account   backups   caps   cron    empty   log   msgs   run   spool   yp  at        
114     cache     crash     db     games   lib     mail  preserve   rwho  tmp
115
116 you will find the above directories.
117
118 If you look at the status of one of the PFSes, e.g. `/usr` you will see `/var/hammer` is the default snapshot directory.
119
120     # hammer pfs-status /usr/
121     /usr/   PFS #3 {
122         sync-beg-tid=0x0000000000000001
123         sync-end-tid=0x0000000117ac6270
124         shared-uuid=f33e318e-d2af-11df-b588-01138fad54f5
125         unique-uuid=f33e31cb-d2af-11df-b588-01138fad54f5
126         label=""
127         prune-min=00:00:00
128         operating as a MASTER
129         snapshots directory defaults to /var/hammer/<pfs>
130     }
131
132 There is no "hammer" directory in `/var` now. That is because no snapshots are yet taken. You can verify this by checking the snapshots available for `/usr`
133
134     # hammer snapls /usr
135     Snapshots on /usr       PFS #3
136     Transaction ID          Timestamp               Note
137
138 Snapshots will appear automatically each night as the system performs housekeeping on the Hammer filesystem.  For a new volume, an immediate snapshot can be taken by running the command 'hammer cleanup'.  Among other activites, it will take a snapshot of the filesystem.
139
140     # sudo hammer cleanup
141     cleanup /                    - HAMMER UPGRADE: Creating snapshots
142             Creating snapshots in /var/hammer/root
143      handle PFS #0 using /var/hammer/root
144                snapshots - run
145                    prune - run
146                rebalance - run..
147                  reblock - run....
148                   recopy - run....
149     cleanup /var                 - HAMMER UPGRADE: Creating snapshots
150     [...]
151     cleanup /tmp                 - HAMMER UPGRADE: Creating snapshots
152     [...]
153     cleanup /usr                 - HAMMER UPGRADE: Creating snapshots
154     [...]
155     cleanup /home                - HAMMER UPGRADE: Creating snapshots
156     [...]
157     cleanup /usr/obj             - HAMMER UPGRADE: Creating snapshots
158     [...]
159     cleanup /var/crash           - HAMMER UPGRADE: Creating snapshots
160     [...]
161     cleanup /var/tmp             - HAMMER UPGRADE: Creating snapshots
162     [...]
163     cleanup /var/isos            - HAMMER UPGRADE: Creating snapshots
164     [...]
165
166 No snapshots were taken for `/tmp`, `/usr/obj` and `/var/tmp`. This is because the PFSes are flagged as `nohistory`. HAMMER tracks history for all files in a PFS, naturally this consumes disk space until the history is pruned. To prevent that temporary files on the mentioned PFSes (e.g., object files, crash dumps) consume disk space, the PFSes are marked as `nohistory`.
167
168 In `/var` will be a new directory called *hammer* with the following sub directories
169
170
171     # cd hammer/
172     # ls -l
173     total 0
174     drwxr-xr-x  1 root  wheel  0 Oct 13 11:51 home
175     drwxr-xr-x  1 root  wheel  0 Oct 13 11:42 root
176     drwxr-xr-x  1 root  wheel  0 Oct 13 11:43 tmp
177     drwxr-xr-x  1 root  wheel  0 Oct 13 11:51 usr
178     drwxr-xr-x  1 root  wheel  0 Oct 13 11:54 var
179
180
181 Well let us look inside `/var/hammer/usr`
182
183
184     # cd usr/
185     # ls -l
186     total 0
187     drwxr-xr-x  1 root  wheel   0 Oct 13 11:54 obj
188     lrwxr-xr-x  1 root  wheel  25 Oct 13 11:43 snap-20101013-1143 -> /usr/@@0x0000000117ac6cb0
189
190
191 We have a symlink pointing to the snapshot transaction ID shown below.
192
193
194     # hammer snapls /usr
195     Snapshots on /usr       PFS #3
196     Transaction ID          Timestamp               Note
197     0x0000000117ac6cb0      2010-10-13 11:43:04 IST -
198     #
199
200
201 You can read more about snapshots, prune, reblance, reblock, recopy etc from [hammer(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=hammer&section=8) especially look under the heading "cleanup [filesystem ...]"
202
203 You can learn more about PFS mirroring [here](http://www.dragonflybsd.org/docs/how_to_implement_hammer_pseudo_file_system__40___pfs___41___slave_mirroring_from_pfs_master/)
204
205 In order to correctly map hard disk sernos to device names you can use the 'devattr' command.
206
207     # udevd
208     # devattr -d "ad*" -p serno
209     Device ad4:
210             serno = Z2AD9WN4
211     Device ad4s1:
212     Device ad4s1d:
213
214     Device ad5:
215             serno = 9VMRFDSY
216     Device ad5s1:
217     Device ad5s1d:
218
219     Device ad3:
220             serno = Z2AD9WLW
221     Device ad3s1:
222     Device ad3s1a:
223     Device ad3s1b:
224     Device ad3s1d:
225
226 Or if your disks are 'da', just change it as appropiate.
227
228 ## Configuring and Starting the SSH Server
229
230 Described in detail [[here|/docs/newhandbook/sshserver/]]
231
232 ## Software/Programs and Configuration Files Location 
233
234 DragonFly default installation contains the base software/programs from the DragonFly project itself and few other software from [pkgsrc](http://www.netbsd.org/docs/software/packages.html) which is the DragonFly official package management system. Ready to install binary software from pkgsrc is referred to as *packages*.
235
236 The base programs are located in the folders 
237
238     /bin    /sbin
239     /usr/bin   /usr/sbin
240
241 The configuration files for the base system can be found in `/etc`. There is also `/usr/local/etc` which is used by third-party programs. The software/programs from pkgsrc are located in `/usr/pkg/bin` and `/usr/pkg/sbin`. Their configuration files are found in `/usr/pkg/etc`.
242
243 ## Installing Third-party Software
244
245 Have a look at the [[dports howto|/docs/howtos/HowToDPorts/]] for an in-depth description about dealing with packaging systems. Note that DragonFly BSD has several older package managers (like `pkgin`), but that the most modern binary package installation system as of 2014, is `pkg`.
246
247 ### Using pkg
248
249 Read [[dports howto|/docs/howtos/HowToDPorts/]] then for some errata, read [[this|http://lists.dragonflybsd.org/pipermail/users/2013-November/090339.html]].
250
251
252 You can look at the help and the man page for the pkg tool like this:
253
254 `pkg help install`
255
256 Example: Read man page for pkg-install
257
258 `man pkg-install`
259
260
261 ### Installing an X desktop environment
262
263 If it's already on your system run X by typing `startx`. If it's not, install
264 it using `pkg install`.
265
266 `(obsolete)`
267 Slightly out of date instructions on installing a GUI (X desktop) environment  are in the [new handbook](http://www.dragonflybsd.org/docs/newhandbook/X/).
268