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. probably.

table of contents

• running abyss
  • installing with docker
  • installing manually
• uploading files
• docs
• todo list

running:

• run ./generate_config.sh to setup the necessary environment variables

docker

• to run with docker, you can use docker compose:

docker compose up -d # might be docker-compose depending on distro

• you can optionally use the docker image directly and set it up how you want

manual

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

./abyss

uploading

• then, simply upload your files with curl:

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

docs

• ABYSS_URL: this is used for the correct formatting of the response of curl.
• AUTH_USERNAME | AUTH_PASSWORD: this is used to access /tree/, which shows all uploaded files
• 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

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