sidegate

README

SideGate

Share files with friends :)

What does it do?

1. Serves a directory and everything below it over HTTP
2. Files can be downloaded from any of the served directories
3. Files can be uploaded into any of the served directories

What else does it do?

1. It won't serve any files or folders that aren't world-readable.

Why?

On several occasions my friends and I have wanted to share large files with each other, but we have run into at least one of the following issues:

1. My MacBook only has USB-C ports, so I can't get the files via a USB flash drive, or external hard drive, unless one of us has an adapter or hub, which we don't
2. The friend's computer isn't also a Mac, so we can't use AirDrop
3. The files can be uploaded to a cloud file hosting provider, and then downloaded, but this seems wasteful of bandwidth when we're connected to the same local network and sitting a few feet from each other
4. The friend's laptop can't run a simple fileserver (like Python's SimpleHTTPServer), because perhaps they don't have enough privileges

All of this is ridiculous, so I wrote this dirt-simple program that I can run on my laptop, and then any of my friends with a web browser can either upload files to or download files from my laptop, without us needing to work around these silly problems.

Why not any of the other projects?

There are other projects out there that perform this function, but, of the ones that I saw, I don't like them because:

1. They're often written in Python with third-party dependencies, and I just want a static binary that's easy to compile with no external dependencies or runtimes necessary, that I can also cross-compile for other platforms and share with less technical friends if they want to use this for themselves
2. Worse still, some projects require Apache or nginx, because they're CGI or PHP scripts
3. They have a ton of extra features that I'm not interested in, e.g. user accounts and groups of users — i.e. a database dependency — in-browser file viewers, and tons of JavaScript and CSS effects

This is a lot more than I thought was necessary.

I wanted something approachable, simple, and portable.

Install

If you have the Go toolchain installed, then the system can be installed by:

$ go get -u github.com/ltriant/sidegate

It will be installed into you Go path's bin directory...

$ $(go env GOPATH)/bin/sidegate

Build

The Go toolchain is necessary to build.

$ git clone https://github.com/ltriant/sidegate.git
$ cd sidegate
$ go build

Running

After installing or building, it can be run without any parameters:

$ sidegate
2020/03/02 09:53:43 Serving local directory /Users/ltriant/projects/github/sidegate
2020/03/02 09:53:43 Listening on http://10.1.18.33:8000

The logged URL — which points to your IP address on your local network — can be shared with your friends, and then amazing file-sharing experiences may commence :)

By default, files are served from the current working directory (i.e. whichever directory you ran the program from), but this can be overridden with the -dir parameter.

Also by default, the server listens on port 8000, but can be overridden by the -port parameter.

$ sidegate -dir /tmp -port 1234

This was intended to be run on a local network only and not the public-facing internet, so there's no SSL.