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.

README.md 3.4 KiB

7 years ago
9 years ago
9 years ago
9 years ago
9 years ago
7 years ago
9 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
9 years ago
7 years ago
9 years ago
7 years ago
7 years ago
9 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. # transfer.sh [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dutchcoders/transfer.sh?utm_source=badge&utm_medium=badge&utm_campaign=&utm_campaign=pr-badge&utm_content=badge) [![Go Report Card](https://goreportcard.com/badge/github.com/dutchcoders/transfer.sh)](https://goreportcard.com/report/github.com/dutchcoders/transfer.sh) [![Docker pulls](https://img.shields.io/docker/pulls/dutchcoders/transfer.sh.svg)](https://hub.docker.com/r/dutchcoders/transfer.sh/) [![Build Status](https://travis-ci.org/dutchcoders/transfer.sh.svg?branch=master)](https://travis-ci.org/dutchcoders/transfer.sh)
  2. Easy and fast file sharing from the command-line. This code contains the server with everything you need to create your own instance.
  3. Transfer.sh support currently the s3 (Amazon S3) and gdrive (Google Drive) providers and local file system (local).
  4. ## Usage
  5. ```
  6. Upload:
  7. $ curl --upload-file ./hello.txt https://transfer.sh/hello.txt
  8. Encrypt & upload:
  9. $ cat /tmp/hello.txt|gpg -ac -o-|curl -X PUT --upload-file "-" https://transfer.sh/test.txt
  10. Download & decrypt:
  11. $ curl https://transfer.sh/1lDau/test.txt|gpg -o- > /tmp/hello.txt
  12. Upload to virustotal:
  13. $ curl -X PUT --upload-file nhgbhhj https://transfer.sh/test.txt/virustotal
  14. Add alias to .bashrc or .zshrc:
  15. ===
  16. transfer() {
  17. # write to output to tmpfile because of progress bar
  18. tmpfile=$( mktemp -t transferXXX )
  19. curl --progress-bar --upload-file $1 https://transfer.sh/$(basename $1) >> $tmpfile;
  20. cat $tmpfile;
  21. rm -f $tmpfile;
  22. }
  23. alias transfer=transfer
  24. ===
  25. $ transfer test.txt
  26. ```
  27. ## Usage
  28. Parameter | Description | Value | Env
  29. --- | --- | --- | ---
  30. listener | port to use for http (:80) | |
  31. profile-listener | port to use for profiler (:6060)| |
  32. force-https | redirect to https | false |
  33. tls-listener | port to use for https (:443) | |
  34. tls-cert-file | path to tls certificate | |
  35. tls-private-key | path to tls private key | |
  36. temp-path | path to temp folder | system temp |
  37. web-path | path to static web files (for development) | |
  38. provider | which storage provider to use | (s3, grdrive or local) |
  39. aws-access-key | aws access key | | AWS_ACCESS_KEY
  40. aws-secret-key | aws access key | | AWS_SECRET_KEY
  41. bucket | aws bucket | | BUCKET
  42. basedir | path storage for local/gdrive provider| |
  43. gdrive-client-json-filepath | path to client json config for gdrive provider| |
  44. gdrive-local-config-path | path to local transfer.sh config cache for gdrive provider| |
  45. lets-encrypt-hosts | hosts to use for lets encrypt certificates (comma seperated) | |
  46. log | path to log file| |
  47. If you want to use TLS using lets encrypt certificates, set lets-encrypt-hosts to your domain, set tls-listener to :443 and enable force-https.
  48. If you want to use TLS using your own certificates, set tls-listener to :443, force-https, tls-cert=file and tls-private-key.
  49. ## Development
  50. Make sure your GOPATH is set correctly.
  51. ```
  52. go run main.go -provider=local --listener :8080 --temp-path=/tmp/ --basedir=/tmp/
  53. ```
  54. ## Build
  55. ```
  56. go build -o transfersh main.go
  57. ```
  58. ## Docker
  59. For easy deployment we've created a Docker container.
  60. ```
  61. docker run --publish 8080:8080 dutchcoders/transfer.sh:latest --provider local --basedir /tmp/
  62. ```
  63. ## Contributions
  64. Contributions are welcome.
  65. ## Creators
  66. **Remco Verhoef**
  67. - <https://twitter.com/remco_verhoef>
  68. - <https://twitter.com/dutchcoders>
  69. **Uvis Grinfelds**
  70. ## Copyright and license
  71. Code and documentation copyright 2011-2014 Remco Verhoef.
  72. Code released under [the MIT license](LICENSE).