From acd9b90042626b27ee08c184ed90a95d07f444dd Mon Sep 17 00:00:00 2001 From: Lucas Barbieri Date: Sun, 25 Aug 2024 23:16:56 -0300 Subject: [PATCH] feat: remove /upload and just use / --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8f97128..eddb429 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,34 @@ # abyss + abyss is a basic 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 ## table of contents + - [running abyss](#running) - - [installing with docker](#docker) - - [installing manually](#manual) + - [installing with docker](#docker) + - [installing manually](#manual) - [uploading files](#uploading) - [todo list](#todo) ## running: + - change URL environment variable to your end url. example: `URL=paste.abyss.dev` if you your files will be accessed through `paste.abyss.dev/name-of-file` - add your password (key) to `.key` in the root directory of the project - it will be used for authentication for uploads. - add AUTH_USERNAME and AUTH_PASSWORD environment variables for access to `/tree/` ### docker + - to run with docker, you can use docker compose: + ```bash docker compose up -d # might be docker-compose depending on distro ``` + - dont change inside port of 8080 unless you know what you're doing - when updating, run with `--build` instead: + ```bash docker compose up --build -d ``` @@ -29,6 +36,7 @@ docker compose up --build -d ### manual - to run it, either build with `go build -o abyss` or run it directly with: + ```bash URL="your-domain" AUTH_USERNAME=admin AUTH_PASSWORD=admin go run ./main.go ``` @@ -36,10 +44,13 @@ URL="your-domain" AUTH_USERNAME=admin AUTH_PASSWORD=admin go run ./main.go ## uploading - then, simply upload your files with curl: + ```bash -curl -F "file=@/path/to/file" -H "X-Auth: "$(cat /path/to/.key) http://localhost:8080/upload +curl -F "file=@/path/to/file" -H "X-Auth: "$(cat /path/to/.key) http://localhost:8080/ ``` + ## todo: + - [x] add upload of logs funcionality (like 0x0.st) - [x] add docker easy setup - ~~add db for tracking of file names~~ (dont need that)