removing VM idea moving it somewhere else
[ikiwiki.git] / docs / newhandbook / environmentquickstart / index.mdwn
1 # DragonFly BSD Quick Start
2
3 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.
4
5 [[!toc levels=3 ]]
6 ## Some Unix and BSD Fundamentals
7
8 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.
9
10 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.
11
12 You should understand everything in the [[Unix Basics|/docs/newhandbook/UnixBasics/]] section before you proceed with trying to use your new system.
13
14
15 ## Disk layout
16
17 If you chose to install on the HAMMER file system during installation you will be left with a system with the following disk configuration:
18
19     # df -h
20     Filesystem                Size   Used  Avail Capacity  Mounted on
21     ROOT                      288G    12G   276G     4%    /
22     devfs                     1.0K   1.0K     0B   100%    /dev
23     /dev/serno/9VMBWDM1.s1a   756M   138M   558M    20%    /boot
24     /pfs/@@-1:00001           288G    12G   276G     4%    /var
25     /pfs/@@-1:00002           288G    12G   276G     4%    /tmp
26     /pfs/@@-1:00003           288G    12G   276G     4%    /usr
27     /pfs/@@-1:00004           288G    12G   276G     4%    /home
28     /pfs/@@-1:00005           288G    12G   276G     4%    /usr/obj
29     /pfs/@@-1:00006           288G    12G   276G     4%    /var/crash
30     /pfs/@@-1:00007           288G    12G   276G     4%    /var/tmp
31     procfs                    4.0K   4.0K     0B   100%    /proc
32
33 In this example
34
35 * `/dev/serno/9VMBWDM1` is the hard disk specified with serial number,
36 * `/dev/serno/9VMBWDM1.s1` is the first slice on the hard disk.
37
38 The disklabel looks at follows
39
40     # disklabel /dev/serno/9VMBWDM1.s1
41
42     # /dev/serno/9VMBWDM1.s1:
43     #
44     # Informational fields calculated from the above
45     # All byte equivalent offsets must be aligned
46     #
47     # boot space:    1044992 bytes
48     # data space:  312567643 blocks # 305241.84 MB (320069266944 bytes)
49     #
50     # NOTE: If the partition data base looks odd it may be
51     #       physically aligned instead of slice-aligned
52     #
53     diskid: e67030af-d2af-11df-b588-01138fad54f5
54     label:
55     boot2 data base:      0x000000001000
56     partitions data base: 0x000000100200
57     partitions data stop: 0x004a85ad7000
58     backup label:         0x004a85ad7000
59     total size:           0x004a85ad8200    # 305242.84 MB
60     alignment: 4096
61     display block size: 1024        # for partition display only
62
63     16 partitions:
64     #          size     offset    fstype   fsuuid
65       a:     786432          0    4.2BSD    #     768.000MB
66       b:    8388608     786432      swap    #    8192.000MB
67       d:  303392600    9175040    HAMMER    #  296281.836MB
68       a-stor_uuid: eb1c8aac-d2af-11df-b588-01138fad54f5
69       b-stor_uuid: eb1c8aec-d2af-11df-b588-01138fad54f5
70       d-stor_uuid: eb1c8b21-d2af-11df-b588-01138fad54f5
71
72
73 The slice has 3 partitions:
74
75 * `a` - for `/boot`
76 * `b` - for swap
77 * `d` - for `/`, a HAMMER file system labeled ROOT
78
79 When you create a HAMMER file system you must give it a label, here the installer labeled it as "ROOT" and mounted it as
80
81     ROOT                      288G    12G   276G     4%    /
82
83 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 `/`.
84
85 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`:
86
87     # cat /etc/fstab
88
89     # Device                Mountpoint      FStype  Options         Dump    Pass#
90     /dev/serno/9VMBWDM1.s1a         /boot           ufs     rw      1       1
91     /dev/serno/9VMBWDM1.s1b         none            swap    sw      0       0
92     /dev/serno/9VMBWDM1.s1d         /               hammer  rw      1       1
93     /pfs/var                /var            null    rw              0       0
94     /pfs/tmp                /tmp            null    rw              0       0
95     /pfs/usr                /usr            null    rw              0       0
96     /pfs/home               /home           null    rw              0       0
97     /pfs/usr.obj    /usr/obj                null    rw              0       0
98     /pfs/var.crash  /var/crash              null    rw              0       0
99     /pfs/var.tmp    /var/tmp                null    rw              0       0
100     proc                    /proc           procfs  rw              0       0
101
102
103 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).
104
105 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.
106
107 Now if you look in `/var`
108
109     # cd /var/
110     # ls
111     account   backups   caps   cron    empty   log   msgs   run   spool   yp  at        
112     cache     crash     db     games   lib     mail  preserve   rwho  tmp
113
114 you will find the above directories.
115
116 If you look at the status of one of the PFSes, e.g. `/usr` you will see `/var/hammer` is the default snapshot directory.
117
118     # hammer pfs-status /usr/
119     /usr/   PFS #3 {
120         sync-beg-tid=0x0000000000000001
121         sync-end-tid=0x0000000117ac6270
122         shared-uuid=f33e318e-d2af-11df-b588-01138fad54f5
123         unique-uuid=f33e31cb-d2af-11df-b588-01138fad54f5
124         label=""
125         prune-min=00:00:00
126         operating as a MASTER
127         snapshots directory defaults to /var/hammer/<pfs>
128     }
129
130 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`
131
132     # hammer snapls /usr
133     Snapshots on /usr       PFS #3
134     Transaction ID          Timestamp               Note
135
136 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.
137
138     # sudo hammer cleanup
139     cleanup /                    - HAMMER UPGRADE: Creating snapshots
140             Creating snapshots in /var/hammer/root
141      handle PFS #0 using /var/hammer/root
142                snapshots - run
143                    prune - run
144                rebalance - run..
145                  reblock - run....
146                   recopy - run....
147     cleanup /var                 - HAMMER UPGRADE: Creating snapshots
148     [...]
149     cleanup /tmp                 - HAMMER UPGRADE: Creating snapshots
150     [...]
151     cleanup /usr                 - HAMMER UPGRADE: Creating snapshots
152     [...]
153     cleanup /home                - HAMMER UPGRADE: Creating snapshots
154     [...]
155     cleanup /usr/obj             - HAMMER UPGRADE: Creating snapshots
156     [...]
157     cleanup /var/crash           - HAMMER UPGRADE: Creating snapshots
158     [...]
159     cleanup /var/tmp             - HAMMER UPGRADE: Creating snapshots
160     [...]
161     cleanup /var/isos            - HAMMER UPGRADE: Creating snapshots
162     [...]
163
164 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`.
165
166 In `/var` will be a new directory called *hammer* with the following sub directories
167
168
169     # cd hammer/
170     # ls -l
171     total 0
172     drwxr-xr-x  1 root  wheel  0 Oct 13 11:51 home
173     drwxr-xr-x  1 root  wheel  0 Oct 13 11:42 root
174     drwxr-xr-x  1 root  wheel  0 Oct 13 11:43 tmp
175     drwxr-xr-x  1 root  wheel  0 Oct 13 11:51 usr
176     drwxr-xr-x  1 root  wheel  0 Oct 13 11:54 var
177
178
179 Well let us look inside `/var/hammer/usr`
180
181
182     # cd usr/
183     # ls -l
184     total 0
185     drwxr-xr-x  1 root  wheel   0 Oct 13 11:54 obj
186     lrwxr-xr-x  1 root  wheel  25 Oct 13 11:43 snap-20101013-1143 -> /usr/@@0x0000000117ac6cb0
187
188
189 We have a symlink pointing to the snapshot transaction ID shown below.
190
191
192     # hammer snapls /usr
193     Snapshots on /usr       PFS #3
194     Transaction ID          Timestamp               Note
195     0x0000000117ac6cb0      2010-10-13 11:43:04 IST -
196     #
197
198
199 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 ...]"
200
201 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/)
202
203 In order to correctly map hard disk sernos to device names you can use the 'devattr' command.
204
205     # udevd
206     # devattr -d "ad*" -p serno
207     Device ad4:
208             serno = Z2AD9WN4
209     Device ad4s1:
210     Device ad4s1d:
211
212     Device ad5:
213             serno = 9VMRFDSY
214     Device ad5s1:
215     Device ad5s1d:
216
217     Device ad3:
218             serno = Z2AD9WLW
219     Device ad3s1:
220     Device ad3s1a:
221     Device ad3s1b:
222     Device ad3s1d:
223
224 Or if your disks are 'da', just change it as appropiate.
225
226 ## Configuring and Starting the SSH Server
227
228 Described in detail [[here|/docs/newhandbook/sshserver/]]
229
230 ## Software/Programs and Configuration Files Location 
231
232 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*.
233
234 The base programs are located in the folders 
235
236     /bin    /sbin
237     /usr/bin   /usr/sbin
238
239 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`.
240
241 ## Installing Third-party Software
242
243 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`.
244
245 ### Using pkg
246
247 Read [[dports howto|/docs/howtos/HowToDPorts/]] then for some errata, read [[this|http://lists.dragonflybsd.org/pipermail/users/2013-November/090339.html]].
248
249
250 You can look at the help and the man page for the pkg tool like this:
251
252 `pkg help install`
253
254 Example: Read man page for pkg-install
255
256 `man pkg-install`
257
258
259 ### Installing an X desktop environment
260
261 If it's already on your system run X by typing `startx`. If it's not, install
262 it using `pkg install`.
263
264 `(obsolete)`
265 Slightly out of date instructions on installing a GUI (X desktop) environment  are in the [new handbook](http://www.dragonflybsd.org/docs/newhandbook/X/).
266