Giter Club home page Giter Club logo

zipline-1's Introduction

A ShareX/file upload server that is easy to use, packed with features, and with an easy setup!

Stars Version GitHub last commit (branch) Discord

Build Docker Image (trunk) Docker Image (release)

Features

  • Configurable
  • Fast
  • Built with Next.js & React
  • Token protected uploading
  • Image uploading
  • Image compression
  • Password Protected Uploads
  • URL shortening
  • Text uploading
  • URL Formats (uuid, dates, random alphanumeric, original name, zws)
  • Discord embeds (OG metadata)
  • Gallery viewer, and multiple file format support
  • Code highlighting
  • Fully customizable Discord webhook notifications
  • OAuth2 registration (Discord and GitHub)
  • User invites
  • Easy setup instructions on docs (One command install docker-compose up -d)

Usage

Install & run with Docker

This section requires Docker and docker-compose.

git clone https://github.com/diced/zipline
cd zipline

docker-compose up -d

After installing

After installing, please edit the docker-compose.yml file and find the line that says SECRET=changethis and replace changethis with a random string. Ways you could generate the string could be from a password managers generator, or you could just slam your keyboard and hope for the best.

Building & running from source

This section requires nodejs, yarn or npm.

git clone https://github.com/diced/zipline
cd zipline

# npm install
yarn install
# npm run build
yarn build
# npm start
yarn start

NGINX Proxy

This section requires NGINX.

server {
  listen 80 default_server;
  client_max_body_size 100M;
  server_name <your domain (optional)>;
  location / {
    proxy_pass http://localhost:3000;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
  }
}

Website

The default port is 3000, once you have accessed it you can see a login screen. The default credentials are "administrator" and "password". Once you login please immediately change the details to something more secure. You can do this by clicking on the top right corner where it says "administrator" with a gear icon and clicking Manage Account.

ShareX (Windows)

This section requires ShareX.

After navigating to Zipline, click on the top right corner where it says your username and click Manage Account. Scroll down to see "ShareX Config", select the one you would prefer using. After this you can import the .sxcu into sharex. More information here

Flameshot (Linux)

This section requires Flameshot, jq, and xsel.

You can either use the script below, or generate one directly from Zipline (just like how you can generate a ShareX config). To upload files using flameshot we will use a script. Replace $TOKEN and $HOST with your own values, you probably know how to do this if you use linux.

DATE=$(date '+%h_%Y_%d_%I_%m_%S.png');
flameshot gui -r > ~/Pictures/$DATE;

curl -H "Content-Type: multipart/form-data" -H "authorization: $TOKEN" -F file=@$1 $HOST/api/upload | jq -r 'files[0].url' | xsel -ib

Contributing

Bug reports

Create an issue on GitHub, please include the following (if one of them is not applicable to the issue then it's not needed):

  • The steps to reproduce the bug
  • Logs of Zipline
  • The version of Zipline
  • Your OS & Browser including server OS
  • What you were expecting to see

Feature requests

Create an issue on GitHub, please include the following:

  • Breif explanation of the feature in the title (very breif please)
  • How it would work (detailed, but optional)

Pull Requests (contributions to the codebase)

Create a pull request on GitHub. If your PR does not pass the action checks, then please fix the errors. If your PR was submitted before a release, and I have pushed a new release, please make sure to update your PR to reflect any changes, usually this is handled by GitHub.

zipline-1's People

Contributors

advilm avatar alphanecron avatar ar065 avatar axisiscool avatar cestef avatar chamburr avatar dependabot[bot] avatar diced avatar hexed avatar itzderock avatar nebulabc avatar relaxtakenotes avatar tacticaltechjay avatar winterfe avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.