Skip to content

Latest commit

 

History

History
218 lines (163 loc) · 9.71 KB

README.md

File metadata and controls

218 lines (163 loc) · 9.71 KB
Raw

droppy is a self-hosted file storage server with a web interface and capabilities to edit files and view media directly in the browser. It is particularly well-suited to be run on low-end hardware like the Raspberry Pi.

Features

  • Responsive, scalable HTML5 interface
  • Realtime updates of file system changes
  • Directory and Multi-File upload
  • Drag-and-Drop support
  • Clipboard support to create image/text files
  • Side-by-Side mode
  • Simple and fast Search
  • Shareable public download links
  • Zip download of directories
  • Powerful text editor with themes and broad language support
  • Image and video gallery with touch support
  • Audio player with seeking support
  • Fullscreen support for editor and gallery
  • Supports installing to the homescreen
  • Docker images available for x86-64, ARMv6, ARMv7 and ARMv8

General Information

Two directories will be used, one for configuration and one for the actual files:

  • config: defaults to ~/.droppy/config, override with -c /some/dir
  • files: default ~/.droppy/files override with -f /some/dir

droppy maintains an in-memory representation of the files directory. If you're on slow storage and/or serving 100k or more files, the initial indexing on startup will likely take some time.

Installation

Local Installation 📦

With Node.js >= 20.17.0 installed, run:

$ yarn global add @droppyjs/cli
# or, for NPM users:
$ npm install -g @droppyjs/cli

Then start your server with your configuration options:

$ droppy start -c /srv/droppy/config -f /srv/droppy/files

To make droppy run in the background, you can use the --daemon option, thought it is adviced that you install it as a persistent service in your system. For Linux, see these guides:

Upgrading from legacy droppy

To upgrade from the legacy droppy there is no work on your part. Although you're unlikely to have issues, you should make a backup of your files anyway.

First, remove old droppy.

If you used yarn to install it:

yarn global remove droppy

or, if you used npm to install it:

npm remove -g droppy

Now install as normal:

$ yarn global add @droppyjs/cli
# or, for NPM users:
$ npm install -g @droppyjs/cli

Docker installation 🐳

We currently publish our images to ghcr.io/droppyjs/droppy. You can bind columnes /data and /config should you need.

docker-compose

A sample docker-composer file can be found here: https://github.com/droppyjs/droppy/blob/canary/examples/docker-compose.yml

Caddy

See the example Caddyfile.

Configuration

By default, the server listens on all IPv4 and IPv6 interfaces on port 8989. On first startup, a prompt to create login data for the first account will appear. Once it's created, login credentials are enforced. Additional accounts can be created in the options interface or the command line. Configuration is done in config/config.json, which is created with these defaults:

{
  "listeners" : [
    {
      "host": ["0.0.0.0", "::"],
      "port": 8989,
      "protocol": "http"
    }
  ],
  "public": false,
  "timestamps": true,
  "linkLength": 5,
  "linkExtensions": false,
  "logLevel": 2,
  "maxFileSize": 0,
  "updateInterval": 1000,
  "pollingInterval": 0,
  "keepAlive": 20000,
  "allowFrame": false,
  "readOnly": false,
  "ignorePatterns": [],
  "watch": true,
  "headers": {}
}

Options

  • listeners Array - Defines on which network interfaces, port and protocols the server will listen. See listener options below. listeners has no effect when droppy is used as a module. The default listens on HTTP port 8989 on all interfaces and protocols.
  • public boolean - When enabled, no user authentication is performed. Default: false.
  • timestamps boolean - When enabled, adds timestamps to log output. Default: true.
  • linkLength number - The amount of characters in a shared link. Default: 5.
  • linkExtensions boolean - Whether shared links should include the file extension. This can be used to allow other software to make a guess on the content of the file without actually retrieving it. Default: false.
  • logLevel number - Logging amount. 0 is no logging, 1 is errors, 2 is info (HTTP requests), 3 is debug (Websocket communication). Default: 2.
  • maxFileSize number - The maximum file size in bytes a user can upload in a single file. 0 means no limit. Default: 0.
  • updateInterval number - Interval in milliseconds in which a single client can receive update messages through changes in the file system. Default: 1000.
  • pollingInterval number - Interval in milliseconds in which the file system is polled for changes, which may necessary for files on external or network-mapped drives. Corresponds to chokidar's usePolling option. This is CPU-intensive. 0 disables polling. Default: 0.
  • keepAlive number - Interval in milliseconds in which the server sends websocket keepalive messages, which may be necessary when proxies are involved. 0 disables keepalive messages. Default: 20000.
  • uploadTimeout number - Request timeout for upload requests in milliseconds. Default: 604800000 which is 7 days.
  • allowFrame boolean - Allow the page to be loaded into a <frame> or <iframe>. Default: false.
  • readOnly boolean - Treat all files as being read-only. Default: false.
  • dev boolean - Enable developer mode, skipping resource minification and enabling live reload. Default: false.
  • ignorePatterns Array - Array of file path glob patterns to ignore when indexing files. See here for supported patterns. Default: [].
  • watch boolean - Whether to watch the local file system for changes. Disabling this may improve performance when dealing with a large number of files, but with the downside that changes not done via droppy won't be detected. Default: true.
  • headers Object: A object with key-value pairs of custom HTTP headers to set on all responses, for example {"Access-Control-Allow-Origin": "*"}. Default: {}.

Listener Options

listeners defines on which network interfaces, ports and protocol(s) the server will listen. For example:

"listeners": [
  {
    "host": "::",
    "port": 80,
    "socket": "/tmp/droppy",
    "protocol": "http"
  },
  {
    "host": "0.0.0.0",
    "port": 443,
    "protocol": "https",
    "key": "~/certs/example.com.key",
    "cert": "~/certs/example.com.crt"
  }
]

The above configuration will result in:

  • HTTP listening on all IPv4 and IPv6 interfaces, port 80 and on the unix domain socket /tmp/droppy.
  • HTTPS listening on all IPv4 interfaces, port 443 using the provided TLS files.

A listener object accepts these options:

  • host string/Array - Network interface(s) addresses to listen on. Required when port is given. Note that "::" will typically bind to both IPv4 and IPv6 on all addresses but a "0.0.0.0" address might be required if IPv6 is disabled.
  • port number/string/Array - Network port(s) to listen on. Required when host is given.
  • socket string/Array - Unix domain socket(s) to listen on.
  • protocol string - Protocol to use, http or https. Required.

For TLS the following additional options are available. Paths can be given relative to the configuration directory and ~ is resolved as expected.

  • cert string - Path to PEM-encoded TLS certificate file, which can include additional intermediate certificates concatenated after the main certificate. Required.
  • key string - Path to PEM-encoded TLS private key file not encrypted with a passphrase. Required.

Downloading from the command line

To download shared links with curl and wget to the correct filename:

$ curl -OJ url
$ wget --content-disposition url

Development

To start a live-reloading dev server:

$ git clone https://github.com/droppyjs/droppy && cd droppy
$ lerna bootstrap
$ yarn start

The Makefile has a few old tasks for updating dependencies, pushing docker images, see the comment above for dependencies of those tasks. This should not be required anymore, but is left as a reference.

© Mark Hughes, silverwind, distributed under BSD licence.