open-index/open-npm huggingface dataset:
npm package: @nephele/adapter-s3
Description: S3 (or compatible) object storage adapter for the Nephele WebDAV server.
Author: Hunter Perrin
Latest version: 1.0.0-alpha.67

# S3 (or Compatible) Object Storage Nephele Adapter

A Nephele adapter that uses an S3 or S3 compatible object storage service as the storage backend.

It is tested using [MinIO](https://min.io/), which is an S3 compatible object storage server, but it should also work with AWS S3, Cloudflare R2, Backblaze B2, Digital Ocean Spaces, Ceph, etc. If you encounter any issues with an S3 compatible object store, please file a bug report in the Nephele repository.

# Installation

```sh
npm i -s @nephele/adapter-s3
```

# Usage

The default export is the adapter, and it's also a named export "Adapter". Instantiate this class, providing an options object, and give that to Nephele as the adapter.

```js
import express from 'express';
import nepheleServer from 'nephele';
import S3Adapter from '@nephele/adapter-s3';
import ExampleAuthenticator from '@nephele/authenticator-example';

const app = express();
const port = 8080;

app.use(
  '/',
  nepheleServer({
    adapter: new S3Adapter({
      s3Config: {
        endpoint: 'https://mys3endpointurl/',
        region: 'us-east-1',
        credentials: {
          accessKeyId: 'my-s3-access-key',
          secretAccessKey: 'my-s3-secret-key-shh-dont-tell',
        },
      },
      bucket: 'MyBucket',
    }),
    authenticator: new ExampleAuthenticator(),
  }),
);

app.listen(port, (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(`Nephele WebDAV server listening on port ${port}`);
});
```

# Options / Defaults

- `s3Config`: The S3 client config object.
- `bucket`: The S3 bucket.
- `uploadQueueSize` = `4`: The number of chunks to upload simultaneously to the storage.
- `root` = `''`: The path in the S3 bucket to be the root of the adapter. '' means the root of the bucket.

## s3Config

See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-s3/TypeAlias/S3ClientConfigType/

# Properties and Locks

WebDAV properties and locks are stored in the metadata of objects. There is no support for properties or locks on a directory, since S3 doesn't really have "real" directories.

# Empty Directories

S3 does not have the concept of an empty directory, since "directories" are just common prefixes among keys. As such, Nephele represents an empty directory in S3 by creating an empty object under the directory with the name ".nepheleempty". It is safe to delete these objects. It is the same as deleting the empty directory.

# License

Copyright 2022-2025 SciActive Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
npm package: @nephele/adapter-virtual
Description: Virtual resource adapter for the Nephele WebDAV server.
Author: Hunter Perrin
Latest version: 1.0.0-alpha.67

# Virtual File Nephele Adapter

A Nephele adapter that serves virtual files from memory.

# Installation

```sh
npm i -s @nephele/adapter-virtual
```

# Usage

The default export is the adapter, and it's also a named export "Adapter". Instantiate this class, providing an options object, and give that to Nephele as the adapter.

```js
import express from 'express';
import nepheleServer from 'nephele';
import VirtualAdapter from '@nephele/adapter-virtual';
import ExampleAuthenticator from '@nephele/authenticator-example';

const app = express();
const port = 8080;

app.use(
  '/',
  nepheleServer({
    adapter: new VirtualAdapter({
      files: {
        properties: {
          creationdate: new Date(),
          getlastmodified: new Date(),
          owner: 'root',
        },
        locks: {},
        children: [
          {
            name: "someuser's stuff",
            properties: {
              creationdate: new Date(),
              getlastmodified: new Date(),
              owner: 'someuser',
            },
            locks: {},
            children: [
              {
                name: 'example.txt',
                properties: {
                  creationdate: new Date(),
                  getlastmodified: new Date(),
                  owner: 'someuser',
                },
                locks: {},
                content: Buffer.from('Hello, world.'),
              },
            ],
          },
        ],
      },
    }),
    authenticator: new ExampleAuthenticator(),
  }),
);

app.listen(port, (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(`Nephele WebDAV server listening on port ${port}`);
});
```

If you're using the insecure authenticator, setting the `owner` of a resource to `"nobody"` will make it editable. If you're using the PAM authenticator, setting the `owner` to `"root"` will make it read-only.

# Options / Defaults

- `files`: The root file entry to serve from the virtual adapter.

# License

Copyright 2022-2025 SciActive Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
npm package: @nephele/authenticator-none
Description: Unrestricted authenticator for the Nephele WebDAV server.
Author: Hunter Perrin
Latest version: 1.0.0-alpha.67

# Unrestricted Nephele Authenticator

A Nephele authenticator that allows **unrestricted access** to all users.

# Installation

```sh
npm i -s @nephele/authenticator-none
```

# Security Implications

If you use this authenticator, anyone who can reach your server on the network will have full access to create, read, update, and delete all resources controlled by this authenticator!

# Usage

The default export is the authenticator, and it's also a named export "Authenticator". Instantiate this class, and give that to Nephele as the authenticator.

```js
import express from 'express';
import nepheleServer from 'nephele';
import ExampleAdapter from '@nephele/adapter-example';
import InsecureAuthenticator from '@nephele/authenticator-none';

const app = express();
const port = 8080;

app.use(
  '/',
  nepheleServer({
    adapter: new ExampleAdapter(),
    authenticator: new InsecureAuthenticator(),
  }),
);

app.listen(port, (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(`Nephele WebDAV server listening on port ${port}`);
});
```

# License

Copyright 2022-2025 SciActive Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
npm package: @nephele/authenticator-nymph
Description: Nymph.js authenticator for the Nephele WebDAV server.
Author: Hunter Perrin
Latest version: 1.0.0-alpha.67

# Nymph Nephele Authenticator

A Nephele authenticator that uses [Nymph.js](https://nymph.io/) (with Tilmeld) to authenticate users.

# Installation

```sh
npm i -s @nephele/authenticator-nymph
```

# Usage

The default export is the authenticator, and it's also a named export "Authenticator". Instantiate this class, providing an options object, and give that to Nephele as the authenticator.

```js
import express from 'express';
import nepheleServer from 'nephele';
import ExampleAdapter from '@nephele/adapter-example';
import NymphAuthenticator, { User } from '@nephele/authenticator-nymph';

const app = express();
const port = 8080;

app.use(
  '/',
  nepheleServer({
    adapter: new ExampleAdapter(),
    authenticator: new NymphAuthenticator({
      nymph: myNymphInstance,
      realm: 'My WebDAV Server',
    }),
  }),
);

app.listen(port, (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(`Nephele WebDAV server listening on port ${port}`);
});
```

One important note is that this authenticator merely authenticates the Nephele request. It **does not** fill the user session on the Tilmeld instance.

# Options / Defaults

- `realm` = `'Nephele WebDAV Service'`: The realm is the name reported by the server when the user is prompted to authenticate.
- `nymph`: The instance of Nymph that will authenticate the users. This must have Tilmeld loaded.

# License

Copyright 2022-2025 SciActive Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
npm package: @nephele/plugin-index
Description: Index file and directory contents listing plugin (browser support) for the Nephele WebDAV server.
Author: Hunter Perrin
Latest version: 1.0.0-alpha.67

# Index Nephele Plugin

A Nephele plugin to serve index files and list directory contents.

# Installation

```sh
npm i -s @nephele/plugin-index
```

# Usage

The default export is the plugin, and it's also a named export "Plugin". Instantiate this class, and give that to Nephele as a plugin.

```js
import express from 'express';
import nepheleServer from 'nephele';
import ExampleAdapter from '@nephele/adapter-example';
import ExampleAuthenticator from '@nephele/authenticator-example';
import IndexPlugin from '@nephele/plugin-index';

const app = express();
const port = 8080;

app.use(
  '/',
  nepheleServer({
    adapter: new ExampleAdapter(),
    authenticator: new ExampleAuthenticator(),
    plugins: [
      new IndexPlugin({
        name: 'Nephele Server',
      }),
    ],
  }),
);

app.listen(port, (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(`Nephele WebDAV server listening on port ${port}`);
});
```

The plugin, by default, will serve the "index.html" or "index.htm" file (if it exists) when a request for the directory is made. If no such file exists, by default, the plugin will serve a directory listing page with upload/file management forms.

# Options / Defaults

- `name` = `'Nephele Server'`: The name of the server reported on the directory listing pages.
- `serveIndexes` = `true`: Whether to serve "index.html" and "index.htm" files when a GET request for a directory is made.
- `serveListings` = `true`: Whether to serve directory listings when a request to a directory is made.
- `showForms` = `true`: Whether to show file management forms on directory listings.

## serveListings

If the user has access to create/modify/delete files in the directory, the listing page will include forms to do those tasks (if showForms is not false).

# License

Copyright 2022-2025 SciActive Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
npm package: @nephele/plugin-read-only
Description: Read-only path plugin for the Nephele WebDAV server.
Author: Hunter Perrin
Latest version: 1.0.0-alpha.67

# Read-Only Nephele Plugin

A Nephele plugin to make a path read-only.

# Installation

```sh
npm i -s @nephele/plugin-read-only
```

# Usage

The default export is the plugin, and it's also a named export "Plugin". Instantiate this class, and give that to Nephele as a plugin.

```js
import express from 'express';
import nepheleServer from 'nephele';
import ExampleAdapter from '@nephele/adapter-example';
import ExampleAuthenticator from '@nephele/authenticator-example';
import ReadOnlyPlugin from '@nephele/plugin-read-only';

const app = express();
const port = 8080;

app.use(
  '/',
  nepheleServer({
    adapter: new ExampleAdapter(),
    authenticator: new ExampleAuthenticator(),
    plugins: [new ReadOnlyPlugin()],
  }),
);

app.listen(port, (err) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(`Nephele WebDAV server listening on port ${port}`);
});
```

This plugin is useful if you want to make a WebDAV server accessible publicly, but without all of the write/modify features enabled.

# License

Copyright 2022-2025 SciActive Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.