From 6d75d620f928f4fa0ae5f25802b26d299e3d8e72 Mon Sep 17 00:00:00 2001 From: Dmitry Manchinskiy Date: Mon, 9 May 2022 17:22:29 +0300 Subject: [PATCH] Update README.md --- .travis.yml | 2 +- README.md | 146 +++++++++++++++++++++++++++------------------------- 2 files changed, 78 insertions(+), 70 deletions(-) diff --git a/.travis.yml b/.travis.yml index 50e69a5..a442a3b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,7 @@ language: go go: - - "1.16" + - "1.18" before_script: - go vet ./... diff --git a/README.md b/README.md index 8fdd4f4..2f74f5b 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,24 @@ - -linx-server +linx-server ====== -[![Build Status](https://travis-ci.org/andreimarcu/linx-server.svg?branch=master)](https://travis-ci.org/andreimarcu/linx-server) +[![Build Status](https://travis-ci.org/xtrafrancyz/linx-server.svg?branch=master)](https://travis-ci.org/xtrafrancyz/linx-server) -Self-hosted file/media sharing website. +Self-hosted file/media sharing website. ### Demo -You can see what it looks like using the demo: [https://demo.linx-server.net/](https://demo.linx-server.net/) +You can see what it looks like using the demo: [https://drop.xtrafrancyz.net/](https://drop.xtrafrancyz.net/) ### Features -- Display common filetypes (image, video, audio, markdown, pdf) +- 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](https://github.com/andreimarcu/linx-client) for uploading through command-line) +- Documented API with keys if need to restrict uploads (can + use [linx-client](https://github.com/andreimarcu/linx-client) for uploading through command-line) - Torrent download of files using web seeding - File expiry, deletion key, file access key, and random filename options - ### Screenshots + @@ -28,17 +28,18 @@ 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 __linx-server.conf__ in the following examples - +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 __linx-server.conf__ in the following examples Example running + ``` docker run -p 8080:8080 -v /path/to/linx-server.conf:/data/linx-server.conf -v /path/to/meta:/data/meta -v /path/to/files:/data/files andreimarcu/linx-server -config /data/linx-server.conf ``` -Example with docker-compose +Example with docker-compose + ``` version: '2.2' services: @@ -56,19 +57,22 @@ services: - "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](https://github.com/andreimarcu/linx-server/releases) +1. Grab the latest binary from the [releases](https://github.com/xtrafrancyz/linx-server/releases) 2. Run ```./linx-server``` - Usage ----- #### Configuration -All configuration options are accepted either as arguments or can be placed in a file as such (see example file linx-server.conf.example in repo): + +All configuration options are accepted either as arguments or can be placed in a file as such (see example file +linx-server.conf.example in repo): + ```ini bind = 127.0.0.1:8080 sitename = myLinx @@ -76,84 +80,87 @@ maxsize = 4294967296 maxexpiry = 86400 # ... etc ``` -...and then run ```linx-server -config path/to/linx-server.conf``` -#### Options +...and then run ```linx-server -config path/to/linx-server.conf``` -|Option|Description -|------|----------- -| ```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 = https://mylinx.example.org/``` | the site url (default is inferred from execution context) -| ```selifpath = selif``` | path relative to site base url (the "selif" in mylinx.example.org/selif/image.jpg) where files are accessed directly (default: selif) -| ```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 = true``` | 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';") -| ```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';") -| ```refererpolicy = "..."``` | Referrer-Policy header for pages (default is "same-origin") -| ```filereferrerpolicy = "..."``` | Referrer-Policy header for files (default is "same-origin") -| ```xframeoptions = "..." ``` | X-Frame-Options header (default is "SAMEORIGIN") -| ```remoteuploads = true``` | (optionally) enable remote uploads (/upload?url=https://...) -| ```nologs = true``` | (optionally) disable request logs in stdout -| ```custompagespath = custom_pages/``` | (optionally) specify path to directory containing markdown pages (must end in .md) that will be added to the site navigation (this can be useful for providing contact/support information and so on). For example, custom_pages/My_Page.md will become My Page in the site navigation +#### Options +| Option | Description | +|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ```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 = https://mylinx.example.org/``` | the site url (default is inferred from execution context) | +| ```selifpath = selif``` | path relative to site base url (the "selif" in mylinx.example.org/selif/image.jpg) where files are accessed directly (default: selif) | +| ```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 = true``` | 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';") | +| ```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';") | +| ```refererpolicy = "..."``` | Referrer-Policy header for pages (default is "same-origin") | +| ```filereferrerpolicy = "..."``` | Referrer-Policy header for files (default is "same-origin") | +| ```xframeoptions = "..." ``` | X-Frame-Options header (default is "SAMEORIGIN") | +| ```remoteuploads = true``` | (optionally) enable remote uploads (/upload?url=https://...) | +| ```nologs = true``` | (optionally) disable request logs in stdout | +| ```custompagespath = custom_pages/``` | (optionally) specify path to directory containing markdown pages (must end in .md) that will be added to the site navigation (this can be useful for providing contact/support information and so on). For example, custom_pages/My_Page.md will become My Page in the site navigation | #### 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 linx-cleanup directory. - -|Option|Description -|------|----------- -| ```cleanup-every-minutes = 5``` | How often to clean up expired files in minutes (default is 0, which means files will be cleaned up as they are accessed) +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 linx-cleanup directory. +| Option | Description | +|---------------------------------|--------------------------------------------------------------------------------------------------------------------------| +| ```cleanup-every-minutes = 5``` | How often to clean up expired files in minutes (default is 0, which means files will be cleaned up as they are accessed) | #### Require API Keys for uploads -|Option|Description -|------|----------- -| ```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 -| ```basicauth = true``` | (optionally) allow basic authorization to upload or paste files from browser when `-authfile` is enabled. When uploading, you will be prompted to enter a user and password - leave the user blank and use your auth key as the password +| Option | Description | +|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ```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 | +| ```basicauth = true``` | (optionally) allow basic authorization to upload or paste files from browser when `-authfile` is enabled. When uploading, you will be prompted to enter a user and password - leave the user blank and use your auth key as the password | A helper utility ```linx-genkey``` is provided which hashes keys to the format required in the auth files. #### Storage backends + The following storage backends are available: -|Name|Notes|Options -|----|-----|------- -|LocalFS|Enabled by default, this backend uses the filesystem|```filespath = files/``` -- Path to store uploads (default is files/)
```metapath = meta/``` -- Path to store information about uploads (default is meta/)| -|S3|Use with any S3-compatible provider.
This implementation will stream files through the linx instance (every download will request and stream the file from the S3 bucket).

For high-traffic environments, one might consider using an external caching layer such as described [in this article](https://blog.sentry.io/2017/03/01/dodging-s3-downtime-with-nginx-and-haproxy.html).|```s3-endpoint = https://...``` -- S3 endpoint
```s3-region = us-east-1``` -- S3 region
```s3-bucket = mybucket``` -- S3 bucket to use for files and metadata
```s3-force-path-style = true``` (optional) -- force path-style addresing (e.g. https://s3.amazonaws.com/linx/example.txt)

Environment variables to provide:
```AWS_ACCESS_KEY_ID``` -- the S3 access key
```AWS_SECRET_ACCESS_KEY ``` -- the S3 secret key
```AWS_SESSION_TOKEN``` (optional) -- the S3 session token| +| Name | Notes | Options | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocalFS | Enabled by default, this backend uses the filesystem | ```filespath = files/``` -- Path to store uploads (default is files/)
```metapath = meta/``` -- Path to store information about uploads (default is meta/) | +| S3 | Use with any S3-compatible provider.
This implementation will stream files through the linx instance (every download will request and stream the file from the S3 bucket).

For high-traffic environments, one might consider using an external caching layer such as described [in this article](https://blog.sentry.io/2017/03/01/dodging-s3-downtime-with-nginx-and-haproxy.html). | ```s3-endpoint = https://...``` -- S3 endpoint
```s3-region = us-east-1``` -- S3 region
```s3-bucket = mybucket``` -- S3 bucket to use for files and metadata
```s3-force-path-style = true``` (optional) -- force path-style addresing (e.g. https://s3.amazonaws.com/linx/example.txt)

Environment variables to provide:
```AWS_ACCESS_KEY_ID``` -- the S3 access key
```AWS_SECRET_ACCESS_KEY ``` -- the S3 secret key
```AWS_SESSION_TOKEN``` (optional) -- the S3 session token | + +#### SSL with built-in server +| Option | Description | +|-----------------------------------|----------------------------------------------------------------------------| +| ```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) | -#### SSL with built-in server -|Option|Description -|------|----------- -| ```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 -#### Use with http proxy -|Option|Description -|------|----------- -| ```realip = true``` | let linx-server know you (nginx, etc) are providing the X-Real-IP and/or X-Forwarded-For headers. +| Option | Description | +|---------------------|---------------------------------------------------------------------------------------------------| +| ```realip = true``` | let linx-server know you (nginx, etc) are providing the X-Real-IP and/or X-Forwarded-For headers. | #### Use with fastcgi -|Option|Description -|------|----------- -| ```fastcgi = true``` | serve through fastcgi + +| Option | Description | +|----------------------|-----------------------| +| ```fastcgi = true``` | serve through fastcgi | 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 { ... @@ -167,24 +174,25 @@ server { } } ``` + And run linx-server with the ```fastcgi = true``` 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 +Any help is welcome, PRs will be reviewed and merged accordingly. -1. ```go get -u github.com/andreimarcu/linx-server ``` -2. ```cd $GOPATH/src/github.com/andreimarcu/linx-server ``` +1. ```git clone https://github.com/xtrafrancyz/linx-server ``` +2. ```cd linx-server ``` 3. ```go build && ./linx-server``` - License ------- Copyright (C) 2015 Andrei Marcu @@ -196,11 +204,11 @@ the Free Software Foundation, either version 3 of the License, or 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 +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 . +along with this program. If not, see . Author -------