nanawel/cliup repository overview

⁠CLIup

Simple and efficient self-hosted, CLI-oriented file sharing service over HTTP.

Github: https://github.com/nanawel/cliup⁠

⚠ Please refer to the README from the source code repository⁠ for up-to-date info.

⁠Why CLIup? 🤔

I needed a file sharing service that could be easily used with only curl and wget for maximum compatibility with all possible contexts (even light live environments or BusyBox-like shells).

What I also needed, was a way to get access to a file once uploaded using a moderately secure key that I could remember for at least some minutes, enough to retrieve the file from another computer with... you guessed it, another curl or wget.

👍 What you get with CLIup:

• Self-hosted service up and running in seconds
• Upload files with PUT or POST requests from your favorite terminal
• Get a random password composed of several common words in return

👎 What you don't get with CLIup:

• An end-to-end encrypted file sharing service
• Encrypted files on server
• A scalable service able to serve thousands of requests

⁠Nice! Is there a demo? 👀

Well, no. For obvious reasons, running an anonymous public file-sharing service is not a good idea these days.

So if you want to test it, install it on your own server! 👷‍♀️

⁠Use 🚀

# Easiest, using curl + PUT
curl -T myfile.bin myhost.tld
File uploaded successfully. The password for your file is:
institute-crisis-individual

# On some other computer
curl myhost.tld/institute-crisis-individual > myfile.bin

You may also use POST like so:

# You need to set the name of your file in the path after the host
curl -F "[email protected]" myhost.tld/myfile.bin
File uploaded successfully. The password for your file is:
foundation-balance-february

To delete a file, you only need its password too:

curl -X DELETE myhost.tld/foundation-balance-february
OK, the file has been deleted.

⁠Serve 🌎

⁠Locally

# By default, will listen on localhost:8080
make server-start

⁠Docker 🐳

Quick & dirty:

docker run -d -p 80:8080 nanawel/cliup

With proper upload folder and UID/GID:

mkdir ./uploads
docker run -d -p 80:8080 -v ./uploads:/srv/uploads -u 1000:1000 nanawel/cliup

⁠Reverse-proxy configuration

Of course you should use SSL/TLS with this service. But it's not embedded in the Docker itself nor in the server code. So you should configure properly a reverse-proxy with the solution of your choice.

⁠Nginx

You must set an appropriate client_max_body_size value depending on the MAX_UPLOAD_SIZE you set for the service (see §Configuration below).

Example in your vhost (here for 100 MB max):

client_max_body_size 100M;

⁠Apache

With Apache, you have 2 configurations value to check: LimitRequestBody but also Proxy100Continue that must be disabled (Off).

So for a hard limit to 100 MB, this should be:

LimitRequestBody 104857600
Proxy100Continue Off

⁠Purge ♻

Files are not automatically removed as there is no cronjob inside the Docker container. You should add such a job yourself on the host if you want expired files to be really deleted and thus space reclaimed:

docker exec <your-container> php admin.php purge

⁠Configuration

You can use the following environment variables to configure the service:

    BASE_URL              (default: <empty>)
    DEBUG                 (default: 0)
    EXPIRATION_TIME       (default: 86400      => 1 day)
    HASH_SALT             (default: <empty>)
    PASS_WORDS_COUNT      (default: 3)
    LOG_ACTIVITY          (default: 1)
    MAX_UPLOAD_SIZE       (default: 1048576    => 1 MB)
    TMP_DIR               (default: "/tmp")
    TRACE_CLIENT_INFO     (default: 1)
    UPLOAD_DIR            (default: "/tmp" or "/srv/uploads" on Docker)
    UPLOAD_DIR_PERMS      (default: "0700")
    UPLOAD_NAME_MAX_LEN   (default: 255)
    WORDSLIST_FILE        (default: "./wordslist.txt")