Skip to content

Commit

Permalink
WIP installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
davidcralph committed Mar 15, 2021
1 parent 26ae752 commit 4008835
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
10 changes: 10 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -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
18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 4008835

Please sign in to comment.