Skip to content

Commit

Permalink
docs: update docs on /upload
Browse files Browse the repository at this point in the history
  • Loading branch information
jabuxas committed Oct 15, 2024
1 parent bdab72d commit ba7ebb6
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# abyss

abyss is a basic single user http server made for uploading files (logs, images) and then sharing them to the internet
abyss is a basic (mostly) single user http server made for uploading files (logs, images) and then sharing them to the internet

note: this is a project made for learning purposes, you should use other more mature projects if running in production. probably.

Expand Down Expand Up @@ -58,6 +58,7 @@ curl -F "file=@/path/to/file" -H "X-Auth: "$(cat /path/to/.key) http://localhost
- `UPLOAD_KEY`: this is key checked when uploading files. if the key doesn't match with server's one, then it refuses uploading.
- `ABYSS_FILEDIR`: this points to the directory where abyss will save the uploads to. defaults to `./files`
- `ABYSS_PORT`: this is the port the server will run on. safe to leave empty. defaults to 3235
- `SHOULD_AUTH`: if it is `yes`, then to upload files you will need authentication (same as `/tree`), anything other than that and upload is free for anyone

## todo:

Expand Down

0 comments on commit ba7ebb6

Please sign in to comment.