Update README.md

This commit is contained in:
Andrei Marcu 2020-10-16 16:57:09 -07:00
parent ef99024433
commit 91b9885ac6
1 changed files with 12 additions and 3 deletions

View File

@ -9,11 +9,20 @@ Self-hosted file/media sharing website.
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://demo.linx-server.net/](https://demo.linx-server.net/)
### Clients
**Official**
- CLI: **linx-client** - [Source](https://github.com/andreimarcu/linx-client)
**Unofficial**
- Android: **LinxShare** - [Source](https://github.com/iksteen/LinxShare/) | [Google Play](https://play.google.com/store/apps/details?id=org.thegraveyard.linxshare)
- CLI: **golinx** - [Source](https://github.com/mutantmonkey/golinx)
### Features ### 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 - 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, or [LinxShare](https://github.com/iksteen/LinxShare/) client for android - also available on the (Play Store)[https://play.google.com/store/apps/details?id=org.thegraveyard.linxshare] ) - Documented API with keys for restricting uploads
- Torrent download of files using web seeding - Torrent download of files using web seeding
- File expiry, deletion key, file access key, and random filename options - File expiry, deletion key, file access key, and random filename options
@ -60,8 +69,8 @@ Ideally, you would use a reverse proxy such as nginx or caddy to handle TLS cert
#### Using a binary release #### 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/andreimarcu/linx-server/releases), then run ```go install```
2. Run ```./linx-server``` 2. Run ```linx-server -config path/to/linx-server.conf```
Usage Usage