JavaScript Go CSS HTML Shell
Clone or download
andreimarcu Merge pull request #141 from bruj0/patch-1
Fix files and meta permissions
Latest commit 7c024d9 Apr 26, 2018
Permalink
Failed to load latest commit information.
backends Add linx-cleanup tool May 2, 2017
expiry Add linx-cleanup tool May 2, 2017
linx-cleanup Fix -nologs on linx-cleanup tool (closes #136) Feb 25, 2018
linx-genkey Remove artifact Oct 12, 2015
static Use value instead of selectedOptions. Oct 23, 2016
templates Add option for maximum expiration time (fixes #99) Sep 19, 2016
.gitignore Add linx-cleanup tool May 2, 2017
.travis.yml Add ability to short urls for uploaded content (#85) Jun 15, 2016
Dockerfile Fix files and meta permissions Apr 21, 2018
LICENSE.txt Updated README and license Sep 29, 2015
README.md Add `linx-cleanup` info to readme May 5, 2017
auth.go Rename auth header to Linx-Api-Key and remove Oct 14, 2015
auth_test.go Rename auth header to Linx-Api-Key and remove Oct 14, 2015
build.sh Add linx-cleanup to build script Oct 11, 2017
csp.go Cleanup vim artifacts Oct 4, 2015
csp_test.go Adjust the csp_test to use the new mux Oct 10, 2015
csrf.go Cleanup Oct 15, 2015
delete.go Add linx-cleanup tool May 2, 2017
display.go Add linx-cleanup tool May 2, 2017
expiry.go Add linx-cleanup tool May 2, 2017
fileserve.go Add linx-cleanup tool May 2, 2017
headers.go Infer site URL from host and headers Jun 5, 2016
linx-server.service Add Install-section to systemd-service Oct 9, 2016
meta.go Add linx-cleanup tool May 2, 2017
pages.go Add option for maximum expiration time (fixes #99) Sep 19, 2016
server.go Add linx-cleanup tool May 2, 2017
server_test.go Change unknown extension from .ext to .file Mar 25, 2017
shorturl.go Add ability to short urls for uploaded content (#85) Jun 15, 2016
templates.go Fix that custom sitename gets ignored Jun 15, 2016
torrent.go Add linx-cleanup tool May 2, 2017
torrent_test.go use abstracted storage for flexibility Jun 9, 2016
upload.go Add linx-cleanup tool May 2, 2017
util.go Remove mime type to extension map from util.go Mar 25, 2017

README.md

linx-server

Build Status

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 if need to restrict uploads (can use linx-client for uploading through command-line)
  • Torrent download of files using web seeding
  • File expiry, deletion key, and random filename options

Screenshots


Get release and run

  1. Grab the latest binary from the releases
  2. Run ./linx-server

Usage

Configuration

All configuration options are accepted either as arguments or can be placed in an ini-style file as such:

maxsize = 4294967296
allowhotlink = true
# etc

...and then invoke linx-server -config path/to/config.ini

Options

  • -bind 127.0.0.1:8080 -- what to bind to (default is 127.0.0.1:8080)
  • -sitename myLinx -- the site name displayed on top (default is inferred from Host header)
  • -siteurl "http://mylinx.example.org/" -- the site url (default is inferred from execution context)
  • -filespath files/ -- Path to store uploads (default is files/)
  • -metapath meta/ -- Path to store information about uploads (default is meta/)
  • -maxsize 4294967296 -- maximum upload file size in bytes (default 4GB)
  • -maxexpiry 86400 -- maximum expiration time in seconds (default is 0, which is no expiry)
  • -allowhotlink -- Allow file hotlinking
  • -contentsecuritypolicy "..." -- Content-Security-Policy header for pages (default is "default-src 'self'; img-src 'self' data:; style-src 'self' 'unsafe-inline'; frame-ancestors 'self'; referrer origin;")
  • -filecontentsecuritypolicy "..." -- Content-Security-Policy header for files (default is "default-src 'none'; img-src 'self'; object-src 'self'; media-src 'self'; style-src 'self' 'unsafe-inline'; frame-ancestors 'self'; referrer origin;")
  • -xframeoptions "..." -- X-Frame-Options header (default is "SAMEORIGIN")
  • -remoteuploads -- (optionally) enable remote uploads (/upload?url=https://...)
  • -nologs -- (optionally) disable request logs in stdout
  • -googleapikey -- (optionally) API Key for Google's URL Shortener. (How to create one)

SSL with built-in server

  • -certfile path/to/your.crt -- Path to the ssl certificate (required if you want to use the https server)
  • -keyfile path/to/your.key -- Path to the ssl key (required if you want to use the https server)

Use with http proxy

  • -realip -- let linx-server know you (nginx, etc) are providing the X-Real-IP and/or X-Forwarded-For headers.

Use with fastcgi

  • -fastcgi -- serve through fastcgi

Require API Keys for uploads

  • -authfile path/to/authfile -- (optionally) require authorization for upload/delete by providing a newline-separated file of scrypted auth keys
  • -remoteauthfile path/to/remoteauthfile -- (optionally) require authorization for remote uploads by providing a newline-separated file of scrypted auth keys

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

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. If you'd like to automatically clean up files that have expired, you can use the included linx-cleanup utility. To run it automatically, use a cronjob or similar type of scheduled task.

You should be careful to ensure that only one instance of linx-client runs at a time to avoid unexpected behavior. It does not implement any type of locking.

Options

  • -filespath files/ -- Path to stored uploads (default is files/)
  • -metapath meta/ -- Path to stored information about uploads (default is meta/)
  • -nologs -- (optionally) disable deletion logs in stdout

Deployment

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

1. Using fastcgi

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

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

And run linx-server with the -fastcgi option.

2. Using the built-in https server

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

3. Using the built-in http server

Run linx-server normally.

4. Using Docker with the built-in http server

First, build the image: docker build -t linx-server .

You'll need some directories for the persistent storage. For the purposes of this example, we will use /media/meta and /media/files.

Then, run it: docker run -p 8080:8080 -v /media/meta:/data/meta -v /media/files:/data/files linx-server

Development

Any help is welcome, PRs will be reviewed and merged accordingly.
The official IRC channel is #linx on irc.oftc.net

  1. go get -u github.com/andreimarcu/linx-server
  2. cd $GOPATH/src/github.com/andreimarcu/linx-server
  3. go build && ./linx-server

License

Copyright (C) 2015 Andrei Marcu

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Author

Andrei Marcu, http://andreim.net/