Sign inSign up

smartblug/psitransfer

By smartblug

•Updated about 6 years ago

Simple open source self-hosted file sharing solution with keycloak support.

Image
0

5.2K

smartblug/psitransfer repository overview

⁠PsiTransfer

Latests Version Latests Build Known Vulnerabilities Github Stars Docker Stars Docker Pulls Docker Automated buil Latest Release

Simple open source self-hosted file sharing solution.
It's an alternative to paid services like Dropbox, WeTransfer.

  • No accounts, no logins
  • Mobile friendly responsive interface
  • Supports many and very big files (Streams ftw)
  • Resumable up- and downloads (tus.io⁠)
  • Set an expire-time for your upload bucket
  • One-time downloads
  • Download all files as zip/tar.gz archive
  • Modal-style file preview
  • Requires Node >=7.4 or use --harmony-async-await flag
  • Password protected download list (AES⁠)
  • /admin Page lists bucket information, Screenshot⁠ (disabled until you set adminPass config value)
  • Lightweight Vue⁠ based frontend apps. Gzipped (on by default) less than 65k
  • Explicit named bucket IDs with query param sid=<myBucketID>

See the blog posts about PsiTransfer: https://psi.cx/tags/PsiTransfer/⁠ and checkout the Documentation⁠

Screenshot

Demo: https://transfer.psi.cx⁠

⁠Quickstart

⁠Docker
# data volume needs UID 1000
$ sudo chown -R 1000 $PWD/data 

$ docker run -p 0.0.0.0:3000:3000 -e PSITRANSFER_ADMIN_PASS=secret -v $PWD/data:/data psitrax/psitransfer

Specify the version by using image tags⁠ e.g.:

  • latest: corresponds to master branch
  • 1: latest stable 1.x.x
  • 1.1: latest stable 1.1.x
  • 1.0.0: exact version
⁠Docker with keycloak
# data volume needs UID 1000
$ sudo chown -R 1000 $PWD/data 

$ docker run -p 0.0.0.0:3000:3000 -e PSITRANSFER_ADMIN_PASS=secret -e PSITRANSFER_KEYCLOAK='{"front":{"realm":"PsiTransfer","auth-server-url":"http://192.168.5.4:8080/auth","ssl-required":"external","resource":"PsiTransfer_FrontEnd","public-client":true,"confidential-port":0},"back":{"realm":"PsiTransfer","bearer-only":true,"auth-server-url":"http://192.168.5.4:8080/auth","ssl-required":"external","resource":"PsiTransfer_BackEnd","confidential-port":0}}' -v $PWD/data:/data smartblug/psitransfer
⁠Manual, precompiled
# Be sure to have NodeJS >= 7.4
$ node -v
v7.4.0

# Download and extract latest release package from
# https://github.com/SmartBlug/psitransfer/releases

# Install dependencies and start the app
$ NODE_ENV=production npm install
$ npm start
⁠Manual, from source
# Compile the frontend apps
$ cd app
$ npm install
$ npm run build

# Install dependencies
$ cd ..
$ npm install
$ npm start
⁠Configuration

There are some configs in config.js like port and data-dir.
You can:

  • Edit the config.js (not recommend)
  • Add a config.production.js where production is the value from NODE_ENV
    See config.dev.js
  • Define environment Variables like PSITRANSFER_UPLOAD_DIR
⁠Keycloak support :
  • setup your Keycloak server
  • use PSITRANSFER_KEYCLOAK and define front and back parameters
{ 
  "front": {
    "realm": "PsiTransfer",
    "auth-server-url": "https://iam.mydomain.com/auth",
    "ssl-required": "external",
    "resource": "PsiTransfer_FrontEnd",
    "public-client": true,
    "confidential-port": 0
  },
  "back": {
    "realm": "PsiTransfer",
    "bearer-only": true,
    "auth-server-url": "https://iam.mydomain.com/auth",
    "ssl-required": "external",
    "resource": "PsiTransfer_BackEnd",
    "confidential-port": 0
  }
}
⁠Email notifications support :
  • Use Keycloak to authenticate user
  • use PSITRANSFER_MAIL_ON_USAGE and define your email parameters (using nodemailer⁠ transporter)
{
  "transporter":{
    "service": "gmail",
    "auth": {
      "user": "<[email protected]>",
      "pass": "<password>"
    }
  },
  "from":"[email protected]",
  "subject":"PsiTransfer Usage - %%TYPE%%",
  "body": {
    "Access":"Your Shared link %%URL%% has been used",
    "Guest Access":"Your Shared link %%URL%% has been used by your guest",
    "Download":"Your Shared file \"%%FILENAME%%\" from %%URL%% has been downloaded",
    "Download Compressed":"Your Shared files %%URL%% have been downloaded"
  }
}

Keywords TYPE, URL and FILENAME will be remplaced with relevant content
You can disabled specific notifications with false like this :

{
  "transporter":{
    "service": "gmail",
    "auth": {
      "user": "<[email protected]>",
      "pass": "<password>"
    }
  },
  "from":"[email protected]",
  "subject":"PsiTransfer Usage - %%TYPE%%",
  "body": {
    "Access": false,
    "Guest Access":"Your Shared link %%URL%% has been used by your guest",
    "Download": false,
    "Download Compressed":"Your Shared files %%URL%% have been downloaded"
  }
}
⁠Customization

public/upload.html and download.html are kept simple.
You can alter these files and add your logo and styles.
The following elements are mandatory:
common.js and respectively upload.js, download.js as well as <div id="upload">, <div id="download">
Please keep a footnote like Powered by PsiTransfer :)

⁠Debug

Psitransfer uses debug⁠:

DEBUG=psitransfer:* npm start

⁠Side notes

  • There is no (end-to-end) payload encryption (yet).
  • Download all as ZIP does not support resuming the download.

:star2: Contribution is highly welcome :metal:

Want to say thanks and buy creator a beer? Donate

⁠License

BSD⁠

Tag summary

Content type

Image

Digest

Size

145.6 MB

Last updated

about 6 years ago

docker pull smartblug/psitransfer