Skip to content

Latest commit

 

History

History
125 lines (94 loc) · 3.36 KB

README.md

File metadata and controls

125 lines (94 loc) · 3.36 KB
Raw

chunkdrive

chunkdrive is a proof of concept tool that allows you to store vast amounts of data by splitting it into chunks and uploading them to services that offer free storage.

Each chunk is send to a random so called "bucket". Each bucket can be configured to use a different storage service and encryption method.

video.mp4

Configuration

chunkdrive is configured using a YAML file, by default it looks for config.yaml in the current directory, but you can specify a different path using the CD_CONFIG_PATH environment variable.

Example config 
buckets:
  some_name_you_choose:
    source:
      type: local
      folder: /path/to/folder
      max_size: 1000000000 # optional
    encryption:
      type: aes
      key: your_encryption_key
  some_other_name_you_choose:
    source:
      type: discord_webhook
        url: https://discord.com/api/webhooks/1234567890/abcdefghijklmnopqrstuvwxyz
    encryption:  # if you want to use none, you can omit this section
      type: none
services:
  - type: http
    port: 8080

Supported storage services

You can make as many buckets as you want, each bucket can have a different storage service or the same one.

Local folder 
buckets:
  some_name_you_choose:
    source:
      type: local
      folder: /path/to/folder
      max_size: 1000000000 # optional
Discord webhooks 
buckets:
  some_name_you_choose:
    source:
      type: discord_webhook
        url: https://discord.com/api/webhooks/1234567890/abcdefghijklmnopqrstuvwxyz
GitHub Releases 
buckets:
  some_name_you_choose:
    source:
      type: github_release
      user: your_github_username
      repo: your_github_repo
      pat: your_github_personal_access_token

pat should have the repo scope, so it can create releases and upload files to them.

Services

HTTP server 
services:
  - type: http
    port: 8080
    address: 127.0.0.1  # optional
    see_root: true  # optional
    readonly: false  # optional
    style_path: ./style.css  # optional
    script_path: ./script.js  # optional
  • address specifies the address to listen on.
  • see_root makes the / directory visible. Useful if you want to make a share server where users need to explicitly specify the descriptor to access data.
  • readonly makes the server read-only.
  • style_path specifies a path to a CSS file that will be used to style the web interface. Tip: if you want to make minor changes, you should edit ./web/src/style/config.css and run pnpm run build-style to generate a new CSS file. The HTTP server does not handle authentication or SSL. It was designed to be used behind a reverse proxy like nginx.

The interface is fully working without JavaScript. There are only minor things that require JavaScript:

  • Drag and drop upload
  • Theme preference saving
  • Upload progress bar
  • Warn on delete
  • Warn on leaving the page while uploading

Debug shell

chunkdrive includes a debug shell that lets you inspect the state of the filesystem and the buckets. You can enter it by running chunkdrive --shell.