summaryrefslogtreecommitdiff
path: root/README.md
blob: a049e2ce7d568376c5d732a969d2aaad7b4f96ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
rtslib-fb
=========

A Python object API for managing the Linux LIO kernel target
------------------------------------------------------------
rtslib-fb is an object-based Python library for configuring the LIO
generic SCSI target, present in 3.x Linux kernel versions.

It supports both Python 2 and Python 3, thanks to the python-six library.

rtslib-fb development
---------------------
rtslib-fb is licensed under the Apache 2.0 license. Contributions are welcome.

Since rtslib-fb is used most often with targetcli-fb, the targetcli-fb
mailing should be used for rtslib-fb discussion.

 * Mailing list: [targetcli-fb-devel](https://lists.fedorahosted.org/mailman/listinfo/targetcli-fb-devel)
 * Source repo: [GitHub](https://github.com/open-iscsi/rtslib-fb)
 * Bugs: [GitHub](https://github.com/open-iscsi/rtslib-fb/issues) or [Trac](https://fedorahosted.org/targetcli-fb/)
 * Tarballs: [fedorahosted](https://fedorahosted.org/releases/t/a/targetcli-fb/)

In-repo packaging
-----------------
Packaging scripts for RPM and DEB are included, but these are to make end-user
custom packaging easier -- distributions tend to maintain their own packaging
scripts separately. If you run into issues with packaging, start with opening
a bug on your distro's bug reporting system.

Some people do use these scripts, so we want to keep them around. Fixes for
any breakage you encounter are welcome.

"fb" -- "free branch"
---------------------

rtslib-fb is a fork of the "rtslib" code written by RisingTide Systems.
The "-fb" differentiates between the original and this version.
Please ensure to use either all "fb" versions of the targetcli components --
targetcli, rtslib, and configshell, or stick with all non-fb versions, since
they are no longer strictly compatible.