|
1
by Hilko Bengen
Import upstream version 1.1.2 |
1 |
NBD is a protocol for accessing Block Devices (hard disks and |
2 |
disk-like things) over a Network. |
|
3 |
||
4 |
'nbdkit' is a toolkit for creating NBD servers. |
|
5 |
||
6 |
The key features are: |
|
7 |
||
8 |
* Multithreaded NBD server written in C with good performance. |
|
9 |
||
10 |
* Well-documented, simple plugin API with a stable ABI guarantee. |
|
11 |
Let's you export "unconventional" block devices easily. |
|
12 |
||
13 |
* Liberal license (BSD) allows nbdkit to be linked to proprietary |
|
14 |
libraries or included in proprietary code. |
|
15 |
||
16 |
For documentation, see the docs/ directory. |
|
17 |
||
18 |
For plugins and examples, see the plugins/ directory. |
|
19 |
||
20 |
License
|
|
21 |
-------
|
|
22 |
||
23 |
This software is copyright (C) Red Hat Inc. and licensed under a BSD |
|
24 |
license. See LICENSE for details. |
|
25 |
||
26 |
Building from source |
|
27 |
--------------------
|
|
28 |
||
29 |
By default nbdkit needs nothing except Linux and reasonably recent gcc. |
|
30 |
||
|
1.1.4
by Hilko Bengen
Import upstream version 1.1.6 |
31 |
To build the man pages, you will need to install: |
32 |
||
33 |
- pod2man (included with perl) |
|
34 |
||
35 |
There are some *optional* libraries you may want to install for the |
|
36 |
plugins. |
|
37 |
||
38 |
For the gzip plugin: |
|
39 |
||
40 |
- zlib |
|
41 |
||
42 |
For the xz plugin: |
|
43 |
||
44 |
- liblzma |
|
45 |
||
|
1.1.6
by Hilko Bengen
Import upstream version 1.1.8 |
46 |
For the curl (HTTP/FTP) plugin: |
47 |
||
48 |
- libcurl |
|
49 |
||
|
1.1.4
by Hilko Bengen
Import upstream version 1.1.6 |
50 |
For the libvirt plugin: |
51 |
||
52 |
- libvirt |
|
53 |
||
54 |
For the libguestfs plugin, and to run the test suite: |
|
55 |
||
56 |
- libguestfs |
|
57 |
||
58 |
- guestfish (from libguestfs) |
|
59 |
||
60 |
For the VDDK plugin: |
|
61 |
||
62 |
- VDDK (see plugins/vddk/README.VDDK) |
|
63 |
||
64 |
For the Perl plugin: |
|
65 |
||
66 |
- perl development libraries |
|
67 |
||
68 |
- perl module ExtUtils::Embed |
|
69 |
||
70 |
For the Python plugin: |
|
71 |
||
72 |
- python development libraries |
|
|
1
by Hilko Bengen
Import upstream version 1.1.2 |
73 |
|
74 |
After installing any dependencies: |
|
75 |
||
76 |
To build from tarball: To build from git: |
|
77 |
---------------------- ------------------ |
|
78 |
autoreconf -i |
|
79 |
./configure ./configure |
|
80 |
make make |
|
81 |
make check make check |
|
82 |
||
83 |
Optionally run this as root to install everything: |
|
84 |
||
85 |
make install |
|
86 |
||
|
1.1.4
by Hilko Bengen
Import upstream version 1.1.6 |
87 |
Tests
|
88 |
-----
|
|
89 |
||
90 |
You will need to install libguestfs to run the test suite. |
|
91 |
||
92 |
The test suite ('make check') is fairly comprehensive. It runs the |
|
93 |
newly built nbdkit + plugin as a captive process, and tests it using |
|
94 |
libguestfs. |
|
95 |
||
96 |
If there is a failure, look at the corresponding tests/*.log file for |
|
97 |
debug information. |
|
98 |
||
|
1
by Hilko Bengen
Import upstream version 1.1.2 |
99 |
Packager information |
100 |
--------------------
|
|
101 |
||
102 |
Tarballs are available from: |
|
103 |
http://libguestfs.org/download/nbdkit |
|
104 |
||
105 |
Developer information |
|
106 |
---------------------
|
|
107 |
||
108 |
For development ideas, see the TODO file. |
|
109 |
||
110 |
The upstream git repository is: |
|
111 |
https://github.com/libguestfs/nbdkit |
|
112 |
||
113 |
Please send patches to the libguestfs mailing list: |
|
114 |
https://www.redhat.com/mailman/listinfo/libguestfs |
|
115 |
||
116 |
For further information, see: |
|
117 |
http://libguestfs.org/ |