README.md 4.77 KB
Newer Older
Tigran Mkrtchyan's avatar
Tigran Mkrtchyan committed
1
2
3
NFS4J
=====

4
5
[![Latest release](https://img.shields.io/github/release/dcache/nfs4j.svg)](https://github.com/dcache/nfs4j/releases/latest)

6
7
The pure java implementation of NFS server version 3, 4.0 and 4.1 including pNFS extension
with nfs4.1-files and flex-files layout types.
Tigran Mkrtchyan's avatar
Tigran Mkrtchyan committed
8
9
10
11

Building from sources
---------------------

12
To build nfs4j from source code Java11 and Maven3 are required.
Tigran Mkrtchyan's avatar
Tigran Mkrtchyan committed
13

14
To run benchmarks:
15
16

```sh
17
18
19
mvn verify -Pbenchmark
```

Tigran Mkrtchyan's avatar
Tigran Mkrtchyan committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
Implementing own NFS server
---------------------------

```java
public class App {

    public static void main(String[] args) throws Exception {

        // create an instance of a filesystem to be exported
        VirtualFileSystem vfs = new ....;

        // create the RPC service which will handle NFS requests
        OncRpcSvc nfsSvc = new OncRpcSvcBuilder()
                .withPort(2049)
                .withTCP()
                .withAutoPublish()
                .withWorkerThreadIoStrategy()
                .build();

        // specify file with export entries
        ExportFile exportFile = new ExportFile(....);

        // create NFS v4.1 server
43
44
45
46
47
        NFSServerV41 nfs4 = new NFSServerV41.Builder()
                .withExportFile(exportFile)
                .withVfs(vfs)
                .withOperationFactory(new MDSOperationFactory())
                .build();
Tigran Mkrtchyan's avatar
Tigran Mkrtchyan committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

        // create NFS v3 and mountd servers
        NfsServerV3 nfs3 = new NfsServerV3(exportFile, vfs);
        MountServer mountd = new MountServer(exportFile, vfs);

        // register NFS servers at portmap service
        nfsSvc.register(new OncRpcProgram(100003, 4), nfs4);
        nfsSvc.register(new OncRpcProgram(100003, 3), nfs3);
        nfsSvc.register(new OncRpcProgram(100005, 3), mountd);

        // start RPC service
        nfsSvc.start();

        System.in.read();
    }
}
```

Use NFS4J in your project
-----------------------------

```xml
<dependency>
    <groupId>org.dcache</groupId>
    <artifactId>nfs4j-core</artifactId>
73
    <version>0.19.0</version>
Tigran Mkrtchyan's avatar
Tigran Mkrtchyan committed
74
75
76
77
78
79
</dependency>

<repositories>
    <repository>
        <id>dcache-releases</id>
        <name>dCache.ORG maven repository</name>
80
        <url>https://download.dcache.org/nexus/repository/public/</url>
Tigran Mkrtchyan's avatar
Tigran Mkrtchyan committed
81
82
83
84
85
        <layout>default</layout>
    </repository>
</repositories>
```

86
87
88
89
90
IMPORTANT WARNINGS
------------------

Though **NFS4J** is used by the [dCache](https://dcache.org) and other projects in production,
the public API is still _unstable_ and subject to change (indicated by leading zero in the
Tigran Mkrtchyan's avatar
Tigran Mkrtchyan committed
91
version number). Thus, should be considered as `beta`.
92
93
94
95

Please consult the [API changes](API-changes.md) document when switching between version numbers.
The patch level releases are not affected by API changes, of course.

96
License
Tigran Mkrtchyan's avatar
Tigran Mkrtchyan committed
97
98
99
100
--------

licensed under [LGPLv2](http://www.gnu.org/licenses/lgpl-2.0.txt "LGPLv2") (or later)

101
How to contribute
102
-----------------
103
104
105
106
107
108
109
110
111
112
113
114

**NFS4J** uses the linux kernel model where git is not only source repository,
but also the way to track contributions and copyrights.

Each submitted patch must have a "Signed-off-by" line.  Patches without
this line will not be accepted.

The sign-off is a simple line at the end of the explanation for the
patch, which certifies that you wrote it or otherwise have the right to
pass it on as an open-source patch.  The rules are pretty simple: if you
can certify the below:

115
```txt
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
    Developer's Certificate of Origin 1.1

    By making a contribution to this project, I certify that:

    (a) The contribution was created in whole or in part by me and I
         have the right to submit it under the open source license
         indicated in the file; or

    (b) The contribution is based upon previous work that, to the best
        of my knowledge, is covered under an appropriate open source
        license and I have the right under that license to submit that
        work with modifications, whether created in whole or in part
        by me, under the same open source license (unless I am
        permitted to submit under a different license), as indicated
        in the file; or

    (c) The contribution was provided directly to me by some other
        person who certified (a), (b) or (c) and I have not modified
        it.

    (d) I understand and agree that this project and the contribution
        are public and that a record of the contribution (including all
        personal information I submit with it, including my sign-off) is
        maintained indefinitely and may be redistributed consistent with
        this project or the open source license(s) involved.
```
142

143
144
then you just add a line saying ( git commit -s )

145
146
147
```txt
Signed-off-by: Random J Developer <random@developer.example.org>
```
148
149
150

using your real name (sorry, no pseudonyms or anonymous contributions.)

Tigran Mkrtchyan's avatar
Tigran Mkrtchyan committed
151
152
153
Contact Us
---------

154
For help and development related discussions please contact us: *dev (@) dcache (.) org*