Put in remaining pages and wiki contents.
[ikiwiki.git] / docs / handbook / handbook-quotas.mdwn
1 \r
2 \r
3 ## 12.12 File System Quotas \r
4 \r
5 Quotas are an optional feature of the operating system that allow you to limit the amount of disk space and/or the number of files a user or members of a group may allocate on a per-file system basis. This is used most often on timesharing systems where it is desirable to limit the amount of resources any one user or group of users may allocate. This will prevent one user or group of users from consuming all of the available disk space.\r
6 \r
7 ### 12.12.1 Configuring Your System to Enable Disk Quotas \r
8 \r
9 Before attempting to use disk quotas, it is necessary to make sure that quotas are configured in your kernel. This is done by adding the following line to your kernel configuration file:\r
10 \r
11     \r
12     options QUOTA\r
13 \r
14 \r
15 The stock `GENERIC` kernel does not have this enabled by default, so you will have to configure, build and install a custom kernel in order to use disk quotas. Please refer to [kernelconfig.html Chapter 9] for more information on kernel configuration.\r
16 \r
17 Next you will need to enable disk quotas in `/etc/rc.conf`. This is done by adding the line:\r
18 \r
19     \r
20     enable_quotas="YES"\r
21 \r
22 \r
23 For finer control over your quota startup, there is an additional configuration variable available. Normally on bootup, the quota integrity of each file system is checked by the [quotacheck(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#quotacheck&section8) program. The [quotacheck(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=quotacheck&section=8) facility insures that the data in the quota database properly reflects the data on the file system. This is a very time consuming process that will significantly affect the time your system takes to boot. If you would like to skip this step, a variable in `/etc/rc.conf` is made available for the purpose:\r
24 \r
25     \r
26     check_quotas="NO"\r
27 \r
28 \r
29 Finally you will need to edit `/etc/fstab` to enable disk quotas on a per-file system basis. This is where you can either enable user or group quotas or both for all of your file systems.\r
30 \r
31 To enable per-user quotas on a file system, add the `userquota` option to the options field in the `/etc/fstab` entry for the file system you want to enable quotas on. For example:\r
32 \r
33     \r
34     /dev/da1s2g   /home    ufs rw,userquota 1 2\r
35 \r
36 \r
37 Similarly, to enable group quotas, use the `groupquota` option instead of `userquota`. To enable both user and group quotas, change the entry as follows:\r
38 \r
39     \r
40     /dev/da1s2g    /home    ufs rw,userquota,groupquota 1 2\r
41 \r
42 \r
43 By default, the quota files are stored in the root directory of the file system with the names `quota.user` and `quota.group` for user and group quotas respectively. See [fstab(5)](http://leaf.dragonflybsd.org/cgi/web-man?command#fstab&section5) for more information. Even though the [fstab(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=fstab&section=5) manual page says that you can specify an alternate location for the quota files, this is not recommended because the various quota utilities do not seem to handle this properly.\r
44 \r
45 At this point you should reboot your system with your new kernel. `/etc/rc` will automatically run the appropriate commands to create the initial quota files for all of the quotas you enabled in `/etc/fstab`, so there is no need to manually create any zero length quota files.\r
46 \r
47 In the normal course of operations you should not be required to run the [quotacheck(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#quotacheck&section8), [quotaon(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=quotaon&section=8), or [quotaoff(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=quotaoff&section=8) commands manually. However, you may want to read their manual pages just to be familiar with their operation.\r
48 \r
49 ### 12.12.2 Setting Quota Limits \r
50 \r
51 Once you have configured your system to enable quotas, verify that they really are enabled. An easy way to do this is to run:\r
52 \r
53     \r
54     # quota -v\r
55 \r
56 \r
57 You should see a one line summary of disk usage and current quota limits for each file system that quotas are enabled on.\r
58 \r
59 You are now ready to start assigning quota limits with the [edquota(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#edquota&section8) command.\r
60 \r
61 You have several options on how to enforce limits on the amount of disk space a user or group may allocate, and how many files they may create. You may limit allocations based on disk space (block quotas) or number of files (inode quotas) or a combination of both. Each of these limits are further broken down into two categories: hard and soft limits.\r
62 \r
63 A hard limit may not be exceeded. Once a user reaches his hard limit he may not make any further allocations on the file system in question. For example, if the user has a hard limit of 500 blocks on a file system and is currently using 490 blocks, the user can only allocate an additional 10 blocks. Attempting to allocate an additional 11 blocks will fail.\r
64 \r
65 Soft limits, on the other hand, can be exceeded for a limited amount of time. This period of time is known as the grace period, which is one week by default. If a user stays over his or her soft limit longer than the grace period, the soft limit will turn into a hard limit and no further allocations will be allowed. When the user drops back below the soft limit, the grace period will be reset.\r
66 \r
67 The following is an example of what you might see when you run the [edquota(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#edquota&section8) command. When the [edquota(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=edquota&section=8) command is invoked, you are placed into the editor specified by the `EDITOR` environment variable, or in the  **vi**  editor if the `EDITOR` variable is not set, to allow you to edit the quota limits.\r
68 \r
69     \r
70     # edquota -u test\r
71 \r
72 \r
73     \r
74     Quotas for user test:\r
75     /usr: blocks in use: 65, limits (soft # 50, hard  75)\r
76             inodes in use: 7, limits (soft # 50, hard  60)\r
77     /usr/var: blocks in use: 0, limits (soft # 50, hard  75)\r
78             inodes in use: 0, limits (soft # 50, hard  60)\r
79 \r
80 \r
81 You will normally see two lines for each file system that has quotas enabled. One line for the block limits, and one line for inode limits. Simply change the value you want updated to modify the quota limit. For example, to raise this user's block limit from a soft limit of 50 and a hard limit of 75 to a soft limit of 500 and a hard limit of 600, change:\r
82 \r
83     \r
84     /usr: blocks in use: 65, limits (soft # 50, hard  75)\r
85 \r
86 \r
87 to:\r
88 \r
89     \r
90      /usr: blocks in use: 65, limits (soft # 500, hard  600)\r
91 \r
92 \r
93 The new quota limits will be in place when you exit the editor.\r
94 \r
95 Sometimes it is desirable to set quota limits on a range of UIDs. This can be done by use of the `-p` option on the [edquota(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#edquota&section8) command. First, assign the desired quota limit to a user, and then run `edquota -p protouser startuid-enduid`. For example, if user `test` has the desired quota limits, the following command can be used to duplicate those quota limits for UIDs 10,000 through 19,999:\r
96 \r
97     \r
98     # edquota -p test 10000-19999\r
99 \r
100 \r
101 For more information see [edquota(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#edquota&section8) manual page.\r
102 \r
103 ### 12.12.3 Checking Quota Limits and Disk Usage \r
104 \r
105 You can use either the [quota(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#quota&section1) or the [repquota(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=repquota&section=8) commands to check quota limits and disk usage. The [quota(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=quota&section=1) command can be used to check individual user or group quotas and disk usage. A user may only examine his own quota, and the quota of a group he is a member of. Only the super-user may view all user and group quotas. The [repquota(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=repquota&section=8) command can be used to get a summary of all quotas and disk usage for file systems with quotas enabled.\r
106 \r
107 The following is some sample output from the `quota -v` command for a user that has quota limits on two file systems.\r
108 \r
109     \r
110     Disk quotas for user test (uid 1002):\r
111          Filesystem  blocks   quota   limit   grace   files   quota   limit   grace\r
112                /usr      65*     50      75   5days       7      50      60\r
113            /usr/var       0      50      75               0      50      60\r
114 \r
115 \r
116 On the `/usr` file system in the above example, this user is currently 15 blocks over the soft limit of 50 blocks and has 5 days of the grace period left. Note the asterisk `*` which indicates that the user is currently over his quota limit.\r
117 \r
118 Normally file systems that the user is not using any disk space on will not show up in the output from the [quota(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#quota&section1) command, even if he has a quota limit assigned for that file system. The `-v` option will display those file systems, such as the `/usr/var` file system in the above example.\r
119 \r
120 ### 12.12.4 Quotas over NFS \r
121 \r
122 Quotas are enforced by the quota subsystem on the NFS server. The [rpc.rquotad(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#rpc.rquotad&section8) daemon makes quota information available to the [quota(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=quota&section=1) command on NFS clients, allowing users on those machines to see their quota statistics.\r
123 \r
124 Enable `rpc.rquotad` in `/etc/inetd.conf` like so:\r
125 \r
126     \r
127     rquotad/1      dgram rpc/udp wait root /usr/libexec/rpc.rquotad rpc.rquotad\r
128 \r
129 \r
130 Now restart `inetd`:\r
131 \r
132     \r
133     # kill -HUP `cat /var/run/inetd.pid`\r
134 \r
135 \r
136 \r
137 \r
138 CategoryHandbook\r
139 CategoryHandbook-storage\r