diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..f818329 --- /dev/null +++ b/.env.example @@ -0,0 +1,10 @@ +SECRET = "1234" +PORT = 8080 +FOLDER = "./uploads/" +LOGGING = "true" +SIZE_LIMIT_ENABLED = "true" +SIZE_LIMIT = 1000 +WEB = "true" +RATELIMIT = "true" +RATELIMIT_DURATION = 60 +RATELIMIT_COUNT = 10 \ No newline at end of file diff --git a/README.md b/README.md index 587f922..9b085bd 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,9 @@ ShareX uploader but in Go so it's very fast I made this as part of learning Go, so it's probably bad code. I don't recommend running it in production. ## Installation -soon - -## Environment Variables -``` -SECRET = "1234" -PORT = 8080 -FOLDER = "./uploads/" -LOGGING = "true" -SIZE_LIMIT_ENABLED = "true" -SIZE_LIMIT = 1000 -WEB = "true" -RATELIMIT = "true" -RATELIMIT_DURATION = 60 -RATELIMIT_COUNT = 10 -``` +1. Install Go and all dependencies +2. Rename .env.example to .env and change info +3. Either run the server with ``go run main.go`` or build with ``go build main.go`` and run the binary ## License [MIT](https://github.com/davidjcralph/gosharex/blob/master/LICENSE)