Contains the Concourse pipeline definition for building a line-server container
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

118 lines
5.1 KiB

9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
  1. linx-server
  2. ======
  3. [![Build Status](https://travis-ci.org/andreimarcu/linx-server.svg?branch=master)](https://travis-ci.org/andreimarcu/linx-server)
  4. Self-hosted file/media sharing website.
  5. ### Features
  6. - Display common filetypes (image, video, audio, markdown, pdf)
  7. - Display syntax-highlighted code with in-place editing
  8. - Documented API with keys if need to restrict uploads (can use [linx-client](https://github.com/andreimarcu/linx-client) for uploading through command-line)
  9. - Torrent download of files using web seeding
  10. - File expiry, deletion key, and random filename options
  11. ### Screenshots
  12. <img width="230" src="https://cloud.githubusercontent.com/assets/4650950/10530123/4211e946-7372-11e5-9cb5-9956c5c49d95.png" /> <img width="230" src="https://cloud.githubusercontent.com/assets/4650950/10530124/4217db8a-7372-11e5-957d-b3abb873dc80.png" /> <img width="230" src="https://cloud.githubusercontent.com/assets/4650950/10530125/4219b8a6-7372-11e5-8b71-eeefb8b603d1.png" /> <img width="230" src="https://cloud.githubusercontent.com/assets/4650950/10530126/421a5964-7372-11e5-8601-5147e64af6fd.png" /> <img width="230" src="https://cloud.githubusercontent.com/assets/4650950/10530127/421b0576-7372-11e5-8ed5-557035bb9f9e.png" />
  13. Get release and run
  14. -------------------
  15. 1. Grab the latest binary from the [releases](https://github.com/andreimarcu/linx-server/releases)
  16. 2. Run ```./linx-server...```
  17. Usage
  18. -----
  19. #### Common options
  20. - ```-bind 127.0.0.1:8080``` -- what to bind to (default is 127.0.0.1:8080)
  21. - ```-sitename myLinx``` -- the site name displayed on top (default is linx)
  22. - ```-siteurl "http://mylinx.example.org/"``` -- the site url (for generating links)
  23. - ```-filespath files/"``` -- Path to store uploads (default is files/)
  24. - ```-metapath meta/``` -- Path to store information about uploads (default is meta/)
  25. - ```-maxsize 4294967296``` maximum upload file size in bytes (default 4GB)
  26. - ```-contentsecuritypolicy "..."``` -- Content-Security-Policy header for pages (default is "default-src 'self'; img-src 'self' data:; style-src 'self' 'unsafe-inline'; referrer origin;")
  27. - ```-filecontentsecuritypolicy "..."``` -- Content-Security-Policy header for files (default is "default-src 'none'; img-src 'self'; object-src 'self'; media-src 'self'; sandbox; referrer origin;"")
  28. - ```-xframeoptions "..." ``` -- X-Frame-Options header (default is "SAMEORIGIN")
  29. - ```-remoteuploads``` -- (optionally) enable remote uploads (/upload?url=https://...)
  30. - ```-nologs``` -- (optionally) disable request logs in stdout
  31. #### SSL with built-in server
  32. - ```-certfile path/to/your.crt``` -- Path to the ssl certificate (required if you want to use the https server)
  33. - ```-keyfile path/to/your.key``` -- Path to the ssl key (required if you want to use the https server)
  34. #### Use with http proxy
  35. - ```-realip``` -- let linx-server know you (nginx, etc) are providing the X-Real-IP and/or X-Forwarded-For headers.
  36. #### Use with fastcgi
  37. - ```-fastcgi``` -- serve through fastcgi
  38. #### Require API Keys for uploads
  39. - ```-authfile path/to/authfile``` -- (optionally) require authorization for upload/delete by providing a newline-separated file of scrypted auth keys
  40. - ```-remoteauthfile path/to/remoteauthfile``` -- (optionally) require authorization for remote uploads by providing a newline-separated file of scrypted auth keys
  41. A helper utility ```linx-genkey``` is provided which hashes keys to the format required in the auth files.
  42. Deployment
  43. ----------
  44. #### 1. Using fastcgi
  45. A suggested deployment is running nginx in front of linx-server serving through fastcgi.
  46. This allows you to have nginx handle the TLS termination for example.
  47. An example configuration:
  48. ```
  49. server {
  50. ...
  51. server_name yourlinx.example.org;
  52. ...
  53. client_max_body_size 4096M;
  54. location / {
  55. fastcgi_pass 127.0.0.1:8080;
  56. include fastcgi_params;
  57. }
  58. }
  59. ```
  60. And run linx-server with the ```-fastcgi``` option.
  61. #### 2. Using the built-in https server
  62. Run linx-server with the ```-certfile path/to/cert.file``` and ```-keyfile path/to/key.file``` options.
  63. #### 3. Using the built-in http server
  64. Run linx-server normally.
  65. Development
  66. -----------
  67. Any help is welcome, PRs will be reviewed and merged accordingly.
  68. The official IRC channel is #linx on irc.oftc.net
  69. 1. ```go get -u github.com/andreimarcu/linx-server ```
  70. 2. ```cd $GOPATH/src/github.com/andreimarcu/linx-server ```
  71. 3. ```go build && ./linx-server```
  72. License
  73. -------
  74. Copyright (C) 2015 Andrei Marcu
  75. This program is free software: you can redistribute it and/or modify
  76. it under the terms of the GNU General Public License as published by
  77. the Free Software Foundation, either version 3 of the License, or
  78. (at your option) any later version.
  79. This program is distributed in the hope that it will be useful,
  80. but WITHOUT ANY WARRANTY; without even the implied warranty of
  81. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  82. GNU General Public License for more details.
  83. You should have received a copy of the GNU General Public License
  84. along with this program. If not, see <http://www.gnu.org/licenses/>.
  85. Author
  86. -------
  87. Andrei Marcu, http://andreim.net/