abyss/README.md

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
  • installing with docker
  • installing manually
• uploading files
• todo list

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:

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:

docker compose up --build -d

manual

• to run it manually, build it with go build -o abyss and run:

URL="your-domain" AUTH_USERNAME=admin AUTH_PASSWORD=admin ./abyss

uploading

• then, simply upload your files with curl:

curl -F "file=@/path/to/file" -H "X-Auth: "$(cat /path/to/.key) http://localhost:8080/

todo:

• add upload of logs funcionality (like 0x0.st)
• add docker easy setup
• add db for tracking of file names (dont need that)
• add file browser (like file://)
• add file extension in its name
• login prompt when accessing /tree
• add rate limits