Go to file
andreimarcu 294e8d8be2 Better text detection 2015-10-28 15:21:54 -04:00
linx-genkey Remove artifact 2015-10-11 21:42:00 -04:00
static Remove unnecessary margin on pastebins 2015-10-21 21:41:27 -04:00
templates Add linx-client in API documentation 2015-10-15 17:26:35 -04:00
.gitignore Add preliminary metadata support 2015-09-27 22:43:41 -04:00
.travis.yml No need for sudo since we got rid of that library 2015-09-29 00:42:56 -04:00
LICENSE.txt Updated README and license 2015-09-28 23:46:50 -04:00
README.md Allow configuration from ini-style file 2015-10-25 14:04:38 -04:00
auth.go Rename auth header to Linx-Api-Key and remove 2015-10-14 16:18:29 -04:00
auth_test.go Rename auth header to Linx-Api-Key and remove 2015-10-14 16:18:29 -04:00
build.sh Update build.sh to build linx-genkey 2015-10-14 16:31:52 -04:00
csp.go Cleanup vim artifacts 2015-10-04 18:24:13 -04:00
csp_test.go Adjust the csp_test to use the new mux 2015-10-10 11:17:38 -04:00
csrf.go Cleanup 2015-10-14 22:47:36 -04:00
delete.go Metadata holds mimetype, sha256sum, archiveFiles 2015-10-07 22:45:34 -04:00
display.go Better text detection 2015-10-28 15:21:54 -04:00
expiry.go Metadata holds mimetype, sha256sum, archiveFiles 2015-10-07 22:45:34 -04:00
fileserve.go Removed unnecessary duplicate static caching 2015-10-14 14:58:27 -04:00
meta.go Better text detection 2015-10-28 15:21:54 -04:00
pages.go nicer 400 error page 2015-10-12 01:03:02 -07:00
server.go Allow configuration from ini-style file 2015-10-25 14:04:38 -04:00
server_test.go trim trailing / for origin checking 2015-10-11 20:06:14 -07:00
templates.go Fix/implement .story 2015-10-15 12:24:23 -04:00
torrent.go Metadata holds mimetype, sha256sum, archiveFiles 2015-10-07 22:45:34 -04:00
torrent_test.go Cleanup vim artifacts 2015-10-04 18:24:13 -04:00
upload.go Trim "-" in filenames 2015-10-28 14:31:51 -04:00
util.go Fix/implement .story 2015-10-15 12:24:23 -04:00

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:

sitename = "my linx"  
siteurl = "https://linx.example.com"  
remoteuploads = true
# etc

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

Common 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 linx)
  • -siteurl "http://mylinx.example.org/" -- the site url (for generating links)
  • -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)
  • -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'; referrer origin;")
  • -filecontentsecuritypolicy "..." -- Content-Security-Policy header for files (default is "default-src 'none'; img-src 'self'; object-src 'self'; media-src '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

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.

Deployment

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.

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/