1
0
Fork 0
mirror of https://github.com/Luzifer/share.git synced 2024-10-18 13:24:23 +00:00
share/README.md
Knut Ahlers af5944e382
Add browser compatibility to README
Signed-off-by: Knut Ahlers <knut@ahlers.me>
2018-04-23 23:54:23 +02:00

1.4 KiB

Go Report Card

Luzifer / share

share is a small replacement I wrote for sharing my files through external services like CloudApp using Amazon S3. Files are uploaded using this utility into S3 and previewed (if supported) using the included frontend.

Browser Support

The web frontend uses ECMAScript 6 (ES6) so a relatively modern browser is required:

  • Apple iOS >= 10.0
  • Apple Safari >= 10
  • Google Chrome >= 58
  • Microsoft Edge >= 14
  • Mozilla Firefox >= 52

Internet Explorer and older versions of the above listed browsers might work (except IE) but are not supported and will never be.

Setup / usage

  • Create a S3 bucket and CloudFront distribution
    (See docs/cloudformation.yml for an example stack)
  • Run bootstrap to initialize frontend files:
    ./share --bucket=<bucket from step 1> --bootstrap
  • Upload files to your sharing bucket:
    ./share --bucket=<bucket from step 1> --base-url='https://your.site.com/#' <yourfile>
  • Share the URL you received from last step

After you've updated the binary you need to run the --bootstrap command once more to have the latest interface changes uploaded to your bucket.