bin404

Bin404

Bin404 is a self-hosted file/media sharing website used for the Sokka project and available at bin.4-0-4.io.

Features

• File sharing: Share files with others, with the option to set an expiration date, a deletion key, and a file access key.
• Media sharing: Share images, videos, audio, and other media files.
• Code sharing: Share code snippets with syntax highlighting and in-place editing.
• Torrent download: Download files using web seeding.
• API: Documented API with keys for restricting uploads.
• Custom pages: Add custom pages to the site navigation.
• Remote uploads: Enable remote uploads. ====== Self-hosted file/media sharing website.

Features

• Display common filetypes (image, video, audio, markdown, pdf)
• Display syntax-highlighted code with in-place editing
• Documented API with keys for restricting uploads
• Torrent download of files using web seeding
• File expiry, deletion key, file access key, and random filename options

Getting started

Using Docker

1. Create directories files and meta and run chown -R 65534:65534 meta && chown -R 65534:65534 files
2. Create a config file (example provided in repo), we'll refer to it as bin404.conf in the following examples

Example running

docker run -p 8080:8080 -v /path/to/bin404-server.conf:/data/bin404-server.conf -v /path/to/meta:/data/meta -v /path/to/files:/data/files ghcr.io/d-a-s-h-o/bin404:latest -config /data/bin404-server.conf

Example with docker-compose

version: '2.2'
services:
  bin404-server:
    container_name: bin404-server
    image: ghcr.io/d-a-s-h-o/bin404:latest
    command: -config /data/bin404-server.conf
    volumes:
      - /path/to/files:/data/files
      - /path/to/meta:/data/meta
      - /path/to/bin404-server.conf:/data/bin404-server.conf
    network_mode: bridge
    ports:
      - "8080:8080"
    restart: unless-stopped

Ideally, you would use a reverse proxy such as nginx or caddy to handle TLS certificates.

Using a binary release

1. Grab the latest binary from the releases, then run go install
2. Run ./bin404 -config path/to/bin404-server.conf

Usage

Configuration

All configuration options are accepted either as arguments or can be placed in a file as such (see example file bin404-server.conf.example in repo):

bind = 127.0.0.1:8080
sitename = Bin404
maxsize = 4294967296
maxexpiry = 86400
# ... etc

...and then run ./bin404 -config path/to/bin404-server.conf

Options

Cleaning up expired files

When files expire, access is disabled immediately, but the files and metadata will persist on disk until someone attempts to access them. You can set the following option to run cleanup every few minutes. This can also be done using a separate utility found the bin404-cleanup directory.

Require API Keys for uploads

A helper utility bin404-genkey is provided which hashes keys to the format required in the auth files.

Storage backends

The following storage backends are available:

SSL with built-in server

Use with http proxy

Use with fastcgi

Deployment

bin404-server supports being deployed in a subdirectory (ie. example.com/bin404/) as well as on its own (bin404.com/).

1. Using fastcgi

A suggested deployment is running nginx in front of bin404-server serving through fastcgi. This allows you to have nginx handle the TLS termination for example.
An example configuration:

server {
    ...
    server_name bin404.example.org;
    ...
    
    client_max_body_size 4096M;
    location / {
        fastcgi_pass 127.0.0.1:8080;
        include fastcgi_params;
    }
}

And run bin404-server with the fastcgi = true option.

2. Using the built-in https server

Run bin404-server with the certfile = path/to/cert.file and keyfile = path/to/key.file options.

3. Using the built-in http server

Run bin404-server normally.

Development

1. go get -u github.com/d-a-s-h-o/bin404
2. cd $GOPATH/src/github.com/d-a-s-h-o/bin404
3. go build && ./bin404