A dead-simple, self-hostable file-upload service, written in C using Mongoose.
This project is largely based off of my pacebin, itself based off of my clink project. The code is nearly identical to that found on pacebin, as they're pretty much the exact same thing.
Please access this project on my Gitea instance, NOT GitHub.
- Tiny executable size (~80kb)
- No dependencies, just libc
- Extremely simple to use--basic POST and GET
- No bloated webapp, just a simple reverse proxy
- Super light on resources
- Basic and easy file deletion
- No duplicate filenames
- Fast!
- Basic filesystem storage--easy to manage without external programs/libraries
You can host this yourself.
Note: all commands here are done as root.
To build this project, you'll need a libc implementation (only tested with glibc), optionally a separate libcrypt implementation, and Git. Most Linux distributions should have all of these by default, but in case yours doesn't:
pacman -S glibc libxcrypt git
emerge --ask sys-libs/glibc dev-vcs/git
apt install glibc git
- Clone this repository:
git clone https://git.swurl.xyz/swirl/trance && cd trance
- Now, you need to compile. When compiling, you can easily change the maximum size of uploaded files. Simply specify the variable
MAX_SIZE
; i.e. for a 100MB limit:make MAX_SIZE=104857600
. This defaults to 50MB.
make
- Now, you need to install. NGINX and systemd files are provided in this project; you may choose not to install them.
For all install commands, you may optionally provide prefix
and DESTDIR
options. This is useful for packagers; i.e. for a PKGBUILD: make prefix=/usr DESTDIR=${pkgdir} install
.
Available install commands are as follows:
make install
installs the executable, NGINX, and systemd files.make install-bin
installs the executable file.make install-systemd
installs the systemd file, as well as its environment file.make install-nginx
installs the NGINX file.
For example, on a non-systemd system using NGINX, you would run make install-bin install-nginx
.
- If using systemd, change the environment file to reflect your desired options:
vim /etc/trance.conf
- You can now enable and start the service:
systemctl enable --now trance
The server should now be running on localhost at port 8082.
An NGINX file is provided with this project. Sorry, no support for Apache or lighttpd or anything else; should've chosen a better HTTP server.
For this, you'll need NGINX (obviously), certbot, and its NGINX plugin. Most Linux distributions should have these in their repositories, i.e.:
pacman -S nginx certbot-nginx
emerge --ask www-servers/nginx app-crypt/certbot-nginx
apt install nginx python-certbot-nginx
This section assumes you've already followed the last.
- Change the domain in the NGINX file:
sed -i 's/your.doma.in/[DOMAIN HERE]' /etc/nginx/sites-available/trance
- Enable the site:
ln -s /etc/nginx/sites-{available,enabled}/trance
- Enable HTTPS for the site:
certbot --nginx -d [DOMAIN HERE]
- Enable and start NGINX:
systemctl enable --now nginx
If it's already running, reload:
systemctl reload nginx
Your site should be running at https://your.doma.in. Test it by going there, and trying the examples. If they don't work, open an issue.
Contributions are always welcome.
Clean it up, janny!
Deleting a file can be done simply by running:
rm /srv/trance/*/SHORTIDHERE
The short ID is the random hexadecimal string BEFORE the filename. You can usually find it through NGINX logs or something.
Replace /srv/trance
with whatever your data directory is.
No. While it might be possible through some NGINX stuff, this is not supported nor it is encouraged.
No. If access logs are turned on, then the server administrator can see your IP, but management of access logs is up to them.
Probably, I don't know. Won't have HTTPS though, so either way, I heavily recommend you use a reverse proxy.
The seed is used for generating deletion keys. Do not share it whatsoever.
I've only tested it on my Arch Linux server, but it should work perfectly fine on all Linux distributions. Probably doesn't work on Windows.
Yes. Simply put the proxy_pass
directive in a subdirectory, i.e.:
location /paste {
proxy_pass http:https://localhost:8082;
}
Every file upload service sucks. Simple as. All of the self-hostable options I could find had problems, including:
- Loads of unnecessary dependencies
- Huge executable size (Go lol)
- Used some bloated webapp with no basic API
- Feature bloat; i.e. encryption, auto-expiration, etc.
- Written in Ruby, NodeJS, PHP, or some other bad language
- No direct reverse-proxy support
- Reliance on statically serving the index files
- Reliance on static configuration like the host
- Reliance on other services (i.e. link shorteners)
This project is intended to be a file upload service that is as simple as possible. Literally just upload, download, and delete files. That's it.
Also, there were surprisingly none written in C.